Botan::TLS::Stream< StreamLayer, ChannelT > Class Template Reference

boost::asio compatible SSL/TLS stream More...

#include <asio_stream.h>

Classes
class	StreamCore
	Helper class that implements Botan::TLS::Callbacks. More...

Public Member Functions
construction
template<typename... Args>
	Stream (Context &context, Args &&... args)
	Construct a new Stream. More...
template<typename Arg >
	Stream (Arg &&arg, Context &context)
	Construct a new Stream. More...
virtual	~Stream ()=default
	Stream (Stream &&other)=default
Stream &	operator= (Stream &&other)=default
	Stream (const Stream &other)=delete
Stream &	operator= (const Stream &other)=delete
configuration and callback setters
void	set_verify_callback (Context::Verify_Callback callback)
	Override the tls_verify_cert_chain callback. More...
void	set_verify_callback (Context::Verify_Callback callback, boost::system::error_code &ec)
	Compatibility overload of set_verify_callback. More...
void	set_verify_depth (int depth)
void	set_verify_depth (int depth, boost::system::error_code &ec)
template<typename verify_mode >
void	set_verify_mode (verify_mode v)
template<typename verify_mode >
void	set_verify_mode (verify_mode v, boost::system::error_code &ec)
shutdown methods
void	shutdown (boost::system::error_code &ec)
	Shut down SSL on the stream. More...
void	shutdown ()
	Shut down SSL on the stream. More...
template<typename ShutdownHandler >
void	async_shutdown (ShutdownHandler &&handler)
	Asynchronously shut down SSL on the stream. More...
I/O methods
template<typename MutableBufferSequence >
std::size_t	read_some (const MutableBufferSequence &buffers, boost::system::error_code &ec)
	Read some data from the stream. More...
template<typename MutableBufferSequence >
std::size_t	read_some (const MutableBufferSequence &buffers)
	Read some data from the stream. More...
template<typename ConstBufferSequence >
std::size_t	write_some (const ConstBufferSequence &buffers, boost::system::error_code &ec)
	Write some data to the stream. More...
template<typename ConstBufferSequence >
std::size_t	write_some (const ConstBufferSequence &buffers)
	Write some data to the stream. More...
template<typename ConstBufferSequence , typename WriteHandler >
auto	async_write_some (const ConstBufferSequence &buffers, WriteHandler &&handler) -> BOOST_ASIO_INITFN_RESULT_TYPE(WriteHandler, void(boost::system::error_code, std::size_t))
	Start an asynchronous write. The function call always returns immediately. More...
template<typename MutableBufferSequence , typename ReadHandler >
auto	async_read_some (const MutableBufferSequence &buffers, ReadHandler &&handler) -> BOOST_ASIO_INITFN_RESULT_TYPE(ReadHandler, void(boost::system::error_code, std::size_t))
	Start an asynchronous read. The function call always returns immediately. More...

Protected Member Functions
void	consume_send_buffer (std::size_t bytesConsumed)
	Mark bytes in the send buffer as consumed, removing them from the buffer. More...
template<typename MutableBufferSequence >
std::size_t	copy_received_data (MutableBufferSequence buffers)
	Copy decrypted data into the user-provided buffer. More...
bool	has_data_to_send () const
	Check if encrypted data is available in the send buffer. More...
bool	has_received_data () const
	Check if decrypted data is available in the receive buffer. More...
const boost::asio::mutable_buffer &	input_buffer ()
boost::asio::const_buffer	send_buffer () const
size_t	send_pending_encrypted_data (boost::system::error_code &ec)
template<class T = ChannelT>
std::enable_if<!std::is_same< Channel, T >::value >::type	setup_native_handle (Connection_Side, boost::system::error_code &)
template<class T = ChannelT>
std::enable_if< std::is_same< Channel, T >::value >::type	setup_native_handle (Connection_Side side, boost::system::error_code &ec)
	Create the native handle. More...
template<typename ConstBufferSequence >
void	tls_encrypt (const ConstBufferSequence &buffers, boost::system::error_code &ec)

Protected Attributes
Context &	m_context
StreamCore	m_core
const boost::asio::mutable_buffer	m_input_buffer
std::vector< uint8_t >	m_input_buffer_space
std::unique_ptr< ChannelT >	m_native_handle
StreamLayer	m_nextLayer
boost::beast::flat_buffer	m_receive_buffer
boost::beast::flat_buffer	m_send_buffer

Friends
template<class H , class S , class A >
class	detail::AsyncHandshakeOperation
template<class H , class S , class M , class A >
class	detail::AsyncReadOperation
template<class H , class S , class A >
class	detail::AsyncWriteOperation

boost::asio accessor methods
using	next_layer_type = typename std::remove_reference< StreamLayer >::type
using	lowest_layer_type = typename next_layer_type::lowest_layer_type
using	executor_type = typename next_layer_type::executor_type
using	native_handle_type = typename std::add_pointer< ChannelT >::type
executor_type	get_executor () noexcept
const next_layer_type &	next_layer () const
next_layer_type &	next_layer ()
lowest_layer_type &	lowest_layer ()
const lowest_layer_type &	lowest_layer () const
native_handle_type	native_handle ()

handshake methods
const ConstBufferSequence &	buffers
const ConstBufferSequence BufferedHandshakeHandler &&	handler
void	handshake (Connection_Side side)
	Performs SSL handshaking. More...
void	handshake (Connection_Side side, boost::system::error_code &ec)
	Performs SSL handshaking. More...
template<typename HandshakeHandler >
auto	async_handshake (Connection_Side side, HandshakeHandler &&handler) ->
	Starts an asynchronous SSL handshake. More...
