Struct portal_lib::protocol::Protocol

pub struct Protocol;

Lower-level abstraction around the protocol. Use this directly if you’d like more control than what the higher-level Portal interface provides

Implementations

impl Protocol

pub fn connect<P: Read + Write>( peer: &mut P, id: &str, direction: Direction, msg: PortalKeyExchange ) -> Result<PortalKeyExchange, Box<dyn Error>>

Connect to a peer & receive the initial exchange data

pub fn derive_key( state: Spake2<Ed25519Group>, peer_data: &PortalKeyExchange ) -> Result<Vec<u8>, Box<dyn Error>>

Derive a shared key with the exchanged PortalConfirmation data. After this point in the exchange we have not verified that our peer has derived the same key as us, just derived the key for ourselves.

pub fn confirm_peer<P: Read + Write>( peer: &mut P, id: &str, direction: Direction, key: &[u8] ) -> Result<(), Box<dyn Error>>

Use the derived session key to verify that our peer has derived the same key as us. After this the peer will be fully confirmed.

pub fn read_encrypted_from<R, D>( reader: &mut R, key: &[u8] ) -> Result<D, Box<dyn Error>>where R: Read, D: DeserializeOwned,

Read an encrypted owned & deserialize-able object from the peer.

pub fn read_encrypted_zero_copy<R>( reader: &mut R, key: &[u8], storage: &mut [u8] ) -> Result<usize, Box<dyn Error>>where R: Read,

Read an encrypted message from the peer, writing the resulting decrypted data into the provided storage region. This allows for the ability to receive an encrypted chunk and decrypt it entirely in-place without extra copies.

pub fn encrypt_and_write_object<W, S>( writer: &mut W, key: &[u8], nseq: &mut NonceSequence, msg: &S ) -> Result<usize, Box<dyn Error>>where W: Write, S: Serialize,

Encrypt & send an EncryptedDataHeader + the entire object to the peer

pub fn encrypt_and_write_header_only<W>( writer: &mut W, key: &[u8], nseq: &mut NonceSequence, data: &mut [u8] ) -> Result<usize, Box<dyn Error>>where W: Write,

Encrypt & send the EncryptedDataHeader to the peer