Google Git
Sign in
android / platform / external / boost / 077d563efdb280a3d144892e2d0ca01e6a49f454 / . / doc / html / boost_asio / reference / ssl__context.html
blob: f74efb4866bd946295aeaf790987de0006fc346f [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>ssl::context</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="socket_base/_socket_base.html" title="socket_base::~socket_base">
<link rel="next" href="ssl__context/add_verify_path.html" title="ssl::context::add_verify_path">
</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="socket_base/_socket_base.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__context/add_verify_path.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__context"></a><a class="link" href="ssl__context.html" title="ssl::context">ssl::context</a>
</h3></div></div></div>
<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>
<a name="boost_asio.reference.ssl__context.types"></a><h5>
<a name="boost_asio.reference.ssl__context.types-heading"></a>
<a class="link" href="ssl__context.html#boost_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/impl_type.html" title="ssl::context::impl_type"><span class="bold"><strong>impl_type</strong></span></a>
</p>
</td>
<td>
<p>
(Deprecated: Use native_handle_type.) The native type of the SSL
context.
</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>
<a name="boost_asio.reference.ssl__context.member_functions"></a><h5>
<a name="boost_asio.reference.ssl__context.member_functions-heading"></a>
<a class="link" href="ssl__context.html#boost_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_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/context.html" title="ssl::context::context"><span class="bold"><strong>context</strong></span></a>
</p>
</td>
<td>
<p>
Constructor.
</p>
<p>
Deprecated constructor taking a reference to an io_service object.
</p>
<p>
Move-construct a context from another.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context/impl.html" title="ssl::context::impl"><span class="bold"><strong>impl</strong></span></a>
</p>
</td>
<td>
<p>
(Deprecated: Use native_handle().) Get the underlying implementation
in the native type.
</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_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_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_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_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_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>
</p>
</td>
<td>
<p>
Destructor.
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="boost_asio.reference.ssl__context.data_members"></a><h5>
<a name="boost_asio.reference.ssl__context.data_members-heading"></a>
<a class="link" href="ssl__context.html#boost_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>
</p>
</td>
<td>
<p>
Implement various bug workarounds.
</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>
</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>
</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>
</p>
</td>
<td>
<p>
Disable TLS v1.
</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>
</p>
</td>
<td>
<p>
Always create a new key when using tmp_dh parameters.
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="boost_asio.reference.ssl__context.requirements"></a><h5>
<a name="boost_asio.reference.ssl__context.requirements-heading"></a>
<a class="link" href="ssl__context.html#boost_asio.reference.ssl__context.requirements">Requirements</a>
</h5>
<p>
<span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/ssl/context.hpp</code>
</p>
<p>
<span class="bold"><strong>Convenience header: </strong></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 &#169; 2003-2011 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="socket_base/_socket_base.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__context/add_verify_path.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>