blob: 6e45b97db896f68dfaa309e537720aeb2af979fa [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>ssl::context_base</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="ssl__context.html" title="ssl::context">
<link rel="next" href="ssl__context_base/default_workarounds.html" title="ssl::context_base::default_workarounds">
</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__context.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_base/default_workarounds.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_base"></a><a class="link" href="ssl__context_base.html" title="ssl::context_base">ssl::context_base</a>
</h3></div></div></div>
<p>
The <a class="link" href="ssl__context_base.html" title="ssl::context_base"><code class="computeroutput"><span class="identifier">ssl</span><span class="special">::</span><span class="identifier">context_base</span></code></a>
class is used as a base for the <a class="link" href="ssl__basic_context.html" title="ssl::basic_context"><code class="computeroutput"><span class="identifier">ssl</span><span class="special">::</span><span class="identifier">basic_context</span></code></a>
class template so that we have a common place to define various enums.
</p>
<pre class="programlisting"><span class="keyword">class</span> <span class="identifier">context_base</span>
</pre>
<a name="boost_asio.reference.ssl__context_base.types"></a><h5>
<a name="id1334704"></a>
<a class="link" href="ssl__context_base.html#boost_asio.reference.ssl__context_base.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_base/file_format.html" title="ssl::context_base::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_base/method.html" title="ssl::context_base::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_base/options.html" title="ssl::context_base::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_base/password_purpose.html" title="ssl::context_base::password_purpose"><span class="bold"><strong>password_purpose</strong></span></a>
</p>
</td>
<td>
<p>
Purpose of PEM password.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context_base/verify_mode.html" title="ssl::context_base::verify_mode"><span class="bold"><strong>verify_mode</strong></span></a>
</p>
</td>
<td>
<p>
Bitmask type for peer verification.
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="boost_asio.reference.ssl__context_base.protected_member_functions"></a><h5>
<a name="id1334911"></a>
<a class="link" href="ssl__context_base.html#boost_asio.reference.ssl__context_base.protected_member_functions">Protected
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_base/_context_base.html" title="ssl::context_base::~context_base"><span class="bold"><strong>~context_base</strong></span></a>
</p>
</td>
<td>
<p>
Protected destructor to prevent deletion through this type.
</p>
</td>
</tr></tbody>
</table></div>
<a name="boost_asio.reference.ssl__context_base.data_members"></a><h5>
<a name="id1334997"></a>
<a class="link" href="ssl__context_base.html#boost_asio.reference.ssl__context_base.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_base/default_workarounds.html" title="ssl::context_base::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_base/no_sslv2.html" title="ssl::context_base::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_base/no_sslv3.html" title="ssl::context_base::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_base/no_tlsv1.html" title="ssl::context_base::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_base/single_dh_use.html" title="ssl::context_base::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>
<tr>
<td>
<p>
<a class="link" href="ssl__context_base/verify_client_once.html" title="ssl::context_base::verify_client_once"><span class="bold"><strong>verify_client_once</strong></span></a>
</p>
</td>
<td>
<p>
Do not request client certificate on renegotiation. Ignored unless
verify_peer is set.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context_base/verify_fail_if_no_peer_cert.html" title="ssl::context_base::verify_fail_if_no_peer_cert"><span class="bold"><strong>verify_fail_if_no_peer_cert</strong></span></a>
</p>
</td>
<td>
<p>
Fail verification if the peer has no certificate. Ignored unless
verify_peer is set.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context_base/verify_none.html" title="ssl::context_base::verify_none"><span class="bold"><strong>verify_none</strong></span></a>
</p>
</td>
<td>
<p>
No verification.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context_base/verify_peer.html" title="ssl::context_base::verify_peer"><span class="bold"><strong>verify_peer</strong></span></a>
</p>
</td>
<td>
<p>
Verify the peer.
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="boost_asio.reference.ssl__context_base.requirements"></a><h5>
<a name="id1335326"></a>
<a class="link" href="ssl__context_base.html#boost_asio.reference.ssl__context_base.requirements">Requirements</a>
</h5>
<p>
<span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/ssl/context_base.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 - 2010 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__context.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_base/default_workarounds.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>