Enum Algorithm

pub enum Algorithm {
    FrodoKem640Aes,
    FrodoKem976Aes,
    FrodoKem1344Aes,
    FrodoKem640Shake,
    FrodoKem976Shake,
    FrodoKem1344Shake,
    EphemeralFrodoKem640Aes,
    EphemeralFrodoKem976Aes,
    EphemeralFrodoKem1344Aes,
    EphemeralFrodoKem640Shake,
    EphemeralFrodoKem976Shake,
    EphemeralFrodoKem1344Shake,
}

The supported FrodoKem algorithms

Variants

FrodoKem640Aes

Available on crate feature frodo640aes only.

The FrodoKEM-640-AES algorithm

FrodoKem976Aes

Available on crate feature frodo976aes only.

The FrodoKEM-976-AES algorithm

FrodoKem1344Aes

Available on crate feature frodo1344aes only.

The FrodoKEM-1344-AES algorithm

FrodoKem640Shake

Available on crate feature frodo640shake only.

The FrodoKEM-640-SHAKE algorithm

FrodoKem976Shake

Available on crate feature frodo976shake only.

The FrodoKEM-976-SHAKE algorithm

FrodoKem1344Shake

Available on crate feature frodo1344shake only.

The FrodoKEM-1344-SHAKE algorithm

EphemeralFrodoKem640Aes

Available on crate feature efrodo640aes only.

The FrodoKEM-640-AES algorithm

EphemeralFrodoKem976Aes

Available on crate feature efrodo976aes only.

The FrodoKEM-976-AES algorithm

EphemeralFrodoKem1344Aes

Available on crate feature efrodo1344aes only.

The FrodoKEM-1344-AES algorithm

EphemeralFrodoKem640Shake

Available on crate feature efrodo640shake only.

The FrodoKEM-640-SHAKE algorithm

EphemeralFrodoKem976Shake

Available on crate feature efrodo976shake only.

The FrodoKEM-976-SHAKE algorithm

EphemeralFrodoKem1344Shake

Available on crate feature efrodo1344shake only.

The FrodoKEM-1344-SHAKE algorithm

Implementations

impl Algorithm

pub fn enabled_algorithms() -> &'static [Algorithm]

Get the enabled algorithms

pub const fn params(&self) -> AlgorithmParams

Get the parameters for this algorithm

pub fn encryption_key_from_decryption_key( &self, secret_key: &DecryptionKey, ) -> EncryptionKey

Get the EncryptionKey from a DecryptionKey

pub fn decryption_key_from_bytes<B: AsRef<[u8]>>( &self, buf: B, ) -> FrodoResult<DecryptionKey>

Obtain a secret key from a byte slice

Returns Err if the byte slice is not the correct length

pub fn encryption_key_from_bytes<B: AsRef<[u8]>>( &self, buf: B, ) -> FrodoResult<EncryptionKey>

Obtain a public key from a byte slice

Returns Err if the byte slice is not the correct length

pub fn ciphertext_from_bytes(&self, buf: &[u8]) -> FrodoResult<Ciphertext>

Obtain a ciphertext from a byte slice

Returns Err if the byte slice is not the correct length

pub fn shared_secret_from_bytes(&self, buf: &[u8]) -> FrodoResult<SharedSecret>

Obtain a shared secret from a byte slice

Returns Err if the byte slice is not the correct length

pub fn generate_keypair( &self, rng: impl CryptoRng, ) -> (EncryptionKey, DecryptionKey)

Generate a new keypair consisting of a EncryptionKey and a DecryptionKey

pub fn try_generate_keypair( &self, rng: impl TryCryptoRng, ) -> FrodoResult<(EncryptionKey, DecryptionKey)>

Try to generate a new keypair consisting of a EncryptionKey and a DecryptionKey

pub fn encapsulate<B: AsRef<[u8]>, S: AsRef<[u8]>>( &self, public_key: &EncryptionKey, msg: B, salt: S, ) -> FrodoResult<(Ciphertext, SharedSecret)>

Encapsulate with given message to generate a SharedSecret and a Ciphertext.

NOTE: The message and salt must be of the correct length for the algorithm. Also, this method is deterministic, meaning that using the same message and salt will yield the same SharedSecret and Ciphertext

pub fn encapsulate_with_rng( &self, public_key: &EncryptionKey, rng: impl CryptoRng, ) -> FrodoResult<(Ciphertext, SharedSecret)>

Encapsulate a random value to generate a SharedSecret and a Ciphertext.

pub fn try_encapsulate_with_rng( &self, public_key: &EncryptionKey, rng: impl TryCryptoRng, ) -> FrodoResult<(Ciphertext, SharedSecret)>

Try to encapsulate a random value to generate a SharedSecret and a Ciphertext.

pub fn decapsulate( &self, secret_key: &DecryptionKey, ciphertext: &Ciphertext, ) -> FrodoResult<(SharedSecret, Vec<u8>)>

Decapsulate the Ciphertext to return the SharedSecret and message generated during encapsulation.

Trait Implementations

impl Clone for Algorithm

fn clone(&self) -> Algorithm

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConstantTimeEq for Algorithm

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

Determine if two items are equal.

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

Determine if two items are NOT equal.

impl Debug for Algorithm

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

Formats the value using the given formatter.

impl Default for Algorithm

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Algorithm

Available on crate feature serde only.

fn deserialize<D>(d: D) -> Result<Algorithm, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Algorithm

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

Formats the value using the given formatter.

impl From<Algorithm> for u128

Available on 64-bit only.

fn from(alg: Algorithm) -> u128

Converts to this type from the input type.

impl From<Algorithm> for u16

fn from(alg: Algorithm) -> u16

Converts to this type from the input type.

impl From<Algorithm> for u32

fn from(alg: Algorithm) -> u32

Converts to this type from the input type.

impl From<Algorithm> for u64

fn from(alg: Algorithm) -> u64

Converts to this type from the input type.

impl From<Algorithm> for u8

fn from(alg: Algorithm) -> u8

Converts to this type from the input type.

impl From<Algorithm> for usize

fn from(alg: Algorithm) -> usize

Converts to this type from the input type.

impl FromStr for Algorithm

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Algorithm

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Algorithm

fn cmp(&self, other: &Algorithm) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Algorithm

fn eq(&self, other: &Algorithm) -> 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 PartialOrd for Algorithm

fn partial_cmp(&self, other: &Algorithm) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Algorithm

Available on crate feature serde only.

fn serialize<S>(&self, s: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<u128> for Algorithm

Available on 64-bit only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: u128) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u16> for Algorithm

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: u16) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u32> for Algorithm

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u64> for Algorithm

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u8> for Algorithm

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<usize> for Algorithm

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Algorithm

impl Eq for Algorithm

impl StructuralPartialEq for Algorithm