Enum mongodb::options::AuthMechanism

#[non_exhaustive]
pub enum AuthMechanism {
    MongoDbCr,
    ScramSha1,
    ScramSha256,
    MongoDbX509,
    Gssapi,
    Plain,
    MongoDbAws,
    MongoDbOidc,
}

The authentication mechanisms supported by MongoDB.

Note: not all of these mechanisms are currently supported by the driver.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

MongoDbCr

MongoDB Challenge Response nonce and MD5 based authentication system. It is currently deprecated and will never be supported by this driver.

ScramSha1

The SCRAM-SHA-1 mechanism as defined in RFC 5802.

See the MongoDB documentation for more information.

ScramSha256

The SCRAM-SHA-256 mechanism which extends RFC 5802 and is formally defined in RFC 7677.

See the MongoDB documentation for more information.

MongoDbX509

The MONGODB-X509 mechanism based on the usage of X.509 certificates to validate a client where the distinguished subject name of the client certificate acts as the username.

See the MongoDB documentation for more information.

Gssapi

Kerberos authentication mechanism as defined in RFC 4752.

See the MongoDB documentation for more information.

Note: This mechanism is not currently supported by this driver but will be in the future.

Plain

The SASL PLAIN mechanism, as defined in RFC 4616, is used in MongoDB to perform LDAP authentication and cannot be used for any other type of authentication. Since the credentials are stored outside of MongoDB, the “$external” database must be used for authentication.

See the MongoDB documentation for more information on LDAP authentication.

MongoDbAws

Available on crate feature aws-auth only.

MONGODB-AWS authenticates using AWS IAM credentials (an access key ID and a secret access key), temporary AWS IAM credentials obtained from an AWS Security Token Service (STS) Assume Role request, or temporary AWS IAM credentials assigned to an EC2 instance or ECS task.

Note: Only server versions 4.4+ support AWS authentication. Additionally, the driver only supports AWS authentication with the tokio runtime.

MongoDbOidc

MONGODB-OIDC authenticates using OpenID Connect access tokens. NOTE: this is not supported by the Rust driver.

Implementations

impl AuthMechanism

pub fn validate_credential(&self, credential: &Credential) -> Result<()>

Determines if the provided credentials have the required information to perform authentication.

pub fn as_str(&self) -> &'static str

Returns this AuthMechanism as a string.

Trait Implementations

impl Clone for AuthMechanism

fn clone(&self) -> AuthMechanism

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AuthMechanism

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuthMechanism

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for AuthMechanism

type Err = Error

The associated error which can be returned from parsing.

fn from_str(str: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl PartialEq for AuthMechanism

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for AuthMechanism