SaslMechanism Class

A SASL authentication mechanism.

Definition

Remarks

Authenticating via a SASL mechanism may be a multi-step process. To determine if the mechanism has completed the necessary steps to authentication, check the IsAuthenticated after each call to Challenge(String, CancellationToken).

Constructors

SaslMechanism(NetworkCredential) Initializes a new instance of the SaslMechanism class.
SaslMechanism(String, String) Initializes a new instance of the SaslMechanism class.

Properties

Credentials Get the user's credentials.
IsAuthenticated Get or set whether the SASL mechanism has finished authenticating.
MechanismName Get the name of the SASL mechanism.
NegotiatedChannelBinding Get whether or not channel-binding was negotiated by the SASL mechanism.
NegotiatedSecurityLayer Get whether or not a security layer was negotiated by the SASL mechanism.
SupportsChannelBinding Get whether or not the SASL mechanism supports channel binding.
SupportsInitialResponse Get whether or not the SASL mechanism supports an initial response (SASL-IR).

Methods

Challenge(String, CancellationToken) Decode the base64-encoded server challenge and return the next challenge response encoded in base64.
Challenge(Byte, Int32, Int32, CancellationToken) Parse the server's challenge token and return the next challenge response.
ChallengeAsync(String, CancellationToken) Asynchronously decode the base64-encoded server challenge and return the next challenge response encoded in base64.
ChallengeAsync(Byte, Int32, Int32, CancellationToken) Asynchronously parse the server's challenge token and return the next challenge response.
Create(String, NetworkCredential) Create an instance of the specified SASL mechanism using the supplied credentials.
Create(String, Encoding, NetworkCredential) Create an instance of the specified SASL mechanism using the supplied credentials.
Equals Determines whether the specified object is equal to the current object.
(Inherited from Object)
Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCode Serves as the default hash function.
(Inherited from Object)
GetType Gets the Type of the current instance.
(Inherited from Object)
IsSupported Determine if the specified SASL mechanism is supported by MailKit.
MemberwiseClone Creates a shallow copy of the current Object.
(Inherited from Object)
Reset Reset the state of the SASL mechanism.
SaslPrep Prepare the user name or password string.
ToString Returns a string that represents the current object.
(Inherited from Object)
TryCreate(String, NetworkCredential, SaslMechanism) Try to create an instance of the specified SASL mechanism using the supplied credentials.
TryCreate(String, Encoding, NetworkCredential, SaslMechanism) Try to create an instance of the specified SASL mechanism using the supplied credentials.
TryGetChannelBinding Try to get a channel-binding.
TryGetChannelBindingToken Try to get a channel-binding token.

See Also