boost_support::socket::tcp::TlsServerSocket Class Reference

Class used to create a tls socket for server for handling transmission and reception of tcp message from driver. More...

#include <tls_server_.h>

Public Types
using	TcpHandlerRead = std::function< void(message::tcp::TcpMessagePtr)>
	Tcp function template used for reception. More...
using	TcpAcceptor = boost::asio::ip::tcp::acceptor
	Type alias for tcp acceptor. More...

Public Member Functions
	TlsServerSocket (std::string_view local_ip_address, std::uint16_t local_port_num)
	Constructs an instance of TlsServerSocket. More...
	~TlsServerSocket ()=default
	Destruct an instance of TlsServerSocket. More...
std::optional< TcpServerConnection >	GetTcpServerConnection (TcpHandlerRead tcp_handler_read)
	Get the tcp connection to communicate. More...

Private Types
using	Tcp = boost::asio::ip::tcp
	Type alias for tcp protocol. More...

Private Attributes
std::string	local_ip_address_
	Store local ip address. More...
std::uint16_t	local_port_num_
	Store local port number. More...
boost::asio::io_context	io_context_
	boost io context More...
boost::asio::ssl::context	io_ssl_context_
	boost io ssl context More...
TcpAcceptor	tcp_acceptor_
	Store tcp acceptor. More...

Detailed Description

Class used to create a tls socket for server for handling transmission and reception of tcp message from driver.

Definition at line 121 of file tls_server_.h.

Member Typedef Documentation

Tcp

using boost_support::socket::tcp::TlsServerSocket::Tcp = boost::asio::ip::tcp

private

Type alias for tcp protocol.

Definition at line 159 of file tls_server_.h.

TcpAcceptor

using boost_support::socket::tcp::TlsServerSocket::TcpAcceptor = boost::asio::ip::tcp::acceptor

Type alias for tcp acceptor.

Definition at line 131 of file tls_server_.h.

TcpHandlerRead

using boost_support::socket::tcp::TlsServerSocket::TcpHandlerRead = std::function<void(message::tcp::TcpMessagePtr)>

Tcp function template used for reception.

Definition at line 126 of file tls_server_.h.

Constructor & Destructor Documentation

TlsServerSocket()

boost_support::socket::tcp::TlsServerSocket::TlsServerSocket	(	std::string_view	local_ip_address,
		std::uint16_t	local_port_num
	)

Constructs an instance of TlsServerSocket.

Parameters

[in]	local_ip_address	The local ip address
[in]	local_port_num	The local port number

Definition at line 21 of file tls_server_.cpp.

    : local_ip_address_{local_ip_address},
      local_port_num_{local_port_num},
      io_context_{},
      io_ssl_context_{boost::asio::ssl::context::tlsv13_server},
      tcp_acceptor_{io_context_, Tcp::endpoint(Tcp::v4(), local_port_num_), true} {
  common::logger::LibBoostLogger::GetLibBoostLogger().GetLogger().LogDebug(
      FILE_NAME, __LINE__, __func__, [&local_ip_address, &local_port_num](std::stringstream &msg) {
        msg << "Tcp Socket Acceptor created at "
            << "<" << local_ip_address << "," << local_port_num << ">";
      });
  // Load certificate and private key from provided locations
  io_ssl_context_.use_certificate_chain_file("../../../openssl/DiagClientLib.crt");
  io_ssl_context_.use_private_key_file("../../../openssl/DiagClientLib.key",
                                       boost::asio::ssl::context::pem);
  SSL_CTX_set_ciphersuites(io_ssl_context_.native_handle(),
                           "TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256");
}

References FILE_NAME, boost_support::common::logger::LibBoostLogger::GetLibBoostLogger(), and io_ssl_context_.

Here is the call graph for this function:

~TlsServerSocket()

boost_support::socket::tcp::TlsServerSocket::~TlsServerSocket ( )

default

Destruct an instance of TlsServerSocket.

Member Function Documentation

GetTcpServerConnection()

std::optional< TcpServerConnection > boost_support::socket::tcp::TlsServerSocket::GetTcpServerConnection

(

TcpHandlerRead

tcp_handler_read

)

Get the tcp connection to communicate.

Parameters

[in]

tcp_handler_read

The local ip address

Definition at line 40 of file tls_server_.cpp.

                                     {
  std::optional<TcpServerConnection> tcp_connection{std::nullopt};
  TcpErrorCodeType ec{};
  Tcp::endpoint endpoint{};
  TcpServerConnection::TlsStream tls_socket{io_context_, io_ssl_context_};
 
  // blocking accept
  tcp_acceptor_.accept(tls_socket.lowest_layer(), endpoint, ec);
  if (ec.value() == boost::system::errc::success) {
    tcp_connection.emplace(std::move(tls_socket), std::move(tcp_handler_read));
    common::logger::LibBoostLogger::GetLibBoostLogger().GetLogger().LogDebug(
        FILE_NAME, __LINE__, __func__, [&endpoint](std::stringstream &msg) {
          msg << "TLS Socket connection received from client "
              << "<" << endpoint.address().to_string() << "," << endpoint.port() << ">";
        });
  } else {
    common::logger::LibBoostLogger::GetLibBoostLogger().GetLogger().LogError(
        FILE_NAME, __LINE__, __func__, [ec](std::stringstream &msg) {
          msg << "TLS Socket Connect to client failed with error: " << ec.message();
        });
  }
  return tcp_connection;
}

References FILE_NAME, boost_support::common::logger::LibBoostLogger::GetLibBoostLogger(), io_context_, io_ssl_context_, and tcp_acceptor_.

Here is the call graph for this function:

Member Data Documentation

io_context_

boost::asio::io_context boost_support::socket::tcp::TlsServerSocket::io_context_

private

boost io context

Definition at line 174 of file tls_server_.h.

Referenced by GetTcpServerConnection().

io_ssl_context_

boost::asio::ssl::context boost_support::socket::tcp::TlsServerSocket::io_ssl_context_

private

boost io ssl context

Definition at line 179 of file tls_server_.h.

Referenced by GetTcpServerConnection(), and TlsServerSocket().

local_ip_address_

std::string boost_support::socket::tcp::TlsServerSocket::local_ip_address_

private

Store local ip address.

Definition at line 164 of file tls_server_.h.

local_port_num_

std::uint16_t boost_support::socket::tcp::TlsServerSocket::local_port_num_

private

Store local port number.

Definition at line 169 of file tls_server_.h.

tcp_acceptor_

TcpAcceptor boost_support::socket::tcp::TlsServerSocket::tcp_acceptor_

private

Store tcp acceptor.

Definition at line 184 of file tls_server_.h.

Referenced by GetTcpServerConnection().

---

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/tcp/tls_server_.h
• /home/runner/work/diag-client-lib/diag-client-lib/diag-client-lib/lib/boost-support/src/boost-support/socket/tcp/tls_server_.cpp