Struct jwt_compact::alg::Es256k

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

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).

Implementations

impl<D> Es256k<D>

where D: FixedOutputReset<OutputSize = U32> + BlockSizeUser + Clone + Default + HashMarker,

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

Available on crate feature es256k only.

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: FixedOutputReset<OutputSize = U32> + BlockSizeUser + Clone + Default + HashMarker,

type SigningKey = SecretKey

Key used when issuing new tokens.

type VerifyingKey = PublicKey

Key used when verifying tokens. May coincide with Self::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: Debug> Debug for Es256k<D>

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

Formats the value using the given formatter.

impl<D> Default for Es256k<D>

where D: FixedOutputReset<OutputSize = U32> + BlockSizeUser + Clone + Default + HashMarker,

fn default() -> Self

Returns the “default value” for a type.

impl SigningKey<Es256k> for SecretKey

This implementation initializes a libsecp256k1 context once on the first call to to_verifying_key if it was not initialized previously.

fn from_slice(raw: &[u8]) -> Result<Self>

Creates a key from raw bytes. Returns an error if the bytes do not represent a valid key.

fn to_verifying_key(&self) -> PublicKey

Converts a signing key to a verification key.

fn as_bytes(&self) -> SecretBytes<'_>

Returns the key as raw bytes.

impl VerifyingKey<Es256k> for PublicKey

fn as_bytes(&self) -> Cow<'_, [u8]>

Serializes the key as a 33-byte compressed form, as per Self::serialize().

fn from_slice(raw: &[u8]) -> Result<Self>

Creates a key from raw bytes. Returns an error if the bytes do not represent a valid key.