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

587 lines
19 KiB
HTML
Raw Normal View History

2023-10-24 21:59:30 -04:00
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::context</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="spawn/overload13.html" title="spawn (13 of 13 overloads)">
<link rel="next" href="ssl__context/add_certificate_authority.html" title="ssl::context::add_certificate_authority">
<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="spawn/overload13.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__context/add_certificate_authority.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__context"></a><a class="link" href="ssl__context.html" title="ssl::context">ssl::context</a>
</h3></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.ssl__context"></a>
</p>
<pre class="programlisting"><span class="keyword">class</span> <span class="identifier">context</span> <span class="special">:</span>
<span class="keyword">public</span> <span class="identifier">ssl</span><span class="special">::</span><span class="identifier">context_base</span><span class="special">,</span>
<span class="identifier">noncopyable</span>
</pre>
<h5>
<a name="asio.reference.ssl__context.h0"></a>
<span><a name="asio.reference.ssl__context.types"></a></span><a class="link" href="ssl__context.html#asio.reference.ssl__context.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__context/file_format.html" title="ssl::context::file_format"><span class="bold"><strong>file_format</strong></span></a>
</p>
</td>
<td>
<p>
File format types.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/method.html" title="ssl::context::method"><span class="bold"><strong>method</strong></span></a>
</p>
</td>
<td>
<p>
Different methods supported by a context.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/native_handle_type.html" title="ssl::context::native_handle_type"><span class="bold"><strong>native_handle_type</strong></span></a>
</p>
</td>
<td>
<p>
The native handle type of the SSL context.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/options.html" title="ssl::context::options"><span class="bold"><strong>options</strong></span></a>
</p>
</td>
<td>
<p>
Bitmask type for SSL options.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/password_purpose.html" title="ssl::context::password_purpose"><span class="bold"><strong>password_purpose</strong></span></a>
</p>
</td>
<td>
<p>
Purpose of PEM password.
</p>
</td>
</tr>
</tbody>
</table></div>
<h5>
<a name="asio.reference.ssl__context.h1"></a>
<span><a name="asio.reference.ssl__context.member_functions"></a></span><a class="link" href="ssl__context.html#asio.reference.ssl__context.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__context/add_certificate_authority.html" title="ssl::context::add_certificate_authority"><span class="bold"><strong>add_certificate_authority</strong></span></a>
</p>
</td>
<td>
<p>
Add certification authority for performing verification.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/add_verify_path.html" title="ssl::context::add_verify_path"><span class="bold"><strong>add_verify_path</strong></span></a>
</p>
</td>
<td>
<p>
Add a directory containing certificate authority files to be used
for performing verification.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/clear_options.html" title="ssl::context::clear_options"><span class="bold"><strong>clear_options</strong></span></a>
</p>
</td>
<td>
<p>
Clear options on the context.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/context.html" title="ssl::context::context"><span class="bold"><strong>context</strong></span></a>
<span class="silver">[constructor]</span>
</p>
</td>
<td>
<p>
Constructor. <br> <span class="silver"></span><br> Construct to take ownership of a native
handle. <br> <span class="silver"></span><br> Move-construct a context from another.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/load_verify_file.html" title="ssl::context::load_verify_file"><span class="bold"><strong>load_verify_file</strong></span></a>
</p>
</td>
<td>
<p>
Load a certification authority file for performing verification.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/native_handle.html" title="ssl::context::native_handle"><span class="bold"><strong>native_handle</strong></span></a>
</p>
</td>
<td>
<p>
Get the underlying implementation in the native type.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/operator_eq_.html" title="ssl::context::operator="><span class="bold"><strong>operator=</strong></span></a>
</p>
</td>
<td>
<p>
Move-assign a context from another.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/set_default_verify_paths.html" title="ssl::context::set_default_verify_paths"><span class="bold"><strong>set_default_verify_paths</strong></span></a>
</p>
</td>
<td>
<p>
Configures the context to use the default directories for finding
certification authority certificates.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/set_options.html" title="ssl::context::set_options"><span class="bold"><strong>set_options</strong></span></a>
</p>
</td>
<td>
<p>
Set options on the context.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/set_password_callback.html" title="ssl::context::set_password_callback"><span class="bold"><strong>set_password_callback</strong></span></a>
</p>
</td>
<td>
<p>
Set the password callback.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/set_verify_callback.html" title="ssl::context::set_verify_callback"><span class="bold"><strong>set_verify_callback</strong></span></a>
</p>
</td>
<td>
<p>
Set the callback used to verify peer certificates.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/set_verify_depth.html" title="ssl::context::set_verify_depth"><span class="bold"><strong>set_verify_depth</strong></span></a>
</p>
</td>
<td>
<p>
Set the peer verification depth.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/set_verify_mode.html" title="ssl::context::set_verify_mode"><span class="bold"><strong>set_verify_mode</strong></span></a>
</p>
</td>
<td>
<p>
Set the peer verification mode.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/use_certificate.html" title="ssl::context::use_certificate"><span class="bold"><strong>use_certificate</strong></span></a>
</p>
</td>
<td>
<p>
Use a certificate from a memory buffer.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/use_certificate_chain.html" title="ssl::context::use_certificate_chain"><span class="bold"><strong>use_certificate_chain</strong></span></a>
</p>
</td>
<td>
<p>
Use a certificate chain from a memory buffer.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/use_certificate_chain_file.html" title="ssl::context::use_certificate_chain_file"><span class="bold"><strong>use_certificate_chain_file</strong></span></a>
</p>
</td>
<td>
<p>
Use a certificate chain from a file.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/use_certificate_file.html" title="ssl::context::use_certificate_file"><span class="bold"><strong>use_certificate_file</strong></span></a>
</p>
</td>
<td>
<p>
Use a certificate from a file.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/use_private_key.html" title="ssl::context::use_private_key"><span class="bold"><strong>use_private_key</strong></span></a>
</p>
</td>
<td>
<p>
Use a private key from a memory buffer.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/use_private_key_file.html" title="ssl::context::use_private_key_file"><span class="bold"><strong>use_private_key_file</strong></span></a>
</p>
</td>
<td>
<p>
Use a private key from a file.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/use_rsa_private_key.html" title="ssl::context::use_rsa_private_key"><span class="bold"><strong>use_rsa_private_key</strong></span></a>
</p>
</td>
<td>
<p>
Use an RSA private key from a memory buffer.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/use_rsa_private_key_file.html" title="ssl::context::use_rsa_private_key_file"><span class="bold"><strong>use_rsa_private_key_file</strong></span></a>
</p>
</td>
<td>
<p>
Use an RSA private key from a file.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/use_tmp_dh.html" title="ssl::context::use_tmp_dh"><span class="bold"><strong>use_tmp_dh</strong></span></a>
</p>
</td>
<td>
<p>
Use the specified memory buffer to obtain the temporary Diffie-Hellman
parameters.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/use_tmp_dh_file.html" title="ssl::context::use_tmp_dh_file"><span class="bold"><strong>use_tmp_dh_file</strong></span></a>
</p>
</td>
<td>
<p>
Use the specified file to obtain the temporary Diffie-Hellman parameters.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/_context.html" title="ssl::context::~context"><span class="bold"><strong>~context</strong></span></a> <span class="silver">[destructor]</span>
</p>
</td>
<td>
<p>
Destructor.
</p>
</td>
</tr>
</tbody>
</table></div>
<h5>
<a name="asio.reference.ssl__context.h2"></a>
<span><a name="asio.reference.ssl__context.data_members"></a></span><a class="link" href="ssl__context.html#asio.reference.ssl__context.data_members">Data
Members</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__context/default_workarounds.html" title="ssl::context::default_workarounds"><span class="bold"><strong>default_workarounds</strong></span></a> <span class="silver">[static]</span>
</p>
</td>
<td>
<p>
Implement various bug workarounds.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/no_compression.html" title="ssl::context::no_compression"><span class="bold"><strong>no_compression</strong></span></a> <span class="silver">[static]</span>
</p>
</td>
<td>
<p>
Disable compression. Compression is disabled by default.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/no_sslv2.html" title="ssl::context::no_sslv2"><span class="bold"><strong>no_sslv2</strong></span></a> <span class="silver">[static]</span>
</p>
</td>
<td>
<p>
Disable SSL v2.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/no_sslv3.html" title="ssl::context::no_sslv3"><span class="bold"><strong>no_sslv3</strong></span></a> <span class="silver">[static]</span>
</p>
</td>
<td>
<p>
Disable SSL v3.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/no_tlsv1.html" title="ssl::context::no_tlsv1"><span class="bold"><strong>no_tlsv1</strong></span></a> <span class="silver">[static]</span>
</p>
</td>
<td>
<p>
Disable TLS v1.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/no_tlsv1_1.html" title="ssl::context::no_tlsv1_1"><span class="bold"><strong>no_tlsv1_1</strong></span></a> <span class="silver">[static]</span>
</p>
</td>
<td>
<p>
Disable TLS v1.1.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/no_tlsv1_2.html" title="ssl::context::no_tlsv1_2"><span class="bold"><strong>no_tlsv1_2</strong></span></a> <span class="silver">[static]</span>
</p>
</td>
<td>
<p>
Disable TLS v1.2.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/no_tlsv1_3.html" title="ssl::context::no_tlsv1_3"><span class="bold"><strong>no_tlsv1_3</strong></span></a> <span class="silver">[static]</span>
</p>
</td>
<td>
<p>
Disable TLS v1.3.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/single_dh_use.html" title="ssl::context::single_dh_use"><span class="bold"><strong>single_dh_use</strong></span></a> <span class="silver">[static]</span>
</p>
</td>
<td>
<p>
Always create a new key when using tmp_dh parameters.
</p>
</td>
</tr>
</tbody>
</table></div>
<h5>
<a name="asio.reference.ssl__context.h3"></a>
<span><a name="asio.reference.ssl__context.requirements"></a></span><a class="link" href="ssl__context.html#asio.reference.ssl__context.requirements">Requirements</a>
</h5>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/ssl/context.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="spawn/overload13.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__context/add_certificate_authority.html"><img src="../../next.png" alt="Next"></a>
</div>
</body>
</html>