Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::asio::ssl::context_base Class Reference

The context_base class is used as a base for the basic_context class template so that we have a common place to define various enums. More...

#include <context_base.hpp>

Inheritance diagram for boost::asio::ssl::context_base:

Public Types

enum  method {
  sslv2,
  sslv2_client,
  sslv2_server,
  sslv3,
  sslv3_client,
  sslv3_server,
  tlsv1,
  tlsv1_client,
  tlsv1_server,
  sslv23,
  sslv23_client,
  sslv23_server,
  tlsv11,
  tlsv11_client,
  tlsv11_server,
  tlsv12,
  tlsv12_client,
  tlsv12_server
}
 Different methods supported by a context. More...
 
enum  file_format {
  asn1,
  pem
}
 File format types. More...
 
enum  password_purpose {
  for_reading,
  for_writing
}
 Purpose of PEM password. More...
 
typedef long options
 Bitmask type for SSL options. More...
 
typedef int verify_mode
 

Public Member Functions

 BOOST_ASIO_STATIC_CONSTANT (long, default_workarounds=SSL_OP_ALL)
 
 BOOST_ASIO_STATIC_CONSTANT (long, single_dh_use=SSL_OP_SINGLE_DH_USE)
 
 BOOST_ASIO_STATIC_CONSTANT (long, no_sslv2=SSL_OP_NO_SSLv2)
 
 BOOST_ASIO_STATIC_CONSTANT (long, no_sslv3=SSL_OP_NO_SSLv3)
 
 BOOST_ASIO_STATIC_CONSTANT (long, no_tlsv1=SSL_OP_NO_TLSv1)
 
 BOOST_ASIO_STATIC_CONSTANT (long, no_compression=0x20000L)
 
 BOOST_ASIO_STATIC_CONSTANT (int, verify_none=SSL_VERIFY_NONE)
 
 BOOST_ASIO_STATIC_CONSTANT (int, verify_peer=SSL_VERIFY_PEER)
 
 BOOST_ASIO_STATIC_CONSTANT (int, verify_fail_if_no_peer_cert=SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
 
 BOOST_ASIO_STATIC_CONSTANT (int, verify_client_once=SSL_VERIFY_CLIENT_ONCE)
 

Protected Member Functions

 ~context_base ()
 Protected destructor to prevent deletion through this type. More...
 

Detailed Description

The context_base class is used as a base for the basic_context class template so that we have a common place to define various enums.

Member Typedef Documentation

Bitmask type for SSL options.

Member Enumeration Documentation

File format types.

Enumerator
asn1 

ASN.1 file.

pem 

PEM file.

Different methods supported by a context.

Enumerator
sslv2 

Generic SSL version 2.

sslv2_client 

SSL version 2 client.

sslv2_server 

SSL version 2 server.

sslv3 

Generic SSL version 3.

sslv3_client 

SSL version 3 client.

sslv3_server 

SSL version 3 server.

tlsv1 

Generic TLS version 1.

tlsv1_client 

TLS version 1 client.

tlsv1_server 

TLS version 1 server.

sslv23 

Generic SSL/TLS.

sslv23_client 

SSL/TLS client.

sslv23_server 

SSL/TLS server.

tlsv11 

Generic TLS version 1.1.

tlsv11_client 

TLS version 1.1 client.

tlsv11_server 

TLS version 1.1 server.

tlsv12 

Generic TLS version 1.2.

tlsv12_client 

TLS version 1.2 client.

tlsv12_server 

TLS version 1.2 server.

Purpose of PEM password.

Enumerator
for_reading 

The password is needed for reading/decryption.

for_writing 

The password is needed for writing/encryption.

Constructor & Destructor Documentation

boost::asio::ssl::context_base::~context_base ( )
inlineprotected

Protected destructor to prevent deletion through this type.

Member Function Documentation

boost::asio::ssl::context_base::BOOST_ASIO_STATIC_CONSTANT ( long  ,
default_workarounds  = SSL_OP_ALL 
)
boost::asio::ssl::context_base::BOOST_ASIO_STATIC_CONSTANT ( long  ,
single_dh_use  = SSL_OP_SINGLE_DH_USE 
)
boost::asio::ssl::context_base::BOOST_ASIO_STATIC_CONSTANT ( long  ,
no_sslv2  = SSL_OP_NO_SSLv2 
)
boost::asio::ssl::context_base::BOOST_ASIO_STATIC_CONSTANT ( long  ,
no_sslv3  = SSL_OP_NO_SSLv3 
)
boost::asio::ssl::context_base::BOOST_ASIO_STATIC_CONSTANT ( long  ,
no_tlsv1  = SSL_OP_NO_TLSv1 
)
boost::asio::ssl::context_base::BOOST_ASIO_STATIC_CONSTANT ( long  ,
no_compression  = 0x20000L 
)
boost::asio::ssl::context_base::BOOST_ASIO_STATIC_CONSTANT ( int  ,
verify_none  = SSL_VERIFY_NONE 
)
boost::asio::ssl::context_base::BOOST_ASIO_STATIC_CONSTANT ( int  ,
verify_peer  = SSL_VERIFY_PEER 
)
boost::asio::ssl::context_base::BOOST_ASIO_STATIC_CONSTANT ( int  ,
verify_fail_if_no_peer_cert  = SSL_VERIFY_FAIL_IF_NO_PEER_CERT 
)
boost::asio::ssl::context_base::BOOST_ASIO_STATIC_CONSTANT ( int  ,
verify_client_once  = SSL_VERIFY_CLIENT_ONCE 
)

The documentation for this class was generated from the following file: