/Core/Dependencies/Boost/boost/asio/ssl/context.hpp
https://bitbucket.org/barakianc/nvidia-physx-and-apex-in-gge · C++ Header · 533 lines · 110 code · 53 blank · 370 comment · 2 complexity · 88317b50a38763e51ad5c7826ccff21b MD5 · raw file
- //
- // ssl/context.hpp
- // ~~~~~~~~~~~~~~~
- //
- // Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
- //
- // Distributed under the Boost Software License, Version 1.0. (See accompanying
- // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
- //
- #ifndef BOOST_ASIO_SSL_CONTEXT_HPP
- #define BOOST_ASIO_SSL_CONTEXT_HPP
- #if defined(_MSC_VER) && (_MSC_VER >= 1200)
- # pragma once
- #endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
- #include <boost/asio/detail/config.hpp>
- #if defined(BOOST_ASIO_ENABLE_OLD_SSL)
- # include <boost/asio/ssl/basic_context.hpp>
- # include <boost/asio/ssl/context_service.hpp>
- #else // defined(BOOST_ASIO_ENABLE_OLD_SSL)
- # include <string>
- # include <boost/asio/io_service.hpp>
- # include <boost/asio/ssl/context_base.hpp>
- # include <boost/asio/ssl/detail/openssl_types.hpp>
- # include <boost/asio/ssl/detail/openssl_init.hpp>
- # include <boost/asio/ssl/detail/password_callback.hpp>
- # include <boost/asio/ssl/detail/verify_callback.hpp>
- # include <boost/asio/ssl/verify_mode.hpp>
- #endif // defined(BOOST_ASIO_ENABLE_OLD_SSL)
- #include <boost/asio/detail/push_options.hpp>
- namespace boost {
- namespace asio {
- namespace ssl {
- #if defined(BOOST_ASIO_ENABLE_OLD_SSL)
- /// Typedef for the typical usage of context.
- typedef basic_context<context_service> context;
- #else // defined(BOOST_ASIO_ENABLE_OLD_SSL)
- class context
- : public context_base,
- private noncopyable
- {
- public:
- /// The native handle type of the SSL context.
- typedef SSL_CTX* native_handle_type;
- /// (Deprecated: Use native_handle_type.) The native type of the SSL context.
- typedef SSL_CTX* impl_type;
- /// Constructor.
- BOOST_ASIO_DECL explicit context(method m);
- /// Deprecated constructor taking a reference to an io_service object.
- BOOST_ASIO_DECL context(boost::asio::io_service&, method m);
- #if defined(BOOST_ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
- /// Move-construct a context from another.
- /**
- * This constructor moves an SSL context from one object to another.
- *
- * @param other The other context object from which the move will occur.
- *
- * @note Following the move, the following operations only are valid for the
- * moved-from object:
- * @li Destruction.
- * @li As a target for move-assignment.
- */
- BOOST_ASIO_DECL context(context&& other);
- /// Move-assign a context from another.
- /**
- * This assignment operator moves an SSL context from one object to another.
- *
- * @param other The other context object from which the move will occur.
- *
- * @note Following the move, the following operations only are valid for the
- * moved-from object:
- * @li Destruction.
- * @li As a target for move-assignment.
- */
- BOOST_ASIO_DECL context& operator=(context&& other);
- #endif // defined(BOOST_ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
- /// Destructor.
- BOOST_ASIO_DECL ~context();
- /// 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 native_handle_type native_handle();
- /// (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 impl_type impl();
- /// Set options on the context.
- /**
- * This function may be used to configure the SSL options used by the context.
- *
- * @param 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.
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @note Calls @c SSL_CTX_set_options.
- */
- BOOST_ASIO_DECL void set_options(options o);
- /// Set options on the context.
- /**
- * This function may be used to configure the SSL options used by the context.
- *
- * @param 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.
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @note Calls @c SSL_CTX_set_options.
- */
- BOOST_ASIO_DECL boost::system::error_code set_options(options o,
- 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.
- *
- * @param v A bitmask of peer verification modes. See @ref verify_mode for
- * available values.
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @note Calls @c SSL_CTX_set_verify.
- */
- BOOST_ASIO_DECL void 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.
- *
- * @param v A bitmask of peer verification modes. See @ref verify_mode for
- * available values.
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @note Calls @c SSL_CTX_set_verify.
- */
- BOOST_ASIO_DECL boost::system::error_code set_verify_mode(
- verify_mode v, 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.
- *
- * @param callback The function object to be used for verifying a certificate.
- * The function signature of the handler must be:
- * @code bool verify_callback(
- * bool preverified, // True if the certificate passed pre-verification.
- * verify_context& ctx // The peer certificate and other context.
- * ); @endcode
- * The return value of the callback is true if the certificate has passed
- * verification, false otherwise.
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @note Calls @c SSL_CTX_set_verify.
- */
- template <typename VerifyCallback>
- void 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.
- *
- * @param callback The function object to be used for verifying a certificate.
- * The function signature of the handler must be:
- * @code bool verify_callback(
- * bool preverified, // True if the certificate passed pre-verification.
- * verify_context& ctx // The peer certificate and other context.
- * ); @endcode
- * The return value of the callback is true if the certificate has passed
- * verification, false otherwise.
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @note Calls @c SSL_CTX_set_verify.
- */
- template <typename VerifyCallback>
- boost::system::error_code set_verify_callback(VerifyCallback callback,
- boost::system::error_code& ec);
- /// Load a certification authority file for performing verification.
- /**
- * This function is used to load one or more trusted certification authorities
- * from a file.
- *
- * @param filename The name of a file containing certification authority
- * certificates in PEM format.
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @note Calls @c SSL_CTX_load_verify_locations.
- */
- BOOST_ASIO_DECL void load_verify_file(const std::string& filename);
- /// 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.
- *
- * @param filename The name of a file containing certification authority
- * certificates in PEM format.
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @note Calls @c SSL_CTX_load_verify_locations.
- */
- BOOST_ASIO_DECL boost::system::error_code load_verify_file(
- const std::string& filename, 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.
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @note Calls @c SSL_CTX_set_default_verify_paths.
- */
- BOOST_ASIO_DECL void 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.
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @note Calls @c SSL_CTX_set_default_verify_paths.
- */
- BOOST_ASIO_DECL boost::system::error_code set_default_verify_paths(
- 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".
- *
- * @param path The name of a directory containing the certificates.
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @note Calls @c SSL_CTX_load_verify_locations.
- */
- BOOST_ASIO_DECL void 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".
- *
- * @param path The name of a directory containing the certificates.
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @note Calls @c SSL_CTX_load_verify_locations.
- */
- BOOST_ASIO_DECL boost::system::error_code add_verify_path(
- const std::string& path, 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.
- *
- * @param filename The name of the file containing the certificate.
- *
- * @param format The file format (ASN.1 or PEM).
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @note Calls @c SSL_CTX_use_certificate_file.
- */
- BOOST_ASIO_DECL void 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.
- *
- * @param filename The name of the file containing the certificate.
- *
- * @param format The file format (ASN.1 or PEM).
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @note Calls @c SSL_CTX_use_certificate_file.
- */
- 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 chain from a file.
- /**
- * This function is used to load a certificate chain into the context from a
- * file.
- *
- * @param filename The name of the file containing the certificate. The file
- * must use the PEM format.
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @note Calls @c SSL_CTX_use_certificate_chain_file.
- */
- BOOST_ASIO_DECL void 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.
- *
- * @param filename The name of the file containing the certificate. The file
- * must use the PEM format.
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @note Calls @c SSL_CTX_use_certificate_chain_file.
- */
- BOOST_ASIO_DECL boost::system::error_code use_certificate_chain_file(
- const std::string& filename, 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.
- *
- * @param filename The name of the file containing the private key.
- *
- * @param format The file format (ASN.1 or PEM).
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @note Calls @c SSL_CTX_use_PrivateKey_file.
- */
- BOOST_ASIO_DECL void 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.
- *
- * @param filename The name of the file containing the private key.
- *
- * @param format The file format (ASN.1 or PEM).
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @note Calls @c SSL_CTX_use_PrivateKey_file.
- */
- BOOST_ASIO_DECL boost::system::error_code use_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.
- *
- * @param filename The name of the file containing the RSA private key.
- *
- * @param format The file format (ASN.1 or PEM).
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @note Calls @c SSL_CTX_use_RSAPrivateKey_file.
- */
- BOOST_ASIO_DECL void 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.
- *
- * @param filename The name of the file containing the RSA private key.
- *
- * @param format The file format (ASN.1 or PEM).
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @note Calls @c SSL_CTX_use_RSAPrivateKey_file.
- */
- 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 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.
- *
- * @param filename The name of the file containing the Diffie-Hellman
- * parameters. The file must use the PEM format.
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @note Calls @c SSL_CTX_set_tmp_dh.
- */
- BOOST_ASIO_DECL void 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.
- *
- * @param filename The name of the file containing the Diffie-Hellman
- * parameters. The file must use the PEM format.
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @note Calls @c SSL_CTX_set_tmp_dh.
- */
- BOOST_ASIO_DECL boost::system::error_code use_tmp_dh_file(
- const std::string& filename, 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.
- *
- * @param callback The function object to be used for obtaining the password.
- * The function signature of the handler must be:
- * @code 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.
- * ); @endcode
- * The return value of the callback is a string containing the password.
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @note Calls @c SSL_CTX_set_default_passwd_cb.
- */
- template <typename PasswordCallback>
- void 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.
- *
- * @param callback The function object to be used for obtaining the password.
- * The function signature of the handler must be:
- * @code 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.
- * ); @endcode
- * The return value of the callback is a string containing the password.
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @note Calls @c SSL_CTX_set_default_passwd_cb.
- */
- template <typename PasswordCallback>
- boost::system::error_code set_password_callback(PasswordCallback callback,
- boost::system::error_code& ec);
- private:
- // Helper function used to set a peer certificate verification callback.
- BOOST_ASIO_DECL boost::system::error_code do_set_verify_callback(
- detail::verify_callback_base* callback, boost::system::error_code& ec);
- // Callback used when the SSL implementation wants to verify a certificate.
- BOOST_ASIO_DECL static int verify_callback_function(
- int preverified, X509_STORE_CTX* ctx);
- // Helper function used to set a password callback.
- BOOST_ASIO_DECL boost::system::error_code do_set_password_callback(
- detail::password_callback_base* callback, boost::system::error_code& ec);
- // Callback used when the SSL implementation wants a password.
- BOOST_ASIO_DECL static int password_callback_function(
- char* buf, int size, int purpose, void* data);
- // The underlying native implementation.
- native_handle_type handle_;
- // Ensure openssl is initialised.
- boost::asio::ssl::detail::openssl_init<> init_;
- };
- #endif // defined(BOOST_ASIO_ENABLE_OLD_SSL)
- } // namespace ssl
- } // namespace asio
- } // namespace boost
- #include <boost/asio/detail/pop_options.hpp>
- #include <boost/asio/ssl/impl/context.hpp>
- #if defined(BOOST_ASIO_HEADER_ONLY)
- # include <boost/asio/ssl/impl/context.ipp>
- #endif // defined(BOOST_ASIO_HEADER_ONLY)
- #endif // BOOST_ASIO_SSL_CONTEXT_HPP