2 // ssl/context_base.hpp
3 // ~~~~~~~~~~~~~~~~~~~~
5 // Copyright (c) 2003-2016 Christopher M. Kohlhoff (chris at kohlhoff dot com)
7 // Distributed under the Boost Software License, Version 1.0. (See accompanying
8 // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
11 #ifndef BOOST_ASIO_SSL_CONTEXT_BASE_HPP
12 #define BOOST_ASIO_SSL_CONTEXT_BASE_HPP
14 #if defined(_MSC_VER) && (_MSC_VER >= 1200)
16 #endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
18 #include <boost/asio/detail/config.hpp>
19 #include <boost/asio/ssl/detail/openssl_types.hpp>
21 #include <boost/asio/detail/push_options.hpp>
27 /// The context_base class is used as a base for the basic_context class
28 /// template so that we have a common place to define various enums.
32 /// Different methods supported by a context.
35 /// Generic SSL version 2.
38 /// SSL version 2 client.
41 /// SSL version 2 server.
44 /// Generic SSL version 3.
47 /// SSL version 3 client.
50 /// SSL version 3 server.
53 /// Generic TLS version 1.
56 /// TLS version 1 client.
59 /// TLS version 1 server.
71 /// Generic TLS version 1.1.
74 /// TLS version 1.1 client.
77 /// TLS version 1.1 server.
80 /// Generic TLS version 1.2.
83 /// TLS version 1.2 client.
86 /// TLS version 1.2 server.
90 /// Bitmask type for SSL options.
93 #if defined(GENERATING_DOCUMENTATION)
94 /// Implement various bug workarounds.
95 static const long default_workarounds = implementation_defined;
97 /// Always create a new key when using tmp_dh parameters.
98 static const long single_dh_use = implementation_defined;
101 static const long no_sslv2 = implementation_defined;
104 static const long no_sslv3 = implementation_defined;
107 static const long no_tlsv1 = implementation_defined;
109 /// Disable TLS v1.1.
110 static const long no_tlsv1_1 = implementation_defined;
112 /// Disable TLS v1.2.
113 static const long no_tlsv1_2 = implementation_defined;
115 /// Disable compression. Compression is disabled by default.
116 static const long no_compression = implementation_defined;
118 BOOST_ASIO_STATIC_CONSTANT(long, default_workarounds = SSL_OP_ALL);
119 BOOST_ASIO_STATIC_CONSTANT(long, single_dh_use = SSL_OP_SINGLE_DH_USE);
120 BOOST_ASIO_STATIC_CONSTANT(long, no_sslv2 = SSL_OP_NO_SSLv2);
121 BOOST_ASIO_STATIC_CONSTANT(long, no_sslv3 = SSL_OP_NO_SSLv3);
122 BOOST_ASIO_STATIC_CONSTANT(long, no_tlsv1 = SSL_OP_NO_TLSv1);
123 # if defined(SSL_OP_NO_TLSv1_1)
124 BOOST_ASIO_STATIC_CONSTANT(long, no_tlsv1_1 = SSL_OP_NO_TLSv1_1);
125 # else // defined(SSL_OP_NO_TLSv1_1)
126 BOOST_ASIO_STATIC_CONSTANT(long, no_tlsv1_1 = 0x10000000L);
127 # endif // defined(SSL_OP_NO_TLSv1_1)
128 # if defined(SSL_OP_NO_TLSv1_2)
129 BOOST_ASIO_STATIC_CONSTANT(long, no_tlsv1_2 = SSL_OP_NO_TLSv1_2);
130 # else // defined(SSL_OP_NO_TLSv1_2)
131 BOOST_ASIO_STATIC_CONSTANT(long, no_tlsv1_2 = 0x08000000L);
132 # endif // defined(SSL_OP_NO_TLSv1_2)
133 # if defined(SSL_OP_NO_COMPRESSION)
134 BOOST_ASIO_STATIC_CONSTANT(long, no_compression = SSL_OP_NO_COMPRESSION);
135 # else // defined(SSL_OP_NO_COMPRESSION)
136 BOOST_ASIO_STATIC_CONSTANT(long, no_compression = 0x20000L);
137 # endif // defined(SSL_OP_NO_COMPRESSION)
140 /// File format types.
150 #if !defined(GENERATING_DOCUMENTATION)
151 // The following types and constants are preserved for backward compatibility.
152 // New programs should use the equivalents of the same names that are defined
153 // in the boost::asio::ssl namespace.
154 typedef int verify_mode;
155 BOOST_ASIO_STATIC_CONSTANT(int, verify_none = SSL_VERIFY_NONE);
156 BOOST_ASIO_STATIC_CONSTANT(int, verify_peer = SSL_VERIFY_PEER);
157 BOOST_ASIO_STATIC_CONSTANT(int,
158 verify_fail_if_no_peer_cert = SSL_VERIFY_FAIL_IF_NO_PEER_CERT);
159 BOOST_ASIO_STATIC_CONSTANT(int, verify_client_once = SSL_VERIFY_CLIENT_ONCE);
162 /// Purpose of PEM password.
163 enum password_purpose
165 /// The password is needed for reading/decryption.
168 /// The password is needed for writing/encryption.
173 /// Protected destructor to prevent deletion through this type.
183 #include <boost/asio/detail/pop_options.hpp>
185 #endif // BOOST_ASIO_SSL_CONTEXT_BASE_HPP