Struct BasicAuthProvider 

pub struct BasicAuthProvider { /* private fields */ }

Basic authentication provider implementing RFC 7617.

Provides simple username/password authentication with optional HTTPS enforcement to prevent credential leakage over insecure connections.

Example

use aria2_core::auth::basic_auth::BasicAuthProvider;

let provider = BasicAuthProvider::new(
    "alice".to_string(),
    "secret-password".to_string(),
    true, // Enforce HTTPS
);

Implementations

impl BasicAuthProvider

pub fn new(username: String, password: String, https_only: bool) -> Self

Creates a new Basic authentication provider.

Arguments

• username - The username for authentication
• password - The password for authentication
• https_only - If true, rejects non-HTTPS URLs for security

Security Note

Setting https_only to true is strongly recommended to prevent credential interception. Basic auth credentials are trivially decoded from Base64, making HTTPS essential for security.

pub fn is_https_only(&self) -> bool

Returns whether this provider enforces HTTPS-only mode.

pub fn build_authorization_header_with_url( &self, challenge: &AuthChallenge, url: &str, ) -> Result<String>

Builds an Authorization header value with URL validation.

This is the recommended method as it validates the URL scheme before generating credentials when https_only is enabled.

Arguments

• challenge - The authentication challenge (realm info)
• url - The request URL (used for scheme validation)

Returns

Complete Authorization header value or error if:

• URL scheme is not HTTPS and https_only is enabled
• Base64 encoding fails (unlikely but possible)

Errors

Returns Aria2Error::Parse if the URL cannot be parsed Returns Aria2Error::DownloadFailed if HTTPS is required but not used

Trait Implementations

impl AuthProvider for BasicAuthProvider

fn build_authorization_header( &self, _challenge: &AuthChallenge, ) -> Result<String>

Builds a Basic Authorization header value.

Format: Basic Base64(username:password)

Arguments

• _challenge - The authentication challenge (not used for Basic auth, but included for interface consistency)

Returns

Complete Authorization header starting with “Basic “

fn scheme(&self) -> AuthScheme

Returns the authentication scheme this provider implements.

impl Clone for BasicAuthProvider

fn clone(&self) -> BasicAuthProvider

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BasicAuthProvider

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

Formats the value using the given formatter.