Class OneTimeCodeAuthentication

Namespace

The.Security

Assembly

Instagile.dll

public class OneTimeCodeAuthentication : IAuthentication

Inheritance

object

OneTimeCodeAuthentication

Implements

IAuthentication

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

OneTimeCodeAuthentication(int)

public OneTimeCodeAuthentication(int maxAttempts = 3)

Parameters

maxAttempts int

Fields

VerificationAttemptsClaimKey

public static readonly string VerificationAttemptsClaimKey

Field Value

string

VerificationCodeClaimKey

public static readonly string VerificationCodeClaimKey

Field Value

string

Properties

IsAuthoritative

If true, the returned identity should be accepted without server verification

public bool IsAuthoritative { get; }

Property Value

bool

Remarks

May depend on ambient state - don't cache the result. As well as enabling automatic login, this is used by SecurityService to decide whether it's ok to perform purely-local authentication without calling IEntityStore.Connect.

Realm

Describes identities within the purview of this authenticator

public string Realm { get; }

Property Value

string

RequiresCredentials

Expects non-empty Credentials in order to perform client-side identity operations

public bool RequiresCredentials { get; }

Property Value

bool

Methods

ConsumeCodeAsync(IUserAccount, VerificationCode, CancellationToken?)

public Task<AuthenticationResult> ConsumeCodeAsync(IUserAccount userAccount, VerificationCode code, CancellationToken? cancellationToken = null)

Parameters

userAccount IUserAccount

code VerificationCode

cancellationToken CancellationToken?

Returns

Task<AuthenticationResult>

GetIdentity(Credentials)

Extract a subject from the environment or the supplied credentials.

public AuthenticationResult<string> GetIdentity(Credentials credentials)

Parameters

credentials Credentials

Returns

AuthenticationResult<string>

subject name, unverified - from local knowledge only

SetCodeAsync(IUserAccount, VerificationCode, TimeSpan?, CancellationToken?)

public static Task SetCodeAsync(IUserAccount userAccount, VerificationCode code, TimeSpan? expiryPeriod = null, CancellationToken? cancellationToken = null)

Parameters

userAccount IUserAccount

code VerificationCode

expiryPeriod TimeSpan?

cancellationToken CancellationToken?

Returns

Task

VerifyIdentity(Credentials, string)

Verify that the subject matches the supplied credentials. Available synchronously only if IsAuthoritative returns true.

public AuthenticationResult VerifyIdentity(Credentials credentials, string subject)

Parameters

credentials Credentials

subject string

Returns

AuthenticationResult

(true/false for authentication state, null/reason for failure)

VerifyIdentityAsync(Credentials, IEntityContext, string)

verify that the subject matches the supplied credentials

public Task<AuthenticationResult> VerifyIdentityAsync(Credentials credentials, IEntityContext scopedContext, string subject)

Parameters

credentials Credentials

scopedContext IEntityContext

subject string

Returns

Task<AuthenticationResult>

(true/false for authentication state, null/reason for failure)