Enum Authentication 

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

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

The username for Basic authentication.

password: SecureString

The password for Basic authentication.

ApiKey

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

Fields

header_name: String

The header name for the API key.

key: SecureString

The API key value.

OAuth2(SharedOAuth2Config)

Available on crate feature oauth2 only.

OAuth2 authentication.

This variant requires the oauth2 feature to be enabled. Tokens are acquired automatically and cached for reuse.

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 Display for Authentication

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

Formats the value using the given formatter.