Struct boring::ssl::SslStreamBuilder

pub struct SslStreamBuilder<S> { /* private fields */ }

A partially constructed SslStream, useful for unusual handshakes.

Implementations

impl<S> SslStreamBuilder<S>

where S: Read + Write,

pub fn new(ssl: Ssl, stream: S) -> Self

Begin creating an SslStream atop stream

pub fn set_connect_state(&mut self)

Configure as an outgoing stream from a client.

This corresponds to SSL_set_connect_state.

pub fn set_accept_state(&mut self)

Configure as an incoming stream to a server.

This corresponds to SSL_set_accept_state.

pub fn setup_connect(self) -> MidHandshakeSslStream<S>

Initiates a client-side TLS handshake, returning a MidHandshakeSslStream.

This method calls Self::set_connect_state and returns without actually initiating the handshake. The caller is then free to call MidHandshakeSslStream and loop on HandshakeError::WouldBlock.

pub fn connect(self) -> Result<SslStream<S>, HandshakeError<S>>

Attempts a client-side TLS handshake.

This is a convenience method which combines Self::setup_connect and MidHandshakeSslStream::handshake.

pub fn setup_accept(self) -> MidHandshakeSslStream<S>

Initiates a server-side TLS handshake, returning a MidHandshakeSslStream.

This method calls Self::set_accept_state and returns without actually initiating the handshake. The caller is then free to call MidHandshakeSslStream and loop on HandshakeError::WouldBlock.

pub fn accept(self) -> Result<SslStream<S>, HandshakeError<S>>

Attempts a server-side TLS handshake.

This is a convenience method which combines Self::setup_accept and MidHandshakeSslStream::handshake.

pub fn handshake(self) -> Result<SslStream<S>, HandshakeError<S>>

Initiates the handshake.

This will fail if set_accept_state or set_connect_state was not called first.

This corresponds to SSL_do_handshake.

impl<S> SslStreamBuilder<S>

pub fn get_ref(&self) -> &S

Returns a shared reference to the underlying stream.

pub fn get_mut(&mut self) -> &mut S

Returns a mutable reference to the underlying stream.

Warning

It is inadvisable to read from or write to the underlying stream as it will most likely corrupt the SSL session.

pub fn ssl(&self) -> &SslRef

Returns a shared reference to the Ssl object associated with this builder.

pub fn ssl_mut(&mut self) -> &mut SslRef

Returns a mutable reference to the Ssl object associated with this builder.

pub fn set_dtls_mtu_size(&mut self, mtu_size: usize)

👎Deprecated since 0.10.30: Use SslRef::set_mtu instead

Set the DTLS MTU size.

It will be ignored if the value is smaller than the minimum packet size the DTLS protocol requires.

Panics

This function panics if the given mtu size can’t be represented in a positive c_long range