boost_support::socket::tls::TlsContext Class Reference

Tls context class responsible for setting cipher suite and loading certificates. More...

#include <tls_context.h>

Public Types
using	Tls12VersionClient = client::tls::TlsVersion12
	Type alias for Tls client with version 1.2. More...
using	Tls13VersionClient = client::tls::TlsVersion13
	Type alias for Tls client with version 1.3. More...
using	Tls12VersionServer = server::tls::TlsVersion12
	Type alias for Tls server with version 1.2. More...
using	Tls13VersionServer = server::tls::TlsVersion13
	Type alias for Tls server with version 1.3. More...
using	SslContext = boost::asio::ssl::context
	Type alias for boost ssl context. More...

Public Member Functions
	TlsContext (Tls12VersionClient client, std::string_view ca_certification_path) noexcept
	Constructs an instance of TlsContext. More...
	TlsContext (Tls13VersionClient client, std::string_view ca_certification_path) noexcept
	Constructs an instance of TlsContext. More...
	TlsContext (Tls12VersionServer server, std::string_view certificate_path, std::string_view private_key_path) noexcept
	Constructs an instance of TlsContext. More...
	TlsContext (Tls13VersionServer server, std::string_view certificate_path, std::string_view private_key_path) noexcept
	Constructs an instance of TlsContext. More...
	TlsContext (const TlsContext &other) noexcept=delete
	Deleted copy assignment and copy constructor. More...
TlsContext &	operator= (const TlsContext &other) noexcept=delete
	TlsContext (TlsContext &&other) noexcept=default
	Defaulted move assignment and move constructor. More...
TlsContext &	operator= (TlsContext &&other) noexcept=default
	~TlsContext () noexcept=default
	Destruct an instance of TcpSocket. More...
SslContext &	GetContext () noexcept
	Function to get the ssl context reference. More...

Private Attributes
SslContext	ssl_context_
	Store the boost ssl context. More...

Detailed Description

Tls context class responsible for setting cipher suite and loading certificates.

Definition at line 24 of file tls_context.h.

Member Typedef Documentation

SslContext

using boost_support::socket::tls::TlsContext::SslContext = boost::asio::ssl::context

Type alias for boost ssl context.

Definition at line 49 of file tls_context.h.

Tls12VersionClient

using boost_support::socket::tls::TlsContext::Tls12VersionClient = client::tls::TlsVersion12

Type alias for Tls client with version 1.2.

Definition at line 29 of file tls_context.h.

Tls12VersionServer

using boost_support::socket::tls::TlsContext::Tls12VersionServer = server::tls::TlsVersion12

Type alias for Tls server with version 1.2.

Definition at line 39 of file tls_context.h.

Tls13VersionClient

using boost_support::socket::tls::TlsContext::Tls13VersionClient = client::tls::TlsVersion13

Type alias for Tls client with version 1.3.

Definition at line 34 of file tls_context.h.

Tls13VersionServer

using boost_support::socket::tls::TlsContext::Tls13VersionServer = server::tls::TlsVersion13

Type alias for Tls server with version 1.3.

Definition at line 44 of file tls_context.h.

Constructor & Destructor Documentation

TlsContext() [1/6]

boost_support::socket::tls::TlsContext::TlsContext ( Tls12VersionClient  client, std::string_view  ca_certification_path  )

noexcept

Constructs an instance of TlsContext.

Parameters

[in]	client	The Tls 1.2 version client
[in]	ca_certification_path	The path to root CA certificate

Definition at line 135 of file tls_context.cpp.

    : ssl_context_{boost::asio::ssl::context::tlsv12_client} {
  // Load the root CA certificates
  ssl_context_.load_verify_file(std::string{ca_certification_path});
  // Load the cipher suites
  if (SSL_CTX_set_cipher_list(ssl_context_.native_handle(),
                              ConvertCipherListToString(client.cipher_suites).c_str()) == 0) {
    // Failure
  }
}

TlsContext() [2/6]

boost_support::socket::tls::TlsContext::TlsContext ( Tls13VersionClient  client, std::string_view  ca_certification_path  )

noexcept

Constructs an instance of TlsContext.

