Class ScramShaAuthenticator

Namespace

MongoDB.Driver.Core.Authentication

Assembly

MongoDB.Driver.Core.dll

A SCRAM-SHA SASL authenticator.

public abstract class ScramShaAuthenticator : SaslAuthenticator, IAuthenticator

Inheritance

object

SaslAuthenticator

ScramShaAuthenticator

Implements

IAuthenticator

Derived

ScramSha1Authenticator

ScramSha256Authenticator

Inherited Members

SaslAuthenticator.Name

SaslAuthenticator.Authenticate(IConnection, ConnectionDescription, CancellationToken)

SaslAuthenticator.AuthenticateAsync(IConnection, ConnectionDescription, CancellationToken)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ScramShaAuthenticator(UsernamePasswordCredential, HashAlgorithmName, H, Hi, Hmac)

Initializes a new instance of the ScramShaAuthenticator class.

[Obsolete("Use the newest overload instead.")]
protected ScramShaAuthenticator(UsernamePasswordCredential credential, HashAlgorithmName hashAlgorithmName, ScramShaAuthenticator.H h, ScramShaAuthenticator.Hi hi, ScramShaAuthenticator.Hmac hmac)

Parameters

credential UsernamePasswordCredential

The credential.

hashAlgorithmName HashAlgorithmName

The hash algorithm name.

h ScramShaAuthenticator.H

The H function to use.

hi ScramShaAuthenticator.Hi

The Hi function to use.

hmac ScramShaAuthenticator.Hmac

The Hmac function to use.

ScramShaAuthenticator(UsernamePasswordCredential, HashAlgorithmName, H, Hi, Hmac, ServerApi)

Initializes a new instance of the ScramShaAuthenticator class.

protected ScramShaAuthenticator(UsernamePasswordCredential credential, HashAlgorithmName hashAlgorithmName, ScramShaAuthenticator.H h, ScramShaAuthenticator.Hi hi, ScramShaAuthenticator.Hmac hmac, ServerApi serverApi)

Parameters

credential UsernamePasswordCredential

The credential.

hashAlgorithmName HashAlgorithmName

The hash algorithm name.

h ScramShaAuthenticator.H

The H function to use.

hi ScramShaAuthenticator.Hi

The Hi function to use.

hmac ScramShaAuthenticator.Hmac

The Hmac function to use.

serverApi ServerApi

The server API.

Properties

DatabaseName

Gets the name of the database.

public override string DatabaseName { get; }

Property Value

string

The name of the database.

Methods

CustomizeInitialHelloCommand(BsonDocument)

Optionally customizes hello or legacy hello command.

public override BsonDocument CustomizeInitialHelloCommand(BsonDocument helloCommand)

Parameters

helloCommand BsonDocument

Initial command.

Returns

BsonDocument

Optionally mutated command.