Struct snow::TransportState

pub struct TransportState { /* private fields */ }

A state machine encompassing the transport phase of a Noise session, using the two CipherStates (for sending and receiving) that were spawned from the SymmetricState’s Split() method, called after a handshake has been finished.

Also see: the relevant Noise spec section.

Implementations

impl TransportState

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

Get the remote party’s static public key, if available.

Note: will return None if either the chosen Noise pattern doesn’t necessitate a remote static key, or if the remote static key is not yet known (as can be the case in the XX pattern, for example).

pub fn write_message(
    &mut self,
    payload: &[u8],
    message: &mut [u8]
) -> Result<usize, Error>

Construct a message from payload (and pending handshake tokens if in handshake state), and writes it to the output buffer.

Returns the size of the written payload.

Errors

Will result in Error::Input if the size of the output exceeds the max message length in the Noise Protocol (65535 bytes).

pub fn read_message(
    &mut self,
    payload: &[u8],
    message: &mut [u8]
) -> Result<usize, Error>

Reads a noise message from input

Returns the size of the payload written to payload.

Errors

Will result in Error::Decrypt if the contents couldn’t be decrypted and/or the authentication tag didn’t verify.

Panics

This function will panic if there is no key, or if there is a nonce overflow.

pub fn rekey_outgoing(&mut self)

Generates a new key for the egress symmetric cipher according to Section 4.2 of the Noise Specification. Synchronizing timing of rekey between initiator and responder is the responsibility of the application, as described in Section 11.3 of the Noise Specification.

pub fn rekey_incoming(&mut self)

Generates a new key for the ingress symmetric cipher according to Section 4.2 of the Noise Specification. Synchronizing timing of rekey between initiator and responder is the responsibility of the application, as described in Section 11.3 of the Noise Specification.

pub fn rekey_manually(
    &mut self,
    initiator: Option<&[u8]>,
    responder: Option<&[u8]>
)

Set a new key for the one or both of the initiator-egress and responder-egress symmetric ciphers.

pub fn rekey_initiator_manually(&mut self, key: &[u8])

Set a new key for the initiator-egress symmetric cipher.

pub fn rekey_responder_manually(&mut self, key: &[u8])

Set a new key for the responder-egress symmetric cipher.

pub fn set_receiving_nonce(&mut self, nonce: u64)

Sets the receiving CipherState’s nonce. Useful for using noise on lossy transports.

pub fn receiving_nonce(&self) -> u64

Get the forthcoming inbound nonce value.

Errors

Will result in Error::State if not in transport mode.

pub fn sending_nonce(&self) -> u64

Get the forthcoming outbound nonce value.

Errors

Will result in Error::State if not in transport mode.

pub fn is_initiator(&self) -> bool

Check if this session was started with the “initiator” role.

Trait Implementations

impl Debug for TransportState

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

Formats the value using the given formatter.

impl TryFrom<HandshakeState> for TransportState

type Error = Error

The type returned in the event of a conversion error.

fn try_from(old: HandshakeState) -> Result<Self, Self::Error>

Performs the conversion.