context.hpp

Go to the documentation of this file.

//
// ssl/context.hpp
// ~~~~~~~~~~~~~~~
//
// Copyright (c) 2003-2015 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 ASIO_SSL_CONTEXT_HPP
#define ASIO_SSL_CONTEXT_HPP

#if defined(_MSC_VER) && (_MSC_VER >= 1200)
# pragma once
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)

#include "asio/detail/config.hpp"

#if defined(ASIO_ENABLE_OLD_SSL)
# include "asio/ssl/basic_context.hpp"
# include "asio/ssl/context_service.hpp"
#else // defined(ASIO_ENABLE_OLD_SSL)
# include <string>
# include "asio/buffer.hpp"
# include "asio/io_service.hpp"
# include "asio/ssl/context_base.hpp"
# include "asio/ssl/detail/openssl_types.hpp"
# include "asio/ssl/detail/openssl_init.hpp"
# include "asio/ssl/detail/password_callback.hpp"
# include "asio/ssl/detail/verify_callback.hpp"
# include "asio/ssl/verify_mode.hpp"
#endif // defined(ASIO_ENABLE_OLD_SSL)

#include "asio/detail/push_options.hpp"

namespace asio {
namespace ssl {

#if defined(ASIO_ENABLE_OLD_SSL)

typedef basic_context<context_service> context;

#else // defined(ASIO_ENABLE_OLD_SSL)

class context
  : public context_base,
    private noncopyable
{
public:
  typedef SSL_CTX* native_handle_type;

  typedef SSL_CTX* impl_type;

  ASIO_DECL explicit context(method m);

  ASIO_DECL context(asio::io_service&, method m);

#if defined(ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)

  ASIO_DECL context(context&& other);


  ASIO_DECL context& operator=(context&& other);
#endif // defined(ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)

  ASIO_DECL ~context();


  ASIO_DECL native_handle_type native_handle();


  ASIO_DECL impl_type impl();


  ASIO_DECL void clear_options(options o);


  ASIO_DECL asio::error_code clear_options(options o,
      asio::error_code& ec);


  ASIO_DECL void set_options(options o);


  ASIO_DECL asio::error_code set_options(options o,
      asio::error_code& ec);


  ASIO_DECL void set_verify_mode(verify_mode v);


  ASIO_DECL asio::error_code set_verify_mode(
      verify_mode v, asio::error_code& ec);


  ASIO_DECL void set_verify_depth(int depth);


  ASIO_DECL asio::error_code set_verify_depth(
      int depth, asio::error_code& ec);


  template <typename VerifyCallback>
  void set_verify_callback(VerifyCallback callback);


  template <typename VerifyCallback>
  asio::error_code set_verify_callback(VerifyCallback callback,
      asio::error_code& ec);


  ASIO_DECL void load_verify_file(const std::string& filename);


  ASIO_DECL asio::error_code load_verify_file(
      const std::string& filename, asio::error_code& ec);


  ASIO_DECL void add_certificate_authority(const const_buffer& ca);


  ASIO_DECL asio::error_code add_certificate_authority(
      const const_buffer& ca, asio::error_code& ec);


  ASIO_DECL void set_default_verify_paths();


  ASIO_DECL asio::error_code set_default_verify_paths(
      asio::error_code& ec);


  ASIO_DECL void add_verify_path(const std::string& path);


  ASIO_DECL asio::error_code add_verify_path(
      const std::string& path, asio::error_code& ec);


  ASIO_DECL void use_certificate(
      const const_buffer& certificate, file_format format);


  ASIO_DECL asio::error_code use_certificate(
      const const_buffer& certificate, file_format format,
      asio::error_code& ec);


  ASIO_DECL void use_certificate_file(
      const std::string& filename, file_format format);


  ASIO_DECL asio::error_code use_certificate_file(
      const std::string& filename, file_format format,
      asio::error_code& ec);


  ASIO_DECL void use_certificate_chain(const const_buffer& chain);


  ASIO_DECL asio::error_code use_certificate_chain(
      const const_buffer& chain, asio::error_code& ec);


  ASIO_DECL void use_certificate_chain_file(const std::string& filename);


  ASIO_DECL asio::error_code use_certificate_chain_file(
      const std::string& filename, asio::error_code& ec);


  ASIO_DECL void use_private_key(
      const const_buffer& private_key, file_format format);


  ASIO_DECL asio::error_code use_private_key(
      const const_buffer& private_key, file_format format,
      asio::error_code& ec);


  ASIO_DECL void use_private_key_file(
      const std::string& filename, file_format format);


  ASIO_DECL asio::error_code use_private_key_file(
      const std::string& filename, file_format format,
      asio::error_code& ec);


  ASIO_DECL void use_rsa_private_key(
      const const_buffer& private_key, file_format format);


  ASIO_DECL asio::error_code use_rsa_private_key(
      const const_buffer& private_key, file_format format,
      asio::error_code& ec);


  ASIO_DECL void use_rsa_private_key_file(
      const std::string& filename, file_format format);


  ASIO_DECL asio::error_code use_rsa_private_key_file(
      const std::string& filename, file_format format,
      asio::error_code& ec);


  ASIO_DECL void use_tmp_dh(const const_buffer& dh);


  ASIO_DECL asio::error_code use_tmp_dh(
      const const_buffer& dh, asio::error_code& ec);


  ASIO_DECL void use_tmp_dh_file(const std::string& filename);


  ASIO_DECL asio::error_code use_tmp_dh_file(
      const std::string& filename, asio::error_code& ec);


  template <typename PasswordCallback>
  void set_password_callback(PasswordCallback callback);


  template <typename PasswordCallback>
  asio::error_code set_password_callback(PasswordCallback callback,
      asio::error_code& ec);

private:
  struct bio_cleanup;
  struct x509_cleanup;
  struct evp_pkey_cleanup;
  struct rsa_cleanup;
  struct dh_cleanup;

  // Helper function used to set a peer certificate verification callback.
  ASIO_DECL asio::error_code do_set_verify_callback(
      detail::verify_callback_base* callback, asio::error_code& ec);

  // Callback used when the SSL implementation wants to verify a certificate.
  ASIO_DECL static int verify_callback_function(
      int preverified, X509_STORE_CTX* ctx);

  // Helper function used to set a password callback.
  ASIO_DECL asio::error_code do_set_password_callback(
      detail::password_callback_base* callback, asio::error_code& ec);

  // Callback used when the SSL implementation wants a password.
  ASIO_DECL static int password_callback_function(
      char* buf, int size, int purpose, void* data);

  // Helper function to set the temporary Diffie-Hellman parameters from a BIO.
  ASIO_DECL asio::error_code do_use_tmp_dh(
      BIO* bio, asio::error_code& ec);

  // Helper function to make a BIO from a memory buffer.
  ASIO_DECL BIO* make_buffer_bio(const const_buffer& b);

  // The underlying native implementation.
  native_handle_type handle_;

  // Ensure openssl is initialised.
  asio::ssl::detail::openssl_init<> init_;
};

#endif // defined(ASIO_ENABLE_OLD_SSL)

} // namespace ssl
} // namespace asio

#include "asio/detail/pop_options.hpp"

#include "asio/ssl/impl/context.hpp"
#if defined(ASIO_HEADER_ONLY)
# include "asio/ssl/impl/context.ipp"
#endif // defined(ASIO_HEADER_ONLY)

#endif // ASIO_SSL_CONTEXT_HPP