template<typename ConstBufferSequence , typename BufferedHandshakeHandler >
	BOOST_ASIO_INITFN_RESULT_TYPE (BufferedHandshakeHandler, void(boost::system::error_code, std::size_t)) async_handshake(Connection_Side side
	BOOST_ASIO_HANDSHAKE_HANDLER_CHECK (BufferedHandshakeHandler, handler) type_check
throw	Not_Implemented ("buffered async handshake is not implemented")

Detailed Description

template<class StreamLayer, class ChannelT = Channel>
class Botan::TLS::Stream< StreamLayer, ChannelT >

boost::asio compatible SSL/TLS stream

Currently only the TLS::Client specialization is implemented.

Template Parameters

StreamLayer	type of the next layer, usually a network socket
ChannelT	type of the native_handle, defaults to Botan::TLS::Channel, only needed for testing purposes

Definition at line 49 of file asio_stream.h.

Member Typedef Documentation

executor_type

template<class StreamLayer , class ChannelT = Channel>

using Botan::TLS::Stream< StreamLayer, ChannelT >::executor_type = typename next_layer_type::executor_type

Definition at line 105 of file asio_stream.h.

lowest_layer_type

template<class StreamLayer , class ChannelT = Channel>

using Botan::TLS::Stream< StreamLayer, ChannelT >::lowest_layer_type = typename next_layer_type::lowest_layer_type

Definition at line 104 of file asio_stream.h.

native_handle_type

template<class StreamLayer , class ChannelT = Channel>

using Botan::TLS::Stream< StreamLayer, ChannelT >::native_handle_type = typename std::add_pointer<ChannelT>::type

Definition at line 106 of file asio_stream.h.

next_layer_type

template<class StreamLayer , class ChannelT = Channel>

using Botan::TLS::Stream< StreamLayer, ChannelT >::next_layer_type = typename std::remove_reference<StreamLayer>::type

Definition at line 103 of file asio_stream.h.

Constructor & Destructor Documentation

Stream() [1/4]

template<class StreamLayer , class ChannelT = Channel>

template<typename... Args>

Botan::TLS::Stream< StreamLayer, ChannelT >::Stream ( Context &  context, Args &&...  args  )

inlineexplicit

Construct a new Stream.

Parameters

context	The context parameter is used to set up the underlying native handle. Using code is responsible for lifetime management of the context and must ensure that it is available for the lifetime of the stream.
args	Arguments to be forwarded to the construction of the next layer.

Definition at line 64 of file asio_stream.h.

Referenced by Botan::TLS::Stream< StreamLayer, ChannelT >::async_read_some().

         : m_context(context)
         , m_nextLayer(std::forward<Args>(args)...)
         , m_core(m_receive_buffer, m_send_buffer, m_context)
         , m_input_buffer_space(MAX_CIPHERTEXT_SIZE, '\0')
         , m_input_buffer(m_input_buffer_space.data(), m_input_buffer_space.size())
         {}

Stream() [2/4]

template<class StreamLayer , class ChannelT = Channel>

template<typename Arg >

Botan::TLS::Stream< StreamLayer, ChannelT >::Stream ( Arg &&  arg, Context &  context  )

inlineexplicit

Construct a new Stream.

Convenience overload for boost::asio::ssl::stream compatibility.

Parameters

arg	This argument is forwarded to the construction of the next layer.
context	The context parameter is used to set up the underlying native handle. Using code is responsible for lifetime management of the context and must ensure that is available for the lifetime of the stream.

Definition at line 83 of file asio_stream.h.

         : m_context(context)
         , m_nextLayer(std::forward<Arg>(arg))
         , m_core(m_receive_buffer, m_send_buffer, m_context)
         , m_input_buffer_space(MAX_CIPHERTEXT_SIZE, '\0')
         , m_input_buffer(m_input_buffer_space.data(), m_input_buffer_space.size())
         {}

~Stream()

template<class StreamLayer , class ChannelT = Channel>

virtual Botan::TLS::Stream< StreamLayer, ChannelT >::~Stream ( )

virtualdefault

Stream() [3/4]

template<class StreamLayer , class ChannelT = Channel>

Botan::TLS::Stream< StreamLayer, ChannelT >::Stream ( Stream< StreamLayer, ChannelT > &&  other )

default

Stream() [4/4]

template<class StreamLayer , class ChannelT = Channel>

Botan::TLS::Stream< StreamLayer, ChannelT >::Stream ( const Stream< StreamLayer, ChannelT > &  other )

delete

Member Function Documentation

async_handshake()

template<class StreamLayer , class ChannelT = Channel>

template<typename HandshakeHandler >

auto Botan::TLS::Stream< StreamLayer, ChannelT >::async_handshake ( Connection_Side  side, HandshakeHandler &&  handler  ) ->

inline

Starts an asynchronous SSL handshake.

This function call always returns immediately.

Parameters

side	The type of handshaking to be performed, i.e. as a client or as a server.
handler	The handler to be called when the handshake operation completes. The equivalent function signature of the handler must be: void(boost::system::error_code)

Exceptions

NotImplemented

if Connection_Side is not CLIENT

Definition at line 258 of file asio_stream.h.

References Botan::TLS::Stream< StreamLayer, ChannelT >::BOOST_ASIO_HANDSHAKE_HANDLER_CHECK(), Botan::TLS::Stream< StreamLayer, ChannelT >::handler, init, and Botan::TLS::Stream< StreamLayer, ChannelT >::setup_native_handle().

         {
         BOOST_ASIO_HANDSHAKE_HANDLER_CHECK(HandshakeHandler, handler) type_check;

         boost::system::error_code ec;
         setup_native_handle(side, ec);
         // If ec is set by setup_native_handle, the AsyncHandshakeOperation created below will do nothing but call the
         // handler with the error_code set appropriately - no need to early return here.

         boost::asio::async_completion<HandshakeHandler, void(boost::system::error_code)> init(handler);

         detail::AsyncHandshakeOperation<typename std::decay<HandshakeHandler>::type, Stream>
         op{std::move(init.completion_handler), *this, ec};

         return init.result.get();
         }

async_read_some()

template<class StreamLayer , class ChannelT = Channel>

template<typename MutableBufferSequence , typename ReadHandler >

auto Botan::TLS::Stream< StreamLayer, ChannelT >::async_read_some ( const MutableBufferSequence &  buffers, ReadHandler &&  handler  ) -> BOOST_ASIO_INITFN_RESULT_TYPE(ReadHandler, void(boost::system::error_code, std::size_t))

inline

Start an asynchronous read. The function call always returns immediately.

Parameters

buffers	The buffers into which the data will be read. Although the buffers object may be copied as necessary, ownership of the underlying buffers is retained by the caller, which must guarantee that they remain valid until the handler is called.
handler	The handler to be called when the read operation completes. The equivalent function signature of the handler must be: void(boost::system::error_code, std::size_t)

Definition at line 504 of file asio_stream.h.

References Botan::TLS::Stream< StreamLayer, ChannelT >::buffers, Botan::TLS::Stream< StreamLayer, ChannelT >::handler, init, and Botan::TLS::Stream< StreamLayer, ChannelT >::Stream().

         {
         BOOST_ASIO_READ_HANDLER_CHECK(ReadHandler, handler) type_check;

         boost::asio::async_completion<ReadHandler, void(boost::system::error_code, std::size_t)> init(handler);

         detail::AsyncReadOperation<typename std::decay<ReadHandler>::type, Stream, MutableBufferSequence>
         op{std::move(init.completion_handler), *this, buffers};
         return init.result.get();
         }

async_shutdown()

template<class StreamLayer , class ChannelT = Channel>

template<typename ShutdownHandler >

void Botan::TLS::Stream< StreamLayer, ChannelT >::async_shutdown ( ShutdownHandler &&  handler )

inline

Asynchronously shut down SSL on the stream.

This function call always returns immediately.

Parameters

handler

The handler to be called when the handshake operation completes. The equivalent function signature of the handler must be: void(boost::system::error_code)

Definition at line 347 of file asio_stream.h.

References Botan::TLS::Stream< StreamLayer, ChannelT >::BOOST_ASIO_HANDSHAKE_HANDLER_CHECK(), BOTAN_UNUSED, Botan::TLS::Stream< StreamLayer, ChannelT >::handler, and Botan::TLS::Stream< StreamLayer, ChannelT >::Not_Implemented().

         {
         BOOST_ASIO_HANDSHAKE_HANDLER_CHECK(ShutdownHandler, handler) type_check;
         BOTAN_UNUSED(handler);
         throw Not_Implemented("async shutdown is not implemented");
         // TODO: Implement a subclass of AsyncBase that calls native_handle()->close() and writes pending data from
         // the core to the network, e.g. using AsyncWriteOperation.
         }

async_write_some()

template<class StreamLayer , class ChannelT = Channel>

template<typename ConstBufferSequence , typename WriteHandler >

auto Botan::TLS::Stream< StreamLayer, ChannelT >::async_write_some ( const ConstBufferSequence &  buffers, WriteHandler &&  handler  ) -> BOOST_ASIO_INITFN_RESULT_TYPE(WriteHandler, void(boost::system::error_code, std::size_t))

inline

Start an asynchronous write. The function call always returns immediately.

Parameters

buffers	The data to be written.
handler	The handler to be called when the write operation completes. Copies will be made of the handler as required. The equivalent function signature of the handler must be: void(boost::system::error_code, std::size_t)

Definition at line 467 of file asio_stream.h.

References Botan::TLS::Stream< StreamLayer, ChannelT >::buffers, Botan::TLS::Stream< StreamLayer, ChannelT >::consume_send_buffer(), Botan::TLS::Stream< StreamLayer, ChannelT >::handler, init, Botan::TLS::Stream< StreamLayer, ChannelT >::m_send_buffer, and Botan::TLS::Stream< StreamLayer, ChannelT >::tls_encrypt().

         {
         BOOST_ASIO_WRITE_HANDLER_CHECK(WriteHandler, handler) type_check;

         boost::asio::async_completion<WriteHandler, void(boost::system::error_code, std::size_t)> init(handler);

         boost::system::error_code ec;
         tls_encrypt(buffers, ec);
         if(ec)
            {
            // we cannot be sure how many bytes were committed here so clear the send_buffer and let the
            // AsyncWriteOperation call the handler with the error_code set
            consume_send_buffer(m_send_buffer.size());
            detail::AsyncWriteOperation<typename std::decay<WriteHandler>::type, Stream>
            op{std::move(init.completion_handler), *this, std::size_t(0), ec};
            return init.result.get();
            }

         detail::AsyncWriteOperation<typename std::decay<WriteHandler>::type, Stream>
         op{std::move(init.completion_handler), *this, boost::asio::buffer_size(buffers)};

         return init.result.get();
         }

BOOST_ASIO_HANDSHAKE_HANDLER_CHECK()

template<class StreamLayer , class ChannelT = Channel>

Botan::TLS::Stream< StreamLayer, ChannelT >::BOOST_ASIO_HANDSHAKE_HANDLER_CHECK	(	BufferedHandshakeHandler	,
		handler
	)

Referenced by Botan::TLS::Stream< StreamLayer, ChannelT >::async_handshake(), and Botan::TLS::Stream< StreamLayer, ChannelT >::async_shutdown().

BOOST_ASIO_INITFN_RESULT_TYPE()

template<class StreamLayer , class ChannelT = Channel>

template<typename ConstBufferSequence , typename BufferedHandshakeHandler >

Botan::TLS::Stream< StreamLayer, ChannelT >::BOOST_ASIO_INITFN_RESULT_TYPE	(	BufferedHandshakeHandler	,
		void(boost::system::error_code, std::size_t)
	)

Exceptions

Not_Implemented

consume_send_buffer()

template<class StreamLayer , class ChannelT = Channel>

void Botan::TLS::Stream< StreamLayer, ChannelT >::consume_send_buffer ( std::size_t  bytesConsumed )

inlineprotected

Mark bytes in the send buffer as consumed, removing them from the buffer.

Definition at line 617 of file asio_stream.h.

References Botan::TLS::Stream< StreamLayer, ChannelT >::m_send_buffer.

Referenced by Botan::TLS::Stream< StreamLayer, ChannelT >::async_write_some(), Botan::TLS::detail::AsyncWriteOperation< Handler, Stream, Allocator >::operator()(), and Botan::TLS::Stream< StreamLayer, ChannelT >::send_pending_encrypted_data().

{ m_send_buffer.consume(bytesConsumed); }

copy_received_data()

template<class StreamLayer , class ChannelT = Channel>

template<typename MutableBufferSequence >

std::size_t Botan::TLS::Stream< StreamLayer, ChannelT >::copy_received_data ( MutableBufferSequence  buffers )

inlineprotected

Copy decrypted data into the user-provided buffer.

Definition at line 602 of file asio_stream.h.

References Botan::TLS::Stream< StreamLayer, ChannelT >::buffers, and Botan::TLS::Stream< StreamLayer, ChannelT >::m_receive_buffer.

Referenced by Botan::TLS::detail::AsyncReadOperation< Handler, Stream, MutableBufferSequence, Allocator >::operator()(), and Botan::TLS::Stream< StreamLayer, ChannelT >::read_some().

         {
         // Note: It would be nice to avoid this buffer copy. This could be achieved by equipping the StreamCore with
         // the user's desired target buffer once a read is started, and reading directly into that buffer in tls_record
         // received. However, we need to deal with the case that the receive buffer provided by the caller is smaller
         // than the decrypted record, so this optimization might not be worth the additional complexity.
         const auto copiedBytes = boost::asio::buffer_copy(buffers, m_receive_buffer.data());
         m_receive_buffer.consume(copiedBytes);
         return copiedBytes;
         }

get_executor()

template<class StreamLayer , class ChannelT = Channel>

executor_type Botan::TLS::Stream< StreamLayer, ChannelT >::get_executor ( )

inlinenoexcept

Definition at line 108 of file asio_stream.h.

References Botan::TLS::Stream< StreamLayer, ChannelT >::m_nextLayer.

{ return m_nextLayer.get_executor(); }

handshake() [1/2]

template<class StreamLayer , class ChannelT = Channel>

void Botan::TLS::Stream< StreamLayer, ChannelT >::handshake ( Connection_Side  side )

inline

Performs SSL handshaking.

The function call will block until handshaking is complete or an error occurs.

Parameters

side	The type of handshaking to be performed, i.e. as a client or as a server.

Exceptions

boost::system::system_error

if error occured, or if the chosen Connection_Side is not available

Definition at line 198 of file asio_stream.h.

         {
         boost::system::error_code ec;
         handshake(side, ec);
         boost::asio::detail::throw_error(ec, "handshake");
         }

handshake() [2/2]

template<class StreamLayer , class ChannelT = Channel>

void Botan::TLS::Stream< StreamLayer, ChannelT >::handshake ( Connection_Side  side, boost::system::error_code &  ec  )

inline

Performs SSL handshaking.

The function call will block until handshaking is complete or an error occurs.

Parameters

side	The type of handshaking to be performed, i.e. as a client or as a server.
ec	Set to indicate what error occurred, if any.

Definition at line 213 of file asio_stream.h.

References Botan::Exception::error_type(), Botan::TLS::Stream< StreamLayer, ChannelT >::input_buffer(), Botan::TLS::Stream< StreamLayer, ChannelT >::m_nextLayer, Botan::TLS::Stream< StreamLayer, ChannelT >::native_handle(), Botan::TLS::Stream< StreamLayer, ChannelT >::send_pending_encrypted_data(), Botan::TLS::Stream< StreamLayer, ChannelT >::setup_native_handle(), Botan::TLS::TLS_Exception::type(), and Botan::Unknown.

         {
         setup_native_handle(side, ec);

         // send client hello, which was written to the send buffer on client instantiation
         send_pending_encrypted_data(ec);

         while(!native_handle()->is_active() && !ec)
            {
            boost::asio::const_buffer read_buffer{input_buffer().data(), m_nextLayer.read_some(input_buffer(), ec)};
            if(ec)
               { return; }

            try
               {
               native_handle()->received_data(static_cast<const uint8_t*>(read_buffer.data()), read_buffer.size());
               }
            catch(const TLS_Exception& e)
               {
               ec = e.type();
               }
            catch(const Botan::Exception& e)
               {
               ec = e.error_type();
               }
            catch(const std::exception&)
               {
               ec = Botan::ErrorType::Unknown;
               }

            send_pending_encrypted_data(ec);
            }
         }

has_data_to_send()

template<class StreamLayer , class ChannelT = Channel>

bool Botan::TLS::Stream< StreamLayer, ChannelT >::has_data_to_send ( ) const

inlineprotected

Check if encrypted data is available in the send buffer.

Definition at line 614 of file asio_stream.h.

References Botan::TLS::Stream< StreamLayer, ChannelT >::m_send_buffer.

Referenced by Botan::TLS::detail::AsyncWriteOperation< Handler, Stream, Allocator >::operator()(), and Botan::TLS::detail::AsyncHandshakeOperation< Handler, Stream, Allocator >::operator()().

{ return m_send_buffer.size() > 0; }

has_received_data()

template<class StreamLayer , class ChannelT = Channel>

bool Botan::TLS::Stream< StreamLayer, ChannelT >::has_received_data ( ) const

inlineprotected

Check if decrypted data is available in the receive buffer.

Definition at line 598 of file asio_stream.h.

References Botan::TLS::Stream< StreamLayer, ChannelT >::m_receive_buffer.

Referenced by Botan::TLS::detail::AsyncReadOperation< Handler, Stream, MutableBufferSequence, Allocator >::operator()(), and Botan::TLS::Stream< StreamLayer, ChannelT >::read_some().

{ return m_receive_buffer.size() > 0; }

input_buffer()

template<class StreamLayer , class ChannelT = Channel>

const boost::asio::mutable_buffer& Botan::TLS::Stream< StreamLayer, ChannelT >::input_buffer ( )

inlineprotected

Definition at line 594 of file asio_stream.h.

References Botan::TLS::Stream< StreamLayer, ChannelT >::m_input_buffer.

Referenced by Botan::TLS::Stream< StreamLayer, ChannelT >::handshake(), Botan::TLS::detail::AsyncReadOperation< Handler, Stream, MutableBufferSequence, Allocator >::operator()(), Botan::TLS::detail::AsyncHandshakeOperation< Handler, Stream, Allocator >::operator()(), and Botan::TLS::Stream< StreamLayer, ChannelT >::read_some().

{ return m_input_buffer; }

lowest_layer() [1/2]

template<class StreamLayer , class ChannelT = Channel>

lowest_layer_type& Botan::TLS::Stream< StreamLayer, ChannelT >::lowest_layer ( )

inline

Definition at line 113 of file asio_stream.h.

References Botan::TLS::Stream< StreamLayer, ChannelT >::m_nextLayer.

{ return m_nextLayer.lowest_layer(); }

lowest_layer() [2/2]

template<class StreamLayer , class ChannelT = Channel>

const lowest_layer_type& Botan::TLS::Stream< StreamLayer, ChannelT >::lowest_layer ( ) const

inline

Definition at line 114 of file asio_stream.h.

References Botan::TLS::Stream< StreamLayer, ChannelT >::m_nextLayer.

{ return m_nextLayer.lowest_layer(); }

native_handle()

template<class StreamLayer , class ChannelT = Channel>

native_handle_type Botan::TLS::Stream< StreamLayer, ChannelT >::native_handle ( )

inline

Definition at line 116 of file asio_stream.h.

References Botan::TLS::Stream< StreamLayer, ChannelT >::m_native_handle.

Referenced by Botan::TLS::Stream< StreamLayer, ChannelT >::handshake(), Botan::TLS::detail::AsyncReadOperation< Handler, Stream, MutableBufferSequence, Allocator >::operator()(), Botan::TLS::detail::AsyncHandshakeOperation< Handler, Stream, Allocator >::operator()(), Botan::TLS::Stream< StreamLayer, ChannelT >::read_some(), Botan::TLS::Stream< StreamLayer, ChannelT >::shutdown(), and Botan::TLS::Stream< StreamLayer, ChannelT >::tls_encrypt().

{ return m_native_handle.get(); }

next_layer() [1/2]

template<class StreamLayer , class ChannelT = Channel>

const next_layer_type& Botan::TLS::Stream< StreamLayer, ChannelT >::next_layer ( ) const

inline

Definition at line 110 of file asio_stream.h.

References Botan::TLS::Stream< StreamLayer, ChannelT >::m_nextLayer.

Referenced by Botan::TLS::detail::AsyncReadOperation< Handler, Stream, MutableBufferSequence, Allocator >::operator()(), Botan::TLS::detail::AsyncWriteOperation< Handler, Stream, Allocator >::operator()(), and Botan::TLS::detail::AsyncHandshakeOperation< Handler, Stream, Allocator >::operator()().

{ return m_nextLayer; }

next_layer() [2/2]

template<class StreamLayer , class ChannelT = Channel>

next_layer_type& Botan::TLS::Stream< StreamLayer, ChannelT >::next_layer ( )

inline

Definition at line 111 of file asio_stream.h.

References Botan::TLS::Stream< StreamLayer, ChannelT >::m_nextLayer.

{ return m_nextLayer; }

Not_Implemented()

template<class StreamLayer , class ChannelT = Channel>

throw Botan::TLS::Stream< StreamLayer, ChannelT >::Not_Implemented

(

"buffered async handshake is not implemented"

)

Referenced by Botan::TLS::Stream< StreamLayer, ChannelT >::async_shutdown(), Botan::TLS::Stream< StreamLayer, ChannelT >::set_verify_depth(), and Botan::TLS::Stream< StreamLayer, ChannelT >::set_verify_mode().

operator=() [1/2]

template<class StreamLayer , class ChannelT = Channel>

Stream& Botan::TLS::Stream< StreamLayer, ChannelT >::operator= ( Stream< StreamLayer, ChannelT > &&  other )

default

operator=() [2/2]

template<class StreamLayer , class ChannelT = Channel>

Stream& Botan::TLS::Stream< StreamLayer, ChannelT >::operator= ( const Stream< StreamLayer, ChannelT > &  other )

delete

read_some() [1/2]

template<class StreamLayer , class ChannelT = Channel>

template<typename MutableBufferSequence >

std::size_t Botan::TLS::Stream< StreamLayer, ChannelT >::read_some ( const MutableBufferSequence &  buffers, boost::system::error_code &  ec  )

inline

Read some data from the stream.

The function call will block until one or more bytes of data has been read successfully, or until an error occurs.

Parameters

buffers	The buffers into which the data will be read.
ec	Set to indicate what error occured, if any.

Returns

The number of bytes read. Returns 0 if an error occurred.

Definition at line 371 of file asio_stream.h.

References Botan::TLS::Stream< StreamLayer, ChannelT >::buffers, Botan::TLS::Stream< StreamLayer, ChannelT >::copy_received_data(), Botan::Exception::error_type(), Botan::TLS::Stream< StreamLayer, ChannelT >::has_received_data(), Botan::TLS::Stream< StreamLayer, ChannelT >::input_buffer(), Botan::TLS::Stream< StreamLayer, ChannelT >::m_nextLayer, Botan::TLS::Stream< StreamLayer, ChannelT >::native_handle(), Botan::TLS::TLS_Exception::type(), and Botan::Unknown.

Referenced by Botan::TLS::Stream< StreamLayer, ChannelT >::read_some().

         {
         if(has_received_data())
            { return copy_received_data(buffers); }

         boost::asio::const_buffer read_buffer{input_buffer().data(), m_nextLayer.read_some(input_buffer(), ec)};
         if(ec)
            { return 0; }

         try
            {
            native_handle()->received_data(static_cast<const uint8_t*>(read_buffer.data()), read_buffer.size());
            }
         catch(const TLS_Exception& e)
            {
            ec = e.type();
            }
         catch(const Botan::Exception& e)
            {
            ec = e.error_type();
            }
         catch(const std::exception&)
            {
            ec = Botan::ErrorType::Unknown;
            }

         return !ec ? copy_received_data(buffers) : 0;
         }

read_some() [2/2]

template<class StreamLayer , class ChannelT = Channel>

template<typename MutableBufferSequence >

std::size_t Botan::TLS::Stream< StreamLayer, ChannelT >::read_some ( const MutableBufferSequence &  buffers )

inline

Read some data from the stream.

The function call will block until one or more bytes of data has been read successfully, or until an error occurs.

Parameters

buffers

The buffers into which the data will be read.

Returns

The number of bytes read. Returns 0 if an error occurred.

Exceptions

boost::system::system_error

if error occured

Definition at line 412 of file asio_stream.h.

References Botan::TLS::Stream< StreamLayer, ChannelT >::buffers, and Botan::TLS::Stream< StreamLayer, ChannelT >::read_some().

         {
         boost::system::error_code ec;
         auto const n = read_some(buffers, ec);
         boost::asio::detail::throw_error(ec, "read_some");
         return n;
         }

send_buffer()

template<class StreamLayer , class ChannelT = Channel>

boost::asio::const_buffer Botan::TLS::Stream< StreamLayer, ChannelT >::send_buffer ( ) const

inlineprotected

Definition at line 595 of file asio_stream.h.

References Botan::TLS::Stream< StreamLayer, ChannelT >::m_send_buffer.

Referenced by Botan::TLS::detail::AsyncWriteOperation< Handler, Stream, Allocator >::operator()(), and Botan::TLS::Stream< StreamLayer, ChannelT >::send_pending_encrypted_data().

{ return m_send_buffer.data(); }

send_pending_encrypted_data()

template<class StreamLayer , class ChannelT = Channel>

size_t Botan::TLS::Stream< StreamLayer, ChannelT >::send_pending_encrypted_data ( boost::system::error_code &  ec )

inlineprotected

Definition at line 658 of file asio_stream.h.

References Botan::TLS::Stream< StreamLayer, ChannelT >::consume_send_buffer(), Botan::TLS::Stream< StreamLayer, ChannelT >::m_nextLayer, and Botan::TLS::Stream< StreamLayer, ChannelT >::send_buffer().

Referenced by Botan::TLS::Stream< StreamLayer, ChannelT >::handshake(), Botan::TLS::Stream< StreamLayer, ChannelT >::shutdown(), and Botan::TLS::Stream< StreamLayer, ChannelT >::write_some().

         {
         if(ec)
            { return 0; }

         auto writtenBytes = boost::asio::write(m_nextLayer, send_buffer(), ec);
         consume_send_buffer(writtenBytes);
         return writtenBytes;
         }

set_verify_callback() [1/2]

template<class StreamLayer , class ChannelT = Channel>

void Botan::TLS::Stream< StreamLayer, ChannelT >::set_verify_callback ( Context::Verify_Callback  callback )

inline

Override the tls_verify_cert_chain callback.

This changes the verify_callback in the stream's TLS::Context, and hence the tls_verify_cert_chain callback used in the handshake. Using this function is equivalent to setting the callback via

See also

Botan::TLS::Context::set_verify_callback

Note

This function should only be called before initiating the TLS handshake

Definition at line 131 of file asio_stream.h.

References Botan::TLS::Stream< StreamLayer, ChannelT >::m_context, and Botan::TLS::Context::set_verify_callback().

         {
         m_context.set_verify_callback(std::move(callback));
         }

set_verify_callback() [2/2]

template<class StreamLayer , class ChannelT = Channel>

void Botan::TLS::Stream< StreamLayer, ChannelT >::set_verify_callback ( Context::Verify_Callback  callback, boost::system::error_code &  ec  )

inline

Compatibility overload of set_verify_callback.

Parameters

callback	the callback implementation
ec	This parameter is unused.

Definition at line 142 of file asio_stream.h.

References BOTAN_UNUSED, Botan::TLS::Stream< StreamLayer, ChannelT >::m_context, and Botan::TLS::Context::set_verify_callback().

         {
         BOTAN_UNUSED(ec);
         m_context.set_verify_callback(std::move(callback));
         }

set_verify_depth() [1/2]

template<class StreamLayer , class ChannelT = Channel>

void Botan::TLS::Stream< StreamLayer, ChannelT >::set_verify_depth ( int  depth )

inline

Exceptions

Not_Implemented

Definition at line 149 of file asio_stream.h.

References BOTAN_UNUSED, and Botan::TLS::Stream< StreamLayer, ChannelT >::Not_Implemented().

         {
         BOTAN_UNUSED(depth);
         throw Not_Implemented("set_verify_depth is not implemented");
         }

set_verify_depth() [2/2]

template<class StreamLayer , class ChannelT = Channel>

void Botan::TLS::Stream< StreamLayer, ChannelT >::set_verify_depth ( int  depth, boost::system::error_code &  ec  )

inline

Not Implemented.

Parameters

depth	the desired verification depth
ec	Will be set to Botan::ErrorType::NotImplemented

Definition at line 160 of file asio_stream.h.

References BOTAN_UNUSED, and Botan::NotImplemented.

         {
         BOTAN_UNUSED(depth);
         ec = Botan::ErrorType::NotImplemented;
         }

set_verify_mode() [1/2]

template<class StreamLayer , class ChannelT = Channel>

template<typename verify_mode >

void Botan::TLS::Stream< StreamLayer, ChannelT >::set_verify_mode ( verify_mode  v )

inline

Exceptions

Not_Implemented

Definition at line 168 of file asio_stream.h.

References BOTAN_UNUSED, and Botan::TLS::Stream< StreamLayer, ChannelT >::Not_Implemented().

         {
         BOTAN_UNUSED(v);
         throw Not_Implemented("set_verify_mode is not implemented");
         }

set_verify_mode() [2/2]

template<class StreamLayer , class ChannelT = Channel>

template<typename verify_mode >

void Botan::TLS::Stream< StreamLayer, ChannelT >::set_verify_mode ( verify_mode  v, boost::system::error_code &  ec  )

inline

Not Implemented.

Parameters

v	the desired verify mode
ec	Will be set to Botan::ErrorType::NotImplemented

Definition at line 180 of file asio_stream.h.

References BOTAN_UNUSED, and Botan::NotImplemented.

         {
         BOTAN_UNUSED(v);
         ec = Botan::ErrorType::NotImplemented;
         }

setup_native_handle() [1/2]

template<class StreamLayer , class ChannelT = Channel>

template<class T = ChannelT>

std::enable_if<!std::is_same<Channel, T>::value>::type Botan::TLS::Stream< StreamLayer, ChannelT >::setup_native_handle ( Connection_Side  , boost::system::error_code &    )

inlineprotected

Definition at line 625 of file asio_stream.h.

Referenced by Botan::TLS::Stream< StreamLayer, ChannelT >::async_handshake(), and Botan::TLS::Stream< StreamLayer, ChannelT >::handshake().

{}

setup_native_handle() [2/2]

template<class StreamLayer , class ChannelT = Channel>

template<class T = ChannelT>

std::enable_if<std::is_same<Channel, T>::value>::type Botan::TLS::Stream< StreamLayer, ChannelT >::setup_native_handle ( Connection_Side  side, boost::system::error_code &  ec  )

inlineprotected

Create the native handle.

Depending on the desired connection side, this function will create a Botan::TLS::Client or a Botan::TLS::Server.

Parameters

side	The desired connection side (client or server)
ec	Set to NotImplemented when side is SERVER - currently only CLIENT is implemented

Definition at line 638 of file asio_stream.h.

References Botan::TLS::CLIENT, Botan::TLS::Stream< StreamLayer, ChannelT >::m_context, Botan::TLS::Stream< StreamLayer, ChannelT >::m_core, Botan::TLS::Context::m_credentials_manager, Botan::TLS::Stream< StreamLayer, ChannelT >::m_native_handle, Botan::TLS::Context::m_policy, Botan::TLS::Context::m_rng, Botan::TLS::Context::m_server_info, Botan::TLS::Context::m_session_manager, and Botan::NotImplemented.

         {
         if(side == CLIENT)
            {
            m_native_handle = std::unique_ptr<Client>(
                                 new Client(m_core,
                                            m_context.m_session_manager,
                                            m_context.m_credentials_manager,
                                            m_context.m_policy,
                                            m_context.m_rng,
                                            m_context.m_server_info));
            }
         else
            {
            // TODO: First steps in order to support the server side of this stream would be to instantiate a
            // Botan::TLS::Server instance as the stream's native_handle and implement the handshake appropriately.
            ec = Botan::ErrorType::NotImplemented;
            }
         }

shutdown() [1/2]

template<class StreamLayer , class ChannelT = Channel>

void Botan::TLS::Stream< StreamLayer, ChannelT >::shutdown ( boost::system::error_code &  ec )

inline

Shut down SSL on the stream.

This function is used to shut down SSL on the stream. The function call will block until SSL has been shut down or an error occurs. Note that this will not close the lowest layer.

Parameters

ec	Set to indicate what error occured, if any.

Definition at line 300 of file asio_stream.h.

References Botan::Exception::error_type(), Botan::TLS::Stream< StreamLayer, ChannelT >::native_handle(), Botan::TLS::Stream< StreamLayer, ChannelT >::send_pending_encrypted_data(), Botan::TLS::TLS_Exception::type(), and Botan::Unknown.

         {
         try
            {
            native_handle()->close();
            }
         catch(const TLS_Exception& e)
            {
            ec = e.type();
            }
         catch(const Botan::Exception& e)
            {
            ec = e.error_type();
            }
         catch(const std::exception&)
            {
            ec = Botan::ErrorType::Unknown;
            }

         if(!ec)
            { send_pending_encrypted_data(ec); }
         }

shutdown() [2/2]

template<class StreamLayer , class ChannelT = Channel>

void Botan::TLS::Stream< StreamLayer, ChannelT >::shutdown ( )

inline

Shut down SSL on the stream.

This function is used to shut down SSL on the stream. The function call will block until SSL has been shut down or an error occurs. Note that this will not close the lowest layer.

Exceptions

boost::system::system_error

if error occured

Definition at line 331 of file asio_stream.h.

         {
         boost::system::error_code ec;
         shutdown(ec);
         boost::asio::detail::throw_error(ec, "shutdown");
         }

tls_encrypt()

template<class StreamLayer , class ChannelT = Channel>

template<typename ConstBufferSequence >

void Botan::TLS::Stream< StreamLayer, ChannelT >::tls_encrypt ( const ConstBufferSequence &  buffers, boost::system::error_code &  ec  )

inlineprotected

Definition at line 669 of file asio_stream.h.

References Botan::TLS::Stream< StreamLayer, ChannelT >::buffers, Botan::Exception::error_type(), Botan::TLS::Stream< StreamLayer, ChannelT >::native_handle(), Botan::TLS::TLS_Exception::type(), and Botan::Unknown.

Referenced by Botan::TLS::Stream< StreamLayer, ChannelT >::async_write_some(), and Botan::TLS::Stream< StreamLayer, ChannelT >::write_some().

         {
         // NOTE: This is not asynchronous: it encrypts the data synchronously.
         // The data encrypted by native_handle()->send() is synchronously stored in the send_buffer of m_core,
         // but is not actually written to the wire, yet.
         for(auto it = boost::asio::buffer_sequence_begin(buffers);
               !ec && it != boost::asio::buffer_sequence_end(buffers);
               it++)
            {
            const boost::asio::const_buffer buffer = *it;
            try
               {
               native_handle()->send(static_cast<const uint8_t*>(buffer.data()), buffer.size());
               }
            catch(const TLS_Exception& e)
               {
               ec = e.type();
               }
            catch(const Botan::Exception& e)
               {
               ec = e.error_type();
               }
            catch(const std::exception&)
               {
               ec = Botan::ErrorType::Unknown;
               }
            }
         }

write_some() [1/2]

template<class StreamLayer , class ChannelT = Channel>

template<typename ConstBufferSequence >

std::size_t Botan::TLS::Stream< StreamLayer, ChannelT >::write_some ( const ConstBufferSequence &  buffers, boost::system::error_code &  ec  )

inline

Write some data to the stream.

The function call will block until one or more bytes of data has been written successfully, or until an error occurs.

Parameters

buffers	The data to be written.
ec	Set to indicate what error occurred, if any.

Returns

The number of bytes processed from the input buffers.

Definition at line 431 of file asio_stream.h.

References Botan::TLS::Stream< StreamLayer, ChannelT >::buffers, Botan::TLS::Stream< StreamLayer, ChannelT >::send_pending_encrypted_data(), and Botan::TLS::Stream< StreamLayer, ChannelT >::tls_encrypt().

Referenced by Botan::TLS::Stream< StreamLayer, ChannelT >::write_some().

         {
         tls_encrypt(buffers, ec);
         send_pending_encrypted_data(ec);
         return !ec ? boost::asio::buffer_size(buffers) : 0;
         }

write_some() [2/2]

template<class StreamLayer , class ChannelT = Channel>

template<typename ConstBufferSequence >

std::size_t Botan::TLS::Stream< StreamLayer, ChannelT >::write_some ( const ConstBufferSequence &  buffers )

inline

Write some data to the stream.

The function call will block until one or more bytes of data has been written successfully, or until an error occurs.

Parameters

buffers

The data to be written.

Returns

The number of bytes written.

Exceptions

boost::system::system_error

if error occured

Definition at line 450 of file asio_stream.h.

References Botan::TLS::Stream< StreamLayer, ChannelT >::buffers, and Botan::TLS::Stream< StreamLayer, ChannelT >::write_some().

         {
         boost::system::error_code ec;
         auto const n = write_some(buffers, ec);
         boost::asio::detail::throw_error(ec, "write_some");
         return n;
         }

Friends And Related Function Documentation

detail::AsyncHandshakeOperation

template<class StreamLayer , class ChannelT = Channel>

template<class H , class S , class A >

friend class detail::AsyncHandshakeOperation

friend

Definition at line 522 of file asio_stream.h.

detail::AsyncReadOperation

template<class StreamLayer , class ChannelT = Channel>

template<class H , class S , class M , class A >

friend class detail::AsyncReadOperation

friend

Definition at line 520 of file asio_stream.h.

detail::AsyncWriteOperation

template<class StreamLayer , class ChannelT = Channel>

template<class H , class S , class A >

friend class detail::AsyncWriteOperation

friend

Definition at line 521 of file asio_stream.h.

Member Data Documentation

buffers

template<class StreamLayer , class ChannelT = Channel>

const ConstBufferSequence& Botan::TLS::Stream< StreamLayer, ChannelT >::buffers

Definition at line 280 of file asio_stream.h.

Referenced by Botan::TLS::Stream< StreamLayer, ChannelT >::async_read_some(), Botan::TLS::Stream< StreamLayer, ChannelT >::async_write_some(), Botan::TLS::Stream< StreamLayer, ChannelT >::copy_received_data(), Botan::TLS::Stream< StreamLayer, ChannelT >::read_some(), Botan::TLS::Stream< StreamLayer, ChannelT >::tls_encrypt(), and Botan::TLS::Stream< StreamLayer, ChannelT >::write_some().

handler

template<class StreamLayer , class ChannelT = Channel>

const ConstBufferSequence BufferedHandshakeHandler&& Botan::TLS::Stream< StreamLayer, ChannelT >::handler

Initial value:

{
         BOTAN_UNUSED(side, buffers, handler)

Definition at line 282 of file asio_stream.h.

Referenced by Botan::TLS::Stream< StreamLayer, ChannelT >::async_handshake(), Botan::TLS::Stream< StreamLayer, ChannelT >::async_read_some(), Botan::TLS::Stream< StreamLayer, ChannelT >::async_shutdown(), and Botan::TLS::Stream< StreamLayer, ChannelT >::async_write_some().

m_context

template<class StreamLayer , class ChannelT = Channel>

Context& Botan::TLS::Stream< StreamLayer, ChannelT >::m_context

protected

Definition at line 698 of file asio_stream.h.

Referenced by Botan::TLS::Stream< StreamLayer, ChannelT >::set_verify_callback(), and Botan::TLS::Stream< StreamLayer, ChannelT >::setup_native_handle().

m_core

template<class StreamLayer , class ChannelT = Channel>

StreamCore Botan::TLS::Stream< StreamLayer, ChannelT >::m_core

protected

Definition at line 704 of file asio_stream.h.

Referenced by Botan::TLS::Stream< StreamLayer, ChannelT >::setup_native_handle().

m_input_buffer

template<class StreamLayer , class ChannelT = Channel>

const boost::asio::mutable_buffer Botan::TLS::Stream< StreamLayer, ChannelT >::m_input_buffer

protected

Definition at line 709 of file asio_stream.h.

Referenced by Botan::TLS::Stream< StreamLayer, ChannelT >::input_buffer().

m_input_buffer_space

template<class StreamLayer , class ChannelT = Channel>

std::vector<uint8_t> Botan::TLS::Stream< StreamLayer, ChannelT >::m_input_buffer_space

protected

Definition at line 708 of file asio_stream.h.

m_native_handle

template<class StreamLayer , class ChannelT = Channel>

std::unique_ptr<ChannelT> Botan::TLS::Stream< StreamLayer, ChannelT >::m_native_handle

protected

Definition at line 705 of file asio_stream.h.

Referenced by Botan::TLS::Stream< StreamLayer, ChannelT >::native_handle(), and Botan::TLS::Stream< StreamLayer, ChannelT >::setup_native_handle().

m_nextLayer

template<class StreamLayer , class ChannelT = Channel>

StreamLayer Botan::TLS::Stream< StreamLayer, ChannelT >::m_nextLayer

protected

Definition at line 699 of file asio_stream.h.

Referenced by Botan::TLS::Stream< StreamLayer, ChannelT >::get_executor(), Botan::TLS::Stream< StreamLayer, ChannelT >::handshake(), Botan::TLS::Stream< StreamLayer, ChannelT >::lowest_layer(), Botan::TLS::Stream< StreamLayer, ChannelT >::next_layer(), Botan::TLS::Stream< StreamLayer, ChannelT >::read_some(), and Botan::TLS::Stream< StreamLayer, ChannelT >::send_pending_encrypted_data().

m_receive_buffer

template<class StreamLayer , class ChannelT = Channel>

boost::beast::flat_buffer Botan::TLS::Stream< StreamLayer, ChannelT >::m_receive_buffer

protected

Definition at line 701 of file asio_stream.h.

Referenced by Botan::TLS::Stream< StreamLayer, ChannelT >::copy_received_data(), and Botan::TLS::Stream< StreamLayer, ChannelT >::has_received_data().

m_send_buffer

template<class StreamLayer , class ChannelT = Channel>

boost::beast::flat_buffer Botan::TLS::Stream< StreamLayer, ChannelT >::m_send_buffer

protected

Definition at line 702 of file asio_stream.h.

Referenced by Botan::TLS::Stream< StreamLayer, ChannelT >::async_write_some(), Botan::TLS::Stream< StreamLayer, ChannelT >::consume_send_buffer(), Botan::TLS::Stream< StreamLayer, ChannelT >::has_data_to_send(), and Botan::TLS::Stream< StreamLayer, ChannelT >::send_buffer().

---

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

• src/lib/tls/asio/asio_stream.h