#include <context.hpp>

Inheritance diagram for boost::asio::ssl::context:

Collaboration diagram for boost::asio::ssl::context:

Public Types
typedef SSL_CTX *	native_handle_type
	The native handle type of the SSL context. More...

typedef SSL_CTX *	impl_type
	(Deprecated: Use native_handle_type.) The native type of the SSL context. More...

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_DECL	context (method m)
	Constructor. More...

BOOST_ASIO_DECL	context (boost::asio::io_service &, method m)
	Deprecated constructor taking a reference to an io_service object. More...

BOOST_ASIO_DECL	~context ()
	Destructor. More...

BOOST_ASIO_DECL native_handle_type	native_handle ()
	Get the underlying implementation in the native type. More...

BOOST_ASIO_DECL impl_type	impl ()
	(Deprecated: Use native_handle().) Get the underlying implementation in the native type. More...

BOOST_ASIO_DECL void	clear_options (options o)
	Clear options on the context. More...

BOOST_ASIO_DECL boost::system::error_code	clear_options (options o, boost::system::error_code &ec)
	Clear options on the context. More...

BOOST_ASIO_DECL void	set_options (options o)
	Set options on the context. More...

BOOST_ASIO_DECL boost::system::error_code	set_options (options o, boost::system::error_code &ec)
	Set options on the context. More...

BOOST_ASIO_DECL void	set_verify_mode (verify_mode v)
	Set the peer verification mode. More...

BOOST_ASIO_DECL boost::system::error_code	set_verify_mode (verify_mode v, boost::system::error_code &ec)
	Set the peer verification mode. More...

BOOST_ASIO_DECL void	set_verify_depth (int depth)
	Set the peer verification depth. More...

BOOST_ASIO_DECL boost::system::error_code	set_verify_depth (int depth, boost::system::error_code &ec)
	Set the peer verification depth. More...

template<typename VerifyCallback >
void	set_verify_callback (VerifyCallback callback)
	Set the callback used to verify peer certificates. More...

template<typename VerifyCallback >
boost::system::error_code	set_verify_callback (VerifyCallback callback, boost::system::error_code &ec)
	Set the callback used to verify peer certificates. More...

BOOST_ASIO_DECL void	load_verify_file (const std::string &filename)
	Load a certification authority file for performing verification. More...

BOOST_ASIO_DECL boost::system::error_code	load_verify_file (const std::string &filename, boost::system::error_code &ec)
	Load a certification authority file for performing verification. More...

BOOST_ASIO_DECL void	add_certificate_authority (const const_buffer &ca)
	Add certification authority for performing verification. More...

BOOST_ASIO_DECL boost::system::error_code	add_certificate_authority (const const_buffer &ca, boost::system::error_code &ec)
	Add certification authority for performing verification. More...

BOOST_ASIO_DECL void	set_default_verify_paths ()
	Configures the context to use the default directories for finding certification authority certificates. More...

BOOST_ASIO_DECL boost::system::error_code	set_default_verify_paths (boost::system::error_code &ec)
	Configures the context to use the default directories for finding certification authority certificates. More...

BOOST_ASIO_DECL void	add_verify_path (const std::string &path)
	Add a directory containing certificate authority files to be used for performing verification. More...

BOOST_ASIO_DECL boost::system::error_code	add_verify_path (const std::string &path, boost::system::error_code &ec)
	Add a directory containing certificate authority files to be used for performing verification. More...

BOOST_ASIO_DECL void	use_certificate (const const_buffer &certificate, file_format format)
	Use a certificate from a memory buffer. More...

BOOST_ASIO_DECL boost::system::error_code	use_certificate (const const_buffer &certificate, file_format format, boost::system::error_code &ec)
	Use a certificate from a memory buffer. More...

BOOST_ASIO_DECL void	use_certificate_file (const std::string &filename, file_format format)
	Use a certificate from a file. More...

BOOST_ASIO_DECL boost::system::error_code	use_certificate_file (const std::string &filename, file_format format, boost::system::error_code &ec)
	Use a certificate from a file. More...

BOOST_ASIO_DECL void	use_certificate_chain (const const_buffer &chain)
	Use a certificate chain from a memory buffer. More...

BOOST_ASIO_DECL boost::system::error_code	use_certificate_chain (const const_buffer &chain, boost::system::error_code &ec)
	Use a certificate chain from a memory buffer. More...

