Struct dryoc::kx::Session

pub struct Session<SessionKey: ByteArray<CRYPTO_KX_SESSIONKEYBYTES>> { /* private fields */ }

Key derivation implemantation based on Curve25519, Diffie-Hellman, and Blake2b. Compatible with libsodium’s crypto_kx_* functions.

Implementations

impl<SessionKey: NewByteArray<CRYPTO_KX_SESSIONKEYBYTES>> Session<SessionKey>

pub fn new_client<PublicKey: ByteArray<CRYPTO_KX_PUBLICKEYBYTES>, SecretKey: ByteArray<CRYPTO_KX_SECRETKEYBYTES>>(
    client_keypair: &KeyPair<PublicKey, SecretKey>,
    server_public_key: &PublicKey
) -> Result<Self, Error>

Computes client session keys, given client_keypair and server_public_key, returning a new session upon success.

pub fn new_server<PublicKey: ByteArray<CRYPTO_KX_PUBLICKEYBYTES>, SecretKey: ByteArray<CRYPTO_KX_SECRETKEYBYTES>>(
    server_keypair: &KeyPair<PublicKey, SecretKey>,
    client_public_key: &PublicKey
) -> Result<Self, Error>

Computes server session keys, given server_keypair and client_public_key, returning a new session upon success.

impl Session<SessionKey>

pub fn new_client_with_defaults<PublicKey: ByteArray<CRYPTO_KX_PUBLICKEYBYTES>, SecretKey: ByteArray<CRYPTO_KX_SECRETKEYBYTES>>(
    client_keypair: &KeyPair<PublicKey, SecretKey>,
    server_public_key: &PublicKey
) -> Result<Self, Error>

Returns a new client session upon success using the default types for the given client_keypair and server_public_key. Wraps Session::new_client, provided for convenience.

pub fn new_server_with_defaults<PublicKey: ByteArray<CRYPTO_KX_PUBLICKEYBYTES>, SecretKey: ByteArray<CRYPTO_KX_SECRETKEYBYTES>>(
    server_keypair: &KeyPair<PublicKey, SecretKey>,
    client_public_key: &PublicKey
) -> Result<Self, Error>

Returns a new server session upon success using the default types for the given server_keypair and client_public_key. Wraps Session::new_server, provided for convenience.

impl<SessionKey: ByteArray<CRYPTO_KX_SESSIONKEYBYTES>> Session<SessionKey>

pub fn into_parts(self) -> (SessionKey, SessionKey)

Moves the rx_key and tx_key out of this instance, returning them as a tuple with (rx_key, tx_key).

pub fn rx_as_slice(&self) -> &[u8]

Returns a reference to a slice of the Rx session key.

pub fn tx_as_slice(&self) -> &[u8]

Returns a reference to a slice of the Tx session key.

pub fn rx_as_array(&self) -> &[u8; 32]

Returns a reference to an array of the Rx session key.

pub fn tx_as_array(&self) -> &[u8; 32]

Returns a reference to an array of the Tx session key.

Trait Implementations

impl<SessionKey: Clone + ByteArray<CRYPTO_KX_SESSIONKEYBYTES>> Clone for Session<SessionKey>

fn clone(&self) -> Session<SessionKey>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<SessionKey: Debug + ByteArray<CRYPTO_KX_SESSIONKEYBYTES>> Debug for Session<SessionKey>

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

Formats the value using the given formatter.

impl<'de, SessionKey: ByteArray<CRYPTO_KX_SESSIONKEYBYTES>> Deserialize<'de> for Session<SessionKey>where
    SessionKey: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<SessionKey: ByteArray<CRYPTO_KX_SESSIONKEYBYTES>> Serialize for Session<SessionKey>where
    SessionKey: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl<SessionKey: ByteArray<CRYPTO_KX_SESSIONKEYBYTES>> Zeroize for Session<SessionKey>where
    SessionKey: Zeroize,

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.