Struct oqs::kem::Kem

pub struct Kem { /* fields omitted */ }

KEM algorithm

Example

use oqs;
oqs::init();
let kem = oqs::kem::Kem::new(oqs::kem::Algorithm::Kyber512).unwrap();
let (pk, sk) = kem.keypair().unwrap();
let (ct, ss) = kem.encapsulate(&pk).unwrap();
let ss2 = kem.decapsulate(&sk, &ct).unwrap();
assert_eq!(ss, ss2);

Implementations

impl Kem

pub fn new(algorithm: Algorithm) -> Result<Self>

Construct a new algorithm

pub fn algorithm(&self) -> Algorithm

Get the algorithm used by this Kem

pub fn version(&self) -> &'static str

Get the version of the implementation

pub fn claimed_nist_level(&self) -> u8

Get the claimed nist level

pub fn is_ind_cca(&self) -> bool

Is the algorithm ind_cca secure

pub fn length_public_key(&self) -> usize

Get the length of the public key

pub fn length_secret_key(&self) -> usize

Get the length of the secret key

pub fn length_ciphertext(&self) -> usize

Get the length of the ciphertext

pub fn length_shared_secret(&self) -> usize

Get the length of a shared secret

pub fn secret_key_from_bytes<'a>(
    &self,
    buf: &'a [u8]
) -> Option<SecretKeyRef<'a>>

Obtain a secret key objects from bytes

Returns None if the secret key is not the correct length.

pub fn public_key_from_bytes<'a>(
    &self,
    buf: &'a [u8]
) -> Option<PublicKeyRef<'a>>

Obtain a public key from bytes

Returns None if the public key is not the correct length.

pub fn ciphertext_from_bytes<'a>(
    &self,
    buf: &'a [u8]
) -> Option<CiphertextRef<'a>>

Obtain a ciphertext from bytes

Returns None if the ciphertext is not the correct length.

pub fn shared_secret_from_bytes<'a>(
    &self,
    buf: &'a [u8]
) -> Option<SharedSecretRef<'a>>

Obtain a secret key from bytes

Returns None if the shared secret is not the correct length.

pub fn keypair(&self) -> Result<(PublicKey, SecretKey)>

Generate a new keypair

pub fn encapsulate<'a, P: Into<PublicKeyRef<'a>>>(
    &self,
    pk: P
) -> Result<(Ciphertext, SharedSecret)>

Encapsulate to the provided public key

pub fn decapsulate<'a, 'b, S: Into<SecretKeyRef<'a>>, C: Into<CiphertextRef<'b>>>(
    &self,
    sk: S,
    ct: C
) -> Result<SharedSecret>

Decapsulate the provided ciphertext

Trait Implementations

impl Drop for Kem

fn drop(&mut self)

Executes the destructor for this type.

impl TryFrom<Algorithm> for Kem

type Error = Error

The type returned in the event of a conversion error.

fn try_from(alg: Algorithm) -> Result<Kem>

Performs the conversion.

impl Send for Kem

impl Sync for Kem