BOOST_ASIO_DECL void	use_certificate_chain_file (const std::string &filename)
	Use a certificate chain from a file. More...

BOOST_ASIO_DECL boost::system::error_code	use_certificate_chain_file (const std::string &filename, boost::system::error_code &ec)
	Use a certificate chain from a file. More...

BOOST_ASIO_DECL void	use_private_key (const const_buffer &private_key, file_format format)
	Use a private key from a memory buffer. More...

BOOST_ASIO_DECL boost::system::error_code	use_private_key (const const_buffer &private_key, file_format format, boost::system::error_code &ec)
	Use a private key from a memory buffer. More...

BOOST_ASIO_DECL void	use_private_key_file (const std::string &filename, file_format format)
	Use a private key from a file. More...

BOOST_ASIO_DECL boost::system::error_code	use_private_key_file (const std::string &filename, file_format format, boost::system::error_code &ec)
	Use a private key from a file. More...

BOOST_ASIO_DECL void	use_rsa_private_key (const const_buffer &private_key, file_format format)
	Use an RSA private key from a memory buffer. More...

BOOST_ASIO_DECL boost::system::error_code	use_rsa_private_key (const const_buffer &private_key, file_format format, boost::system::error_code &ec)
	Use an RSA private key from a memory buffer. More...

BOOST_ASIO_DECL void	use_rsa_private_key_file (const std::string &filename, file_format format)
	Use an RSA private key from a file. More...

BOOST_ASIO_DECL boost::system::error_code	use_rsa_private_key_file (const std::string &filename, file_format format, boost::system::error_code &ec)
	Use an RSA private key from a file. More...

BOOST_ASIO_DECL void	use_tmp_dh (const const_buffer &dh)
	Use the specified memory buffer to obtain the temporary Diffie-Hellman parameters. More...

BOOST_ASIO_DECL boost::system::error_code	use_tmp_dh (const const_buffer &dh, boost::system::error_code &ec)
	Use the specified memory buffer to obtain the temporary Diffie-Hellman parameters. More...

BOOST_ASIO_DECL void	use_tmp_dh_file (const std::string &filename)
	Use the specified file to obtain the temporary Diffie-Hellman parameters. More...

BOOST_ASIO_DECL boost::system::error_code	use_tmp_dh_file (const std::string &filename, boost::system::error_code &ec)
	Use the specified file to obtain the temporary Diffie-Hellman parameters. More...

template<typename PasswordCallback >
void	set_password_callback (PasswordCallback callback)
	Set the password callback. More...

template<typename PasswordCallback >
boost::system::error_code	set_password_callback (PasswordCallback callback, boost::system::error_code &ec)
	Set the password callback. More...

	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)

Member Typedef Documentation

typedef SSL_CTX* boost::asio::ssl::context::impl_type

(Deprecated: Use native_handle_type.) The native type of the SSL context.

typedef SSL_CTX* boost::asio::ssl::context::native_handle_type

The native handle type of the SSL context.

typedef long boost::asio::ssl::context_base::options

inherited

Bitmask type for SSL options.

typedef int boost::asio::ssl::context_base::verify_mode

inherited

Member Enumeration Documentation

enum boost::asio::ssl::context_base::file_format

inherited

File format types.

Enumerator
asn1	ASN.1 file.
pem	PEM file.

enum boost::asio::ssl::context_base::method

inherited

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.

enum boost::asio::ssl::context_base::password_purpose

inherited

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_DECL boost::asio::ssl::context::context ( method m )

explicit

Constructor.

BOOST_ASIO_DECL boost::asio::ssl::context::context	(	boost::asio::io_service &	,
		method	m
	)

Deprecated constructor taking a reference to an io_service object.

BOOST_ASIO_DECL boost::asio::ssl::context::~context ( )

Destructor.

Member Function Documentation

BOOST_ASIO_DECL void boost::asio::ssl::context::add_certificate_authority ( const const_buffer & ca )

Add certification authority for performing verification.

This function is used to add one trusted certification authority from a memory buffer.

Parameters

ca	The buffer containing the certification authority certificate. The certificate must use the PEM format.

Exceptions

boost::system::system_error Thrown on failure.

Note: Calls SSL_CTX_get_cert_store and X509_STORE_add_cert.

