Struct snow::HandshakeState
source · pub struct HandshakeState { /* private fields */ }Expand description
A state machine encompassing the handshake phase of a Noise session.
Note: you are probably looking for Builder to
get started.
See: https://noiseprotocol.org/noise.html#the-handshakestate-object
Implementations§
source§impl HandshakeState
impl HandshakeState
sourcepub fn was_write_payload_encrypted(&self) -> bool
pub fn was_write_payload_encrypted(&self) -> bool
This method will return true if the previous write payload was encrypted.
See Payload Security Properties for more information on the specific properties of your chosen handshake pattern.
§Examples
let mut session = Builder::new("Noise_NN_25519_AESGCM_SHA256".parse()?)
.build_initiator()?;
// write message...
assert!(session.was_write_payload_encrypted());sourcepub fn write_message(
&mut self,
payload: &[u8],
message: &mut [u8],
) -> Result<usize, Error>
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 message 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).
sourcepub fn read_message(
&mut self,
message: &[u8],
payload: &mut [u8],
) -> Result<usize, Error>
pub fn read_message( &mut self, message: &[u8], payload: &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.
Will result in StateProblem::Exhausted if the max nonce count overflows.
sourcepub fn set_psk(&mut self, location: usize, key: &[u8]) -> Result<(), Error>
pub fn set_psk(&mut self, location: usize, key: &[u8]) -> Result<(), Error>
Set the preshared key at the specified location. It is up to the caller to correctly set the location based on the specified handshake - Snow won’t stop you from placing a PSK in an unused slot.
§Errors
Will result in Error::Input if the PSK is not the right length or the location is out of bounds.
sourcepub fn get_remote_static(&self) -> Option<&[u8]>
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).
sourcepub fn get_handshake_hash(&self) -> &[u8] ⓘ
pub fn get_handshake_hash(&self) -> &[u8] ⓘ
Get the handshake hash.
Returns a slice of length Hasher.hash_len() (i.e. HASHLEN for the chosen Hash function).
sourcepub fn is_initiator(&self) -> bool
pub fn is_initiator(&self) -> bool
Check if this session was started with the “initiator” role.
sourcepub fn is_handshake_finished(&self) -> bool
pub fn is_handshake_finished(&self) -> bool
Check if the handshake is finished and into_transport_mode() can now be called.
sourcepub fn is_my_turn(&self) -> bool
pub fn is_my_turn(&self) -> bool
Check whether it is our turn to send in the handshake state machine
sourcepub fn into_transport_mode(self) -> Result<TransportState, Error>
pub fn into_transport_mode(self) -> Result<TransportState, Error>
Convert this HandshakeState into a TransportState with an internally stored nonce.
sourcepub fn into_stateless_transport_mode(
self,
) -> Result<StatelessTransportState, Error>
pub fn into_stateless_transport_mode( self, ) -> Result<StatelessTransportState, Error>
Convert this HandshakeState into a StatelessTransportState without an internally stored nonce.