Struct truelayer_signing::Verifier

pub struct Verifier<'a> { /* private fields */ }

Builder to verify a request against a Tl-Signature header.

See crate::verify_with_pem for examples.

Implementations

impl<'a> Verifier<'a>

pub fn body(self, body: &'a [u8]) -> Self

Add the full received request body.

pub fn method(self, method: &'a str) -> Self

Add the request method, e.g. "POST".

pub fn path(self, path: &'a str) -> Self

Add the request path, e.g. "/payouts".

Panics

If path does not start with a ‘/’ char.

pub fn header(self, key: &'a str, value: &'a [u8]) -> Self

Add a header name & value. May be called multiple times to add multiple different headers.

All request headers may be added here, any headers not mentioned in the jws signature header will be ignored unless required using Verifier::require_header.

pub fn add_header(&mut self, key: &'a str, value: &'a [u8])

Add a header name & value. May be called multiple times to add multiple different headers.

All request headers may be added here, any headers not mentioned in the jws signature header will be ignored unless required using Verifier::require_header.

Examples found in repository

src/verify.rs (line 87)

    pub fn header(mut self, key: &'a str, value: &'a [u8]) -> Self {
        self.add_header(key, value);
        self
    }

pub fn headers(
    self,
    headers: impl IntoIterator<Item = (&'a str, &'a [u8])>
) -> Self

Appends multiple header names & values.

All request headers may be added here, any headers not mentioned in the jws signature header will be ignored unless required using Verifier::require_header.

Example

truelayer_signing::verify_with_pem(key)
    .headers([("X-Head-A", "123".as_bytes()), ("X-Head-B", "345".as_bytes())]);

pub fn require_header(self, key: &'a str) -> Self

Require a header name that must be included in the Tl-Signature. May be called multiple times to add multiple required headers.

Signatures missing these will fail verification.

pub fn allow_v1(self, allow: bool) -> Self

Sets whether v1 body-only signatures are allowed to pass verification. Default false.

true means both v1 & v2 signatures are allowed.

pub fn verify(&self, tl_signature: &str) -> Result<(), Error>

Verify the given Tl-Signature header value.

Supports v1 (body only) & v2 full request signatures.

Returns Err(_) if verification fails.

Trait Implementations

impl Debug for Verifier<'_>

Debug does not display key info.

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

Formats the value using the given formatter.