Botan::TLS::Blocking_Client Class Reference

#include <tls_blocking.h>

Public Types
typedef std::function< size_t(uint8_t[], size_t)>	read_fn
typedef std::function< void(const uint8_t[], size_t)>	write_fn

Public Member Functions
	Blocking_Client (read_fn reader, write_fn writer, Session_Manager &session_manager, Credentials_Manager &creds, const Policy &policy, RandomNumberGenerator &rng, const Server_Information &server_info=Server_Information(), const Protocol_Version &offer_version=Protocol_Version::latest_tls_version(), const std::vector< std::string > &next_protos={})
void	close ()
void	do_handshake ()
bool	is_closed () const
std::vector< X509_Certificate >	peer_cert_chain () const
size_t	pending () const
size_t	read (uint8_t buf[], size_t buf_len)
const TLS::Channel &	underlying_channel () const
TLS::Channel &	underlying_channel ()
void	write (const uint8_t buf[], size_t buf_len)
virtual	~Blocking_Client ()=default

Protected Member Functions
virtual void	alert_notification (const Alert &)
virtual bool	handshake_complete (const Session &)

Detailed Description

Blocking TLS Client Can be used directly, or subclass to get handshake and alert notifications

Definition at line 22 of file tls_blocking.h.

Member Typedef Documentation

read_fn

typedef std::function<size_t (uint8_t[], size_t)> Botan::TLS::Blocking_Client::read_fn

Definition at line 29 of file tls_blocking.h.

write_fn

typedef std::function<void (const uint8_t[], size_t)> Botan::TLS::Blocking_Client::write_fn

Definition at line 30 of file tls_blocking.h.

Constructor & Destructor Documentation

Blocking_Client()

Botan::TLS::Blocking_Client::Blocking_Client	(	read_fn	reader,
		write_fn	writer,
		Session_Manager &	session_manager,
		Credentials_Manager &	creds,
		const Policy &	policy,
		RandomNumberGenerator &	rng,
		const Server_Information &	server_info = Server_Information(),
		const Protocol_Version &	offer_version = Protocol_Version::latest_tls_version(),
		const std::vector< std::string > &	next_protos = {}
	)

Definition at line 17 of file tls_blocking.cpp.

                                                                   :
   m_read(reader),
   m_callbacks(new TLS::Compat_Callbacks(
                  /*
                  we are ok using deprecated features here because the whole Blocking_Client class
                  is also deprecated, so just silence the warning.
                  */
               TLS::Compat_Callbacks::SILENCE_DEPRECATION_WARNING::PLEASE,
               writer,
               std::bind(&Blocking_Client::data_cb, this, _1, _2),
               std::function<void (Alert)>(std::bind(&Blocking_Client::alert_cb, this, _1)),
               std::bind(&Blocking_Client::handshake_cb, this, _1)
             )),
   m_channel(*m_callbacks.get(),
             session_manager,
             creds,
             policy,
             rng,
             server_info,
             offer_version,
             next)
   {
   }

~Blocking_Client()

virtual Botan::TLS::Blocking_Client::~Blocking_Client ( )

virtualdefault

Member Function Documentation

alert_notification()

virtual void Botan::TLS::Blocking_Client::alert_notification ( const Alert &  )

inlineprotectedvirtual

Application can override to get notification of alerts

Definition at line 83 of file tls_blocking.h.

{}

close()

void Botan::TLS::Blocking_Client::close ( )

inline

Definition at line 65 of file tls_blocking.h.

{ m_channel.close(); }

do_handshake()

void Botan::TLS::Blocking_Client::do_handshake

(

)

Completes full handshake then returns

Definition at line 64 of file tls_blocking.cpp.

References Botan::TLS::Channel::is_active(), Botan::TLS::Channel::is_closed(), and Botan::TLS::Channel::received_data().

   {
   std::vector<uint8_t> readbuf(4096);

   while(!m_channel.is_closed() && !m_channel.is_active())
      {
      const size_t from_socket = m_read(readbuf.data(), readbuf.size());
      m_channel.received_data(readbuf.data(), from_socket);
      }
   }

handshake_complete()

virtual bool Botan::TLS::Blocking_Client::handshake_complete ( const Session &  )

inlineprotectedvirtual

Application can override to get the handshake complete notification

Definition at line 78 of file tls_blocking.h.

{ return true; }

is_closed()

bool Botan::TLS::Blocking_Client::is_closed ( ) const

inline

Definition at line 67 of file tls_blocking.h.

{ return m_channel.is_closed(); }

peer_cert_chain()

std::vector<X509_Certificate> Botan::TLS::Blocking_Client::peer_cert_chain ( ) const

inline

Definition at line 69 of file tls_blocking.h.

         { return m_channel.peer_cert_chain(); }

pending()

size_t Botan::TLS::Blocking_Client::pending ( ) const

inline

Number of bytes pending read in the plaintext buffer (bytes readable without blocking)

Definition at line 52 of file tls_blocking.h.

{ return m_plaintext.size(); }

read()

size_t Botan::TLS::Blocking_Client::read	(	uint8_t	buf[],
		size_t	buf_len
	)

Blocking read, will return at least 1 byte (eventually) or else 0 if the connection is closed.

Definition at line 75 of file tls_blocking.cpp.

References BOTAN_ASSERT_IMPLICATION, Botan::TLS::Channel::is_closed(), and Botan::TLS::Channel::received_data().

   {
   std::vector<uint8_t> readbuf(4096);

   while(m_plaintext.empty() && !m_channel.is_closed())
      {
      const size_t from_socket = m_read(readbuf.data(), readbuf.size());
      m_channel.received_data(readbuf.data(), from_socket);
      }

   const size_t returned = std::min(buf_len, m_plaintext.size());

   for(size_t i = 0; i != returned; ++i)
      buf[i] = m_plaintext[i];
   m_plaintext.erase(m_plaintext.begin(), m_plaintext.begin() + returned);

   BOTAN_ASSERT_IMPLICATION(returned == 0, m_channel.is_closed(),
                            "Only return zero if channel is closed");

   return returned;
   }

underlying_channel() [1/2]

const TLS::Channel& Botan::TLS::Blocking_Client::underlying_channel ( ) const

inline

Definition at line 62 of file tls_blocking.h.

{ return m_channel; }

underlying_channel() [2/2]

TLS::Channel& Botan::TLS::Blocking_Client::underlying_channel ( )

inline

Definition at line 63 of file tls_blocking.h.

{ return m_channel; }

write()

void Botan::TLS::Blocking_Client::write ( const uint8_t  buf[], size_t  buf_len  )

inline

Definition at line 60 of file tls_blocking.h.

{ m_channel.send(buf, buf_len); }

---

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

• src/lib/tls/tls_blocking.h
• src/lib/tls/tls_blocking.cpp