boost/doc/html/boost_asio/reference/ssl__rfc2818_verification.html
2021-10-05 21:37:46 +02:00

179 lines
7.8 KiB
HTML

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::rfc2818_verification</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="ssl__host_name_verification/result_type.html" title="ssl::host_name_verification::result_type">
<link rel="next" href="ssl__rfc2818_verification/operator_lp__rp_.html" title="ssl::rfc2818_verification::operator()">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="ssl__host_name_verification/result_type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="ssl__rfc2818_verification/operator_lp__rp_.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_asio.reference.ssl__rfc2818_verification"></a><a class="link" href="ssl__rfc2818_verification.html" title="ssl::rfc2818_verification">ssl::rfc2818_verification</a>
</h3></div></div></div>
<p>
<a class="indexterm" name="boost_asio.indexterm.ssl__rfc2818_verification"></a>
</p>
<p>
(Deprecated. Use <a class="link" href="ssl__host_name_verification.html" title="ssl::host_name_verification"><code class="computeroutput">ssl::host_name_verification</code></a>.)
Verifies a certificate against a hostname according to the rules described
in RFC 2818.
</p>
<pre class="programlisting">class rfc2818_verification
</pre>
<h5>
<a name="boost_asio.reference.ssl__rfc2818_verification.h0"></a>
<span class="phrase"><a name="boost_asio.reference.ssl__rfc2818_verification.types"></a></span><a class="link" href="ssl__rfc2818_verification.html#boost_asio.reference.ssl__rfc2818_verification.types">Types</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<a class="link" href="ssl__rfc2818_verification/result_type.html" title="ssl::rfc2818_verification::result_type"><span class="bold"><strong>result_type</strong></span></a>
</p>
</td>
<td>
<p>
The type of the function object's result.
</p>
</td>
</tr></tbody>
</table></div>
<h5>
<a name="boost_asio.reference.ssl__rfc2818_verification.h1"></a>
<span class="phrase"><a name="boost_asio.reference.ssl__rfc2818_verification.member_functions"></a></span><a class="link" href="ssl__rfc2818_verification.html#boost_asio.reference.ssl__rfc2818_verification.member_functions">Member
Functions</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<a class="link" href="ssl__rfc2818_verification/operator_lp__rp_.html" title="ssl::rfc2818_verification::operator()"><span class="bold"><strong>operator()</strong></span></a>
</p>
</td>
<td>
<p>
Perform certificate verification.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__rfc2818_verification/rfc2818_verification.html" title="ssl::rfc2818_verification::rfc2818_verification"><span class="bold"><strong>rfc2818_verification</strong></span></a> <span class="silver">[constructor]</span>
</p>
</td>
<td>
<p>
Constructor.
</p>
</td>
</tr>
</tbody>
</table></div>
<h5>
<a name="boost_asio.reference.ssl__rfc2818_verification.h2"></a>
<span class="phrase"><a name="boost_asio.reference.ssl__rfc2818_verification.example"></a></span><a class="link" href="ssl__rfc2818_verification.html#boost_asio.reference.ssl__rfc2818_verification.example">Example</a>
</h5>
<p>
The following example shows how to synchronously open a secure connection
to a given host name:
</p>
<pre class="programlisting">using boost::asio::ip::tcp;
namespace ssl = boost::asio::ssl;
typedef ssl::stream&lt;tcp::socket&gt; ssl_socket;
// Create a context that uses the default paths for finding CA certificates.
ssl::context ctx(ssl::context::sslv23);
ctx.set_default_verify_paths();
// Open a socket and connect it to the remote host.
boost::asio::io_context io_context;
ssl_socket sock(io_context, ctx);
tcp::resolver resolver(io_context);
tcp::resolver::query query("host.name", "https");
boost::asio::connect(sock.lowest_layer(), resolver.resolve(query));
sock.lowest_layer().set_option(tcp::no_delay(true));
// Perform SSL handshake and verify the remote host's certificate.
sock.set_verify_mode(ssl::verify_peer);
sock.set_verify_callback(ssl::rfc2818_verification("host.name"));
sock.handshake(ssl_socket::client);
// ... read and write as normal ...
</pre>
<h5>
<a name="boost_asio.reference.ssl__rfc2818_verification.h3"></a>
<span class="phrase"><a name="boost_asio.reference.ssl__rfc2818_verification.requirements"></a></span><a class="link" href="ssl__rfc2818_verification.html#boost_asio.reference.ssl__rfc2818_verification.requirements">Requirements</a>
</h5>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/ssl/rfc2818_verification.hpp</code>
</p>
<p>
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio/ssl.hpp</code>
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2003-2021 Christopher
M. Kohlhoff<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="ssl__host_name_verification/result_type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="ssl__rfc2818_verification/operator_lp__rp_.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>