Struct Key 

pub struct Key<T>
where
    T: KeyKind,
{ /* private fields */ }

Implementations

impl<T> Key<T>

where T: KeyKind,

pub fn deserialize(value: &[u8]) -> Result<Key<T>, SignalProtocolError>

Create a Key<Kind> instance from a byte string created with the function Key<Kind>::serialize(&self).

pub fn serialize(&self) -> Box<[u8]>

Create a binary representation of the key that includes a protocol identifier.

pub fn key_type(&self) -> KeyType

Return the KeyType that identifies the KEM protocol for this key.

impl Key<Public>

pub fn encapsulate<R>( &self, csprng: &mut R, ) -> Result<(Box<[u8]>, Box<[u8]>), SignalProtocolError>

where R: CryptoRng,

Create a SharedSecret and a Ciphertext. The Ciphertext can be safely sent to the holder of the corresponding SecretKey who can then use it to decapsulate the same SharedSecret.

impl Key<Secret>

pub fn decapsulate( &self, ct_bytes: &Box<[u8]>, ) -> Result<Box<[u8]>, SignalProtocolError>

Decapsulates a SharedSecret that was encapsulated into a Ciphertext by a holder of the corresponding PublicKey.

Trait Implementations

impl<T> Clone for Key<T>

where T: KeyKind,

fn clone(&self) -> Key<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConstantTimeEq for Key<Public>

fn ct_eq(&self, other: &Key<Public>) -> Choice

A constant-time comparison as long as the two keys have a matching type.

If the two keys have different types, the comparison short-circuits, much like comparing two slices of different lengths.

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal.

impl<T> Debug for Key<T>

where T: KeyKind,

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

Formats the value using the given formatter.

impl PartialEq for Key<Public>

fn eq(&self, other: &Key<Public>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&[u8]> for Key<Public>

type Error = SignalProtocolError

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Key<Public>, SignalProtocolError>

Performs the conversion.

impl TryFrom<&[u8]> for Key<Secret>

type Error = SignalProtocolError

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Key<Secret>, SignalProtocolError>

Performs the conversion.

impl Eq for Key<Public>