BOOST_ASIO_DECL boost::system::error_code boost::asio::ssl::context::add_certificate_authority	(	const const_buffer &	ca,
		boost::system::error_code &	ec
	)

Add certification authority for performing verification.

This function is used to add one trusted certification authority from a memory buffer.

Parameters

ca	The buffer containing the certification authority certificate. The certificate must use the PEM format.
ec	Set to indicate what error occurred, if any.

Note: Calls SSL_CTX_get_cert_store and X509_STORE_add_cert.

BOOST_ASIO_DECL void boost::asio::ssl::context::add_verify_path ( const std::string & path )

Add a directory containing certificate authority files to be used for performing verification.

This function is used to specify the name of a directory containing certification authority certificates. Each file in the directory must contain a single certificate. The files must be named using the subject name's hash and an extension of ".0".

Parameters

path	The name of a directory containing the certificates.

Exceptions

boost::system::system_error Thrown on failure.

Note: Calls SSL_CTX_load_verify_locations.

BOOST_ASIO_DECL boost::system::error_code boost::asio::ssl::context::add_verify_path	(	const std::string &	path,
		boost::system::error_code &	ec
	)

Add a directory containing certificate authority files to be used for performing verification.

This function is used to specify the name of a directory containing certification authority certificates. Each file in the directory must contain a single certificate. The files must be named using the subject name's hash and an extension of ".0".

Parameters

path	The name of a directory containing the certificates.
ec	Set to indicate what error occurred, if any.

Note: Calls SSL_CTX_load_verify_locations.

boost::asio::ssl::context_base::BOOST_ASIO_STATIC_CONSTANT	(	long	,
		default_workarounds	= `SSL_OP_ALL`
	)

inherited

boost::asio::ssl::context_base::BOOST_ASIO_STATIC_CONSTANT	(	long	,
		single_dh_use	= `SSL_OP_SINGLE_DH_USE`
	)

inherited

boost::asio::ssl::context_base::BOOST_ASIO_STATIC_CONSTANT	(	long	,
		no_sslv2	= `SSL_OP_NO_SSLv2`
	)

inherited

boost::asio::ssl::context_base::BOOST_ASIO_STATIC_CONSTANT	(	long	,
		no_sslv3	= `SSL_OP_NO_SSLv3`
	)

inherited

boost::asio::ssl::context_base::BOOST_ASIO_STATIC_CONSTANT	(	long	,
		no_tlsv1	= `SSL_OP_NO_TLSv1`
	)

inherited

boost::asio::ssl::context_base::BOOST_ASIO_STATIC_CONSTANT	(	long	,
		no_compression	= `0x20000L`
	)

inherited

boost::asio::ssl::context_base::BOOST_ASIO_STATIC_CONSTANT	(	int	,
		verify_none	= `SSL_VERIFY_NONE`
	)

inherited

boost::asio::ssl::context_base::BOOST_ASIO_STATIC_CONSTANT	(	int	,
		verify_peer	= `SSL_VERIFY_PEER`
	)

inherited

boost::asio::ssl::context_base::BOOST_ASIO_STATIC_CONSTANT	(	int	,
		verify_fail_if_no_peer_cert	= `SSL_VERIFY_FAIL_IF_NO_PEER_CERT`
	)

inherited

boost::asio::ssl::context_base::BOOST_ASIO_STATIC_CONSTANT	(	int	,
		verify_client_once	= `SSL_VERIFY_CLIENT_ONCE`
	)

inherited

BOOST_ASIO_DECL void boost::asio::ssl::context::clear_options ( options o )

Clear options on the context.

This function may be used to configure the SSL options used by the context.

Parameters

o	A bitmask of options. The available option values are defined in the context_base class. The specified options, if currently enabled on the context, are cleared.

Exceptions

boost::system::system_error Thrown on failure.

Note: Calls SSL_CTX_clear_options.

BOOST_ASIO_DECL boost::system::error_code boost::asio::ssl::context::clear_options	(	options	o,
		boost::system::error_code &	ec
	)

Clear options on the context.

This function may be used to configure the SSL options used by the context.

Parameters

o	A bitmask of options. The available option values are defined in the context_base class. The specified options, if currently enabled on the context, are cleared.
ec	Set to indicate what error occurred, if any.