Parameters

[in]	client	The Tls 1.2 version client
[in]	ca_certification_path	The path to root CA certificate

Definition at line 146 of file tls_context.cpp.

    : ssl_context_{boost::asio::ssl::context::tlsv13_client} {
  // Load the root CA certificates
  ssl_context_.load_verify_file(std::string{ca_certification_path});
  // Load the cipher suites
  if (SSL_CTX_set_ciphersuites(ssl_context_.native_handle(),
                               ConvertCipherListToString(client.cipher_suites).c_str()) == 0) {
    // Failure
  }
}

TlsContext() [3/6]

boost_support::socket::tls::TlsContext::TlsContext ( Tls12VersionServer  server, std::string_view  certificate_path, std::string_view  private_key_path  )

noexcept

Constructs an instance of TlsContext.

Parameters

[in]	server	The Tls 1.2 version server
[in]	certificate_path	The path to root CA certificate
[in]	private_key_path	The path to private key

Definition at line 157 of file tls_context.cpp.

    : ssl_context_{boost::asio::ssl::context::tlsv12_server} {
  // Load certificate and private key from provided locations
  ssl_context_.use_certificate_chain_file(std::string{certificate_path});
  ssl_context_.use_private_key_file(std::string{private_key_path}, boost::asio::ssl::context::pem);
  // Load the cipher suites
  if (SSL_CTX_set_ciphersuites(ssl_context_.native_handle(),
                               ConvertCipherListToString(server.cipher_suites).c_str()) == 0) {
    // Failure
  }
}

TlsContext() [4/6]

boost_support::socket::tls::TlsContext::TlsContext ( Tls13VersionServer  server, std::string_view  certificate_path, std::string_view  private_key_path  )

noexcept

Constructs an instance of TlsContext.

Parameters

[in]	server	The Tls 1.2 version server
[in]	certificate_path	The path to root CA certificate
[in]	private_key_path	The path to private key

Definition at line 170 of file tls_context.cpp.

    : ssl_context_{boost::asio::ssl::context::tlsv13_server} {
  // Load certificate and private key from provided locations
  ssl_context_.use_certificate_chain_file(std::string{certificate_path});
  ssl_context_.use_private_key_file(std::string{private_key_path}, boost::asio::ssl::context::pem);
  // Load the cipher suites
  if (SSL_CTX_set_ciphersuites(ssl_context_.native_handle(),
                               ConvertCipherListToString(server.cipher_suites).c_str()) == 0) {
    // Failure
  }
}

TlsContext() [5/6]

boost_support::socket::tls::TlsContext::TlsContext ( const TlsContext &  other )

deletenoexcept

Deleted copy assignment and copy constructor.

TlsContext() [6/6]

boost_support::socket::tls::TlsContext::TlsContext ( TlsContext &&  other )

defaultnoexcept

Defaulted move assignment and move constructor.

~TlsContext()

boost_support::socket::tls::TlsContext::~TlsContext ( )

defaultnoexcept

Destruct an instance of TcpSocket.

Member Function Documentation

GetContext()

SslContext& boost_support::socket::tls::TlsContext::GetContext ( )

inlinenoexcept

Function to get the ssl context reference.

Returns

The reference to ssl context

Definition at line 115 of file tls_context.h.

{ return ssl_context_; }

References ssl_context_.

operator=() [1/2]

TlsContext& boost_support::socket::tls::TlsContext::operator= ( const TlsContext &  other )

deletenoexcept

operator=() [2/2]

TlsContext& boost_support::socket::tls::TlsContext::operator= ( TlsContext &&  other )

defaultnoexcept

Member Data Documentation

ssl_context_

SslContext boost_support::socket::tls::TlsContext::ssl_context_

private

Store the boost ssl context.

Definition at line 121 of file tls_context.h.

Referenced by GetContext().

---

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

• /home/runner/work/diag-client-lib/diag-client-lib/diag-client-lib/lib/boost-support/src/boost-support/socket/tls/tls_context.h
• /home/runner/work/diag-client-lib/diag-client-lib/diag-client-lib/lib/boost-support/src/boost-support/socket/tls/tls_context.cpp