Struct Signature 

pub struct Signature<P: ParameterSet> { /* private fields */ }

Represents a signature using the specified parameter set.

Usage

use parameter_sets::ML_DSA_44 as P;

let msg: &[u8] = b"Hello, world!";

let signature = sk.sign(msg);

// There are different ways to obtain a byte representation of the
// signature.
let signature_encoding = signature.to_bytes();
let encoded_signature_via_SignatureEncoding: &[u8] = &signature_encoding;
let encoded_signature_via_AsBytes = signature.as_bytes();
assert_eq!(encoded_signature_via_SignatureEncoding, encoded_signature_via_AsBytes);

let encoded_signature = encoded_signature_via_AsBytes;

let recv_sig: Signature<P> = encoded_signature.try_into()
    .expect("Failed to parse the received signature");
assert_eq!(recv_sig, signature);

// Equivalently, using the FromBytes trait
let decoded_signature = Signature::<P>::from_bytes(encoded_signature)
    .expect("Failed to decode the received signature");
assert_eq!(decoded_signature, signature);

If the crate is built without the rand feature, then the sign method (which takes only the msg as an argument) will not be available. In that case, you must generate your own random bytes and use the signing methods provided by the SeededSigner trait.

Trait Implementations

impl<P: ParameterSet> AsRef<[u8]> for Signature<P>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<P: Clone + ParameterSet> Clone for Signature<P>

fn clone(&self) -> Signature<P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P: ParameterSet> ContextSigner<Signature<P>> for SigningKey<P>

Available on crate feature rand only.

fn try_sign_with_ctx( &self, msg: &[u8], ctx: &[u8], ) -> Result<Signature<P>, Error>

Attempt to sign the given message, returning a digital signature on success, or an error if something went wrong.

fn sign_with_context(&self, msg: &[u8], ctx: &[u8]) -> S

Sign the given message and return a digital signature

impl<P: Debug + ParameterSet> Debug for Signature<P>

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

Formats the value using the given formatter.

impl<P: Eq + ParameterSet> Eq for Signature<P>

impl<P: ParameterSet> From<Signature<P>> for GenericArray<u8, <P as SignatureLen>::LEN>

fn from(sig: Signature<P>) -> Self

Converts to this type from the input type.

impl<P: PartialEq + ParameterSet> PartialEq for Signature<P>

fn eq(&self, other: &Signature<P>) -> 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<P: ParameterSet> SeededContextSigner<Signature<P>> for SigningKey<P>

fn try_sign_with_ctx_and_seed( &self, seed: &[u8], msg: &[u8], ctx: &[u8], ) -> Result<Signature<P>, Error>

Attempt to sign the given message, returning a digital signature on success, or an error if something went wrong.

fn sign_with_context_and_seed(&self, seed: &[u8], msg: &[u8], ctx: &[u8]) -> S

Sign the given message and return a digital signature

impl<P: ParameterSet> SeededSigner<Signature<P>> for SigningKey<P>

fn try_sign_with_seed( &self, seed: &[u8], msg: &[u8], ) -> Result<Signature<P>, Error>

Attempt to sign the given message, returning a digital signature on success, or an error if something went wrong.

fn sign_with_seed(&self, seed: &[u8], msg: &[u8]) -> S

Sign the given message and return a digital signature

impl<P: ParameterSet> SignatureEncoding for Signature<P>

type Repr = GenericArray<u8, <P as SignatureLen>::LEN>

Byte representation of a signature.

fn to_bytes(&self) -> Self::Repr

Encode signature as its byte representation.

fn encoded_len(&self) -> usize

Get the length of this signature when encoded.

impl<P: ParameterSet> Signer<Signature<P>> for SigningKey<P>

Available on crate feature rand only.

fn try_sign(&self, msg: &[u8]) -> Result<Signature<P>, Error>

Attempt to sign the given message, returning a digital signature on success, or an error if something went wrong.

fn sign(&self, msg: &[u8]) -> S

Sign the given message and return a digital signature.

impl<P: PartialEq + ParameterSet> StructuralPartialEq for Signature<P>

impl<P: ParameterSet> TryFrom<&[u8]> for Signature<P>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl<P: ParameterSet> Verifier<Signature<P>> for VerifyingKey<P>

fn verify(&self, msg: &[u8], signature: &Signature<P>) -> Result<(), Error>

Use Self (e.g. a verifying key) to verify that the provided signature is authentic for a given message bytestring.