Struct rustls::ClientConnection

pub struct ClientConnection { /* fields omitted */ }

This represents a single TLS client connection.

Implementations

impl ClientConnection

pub fn new(config: Arc<ClientConfig>, name: ServerName) -> Result<Self, Error>

Make a new ClientConnection. config controls how we behave in the TLS protocol, name is the name of the server we want to talk to.

pub fn early_data(&mut self) -> Option<WriteEarlyData<'_>>

Returns an io::Write implementer you can write bytes to to send TLS1.3 early data (a.k.a. “0-RTT data”) to the server.

This returns None in many circumstances when the capability to send early data is not available, including but not limited to:

• The server hasn’t been talked to previously.
• The server does not support resumption.
• The server does not support early data.
• The resumption data for the server has expired.

The server specifies a maximum amount of early data. You can learn this limit through the returned object, and writes through it will process only this many bytes.

The server can choose not to accept any sent early data – in this case the data is lost but the connection continues. You can tell this happened using is_early_data_accepted.

pub fn is_early_data_accepted(&self) -> bool

Returns True if the server signalled it will process early data.

If you sent early data and this returns false at the end of the handshake then the server will not process the data. This is not an error, but you may wish to resend the data.

Trait Implementations

impl ClientQuicExt for ClientConnection

fn new_quic(
    config: Arc<ClientConfig>,
    quic_version: Version,
    name: ServerName,
    params: Vec<u8>
) -> Result<ClientConnection, Error>

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

impl Connection for ClientConnection

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 ClientConnection

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

Formats the value using the given formatter.

impl QuicExt for ClientConnection

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