Insane_DNS/libraries/asio-1.28.1/doc/asio/reference/ssl__rfc2818_verification.html

169 lines
11 KiB
HTML

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::rfc2818_verification</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="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()">
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="ssl__host_name_verification/result_type.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="ssl__rfc2818_verification/operator_lp__rp_.html"><img src="../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="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="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"><span class="identifier">ssl</span><span class="special">::</span><span class="identifier">host_name_verification</span></code></a>.)
Verifies a certificate against a hostname according to the rules described
in RFC 2818.
</p>
<pre class="programlisting"><span class="keyword">class</span> <span class="identifier">rfc2818_verification</span>
</pre>
<h5>
<a name="asio.reference.ssl__rfc2818_verification.h0"></a>
<span><a name="asio.reference.ssl__rfc2818_verification.types"></a></span><a class="link" href="ssl__rfc2818_verification.html#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="asio.reference.ssl__rfc2818_verification.h1"></a>
<span><a name="asio.reference.ssl__rfc2818_verification.member_functions"></a></span><a class="link" href="ssl__rfc2818_verification.html#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="asio.reference.ssl__rfc2818_verification.h2"></a>
<span><a name="asio.reference.ssl__rfc2818_verification.example"></a></span><a class="link" href="ssl__rfc2818_verification.html#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"><span class="keyword">using</span> <span class="identifier">asio</span><span class="special">::</span><span class="identifier">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">;</span>
<span class="keyword">namespace</span> <span class="identifier">ssl</span> <span class="special">=</span> <span class="identifier">asio</span><span class="special">::</span><span class="identifier">ssl</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">ssl</span><span class="special">::</span><span class="identifier">stream</span><span class="special">&lt;</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">socket</span><span class="special">&gt;</span> <span class="identifier">ssl_socket</span><span class="special">;</span>
<span class="comment">// Create a context that uses the default paths for finding CA certificates.</span>
<span class="identifier">ssl</span><span class="special">::</span><span class="identifier">context</span> <span class="identifier">ctx</span><span class="special">(</span><span class="identifier">ssl</span><span class="special">::</span><span class="identifier">context</span><span class="special">::</span><span class="identifier">sslv23</span><span class="special">);</span>
<span class="identifier">ctx</span><span class="special">.</span><span class="identifier">set_default_verify_paths</span><span class="special">();</span>
<span class="comment">// Open a socket and connect it to the remote host.</span>
<span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_context</span> <span class="identifier">io_context</span><span class="special">;</span>
<span class="identifier">ssl_socket</span> <span class="identifier">sock</span><span class="special">(</span><span class="identifier">io_context</span><span class="special">,</span> <span class="identifier">ctx</span><span class="special">);</span>
<span class="identifier">tcp</span><span class="special">::</span><span class="identifier">resolver</span> <span class="identifier">resolver</span><span class="special">(</span><span class="identifier">io_context</span><span class="special">);</span>
<span class="identifier">tcp</span><span class="special">::</span><span class="identifier">resolver</span><span class="special">::</span><span class="identifier">query</span> <span class="identifier">query</span><span class="special">(</span><span class="string">"host.name"</span><span class="special">,</span> <span class="string">"https"</span><span class="special">);</span>
<span class="identifier">asio</span><span class="special">::</span><span class="identifier">connect</span><span class="special">(</span><span class="identifier">sock</span><span class="special">.</span><span class="identifier">lowest_layer</span><span class="special">(),</span> <span class="identifier">resolver</span><span class="special">.</span><span class="identifier">resolve</span><span class="special">(</span><span class="identifier">query</span><span class="special">));</span>
<span class="identifier">sock</span><span class="special">.</span><span class="identifier">lowest_layer</span><span class="special">().</span><span class="identifier">set_option</span><span class="special">(</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">no_delay</span><span class="special">(</span><span class="keyword">true</span><span class="special">));</span>
<span class="comment">// Perform SSL handshake and verify the remote host's certificate.</span>
<span class="identifier">sock</span><span class="special">.</span><span class="identifier">set_verify_mode</span><span class="special">(</span><span class="identifier">ssl</span><span class="special">::</span><span class="identifier">verify_peer</span><span class="special">);</span>
<span class="identifier">sock</span><span class="special">.</span><span class="identifier">set_verify_callback</span><span class="special">(</span><span class="identifier">ssl</span><span class="special">::</span><span class="identifier">rfc2818_verification</span><span class="special">(</span><span class="string">"host.name"</span><span class="special">));</span>
<span class="identifier">sock</span><span class="special">.</span><span class="identifier">handshake</span><span class="special">(</span><span class="identifier">ssl_socket</span><span class="special">::</span><span class="identifier">client</span><span class="special">);</span>
<span class="comment">// ... read and write as normal ...</span>
</pre>
<h5>
<a name="asio.reference.ssl__rfc2818_verification.h3"></a>
<span><a name="asio.reference.ssl__rfc2818_verification.requirements"></a></span><a class="link" href="ssl__rfc2818_verification.html#asio.reference.ssl__rfc2818_verification.requirements">Requirements</a>
</h5>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/ssl/rfc2818_verification.hpp</code>
</p>
<p>
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio/ssl.hpp</code>
</p>
</div>
<div class="copyright-footer">Copyright © 2003-2023 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>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="ssl__host_name_verification/result_type.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="ssl__rfc2818_verification/operator_lp__rp_.html"><img src="../../next.png" alt="Next"></a>
</div>
</body>
</html>