Enum HttpSignatureError 

pub enum HttpSignatureError {
    Io(Error),
    Base64(DecodeError),
    Pem(String),
    Pkcs8(String),
    InvalidPrivateKeyLength,
    Utf8(FromUtf8Error),
    Jwk(String),
    Signature(String),
    Validation(String),
    Other(String),
}

Error type for HTTP signature operations.

This enum provides detailed error information for different types of failures that can occur during HTTP signature creation, validation, and key management. Each variant includes context-specific error messages to help with debugging and error handling.

Error Variants

• Io - File system and I/O errors
• Base64 - Base64 encoding/decoding errors
• Pem - PEM format parsing errors
• Pkcs8 - PKCS8 key format errors
• InvalidPrivateKeyLength - Private key length validation errors
• Utf8 - UTF-8 encoding/decoding errors
• Jwk - JSON Web Key format errors
• Signature - Signature creation and verification errors
• Validation - Signature validation and verification errors
• Other - Miscellaneous errors

Variants

Io(Error)

File system and I/O errors.

This error is automatically converted from std::io::Error and occurs when the signature module cannot read key files or perform other I/O operations.

Base64(DecodeError)

Base64 encoding or decoding errors.

This error is automatically converted from base64::DecodeError and occurs when the signature module cannot decode Base64-encoded data such as signatures, keys, or other encoded content.

Pem(String)

PEM format parsing errors.

Occurs when the signature module cannot parse PEM-encoded private keys or certificates. This includes malformed PEM files, unsupported PEM types, or invalid PEM structure.

Pkcs8(String)

PKCS8 key format errors.

Occurs when the signature module cannot parse PKCS8-encoded private keys. This includes unsupported key algorithms, malformed key data, or invalid PKCS8 structure.

InvalidPrivateKeyLength

Private key length validation errors.

Occurs when a private key has an invalid length for the expected algorithm. For Ed25519 keys, this typically means the key is not exactly 32 bytes long.

Utf8(FromUtf8Error)

UTF-8 encoding or decoding errors.

This error is automatically converted from std::string::FromUtf8Error and occurs when the signature module cannot convert byte data to UTF-8 strings, typically when processing key files or signature data.

Jwk(String)

JSON Web Key format errors.

Occurs when there are issues with JWK format, parsing, or processing. This includes malformed JWK JSON, unsupported key types, or invalid JWK structure.

Signature(String)

Signature creation and verification errors.

Occurs when there are issues with HTTP message signature creation or verification. This includes key loading failures, signature generation errors, or algorithm compatibility issues.

Validation(String)

Signature validation and verification errors.

Occurs when signature validation fails, including expired signatures, invalid signature formats, or verification failures against public keys.

Other(String)

Miscellaneous errors that don’t fit into other categories.

This variant is used for errors that are specific to the HTTP signature implementation or other unexpected issues that don’t fall into the standard error categories.

Trait Implementations

impl Debug for HttpSignatureError

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

Formats the value using the given formatter.

impl Display for HttpSignatureError

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

Formats the value using the given formatter.

impl Error for HttpSignatureError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<DecodeError> for HttpSignatureError

fn from(source: DecodeError) -> Self

Converts to this type from the input type.

impl From<Error> for HttpSignatureError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<FromUtf8Error> for HttpSignatureError

fn from(source: FromUtf8Error) -> Self

Converts to this type from the input type.