mirror of
https://github.com/yhirose/cpp-httplib.git
synced 2026-04-12 11:48:30 +00:00
232 lines
17 KiB
HTML
232 lines
17 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en" data-base-path="/cpp-httplib">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<title>TLS Setup - cpp-httplib</title>
|
|
<link rel="icon" type="image/svg+xml" href="/cpp-httplib/favicon.svg">
|
|
<link rel="stylesheet" href="/cpp-httplib/css/main.css">
|
|
<script>
|
|
(function() {
|
|
var t = localStorage.getItem('preferred-theme');
|
|
if (!t) t = window.matchMedia('(prefers-color-scheme: light)').matches ? 'light' : 'dark';
|
|
if (t === 'light') document.documentElement.setAttribute('data-theme', 'light');
|
|
})();
|
|
</script>
|
|
</head>
|
|
<body>
|
|
<header class="header">
|
|
<div class="header-inner">
|
|
<a href="/cpp-httplib/en/" class="header-title">cpp-httplib <span style="font-size:0.75em;font-weight:normal;margin-left:4px">v0.36.0</span></a>
|
|
<div class="header-spacer"></div>
|
|
<nav class="header-nav">
|
|
<a href="/cpp-httplib/en/">
|
|
<svg xmlns="http://www.w3.org/2000/svg" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M3 9l9-7 9 7v11a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2z"/><polyline points="9 22 9 12 15 12 15 22"/></svg>
|
|
Home
|
|
</a>
|
|
|
|
|
|
<a href="/cpp-httplib/en/tour/">
|
|
<svg xmlns="http://www.w3.org/2000/svg" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><circle cx="12" cy="12" r="10"/><polygon points="16.24 7.76 14.12 14.12 7.76 16.24 9.88 9.88 16.24 7.76"/></svg>
|
|
Tour
|
|
</a>
|
|
|
|
|
|
|
|
<a href="https://github.com/yhirose/cpp-httplib" aria-label="GitHub">
|
|
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37 0 0 0-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44 0 0 0 20 4.77 5.07 5.07 0 0 0 19.91 1S18.73.65 16 2.48a13.38 13.38 0 0 0-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07 0 0 0 5 4.77a5.44 5.44 0 0 0-1.5 3.78c0 5.42 3.3 6.61 6.44 7A3.37 3.37 0 0 0 9 18.13V22"/></svg>
|
|
GitHub
|
|
</a>
|
|
|
|
|
|
</nav>
|
|
<div class="header-tools">
|
|
<button class="search-btn" aria-label="Search (⌘K)">
|
|
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><circle cx="11" cy="11" r="8"/><line x1="21" y1="21" x2="16.65" y2="16.65"/></svg>
|
|
</button>
|
|
<button class="theme-toggle" aria-label="Toggle theme"></button>
|
|
|
|
<div class="lang-selector">
|
|
<button class="lang-btn" aria-label="Language">
|
|
<svg xmlns="http://www.w3.org/2000/svg" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><circle cx="12" cy="12" r="10"/><line x1="2" y1="12" x2="22" y2="12"/><path d="M12 2a15.3 15.3 0 0 1 4 10 15.3 15.3 0 0 1-4 10 15.3 15.3 0 0 1-4-10 15.3 15.3 0 0 1 4-10z"/></svg>
|
|
EN
|
|
</button>
|
|
<ul class="lang-popup">
|
|
|
|
<li><a href="#" data-lang="en">EN</a></li>
|
|
|
|
<li><a href="#" data-lang="ja">JA</a></li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
<button class="sidebar-toggle" aria-label="Menu">☰</button>
|
|
</div>
|
|
</header>
|
|
|
|
|
|
|
|
<div class="layout has-sidebar">
|
|
|
|
<aside class="sidebar">
|
|
<nav class="sidebar-nav">
|
|
|
|
<div class="nav-section">
|
|
<a href="/cpp-httplib/en/tour/" class="nav-section-title active">A Tour of cpp-httplib</a>
|
|
|
|
<ul class="nav-list">
|
|
|
|
<li><a href="/cpp-httplib/en/tour/01-getting-started/" class="">Getting Started</a></li>
|
|
|
|
<li><a href="/cpp-httplib/en/tour/02-basic-client/" class="">Basic Client</a></li>
|
|
|
|
<li><a href="/cpp-httplib/en/tour/03-basic-server/" class="">Basic Server</a></li>
|
|
|
|
<li><a href="/cpp-httplib/en/tour/04-static-file-server/" class="">Static File Server</a></li>
|
|
|
|
<li><a href="/cpp-httplib/en/tour/05-tls-setup/" class="active">TLS Setup</a></li>
|
|
|
|
<li><a href="/cpp-httplib/en/tour/06-https-client/" class="">HTTPS Client</a></li>
|
|
|
|
<li><a href="/cpp-httplib/en/tour/07-https-server/" class="">HTTPS Server</a></li>
|
|
|
|
<li><a href="/cpp-httplib/en/tour/08-websocket/" class="">WebSocket</a></li>
|
|
|
|
<li><a href="/cpp-httplib/en/tour/09-whats-next/" class="">What's Next</a></li>
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
</nav>
|
|
</aside>
|
|
<main class="content">
|
|
<article>
|
|
<h1>TLS Setup</h1>
|
|
<p>So far we've been using plain HTTP, but in the real world, HTTPS is the norm. To use HTTPS with cpp-httplib, you need a TLS library.</p>
|
|
<p>In this tour, we'll use OpenSSL. It's the most widely used option, and you'll find plenty of resources online.</p>
|
|
<h2>Installing OpenSSL</h2>
|
|
<p>Install it for your OS.</p>
|
|
<table><thead><tr><th>OS</th><th>How to install</th></tr></thead><tbody>
|
|
<tr><td>macOS</td><td><a href="https://brew.sh/">Homebrew</a> (<code>brew install openssl</code>)</td></tr>
|
|
<tr><td>Ubuntu / Debian</td><td><code>sudo apt install libssl-dev</code></td></tr>
|
|
<tr><td>Windows</td><td><a href="https://vcpkg.io/">vcpkg</a> (<code>vcpkg install openssl</code>)</td></tr>
|
|
</tbody></table>
|
|
<h2>Compile Options</h2>
|
|
<p>To enable TLS, define the <code>CPPHTTPLIB_OPENSSL_SUPPORT</code> macro when compiling. You'll need a few extra options compared to the previous chapters.</p>
|
|
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
|
|
<span style="color:#65737e;"># macOS (Homebrew)
|
|
</span><span style="color:#8fa1b3;">clang++</span><span style="color:#bf616a;"> -std</span><span style="color:#c0c5ce;">=c++17</span><span style="color:#bf616a;"> -DCPPHTTPLIB_OPENSSL_SUPPORT </span><span style="color:#c0c5ce;">\
|
|
</span><span style="color:#bf616a;"> -I</span><span style="color:#c0c5ce;">$</span><span style="color:#bf616a;">(</span><span style="color:#8fa1b3;">brew</span><span style="color:#bf616a;"> --prefix openssl)</span><span style="color:#c0c5ce;">/include \
|
|
</span><span style="color:#bf616a;"> -L</span><span style="color:#c0c5ce;">$</span><span style="color:#bf616a;">(</span><span style="color:#8fa1b3;">brew</span><span style="color:#bf616a;"> --prefix openssl)</span><span style="color:#c0c5ce;">/lib \
|
|
</span><span style="color:#bf616a;"> -lssl -lcrypto </span><span style="color:#c0c5ce;">\
|
|
</span><span style="color:#bf616a;"> -framework</span><span style="color:#c0c5ce;"> CoreFoundation</span><span style="color:#bf616a;"> -framework</span><span style="color:#c0c5ce;"> Security \
|
|
</span><span style="color:#bf616a;"> -o</span><span style="color:#c0c5ce;"> server server.cpp
|
|
</span><span style="color:#c0c5ce;">
|
|
</span><span style="color:#65737e;"># Linux
|
|
</span><span style="color:#8fa1b3;">clang++</span><span style="color:#bf616a;"> -std</span><span style="color:#c0c5ce;">=c++17</span><span style="color:#bf616a;"> -pthread -DCPPHTTPLIB_OPENSSL_SUPPORT </span><span style="color:#c0c5ce;">\
|
|
</span><span style="color:#bf616a;"> -lssl -lcrypto </span><span style="color:#c0c5ce;">\
|
|
</span><span style="color:#bf616a;"> -o</span><span style="color:#c0c5ce;"> server server.cpp
|
|
</span><span style="color:#c0c5ce;">
|
|
</span><span style="color:#65737e;"># Windows (Developer Command Prompt)
|
|
</span><span style="color:#8fa1b3;">cl</span><span style="color:#c0c5ce;"> /EHsc /std:c++17 /DCPPHTTPLIB_OPENSSL_SUPPORT server.cpp libssl.lib libcrypto.lib
|
|
</span></pre>
|
|
</div><div data-code-theme="light"><pre style="background-color:#ffffff;">
|
|
<span style="font-style:italic;color:#969896;"># macOS (Homebrew)
|
|
</span><span style="color:#323232;">clang++ -std</span><span style="font-weight:bold;color:#a71d5d;">=</span><span style="color:#323232;">c++17 -DCPPHTTPLIB_OPENSSL_SUPPORT \
|
|
</span><span style="color:#323232;"> -I$(brew --prefix openssl)/include \
|
|
</span><span style="color:#323232;"> -L$(brew --prefix openssl)/lib \
|
|
</span><span style="color:#323232;"> -lssl -lcrypto \
|
|
</span><span style="color:#323232;"> -framework CoreFoundation -framework Security \
|
|
</span><span style="color:#323232;"> -o server server.cpp
|
|
</span><span style="color:#323232;">
|
|
</span><span style="font-style:italic;color:#969896;"># Linux
|
|
</span><span style="color:#323232;">clang++ -std</span><span style="font-weight:bold;color:#a71d5d;">=</span><span style="color:#323232;">c++17 -pthread -DCPPHTTPLIB_OPENSSL_SUPPORT \
|
|
</span><span style="color:#323232;"> -lssl -lcrypto \
|
|
</span><span style="color:#323232;"> -o server server.cpp
|
|
</span><span style="color:#323232;">
|
|
</span><span style="font-style:italic;color:#969896;"># Windows (Developer Command Prompt)
|
|
</span><span style="color:#323232;">cl /EHsc /std:c++17 /DCPPHTTPLIB_OPENSSL_SUPPORT server.cpp libssl.lib libcrypto.lib
|
|
</span></pre>
|
|
</div></div>
|
|
<p>Let's look at what each option does.</p>
|
|
<ul>
|
|
<li><strong><code>-DCPPHTTPLIB_OPENSSL_SUPPORT</code></strong> — Defines the macro that enables TLS support</li>
|
|
<li><strong><code>-lssl -lcrypto</code></strong> — Links the OpenSSL libraries</li>
|
|
<li><strong><code>-I</code> / <code>-L</code></strong> (macOS only) — Points to the Homebrew OpenSSL paths</li>
|
|
<li><strong><code>-framework CoreFoundation -framework Security</code></strong> (macOS only) — Needed to automatically load system certificates from the Keychain</li>
|
|
</ul>
|
|
<h2>Verifying the Setup</h2>
|
|
<p>Let's make sure everything works. Here's a simple program that passes an HTTPS URL to <code>httplib::Client</code>.</p>
|
|
<div class="code-block-wrapper"><div data-code-theme="dark"><pre style="background-color:#2b303b;">
|
|
<span style="color:#b48ead;">#define </span><span style="color:#c0c5ce;">CPPHTTPLIB_OPENSSL_SUPPORT
|
|
</span><span style="color:#b48ead;">#include </span><span style="color:#c0c5ce;">"</span><span style="color:#a3be8c;">httplib.h</span><span style="color:#c0c5ce;">"
|
|
</span><span style="color:#b48ead;">#include </span><span style="color:#c0c5ce;"><</span><span style="color:#a3be8c;">iostream</span><span style="color:#c0c5ce;">>
|
|
</span><span style="color:#c0c5ce;">
|
|
</span><span style="color:#b48ead;">int </span><span style="color:#8fa1b3;">main</span><span style="color:#c0c5ce;">() {
|
|
</span><span style="color:#c0c5ce;"> httplib::Client </span><span style="color:#8fa1b3;">cli</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">https://www.google.com</span><span style="color:#c0c5ce;">");
|
|
</span><span style="color:#c0c5ce;">
|
|
</span><span style="color:#c0c5ce;"> </span><span style="color:#b48ead;">auto</span><span style="color:#c0c5ce;"> res = cli.</span><span style="color:#8fa1b3;">Get</span><span style="color:#c0c5ce;">("</span><span style="color:#a3be8c;">/</span><span style="color:#c0c5ce;">");
|
|
</span><span style="color:#c0c5ce;"> </span><span style="color:#b48ead;">if </span><span style="color:#c0c5ce;">(res) {
|
|
</span><span style="color:#c0c5ce;"> std::cout << "</span><span style="color:#a3be8c;">Status: </span><span style="color:#c0c5ce;">" << res-></span><span style="color:#bf616a;">status </span><span style="color:#c0c5ce;"><< std::endl;
|
|
</span><span style="color:#c0c5ce;"> } </span><span style="color:#b48ead;">else </span><span style="color:#c0c5ce;">{
|
|
</span><span style="color:#c0c5ce;"> std::cout << "</span><span style="color:#a3be8c;">Error: </span><span style="color:#c0c5ce;">" << </span><span style="color:#8fa1b3;">httplib::to_string</span><span style="color:#c0c5ce;">(res.</span><span style="color:#8fa1b3;">error</span><span style="color:#c0c5ce;">()) << std::endl;
|
|
</span><span style="color:#c0c5ce;"> }
|
|
</span><span style="color:#c0c5ce;">}
|
|
</span></pre>
|
|
</div><div data-code-theme="light"><pre style="background-color:#ffffff;">
|
|
<span style="font-weight:bold;color:#a71d5d;">#define </span><span style="color:#323232;">CPPHTTPLIB_OPENSSL_SUPPORT
|
|
</span><span style="font-weight:bold;color:#a71d5d;">#include </span><span style="color:#183691;">"httplib.h"
|
|
</span><span style="font-weight:bold;color:#a71d5d;">#include </span><span style="color:#183691;"><iostream>
|
|
</span><span style="color:#323232;">
|
|
</span><span style="font-weight:bold;color:#a71d5d;">int </span><span style="font-weight:bold;color:#795da3;">main</span><span style="color:#323232;">() {
|
|
</span><span style="color:#323232;"> httplib::Client cli(</span><span style="color:#183691;">"https://www.google.com"</span><span style="color:#323232;">);
|
|
</span><span style="color:#323232;">
|
|
</span><span style="color:#323232;"> </span><span style="font-weight:bold;color:#a71d5d;">auto</span><span style="color:#323232;"> res </span><span style="font-weight:bold;color:#a71d5d;">=</span><span style="color:#323232;"> cli.Get(</span><span style="color:#183691;">"/"</span><span style="color:#323232;">);
|
|
</span><span style="color:#323232;"> </span><span style="font-weight:bold;color:#a71d5d;">if </span><span style="color:#323232;">(res) {
|
|
</span><span style="color:#323232;"> std::cout </span><span style="font-weight:bold;color:#a71d5d;"><< </span><span style="color:#183691;">"Status: " </span><span style="font-weight:bold;color:#a71d5d;"><<</span><span style="color:#323232;"> res->status </span><span style="font-weight:bold;color:#a71d5d;"><<</span><span style="color:#323232;"> std::endl;
|
|
</span><span style="color:#323232;"> } </span><span style="font-weight:bold;color:#a71d5d;">else </span><span style="color:#323232;">{
|
|
</span><span style="color:#323232;"> std::cout </span><span style="font-weight:bold;color:#a71d5d;"><< </span><span style="color:#183691;">"Error: " </span><span style="font-weight:bold;color:#a71d5d;"><< </span><span style="color:#323232;">httplib::to_string(res.error()) </span><span style="font-weight:bold;color:#a71d5d;"><<</span><span style="color:#323232;"> std::endl;
|
|
</span><span style="color:#323232;"> }
|
|
</span><span style="color:#323232;">}
|
|
</span></pre>
|
|
</div></div>
|
|
<p>Compile and run it. If you see <code>Status: 200</code>, your setup is complete.</p>
|
|
<h2>Other TLS Backends</h2>
|
|
<p>cpp-httplib also supports Mbed TLS and wolfSSL in addition to OpenSSL. You can switch between them just by changing the macro definition and linked libraries.</p>
|
|
<table><thead><tr><th style="text-align: left">Backend</th><th style="text-align: left">Macro</th><th style="text-align: left">Libraries to link</th></tr></thead><tbody>
|
|
<tr><td style="text-align: left">OpenSSL</td><td style="text-align: left"><code>CPPHTTPLIB_OPENSSL_SUPPORT</code></td><td style="text-align: left"><code>libssl</code>, <code>libcrypto</code></td></tr>
|
|
<tr><td style="text-align: left">Mbed TLS</td><td style="text-align: left"><code>CPPHTTPLIB_MBEDTLS_SUPPORT</code></td><td style="text-align: left"><code>libmbedtls</code>, <code>libmbedx509</code>, <code>libmbedcrypto</code></td></tr>
|
|
<tr><td style="text-align: left">wolfSSL</td><td style="text-align: left"><code>CPPHTTPLIB_WOLFSSL_SUPPORT</code></td><td style="text-align: left"><code>libwolfssl</code></td></tr>
|
|
</tbody></table>
|
|
<p>This tour assumes OpenSSL, but the API is the same regardless of which backend you choose.</p>
|
|
<h2>Next Step</h2>
|
|
<p>You're all set with TLS. Next, let's send a request to an HTTPS site.</p>
|
|
<p><strong>Next:</strong> <a href="../06-https-client">HTTPS Client</a></p>
|
|
|
|
</article>
|
|
</main>
|
|
|
|
</div>
|
|
|
|
<footer class="footer">
|
|
© 2026 Yuji Hirose. All rights reserved.
|
|
</footer>
|
|
|
|
<!-- Search modal -->
|
|
<div class="search-overlay" id="search-overlay">
|
|
<div class="search-modal">
|
|
<div class="search-input-wrap">
|
|
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><circle cx="11" cy="11" r="8"/><line x1="21" y1="21" x2="16.65" y2="16.65"/></svg>
|
|
<input type="text" id="search-input" placeholder="Search..." autocomplete="off" spellcheck="false">
|
|
<kbd class="search-esc">ESC</kbd>
|
|
</div>
|
|
<ul class="search-results" id="search-results"></ul>
|
|
</div>
|
|
</div>
|
|
|
|
<script src="/cpp-httplib/js/main.js"></script>
|
|
</body>
|
|
</html>
|