Struct HttpSignatureBase 

pub struct HttpSignatureBase { /* private fields */ }

Signature Base https://datatracker.ietf.org/doc/html/rfc9421#section-2.5

Implementations

impl HttpSignatureBase

pub fn try_new( component_lines: &[HttpMessageComponent], signature_params: &HttpSignatureParams, ) -> Result<HttpSignatureBase, HttpSigError>

Creates a new signature base from component lines and signature params This should not be exposed to user and not used directly. Use wrapper functions generating SignatureBase from base HTTP request and Signer itself instead when newly generating signature When verifying signature, use wrapper functions generating SignatureBase from HTTP request containing signature params itself instead.

pub fn as_bytes(&self) -> Vec<u8>

Returns the signature base string as bytes to be signed

pub fn build_raw_signature( &self, signing_key: &impl SigningKey, ) -> Result<Vec<u8>, HttpSigError>

Build signature from given signing key

pub fn build_signature_headers( &self, signing_key: &impl SigningKey, signature_name: Option<&str>, ) -> Result<HttpSignatureHeaders, HttpSigError>

Build the signature and signature-input headers structs

pub fn verify_signature_headers( &self, verifying_key: &impl VerifyingKey, signature_headers: &HttpSignatureHeaders, ) -> Result<(), HttpSigError>

Verify the signature using the given verifying key

pub fn keyid(&self) -> Option<&str>

Get key id from signature params

pub fn alg(&self) -> Option<&str>

Get algorithm from signature params

pub fn nonce(&self) -> Option<&str>

Get nonce from signature params

pub fn covered_components(&self) -> &[HttpMessageComponentId]

Get covered components from signature params

Trait Implementations

impl Display for HttpSignatureBase

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

Formats the value using the given formatter.