Struct ProviderScheme 

pub struct ProviderScheme {
    pub signature: &'static str,
    pub encoding: SignatureEncoding,
    pub prefix: Option<&'static str>,
    pub timestamp: Option<&'static str>,
}

A provider-specific scheme, configured rather than coded. Entries are separated by commas or spaces, so a provider may send several — for instance during a secret rotation.

Fields

signature: &'static str

The header carrying the signature (or several).

encoding: SignatureEncoding

How each entry is encoded in the header.

prefix: Option<&'static str>

A literal prefix stripped from each entry before decoding (sha256=).

timestamp: Option<&'static str>

The header carrying a Unix-seconds timestamp the provider signs. When set, the payload is {timestamp}.{body} and the replay tolerance applies; when None, the payload is the raw body.

Trait Implementations

impl Clone for ProviderScheme

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ProviderScheme

impl Debug for ProviderScheme

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

Formats the value using the given formatter.

impl Eq for ProviderScheme

impl PartialEq for ProviderScheme

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

Equality operator ==.

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

Inequality operator !=.

impl SignatureScheme for ProviderScheme

fn extract(&self, headers: &HeaderMap, body: &[u8]) -> Option<SignedDelivery>

Reads one delivery’s signature material out of the request headers and the raw body bytes. None on any input the scheme cannot fully read; an empty candidate list counts as unreadable.

fn secret_key<'a>(&self, secret: &'a str) -> Option<Cow<'a, [u8]>>

The key bytes the HMAC runs over: the trimmed secret’s own bytes, unless the scheme’s providers hand out encoded secrets (Svix’s base64 whsec_…), which decode here. None refuses.

fn digest(&self) -> Digest

The digest the scheme’s HMAC runs on. SHA-256 unless a provider signs with SHA-1 (Vercel today). Ignored by a shared-token scheme, which hashes nothing.

fn expected_signature(&self, key: &[u8], signed_payload: &[u8]) -> Vec<u8>

The signature bytes a matching delivery must carry, given the derived key and the bytes the scheme signed. The default is HMAC(self.digest(), key, signed_payload); a shared-token scheme overrides this to return the key’s own bytes, because for it the header is the secret and there is nothing to compute.

impl StructuralPartialEq for ProviderScheme