#include <tls_server.h>

Inheritance diagram for Botan::TLS::Server:

Public Member Functions
std::string	application_protocol () const override

void	close () override

std::optional< std::string >	external_psk_identity () const override

size_t	from_peer (std::span< const uint8_t > data) override

bool	is_active () const override

bool	is_closed () const override

bool	is_closed_for_reading () const override

bool	is_closed_for_writing () const override

bool	is_handshake_complete () const override

SymmetricKey	key_material_export (std::string_view label, std::string_view context, size_t length) const override

bool	new_session_ticket_supported () const

std::vector< X509_Certificate >	peer_cert_chain () const override

std::shared_ptr< const Public_Key >	peer_raw_public_key () const override

size_t	received_data (const uint8_t buf[], size_t buf_size)

size_t	received_data (std::span< const uint8_t > data)

void	renegotiate (bool force_full_renegotiation=false) override

bool	secure_renegotiation_supported () const override

void	send (const uint8_t buf[], size_t buf_size)

void	send (std::span< const uint8_t > data)

void	send (std::string_view val)

void	send_alert (const Alert &alert) override

void	send_fatal_alert (Alert::Type type) override

size_t	send_new_session_tickets (size_t tickets=1)

void	send_warning_alert (Alert::Type type) override

	Server (const std::shared_ptr< Callbacks > &callbacks, const std::shared_ptr< Session_Manager > &session_manager, const std::shared_ptr< Credentials_Manager > &creds, const std::shared_ptr< const Policy > &policy, const std::shared_ptr< RandomNumberGenerator > &rng, bool is_datagram=false, size_t reserved_io_buffer_size=TLS::Channel::IO_BUF_DEFAULT_SIZE)

bool	timeout_check () override

void	to_peer (std::span< const uint8_t > data) override

void	update_traffic_keys (bool request_peer_update=false) override

	~Server () override

Static Public Attributes
static constexpr size_t	IO_BUF_DEFAULT_SIZE = 10 * 1024

Detailed Description

TLS Server

Definition at line 26 of file tls_server.h.

Constructor & Destructor Documentation

◆ Server()

Botan::TLS::Server::Server	(	const std::shared_ptr< Callbacks > &	callbacks,
		const std::shared_ptr< Session_Manager > &	session_manager,
		const std::shared_ptr< Credentials_Manager > &	creds,
		const std::shared_ptr< const Policy > &	policy,
		const std::shared_ptr< RandomNumberGenerator > &	rng,
		bool	is_datagram = false,
		size_t	reserved_io_buffer_size = TLS::Channel::IO_BUF_DEFAULT_SIZE )

Server initialization

The first 5 arguments as well as the final argument reserved_io_buffer_size, are treated similarly to the TLS::Client().

If a client sends the ALPN extension, the TLS::Callbacks::tls_server_choose_app_protocol() will be called and the result sent back to the client. If the empty string is returned, the server will not send an ALPN response. The function can also throw an exception to abort the handshake entirely, the ALPN specification says that if this occurs the alert should be of type TLS::AlertType::NoApplicationProtocol.

The optional argument is_datagram specifies if this is a TLS or DTLS server; unlike clients, which know what type of protocol (TLS vs DTLS) they are negotiating from the start via the offer_version, servers would not until they actually received a client hello.

Parameters

callbacks	contains a set of callback function references required by the TLS server.
session_manager	manages session state
creds	manages application/user credentials
policy	specifies other connection policy information
rng	a random number generator
is_datagram	set to true if this server should expect DTLS connections. Otherwise TLS connections are expected.
reserved_io_buffer_size	This many bytes of memory will be preallocated for the read and write buffers. Smaller values just mean reallocations and copies are more likely.

Definition at line 28 of file tls_server.cpp.

                                 {
   const auto max_version = policy->latest_supported_version(is_datagram);
 
   if(!max_version.is_pre_tls_13()) {
#if defined(BOTAN_HAS_TLS_13)
      m_impl = std::make_unique<Server_Impl_13>(callbacks, session_manager, creds, policy, rng);
 
      if(m_impl->expects_downgrade()) {
         m_impl->set_io_buffer_size(io_buf_sz);
      }
#else
      throw Not_Implemented("TLS 1.3 server is not available in this build");
#endif
   } else {
      m_impl = std::make_unique<Server_Impl_12>(callbacks, session_manager, creds, policy, rng, is_datagram, io_buf_sz);
   }
}

◆ ~Server()

Botan::TLS::Server::~Server ( )

overridedefault

Member Function Documentation

◆ application_protocol()

std::string Botan::TLS::Server::application_protocol ( ) const

overridevirtual

Return the protocol notification set by the client (using the ALPN extension) for this connection, if any. This value is not tied to the session and a later renegotiation of the same session can choose a new protocol.

label	a disambiguating label string
context	a per-association context value
length	the length of the desired key in bytes

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Server()

◆ ~Server()

Member Function Documentation

◆ application_protocol()

◆ close()

◆ external_psk_identity()

◆ from_peer()

◆ is_active()

◆ is_closed()

◆ is_closed_for_reading()

◆ is_closed_for_writing()

◆ is_handshake_complete()

◆ key_material_export()

◆ new_session_ticket_supported()

◆ peer_cert_chain()

◆ peer_raw_public_key()

◆ received_data() [1/2]

◆ received_data() [2/2]

◆ renegotiate()

◆ secure_renegotiation_supported()

◆ send() [1/3]

◆ send() [2/3]

◆ send() [3/3]

◆ send_alert()

◆ send_fatal_alert()

◆ send_new_session_tickets()

◆ send_warning_alert()

◆ timeout_check()

◆ to_peer()

◆ update_traffic_keys()

Member Data Documentation

◆ IO_BUF_DEFAULT_SIZE