Note: Calls SSL_CTX_clear_options.

BOOST_ASIO_DECL impl_type boost::asio::ssl::context::impl ( )

(Deprecated: Use native_handle().) Get the underlying implementation in the native type.

This function may be used to obtain the underlying implementation of the context. This is intended to allow access to context functionality that is not otherwise provided.

BOOST_ASIO_DECL void boost::asio::ssl::context::load_verify_file ( const std::string & filename )

Load a certification authority file for performing verification.

This function is used to load one or more trusted certification authorities from a file.

Parameters

filename The name of a file containing certification authority certificates in PEM format.

Exceptions

boost::system::system_error Thrown on failure.

Note: Calls SSL_CTX_load_verify_locations.

BOOST_ASIO_DECL boost::system::error_code boost::asio::ssl::context::load_verify_file	(	const std::string &	filename,
		boost::system::error_code &	ec
	)

Load a certification authority file for performing verification.

This function is used to load the certificates for one or more trusted certification authorities from a file.

Parameters

filename	The name of a file containing certification authority certificates in PEM format.
ec	Set to indicate what error occurred, if any.

Note: Calls SSL_CTX_load_verify_locations.

BOOST_ASIO_DECL native_handle_type boost::asio::ssl::context::native_handle ( )

Get the underlying implementation in the native type.

This function may be used to obtain the underlying implementation of the context. This is intended to allow access to context functionality that is not otherwise provided.

BOOST_ASIO_DECL void boost::asio::ssl::context::set_default_verify_paths ( )

Configures the context to use the default directories for finding certification authority certificates.

This function specifies that the context should use the default, system-dependent directories for locating certification authority certificates.

Exceptions

boost::system::system_error Thrown on failure.

Note: Calls SSL_CTX_set_default_verify_paths.

BOOST_ASIO_DECL boost::system::error_code boost::asio::ssl::context::set_default_verify_paths ( boost::system::error_code & ec )

Configures the context to use the default directories for finding certification authority certificates.

This function specifies that the context should use the default, system-dependent directories for locating certification authority certificates.

Parameters

ec	Set to indicate what error occurred, if any.

Note: Calls SSL_CTX_set_default_verify_paths.

BOOST_ASIO_DECL void boost::asio::ssl::context::set_options ( options o )

Set options on the context.

This function may be used to configure the SSL options used by the context.

Parameters

o	A bitmask of options. The available option values are defined in the context_base class. The options are bitwise-ored with any existing value for the options.

Exceptions

boost::system::system_error Thrown on failure.

Note: Calls SSL_CTX_set_options.

BOOST_ASIO_DECL boost::system::error_code boost::asio::ssl::context::set_options	(	options	o,
		boost::system::error_code &	ec
	)

Set options on the context.

This function may be used to configure the SSL options used by the context.

Parameters

o	A bitmask of options. The available option values are defined in the context_base class. The options are bitwise-ored with any existing value for the options.
ec	Set to indicate what error occurred, if any.

Note: Calls SSL_CTX_set_options.

template<typename PasswordCallback >

void boost::asio::ssl::context::set_password_callback ( PasswordCallback callback )

Set the password callback.

This function is used to specify a callback function to obtain password information about an encrypted key in PEM format.

Parameters

callback

The function object to be used for obtaining the password. The function signature of the handler must be:

 std::string password_callback(
  std::size_t max_length,  // The maximum size for a password.
  password_purpose purpose // Whether password is for reading or writing.
); 

The return value of the callback is a string containing the password.

Exceptions

boost::system::system_error Thrown on failure.

Note: Calls SSL_CTX_set_default_passwd_cb.

template<typename PasswordCallback >

boost::system::error_code boost::asio::ssl::context::set_password_callback	(	PasswordCallback	callback,
		boost::system::error_code &	ec
	)

Set the password callback.

This function is used to specify a callback function to obtain password information about an encrypted key in PEM format.

Parameters

