Struct rustls::ServerSession

[+] Show declaration

pub struct ServerSession { /* fields omitted */ }

[−] Expand description

This represents a single TLS server session.

Send TLS-protected data to the peer using the io::Write trait implementation. Read data from the peer using the io::Read trait implementation.

Methods

impl ServerSession[−]

Important traits for ServerSession

impl Read for ServerSessionimpl Write for ServerSession

pub fn new(config: &Arc<ServerConfig>) -> ServerSession[−]

Make a new ServerSession. config controls how we behave in the TLS protocol.

pub fn get_sni_hostname(&self) -> Option<&str>[−]

Retrieves the SNI hostname, if any, used to select the certificate and private key.

This returns None until some time after the client's SNI extension value is processed during the handshake. It will never be None when the connection is ready to send or process application data, unless the client does not support SNI.

This is useful for application protocols that need to enforce that the SNI hostname matches an application layer protocol hostname. For example, HTTP/1.1 servers commonly expect the Host: header field of every request on a connection to match the hostname in the SNI extension when the client provides the SNI extension.

The SNI hostname is also used to match sessions during session resumption.

Trait Implementations

impl Session for ServerSession[+]

[+] Show hidden undocumented items

fn read_tls(&mut self, rd: &mut dyn Read) -> Result<usize>[−]

Read TLS content from rd. This method does internal buffering, so rd can supply TLS messages in arbitrary- sized chunks (like a socket or pipe might).

fn write_tls(&mut self, wr: &mut dyn Write) -> Result<usize>[−]

Writes TLS messages to wr.

fn writev_tls(&mut self, wr: &mut dyn WriteV) -> Result<usize>[−]

Like write_tls, but writes potentially many records in one go via wr; a rustls::WriteV. This function has the same semantics as write_tls otherwise.

fn process_new_packets(&mut self) -> Result<(), TLSError>[−]

Processes any new packets read by a previous call to read_tls. Errors from this function relate to TLS protocol errors, and are fatal to the session. Future calls after an error will do no new work and will return the same error.

fn wants_read(&self) -> bool[−]

Returns true if the caller should call read_tls as soon as possible.

fn wants_write(&self) -> bool[−]

Returns true if the caller should call write_tls as soon as possible.

fn is_handshaking(&self) -> bool[−]

Returns true if the session is currently perform the TLS handshake. During this time plaintext written to the session is buffered in memory.

fn set_buffer_limit(&mut self, len: usize)[−]

Sets a limit on the internal buffers used to buffer unsent plaintext (prior to completing the TLS handshake) and unsent TLS records.

fn send_close_notify(&mut self)[−]

Queues a close_notify fatal alert to be sent in the next write_tls call. This informs the peer that the connection is being closed.

fn get_peer_certificates(&self) -> Option<Vec<Certificate>>[−]

Retrieves the certificate chain used by the peer to authenticate.

fn get_alpn_protocol(&self) -> Option<&str>[−]

Retrieves the protocol agreed with the peer via ALPN.

fn get_protocol_version(&self) -> Option<ProtocolVersion>[−]

Retrieves the protocol version agreed with the peer.

fn export_keying_material(
    &self,
    output: &mut [u8],
    label: &[u8],
    context: Option<&[u8]>
) -> Result<(), TLSError>[−]

Derives key material from the agreed session secrets.

fn get_negotiated_ciphersuite(&self) -> Option<&'static SupportedCipherSuite>[−]

Retrieves the ciphersuite agreed with the peer.

fn complete_io<T>(&mut self, io: &mut T) -> Result<(usize, usize), Error> where
    Self: Sized,
    T: Read + Write, [−]

This function uses io to complete any outstanding IO for this session.

impl Debug for ServerSession[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl Read for ServerSession[+]

fn read(&mut self, buf: &mut [u8]) -> Result<usize>[−]

Obtain plaintext data received from the peer over this TLS connection.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut]) -> Result<usize, Error>[−]

Like read, except that it reads into a slice of buffers.

unsafe fn initializer(&self) -> Initializer[−]

🔬 This is a nightly-only experimental API. (read_initializer)

Determines if this Reader can work with buffers of uninitialized memory.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>[−]

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>[−]

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>[−]

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self[−]

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>[−]

Transforms this Read instance to an [Iterator] over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, [−]

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>[−]

Creates an adaptor which will read at most limit bytes from it.

impl Write for ServerSession[+]

[+] Show hidden undocumented items

fn write(&mut self, buf: &[u8]) -> Result<usize>[−]

Send the plaintext buf to the peer, encrypting and authenticating it. Once this function succeeds you should call write_tls which will output the corresponding TLS records.

This function buffers plaintext sent before the TLS handshake completes, and sends it as soon as it can. This buffer is of unlimited size so writing much data before it can be sent will cause excess memory usage.

fn flush(&mut self) -> Result<()>[−]

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice]) -> Result<usize, Error>[−]

Like write, except that it writes from a slice of buffers.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>[−]

Attempts to write an entire buffer into this writer.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>[−]

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self[−]

Creates a "by reference" adaptor for this instance of Write.