Class DefaultAuthenticator

Namespace

MongoDB.Driver.Core.Authentication

Assembly

MongoDB.Driver.Core.dll

The default authenticator. If saslSupportedMechs is not present in the hello or legacy hello results for mechanism negotiation uses SCRAM-SHA-1. Else, uses SCRAM-SHA-256 if present in the list of mechanisms. Otherwise, uses SCRAM-SHA-1 the default, regardless of whether SCRAM-SHA-1 is in the list.

public class DefaultAuthenticator : IAuthenticator

Inheritance

object

DefaultAuthenticator

Implements

IAuthenticator

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DefaultAuthenticator(UsernamePasswordCredential)

Initializes a new instance of the DefaultAuthenticator class.

[Obsolete("Use the newest overload instead.")]
public DefaultAuthenticator(UsernamePasswordCredential credential)

Parameters

credential UsernamePasswordCredential

The credential.

DefaultAuthenticator(UsernamePasswordCredential, ServerApi)

Initializes a new instance of the DefaultAuthenticator class.

public DefaultAuthenticator(UsernamePasswordCredential credential, ServerApi serverApi)

Parameters

credential UsernamePasswordCredential

The credential.

serverApi ServerApi

The server API.

Properties

Name

Gets the name of the authenticator.

public string Name { get; }

Property Value

string

The name.

Methods

Authenticate(IConnection, ConnectionDescription, CancellationToken)

Authenticates the connection.

public void Authenticate(IConnection connection, ConnectionDescription description, CancellationToken cancellationToken)

Parameters

connection IConnection

The connection.

description ConnectionDescription

The connection description.

cancellationToken CancellationToken

The cancellation token.

AuthenticateAsync(IConnection, ConnectionDescription, CancellationToken)

Authenticates the connection.

public Task AuthenticateAsync(IConnection connection, ConnectionDescription description, CancellationToken cancellationToken)

Parameters

connection IConnection

The connection.

description ConnectionDescription

The connection description.

cancellationToken CancellationToken

The cancellation token.

Returns

Task

A Task.

CustomizeInitialHelloCommand(BsonDocument)

Optionally customizes hello or legacy hello command.

public BsonDocument CustomizeInitialHelloCommand(BsonDocument helloCommand)

Parameters

helloCommand BsonDocument

Initial command.

Returns

BsonDocument

Optionally mutated command.