Enum Authentication

pub enum Authentication {
    Bearer(SecureString),
    Basic {
        username: String,
        password: SecureString,
    },
    ApiKey {
        header_name: String,
        key: SecureString,
    },
}

Authentication configuration for API requests.

This enum supports various authentication methods commonly used in APIs. Authentication can be configured at the client level and optionally overridden for individual requests.

Security Features

• Memory Protection: Sensitive data is automatically cleared from memory when dropped
• Display Masking: Credentials are never displayed in full for logging safety
• Debug Safety: Authentication data is redacted in debug output

Examples

use clawspec_core::Authentication;

// Bearer token authentication
let auth = Authentication::Bearer("my-api-token".into());

// Basic authentication
let auth = Authentication::Basic {
    username: "user".to_string(),
    password: "pass".into(),
};

// API key in header
let auth = Authentication::ApiKey {
    header_name: "X-API-Key".to_string(),
    key: "secret-key".into(),
};

Variants

Bearer(SecureString)

Bearer token authentication (RFC 6750) Adds Authorization: Bearer <token> header

Basic

HTTP Basic authentication (RFC 7617) Adds Authorization: Basic <base64(username:password)> header

Fields

username: String

password: SecureString

ApiKey

API key authentication with custom header Adds <header_name>: <key> header

Fields

header_name: String

key: SecureString

Implementations

impl Authentication

pub fn to_header( &self, ) -> Result<(HeaderName, HeaderValue), AuthenticationError>

Converts the authentication into HTTP headers.

Returns a tuple of (HeaderName, HeaderValue) that can be added to the request.

Errors

Returns AuthenticationError if the authentication data contains invalid characters or cannot be properly formatted for HTTP headers.

Trait Implementations

impl Clone for Authentication

fn clone(&self) -> Authentication

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Authentication

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Authentication

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Authentication

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

Formats the value using the given formatter.

impl PartialEq for Authentication

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Authentication

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Authentication

impl StructuralPartialEq for Authentication