Struct oqs::sig::Sig

pub struct Sig { /* fields omitted */ }

Signature scheme

Example

use oqs;
oqs::init();
let scheme = oqs::sig::Sig::new(oqs::sig::Algorithm::Dilithium2).unwrap();
let message = [0u8; 100];
let (pk, sk) = scheme.keypair().unwrap();
let signature = scheme.sign(&message, &sk).unwrap();
assert!(scheme.verify(&message, &signature, &pk).is_ok());

Implementations

impl Sig

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

Construct a new algorithm

May fail if the algorithm is not available

pub fn algorithm(&self) -> Algorithm

Get the algorithm used by this Sig

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

Get the version of the implementation

pub fn claimed_nist_level(&self) -> u8

Obtain the claimed nist level

pub fn is_euf_cma(&self) -> bool

Is this algorithm EUF-CMA?

pub fn length_public_key(&self) -> usize

Length of the public key

pub fn length_secret_key(&self) -> usize

Length of the secret key

pub fn length_signature(&self) -> usize

Maximum length of a signature

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

Construct a secret key object from bytes

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

Construct a public key object from bytes

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

Construct a signature object from bytes

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

Generate a new keypair

pub fn sign<'a, S: Into<SecretKeyRef<'a>>>(
    &self,
    message: &Message,
    sk: S
) -> Result<Signature>

Sign a message

pub fn verify<'a, 'b>(
    &self,
    message: &Message,
    signature: impl Into<SignatureRef<'a>>,
    pk: impl Into<PublicKeyRef<'b>>
) -> Result<()>

Verify a message

Trait Implementations

impl Drop for Sig

fn drop(&mut self)

Executes the destructor for this type.

impl TryFrom<Algorithm> for Sig

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Send for Sig

impl Sync for Sig