Struct curl::easy::Auth

pub struct Auth { /* fields hidden */ }
Documentation

Structure which stores possible authentication methods to get passed to http_auth and proxy_auth.

Implementations

impl Auth
pub fn new() -> Auth

Creates a new set of authentications with no members.

An Auth structure is used to configure which forms of authentication are attempted when negotiating connections with servers.

pub fn basic(&mut Self, on: bool) -> &mut Auth

HTTP Basic authentication.

This is the default choice, and the only method that is in wide-spread use and supported virtually everywhere. This sends the user name and password over the network in plain text, easily captured by others.

pub fn digest(&mut Self, on: bool) -> &mut Auth

HTTP Digest authentication.

Digest authentication is defined in RFC 2617 and is a more secure way to do authentication over public networks than the regular old-fashioned Basic method.

pub fn digest_ie(&mut Self, on: bool) -> &mut Auth

HTTP Digest authentication with an IE flavor.

Digest authentication is defined in RFC 2617 and is a more secure way to do authentication over public networks than the regular old-fashioned Basic method. The IE flavor is simply that libcurl will use a special “quirk” that IE is known to have used before version 7 and that some servers require the client to use.

pub fn gssnegotiate(&mut Self, on: bool) -> &mut Auth

HTTP Negotiate (SPNEGO) authentication.

Negotiate authentication is defined in RFC 4559 and is the most secure way to perform authentication over HTTP.

You need to build libcurl with a suitable GSS-API library or SSPI on Windows for this to work.

pub fn ntlm(&mut Self, on: bool) -> &mut Auth

HTTP NTLM authentication.

A proprietary protocol invented and used by Microsoft. It uses a challenge-response and hash concept similar to Digest, to prevent the password from being eavesdropped.

You need to build libcurl with either OpenSSL, GnuTLS or NSS support for this option to work, or build libcurl on Windows with SSPI support.

pub fn ntlm_wb(&mut Self, on: bool) -> &mut Auth

NTLM delegating to winbind helper.

Authentication is performed by a separate binary application that is executed when needed. The name of the application is specified at compile time but is typically /usr/bin/ntlm_auth

Note that libcurl will fork when necessary to run the winbind application and kill it when complete, calling waitpid() to await its exit when done. On POSIX operating systems, killing the process will cause a SIGCHLD signal to be raised (regardless of whether CURLOPT_NOSIGNAL is set), which must be handled intelligently by the application. In particular, the application must not unconditionally call wait() in its SIGCHLD signal handler to avoid being subject to a race condition. This behavior is subject to change in future versions of libcurl.

A proprietary protocol invented and used by Microsoft. It uses a challenge-response and hash concept similar to Digest, to prevent the password from being eavesdropped.

pub fn aws_sigv4(&mut Self, on: bool) -> &mut Auth

HTTP AWS V4 signature authentication.

This is a special auth type that can’t be combined with the others. It will override the other auth types you might have set.

Enabling this auth type is the same as using “aws:amz” as param in Easy2::aws_sigv4 method.

Trait Implementations

impl Clone for Auth
fn clone(&Self) -> Auth
impl Debug for Auth
fn fmt(&Self, f: &mut fmt::Formatter<'_>) -> fmt::Result

Auto Trait Implementations

impl RefUnwindSafe for Auth
impl Send for Auth
impl Sync for Auth
impl Unpin for Auth
impl UnwindSafe for Auth

Blanket Implementations

impl<T> Any for T
where
    T: 'static + ?Sized,
fn type_id(&Self) -> TypeId
impl<T> Borrow<T> for T
where
    T: ?Sized,
fn borrow(&Self) -> &T
impl<T> BorrowMut<T> for T
where
    T: ?Sized,
fn borrow_mut(&mut Self) -> &mut T
impl<T> From<T> for T
fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where
    U: From<T>,
fn into(Self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where
    T: Clone,
type Owned = T
fn to_owned(&Self) -> T
fn clone_into(&Self, target: &mut T)
impl<T, U> TryFrom<U> for T
where
    U: Into<T>,
type Error = Infallible
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
impl<T, U> TryInto<U> for T
where
    U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
fn try_into(Self) -> Result<U, <U as TryFrom<T>>::Error>