callback	The function object to be used for obtaining the password. The function signature of the handler must be: std::string password_callback( std::size_t max_length, // The maximum size for a password. password_purpose purpose // Whether password is for reading or writing. ); The return value of the callback is a string containing the password.
ec	Set to indicate what error occurred, if any.

Note: Calls SSL_CTX_set_default_passwd_cb.

template<typename VerifyCallback >

void boost::asio::ssl::context::set_verify_callback ( VerifyCallback callback )

Set the callback used to verify peer certificates.

This function is used to specify a callback function that will be called by the implementation when it needs to verify a peer certificate.

Parameters

callback

The function object to be used for verifying a certificate. The function signature of the handler must be:

 bool verify_callback(
  bool preverified, // True if the certificate passed pre-verification.
  verify_context& ctx // The peer certificate and other context.
); 

The return value of the callback is true if the certificate has passed verification, false otherwise.

Exceptions

boost::system::system_error Thrown on failure.

Note: Calls SSL_CTX_set_verify.

template<typename VerifyCallback >

boost::system::error_code boost::asio::ssl::context::set_verify_callback	(	VerifyCallback	callback,
		boost::system::error_code &	ec
	)

Set the callback used to verify peer certificates.

This function is used to specify a callback function that will be called by the implementation when it needs to verify a peer certificate.

Parameters

callback	The function object to be used for verifying a certificate. The function signature of the handler must be: bool verify_callback( bool preverified, // True if the certificate passed pre-verification. verify_context& ctx // The peer certificate and other context. ); The return value of the callback is true if the certificate has passed verification, false otherwise.
ec	Set to indicate what error occurred, if any.

Note: Calls SSL_CTX_set_verify.

BOOST_ASIO_DECL void boost::asio::ssl::context::set_verify_depth ( int depth )

Set the peer verification depth.

This function may be used to configure the maximum verification depth allowed by the context.

Parameters

depth Maximum depth for the certificate chain verification that shall be allowed.

Exceptions

boost::system::system_error Thrown on failure.

Note: Calls SSL_CTX_set_verify_depth.

BOOST_ASIO_DECL boost::system::error_code boost::asio::ssl::context::set_verify_depth	(	int	depth,
		boost::system::error_code &	ec
	)

Set the peer verification depth.

This function may be used to configure the maximum verification depth allowed by the context.

Parameters

depth	Maximum depth for the certificate chain verification that shall be allowed.
ec	Set to indicate what error occurred, if any.

Note: Calls SSL_CTX_set_verify_depth.

BOOST_ASIO_DECL void boost::asio::ssl::context::set_verify_mode ( verify_mode v )

Set the peer verification mode.

This function may be used to configure the peer verification mode used by the context.

Parameters

v	A bitmask of peer verification modes. See verify_mode for available values.

Exceptions

boost::system::system_error Thrown on failure.

Note: Calls SSL_CTX_set_verify.

BOOST_ASIO_DECL boost::system::error_code boost::asio::ssl::context::set_verify_mode	(	verify_mode	v,
		boost::system::error_code &	ec
	)

Set the peer verification mode.

This function may be used to configure the peer verification mode used by the context.

Parameters

v	A bitmask of peer verification modes. See verify_mode for available values.
ec	Set to indicate what error occurred, if any.

Note: Calls SSL_CTX_set_verify.

BOOST_ASIO_DECL void boost::asio::ssl::context::use_certificate	(	const const_buffer &	certificate,
		file_format	format
	)

Use a certificate from a memory buffer.

This function is used to load a certificate into the context from a buffer.

Parameters

certificate	The buffer containing the certificate.
format	The certificate format (ASN.1 or PEM).

Exceptions

boost::system::system_error Thrown on failure.

Note: Calls SSL_CTX_use_certificate or SSL_CTX_use_certificate_ASN1.

BOOST_ASIO_DECL boost::system::error_code boost::asio::ssl::context::use_certificate	(	const const_buffer &	certificate,
		file_format	format,
		boost::system::error_code &	ec
	)

Use a certificate from a memory buffer.

This function is used to load a certificate into the context from a buffer.

Parameters

certificate	The buffer containing the certificate.
format	The certificate format (ASN.1 or PEM).
ec	Set to indicate what error occurred, if any.

Note: Calls SSL_CTX_use_certificate or SSL_CTX_use_certificate_ASN1.

BOOST_ASIO_DECL void boost::asio::ssl::context::use_certificate_chain ( const const_buffer & chain )

Use a certificate chain from a memory buffer.

This function is used to load a certificate chain into the context from a buffer.

Parameters

chain The buffer containing the certificate chain. The certificate chain must use the PEM format.

Exceptions

boost::system::system_error Thrown on failure.

Note: Calls SSL_CTX_use_certificate and SSL_CTX_add_extra_chain_cert.

BOOST_ASIO_DECL boost::system::error_code boost::asio::ssl::context::use_certificate_chain	(	const const_buffer &	chain,
		boost::system::error_code &	ec
	)

Use a certificate chain from a memory buffer.

This function is used to load a certificate chain into the context from a buffer.

Parameters

chain	The buffer containing the certificate chain. The certificate chain must use the PEM format.
ec	Set to indicate what error occurred, if any.

Note: Calls SSL_CTX_use_certificate and SSL_CTX_add_extra_chain_cert.

BOOST_ASIO_DECL void boost::asio::ssl::context::use_certificate_chain_file ( const std::string & filename )

Use a certificate chain from a file.

This function is used to load a certificate chain into the context from a file.

Parameters

filename The name of the file containing the certificate. The file must use the PEM format.

Exceptions

boost::system::system_error Thrown on failure.

Note: Calls SSL_CTX_use_certificate_chain_file.

BOOST_ASIO_DECL boost::system::error_code boost::asio::ssl::context::use_certificate_chain_file	(	const std::string &	filename,
		boost::system::error_code &	ec
	)

Use a certificate chain from a file.

This function is used to load a certificate chain into the context from a file.

Parameters

filename	The name of the file containing the certificate. The file must use the PEM format.
ec	Set to indicate what error occurred, if any.

Note: Calls SSL_CTX_use_certificate_chain_file.

BOOST_ASIO_DECL void boost::asio::ssl::context::use_certificate_file	(	const std::string &	filename,
		file_format	format
	)

Use a certificate from a file.

This function is used to load a certificate into the context from a file.

Parameters

filename	The name of the file containing the certificate.
format	The file format (ASN.1 or PEM).

Exceptions

boost::system::system_error Thrown on failure.

Note: Calls SSL_CTX_use_certificate_file.

BOOST_ASIO_DECL boost::system::error_code boost::asio::ssl::context::use_certificate_file	(	const std::string &	filename,
		file_format	format,
		boost::system::error_code &	ec
	)

Use a certificate from a file.

This function is used to load a certificate into the context from a file.

Parameters

filename	The name of the file containing the certificate.
format	The file format (ASN.1 or PEM).
ec	Set to indicate what error occurred, if any.

Note: Calls SSL_CTX_use_certificate_file.

BOOST_ASIO_DECL void boost::asio::ssl::context::use_private_key	(	const const_buffer &	private_key,
		file_format	format
	)

Use a private key from a memory buffer.

This function is used to load a private key into the context from a buffer.

Parameters

private_key	The buffer containing the private key.
format	The private key format (ASN.1 or PEM).

Exceptions

boost::system::system_error Thrown on failure.

Note: Calls SSL_CTX_use_PrivateKey or SSL_CTX_use_PrivateKey_ASN1.

BOOST_ASIO_DECL boost::system::error_code boost::asio::ssl::context::use_private_key	(	const const_buffer &	private_key,
		file_format	format,
		boost::system::error_code &	ec
	)

Use a private key from a memory buffer.

This function is used to load a private key into the context from a buffer.

Parameters

private_key	The buffer containing the private key.
format	The private key format (ASN.1 or PEM).
ec	Set to indicate what error occurred, if any.

Note: Calls SSL_CTX_use_PrivateKey or SSL_CTX_use_PrivateKey_ASN1.

BOOST_ASIO_DECL void boost::asio::ssl::context::use_private_key_file	(	const std::string &	filename,
		file_format	format
	)

Use a private key from a file.

This function is used to load a private key into the context from a file.

Parameters

filename	The name of the file containing the private key.
format	The file format (ASN.1 or PEM).

Exceptions

boost::system::system_error Thrown on failure.

Note: Calls SSL_CTX_use_PrivateKey_file.

BOOST_ASIO_DECL boost::system::error_code boost::asio::ssl::context::use_private_key_file	(	const std::string &	filename,
		file_format	format,
		boost::system::error_code &	ec
	)

Use a private key from a file.

This function is used to load a private key into the context from a file.

Parameters

filename	The name of the file containing the private key.
format	The file format (ASN.1 or PEM).
ec	Set to indicate what error occurred, if any.

Note: Calls SSL_CTX_use_PrivateKey_file.

BOOST_ASIO_DECL void boost::asio::ssl::context::use_rsa_private_key	(	const const_buffer &	private_key,
		file_format	format
	)

Use an RSA private key from a memory buffer.

This function is used to load an RSA private key into the context from a buffer.

Parameters

private_key	The buffer containing the RSA private key.
format	The private key format (ASN.1 or PEM).

Exceptions

boost::system::system_error Thrown on failure.

Note: Calls SSL_CTX_use_RSAPrivateKey or SSL_CTX_use_RSAPrivateKey_ASN1.

BOOST_ASIO_DECL boost::system::error_code boost::asio::ssl::context::use_rsa_private_key	(	const const_buffer &	private_key,
		file_format	format,
		boost::system::error_code &	ec
	)

Use an RSA private key from a memory buffer.

This function is used to load an RSA private key into the context from a buffer.

Parameters

private_key	The buffer containing the RSA private key.
format	The private key format (ASN.1 or PEM).
ec	Set to indicate what error occurred, if any.

Note: Calls SSL_CTX_use_RSAPrivateKey or SSL_CTX_use_RSAPrivateKey_ASN1.

BOOST_ASIO_DECL void boost::asio::ssl::context::use_rsa_private_key_file	(	const std::string &	filename,
		file_format	format
	)

Use an RSA private key from a file.

This function is used to load an RSA private key into the context from a file.

Parameters

filename	The name of the file containing the RSA private key.
format	The file format (ASN.1 or PEM).

Exceptions

boost::system::system_error Thrown on failure.

Note: Calls SSL_CTX_use_RSAPrivateKey_file.

BOOST_ASIO_DECL boost::system::error_code boost::asio::ssl::context::use_rsa_private_key_file	(	const std::string &	filename,
		file_format	format,
		boost::system::error_code &	ec
	)

Use an RSA private key from a file.

This function is used to load an RSA private key into the context from a file.

Parameters

filename	The name of the file containing the RSA private key.
format	The file format (ASN.1 or PEM).
ec	Set to indicate what error occurred, if any.

Note: Calls SSL_CTX_use_RSAPrivateKey_file.

BOOST_ASIO_DECL void boost::asio::ssl::context::use_tmp_dh ( const const_buffer & dh )

Use the specified memory buffer to obtain the temporary Diffie-Hellman parameters.

This function is used to load Diffie-Hellman parameters into the context from a buffer.

Parameters

dh	The memory buffer containing the Diffie-Hellman parameters. The buffer must use the PEM format.

Exceptions

boost::system::system_error Thrown on failure.

Note: Calls SSL_CTX_set_tmp_dh.

BOOST_ASIO_DECL boost::system::error_code boost::asio::ssl::context::use_tmp_dh	(	const const_buffer &	dh,
		boost::system::error_code &	ec
	)

Use the specified memory buffer to obtain the temporary Diffie-Hellman parameters.

This function is used to load Diffie-Hellman parameters into the context from a buffer.

Parameters

dh	The memory buffer containing the Diffie-Hellman parameters. The buffer must use the PEM format.
ec	Set to indicate what error occurred, if any.

Note: Calls SSL_CTX_set_tmp_dh.

BOOST_ASIO_DECL void boost::asio::ssl::context::use_tmp_dh_file ( const std::string & filename )

Use the specified file to obtain the temporary Diffie-Hellman parameters.

This function is used to load Diffie-Hellman parameters into the context from a file.

Parameters

filename The name of the file containing the Diffie-Hellman parameters. The file must use the PEM format.

Exceptions

boost::system::system_error Thrown on failure.

Note: Calls SSL_CTX_set_tmp_dh.

BOOST_ASIO_DECL boost::system::error_code boost::asio::ssl::context::use_tmp_dh_file	(	const std::string &	filename,
		boost::system::error_code &	ec
	)

Use the specified file to obtain the temporary Diffie-Hellman parameters.

This function is used to load Diffie-Hellman parameters into the context from a file.

Parameters

filename	The name of the file containing the Diffie-Hellman parameters. The file must use the PEM format.
ec	Set to indicate what error occurred, if any.

Note: Calls SSL_CTX_set_tmp_dh.

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

boost_1_57_0/boost/asio/ssl/context.hpp

Public Types

Public Member Functions

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation