Enum biscuit::jwa::SignatureAlgorithm

pub enum SignatureAlgorithm {
    None,
    HS256,
    HS384,
    HS512,
    RS256,
    RS384,
    RS512,
    ES256,
    ES384,
    ES512,
    PS256,
    PS384,
    PS512,
}

The algorithms supported for digital signature and MACs, defined by RFC7518#3.

Variants

None

No encryption/signature is included for the JWT. During verification, the signature MUST BE empty or verification will fail.

HS256

HMAC using SHA-256

HS384

HMAC using SHA-384

HS512

HMAC using SHA-512

RS256

RSASSA-PKCS1-v1_5 using SHA-256

RS384

RSASSA-PKCS1-v1_5 using SHA-384

RS512

RSASSA-PKCS1-v1_5 using SHA-512

ES256

ECDSA using P-256 and SHA-256

ES384

ECDSA using P-384 and SHA-384

ES512

ECDSA using P-521 and SHA-512 – This variant is unsupported and will probably never be.

PS256

RSASSA-PSS using SHA-256 and MGF1 with SHA-256. The size of the salt value is the same size as the hash function output.

PS384

RSASSA-PSS using SHA-384 and MGF1 with SHA-384 The size of the salt value is the same size as the hash function output.

PS512

RSASSA-PSS using SHA-512 and MGF1 with SHA-512 The size of the salt value is the same size as the hash function output.

Implementations

impl SignatureAlgorithm

pub fn sign(&self, data: &[u8], secret: &Secret) -> Result<Vec<u8>, Error>

Take some bytes and sign it according to the algorithm and secret provided.

pub fn verify(
    &self,
    expected_signature: &[u8],
    data: &[u8],
    secret: &Secret
) -> Result<(), Error>

Verify signature based on the algorithm and secret provided.

Trait Implementations

impl Clone for SignatureAlgorithm

fn clone(&self) -> SignatureAlgorithm

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SignatureAlgorithm

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

Formats the value using the given formatter.

impl Default for SignatureAlgorithm

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SignatureAlgorithm

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<SignatureAlgorithm> for SignatureAlgorithm

fn eq(&self, other: &SignatureAlgorithm) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SignatureAlgorithm

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for SignatureAlgorithm

impl Eq for SignatureAlgorithm

impl StructuralEq for SignatureAlgorithm

impl StructuralPartialEq for SignatureAlgorithm