Struct rustls::client::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.

Methods from Deref<Target = ConnectionCommon<ClientConnectionData>>

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

Returns an object that allows reading plaintext.

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

Returns an object that allows writing plaintext.

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

This is a convenience function which solely uses other parts of the public API.

What this means depends on the connection state:

• If the connection is_handshaking, then IO is performed until the handshake is complete.
• Otherwise, if wants_write is true, write_tls is invoked until it is all written.
• Otherwise, if wants_read is true, read_tls is invoked once.

The return value is the number of bytes read from and written to io, respectively.

This function will block if io blocks.

Errors from TLS record handling (i.e., from process_new_packets) are wrapped in an io::ErrorKind::InvalidData-kind error.

pub fn process_new_packets(&mut self) -> Result<IoState, Error>

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

Errors from this function relate to TLS protocol errors, and are fatal to the connection. Future calls after an error will do no new work and will return the same error. After an error is received from process_new_packets, you should not call read_tls any more (it will fill up buffers to no purpose). However, you may call the other methods on the connection, including write, send_close_notify, and write_tls. Most likely you will want to call write_tls to send any alerts queued by the error and then close the underlying connection.

Success from this function comes with some sundry state data about the connection.

pub fn read_tls(&mut self, rd: &mut dyn Read) -> Result<usize, Error>

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

You should call process_new_packets each time a call to this function succeeds.

The returned error only relates to IO on rd. TLS-level errors are emitted from process_new_packets.

This function returns Ok(0) when the underlying rd does so. This typically happens when a socket is cleanly closed, or a file is at EOF.

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

Derives key material from the agreed connection secrets.

This function fills in output with output.len() bytes of key material derived from the master session secret using label and context for diversification.

See RFC5705 for more details on what this does and is for.

For TLS1.3 connections, this function does not use the “early” exporter at any point.

This function fails if called prior to the handshake completing; check with CommonState::is_handshaking first.

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 Debug for ClientConnection

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

Formats the value using the given formatter.

impl Deref for ClientConnection

type Target = ConnectionCommon<ClientConnectionData>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for ClientConnection

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<ClientConnection> for Connection

fn from(conn: ClientConnection) -> Self

Performs the conversion.

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<KeyChange>

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.