Struct jwt_compact::alg::Es256k

pub struct Es256k<D = Sha256> { /* fields omitted */ }

Algorithm implementing elliptic curve digital signatures (ECDSA) on the secp256k1 curve.

The algorithm does not fix the choice of the message digest algorithm; instead, it is provided as a type parameter. SHA-256 is the default parameter value, but it can be set to any cryptographically secure hash function with 32-byte output (e.g., SHA3-256).

This type is available if the crate is built with the secp256k1 feature.

Methods

impl<D> Es256k<D> where
    D: Digest<OutputSize = U32> + Default, 

pub fn new(context: Secp256k1<All>) -> Self

Creates a new algorithm instance. This is a (moderately) expensive operation, so if necessary, the algorithm should be clone()d rather than created anew.

Trait Implementations

impl<D> Algorithm for Es256k<D> where
    D: Digest<OutputSize = U32> + Default, 

type SigningKey = SecretKey

Key used when issuing new tokens.

type VerifyingKey = PublicKey

Key used when verifying tokens. May coincide with SigningKey for symmetric algorithms (e.g., HS*).

type Signature = Signature

Signature produced by the algorithm.

fn name(&self) -> Cow<'static, str>

Returns the name of this algorithm, as mentioned in the alg field of the JWT header.

fn sign(
    &self,
    signing_key: &Self::SigningKey,
    message: &[u8]
) -> Self::Signature

Signs a message with the signing_key.

fn verify_signature(
    &self,
    signature: &Self::Signature,
    verifying_key: &Self::VerifyingKey,
    message: &[u8]
) -> bool

Verifies the message against the signature and verifying_key.

impl<D> Default for Es256k<D> where
    D: Digest<OutputSize = U32> + Default, 

fn default() -> Self

Returns the "default value" for a type.

impl<D: Debug> Debug for Es256k<D>

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

Formats the value using the given formatter.