Struct rustls::ServerConnection

pub struct ServerConnection { /* fields omitted */ }

This represents a single TLS server connection.

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

Implementations

impl ServerConnection

pub fn new(config: Arc<ServerConfig>) -> Result<Self, Error>

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

pub fn 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.

pub fn received_resumption_data(&self) -> Option<&[u8]>

Application-controlled portion of the resumption ticket supplied by the client, if any.

Recovered from the prior session’s set_resumption_data. Integrity is guaranteed by rustls.

Returns Some iff a valid resumption ticket has been received from the client.

pub fn set_resumption_data(&mut self, data: &[u8])

Set the resumption data to embed in future resumption tickets supplied to the client.

Defaults to the empty byte string. Must be less than 2^15 bytes to allow room for other data. Should be called while is_handshaking returns true to ensure all transmitted resumption tickets are affected.

Integrity will be assured by rustls, but the data will be visible to the client. If secrecy from the client is desired, encrypt the data separately.

pub fn reject_early_data(&mut self)

Explicitly discard early data, notifying the client

Useful if invariants encoded in received_resumption_data() cannot be respected.

Must be called while is_handshaking is true.

Trait Implementations

impl Connection for ServerConnection

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

Writes TLS messages to wr.

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 process_new_packets(&mut self) -> Result<IoState, Error>

Processes any new packets read by a previous call to Connection::read_tls.

fn wants_read(&self) -> bool

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

fn wants_write(&self) -> bool

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

fn is_handshaking(&self) -> bool

Returns true if the connection is currently performing the TLS handshake.

fn set_buffer_limit(&mut self, len: Option<usize>)

Sets a limit on the internal buffers used to buffer unsent plaintext (prior to completing the TLS handshake) and unsent TLS records. This limit acts only on application data written through Connection::writer.

fn send_close_notify(&mut self)

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

fn peer_certificates(&self) -> Option<&[Certificate]>

Retrieves the certificate chain used by the peer to authenticate.

fn alpn_protocol(&self) -> Option<&[u8]>

Retrieves the protocol agreed with the peer via ALPN.

fn 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<(), Error>

Derives key material from the agreed connection secrets.

fn negotiated_cipher_suite(&self) -> Option<SupportedCipherSuite>

Retrieves the ciphersuite agreed with the peer.

fn writer(&mut self) -> Writer<'_>

Returns an object that allows writing plaintext.

fn reader(&mut self) -> Reader<'_>

Returns an object that allows reading plaintext.

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 connection.

impl Debug for ServerConnection

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl QuicExt for ServerConnection

fn quic_transport_parameters(&self) -> Option<&[u8]>

This is supported on crate feature quic only.

Return the TLS-encoded transport parameters for the session’s peer.

fn zero_rtt_keys(&self) -> Option<DirectionalKeys>

This is supported on crate feature quic only.

Compute the keys for encrypting/decrypting 0-RTT packets, if available

fn read_hs(&mut self, plaintext: &[u8]) -> Result<(), Error>

This is supported on crate feature quic only.

Consume unencrypted TLS handshake data.

fn write_hs(&mut self, buf: &mut Vec<u8>) -> Option<Keys>

This is supported on crate feature quic only.

Emit unencrypted TLS handshake data.

fn alert(&self) -> Option<AlertDescription>

This is supported on crate feature quic only.

Emit the TLS description code of a fatal alert, if one has arisen.

fn next_1rtt_keys(&mut self) -> Option<PacketKeySet>

This is supported on crate feature quic only.

Compute the keys to use following a 1-RTT key update

impl ServerQuicExt for ServerConnection

fn new_quic(
    config: Arc<ServerConfig>,
    quic_version: Version,
    params: Vec<u8>
) -> Result<ServerConnection, Error>

Make a new QUIC ServerConnection. This differs from ServerConnection::new() in that it takes an extra argument, params, which contains the TLS-encoded transport parameters to send.