Class TwoFactorAuthenticator

Namespace

SWConfigDataSharedLib.Security.GoogleAuthenticator

Assembly

IpPbxCDSSharedLib.dll

public class TwoFactorAuthenticator

Inheritance

object

TwoFactorAuthenticator

Constructors

TwoFactorAuthenticator()

public TwoFactorAuthenticator()

TwoFactorAuthenticator(bool, bool)

public TwoFactorAuthenticator(bool useManagedSha1, bool useUnmanagedOnFail)

Parameters

useManagedSha1 bool

useUnmanagedOnFail bool

Fields

_epoch

public static DateTime _epoch

Field Value

DateTime

Properties

DefaultClockDriftTolerance

public TimeSpan DefaultClockDriftTolerance { get; set; }

Property Value

TimeSpan

TryUnmanagedAlgorithmOnFailure

public bool TryUnmanagedAlgorithmOnFailure { get; set; }

Property Value

bool

UseManagedSha1Algorithm

public bool UseManagedSha1Algorithm { get; set; }

Property Value

bool

Methods

GenerateSetupCode(string, string, int, int)

Generate a setup code for a Google Authenticator user to scan.

public SetupCode GenerateSetupCode(string accountTitleNoSpaces, string accountSecretKey, int qrCodeWidth, int qrCodeHeight)

Parameters

accountTitleNoSpaces string

Account Title (no spaces)

accountSecretKey string

Account Secret Key

qrCodeWidth int

QR Code Width

qrCodeHeight int

QR Code Height

Returns

SetupCode

SetupCode object

GenerateSetupCode(string, string, string, int, int)

Generate a setup code for a Google Authenticator user to scan (with issuer ID).

public SetupCode GenerateSetupCode(string issuer, string accountTitleNoSpaces, string accountSecretKey, int qrCodeWidth, int qrCodeHeight)

Parameters

issuer string

Issuer ID (the name of the system, i.e. 'MyApp')

accountTitleNoSpaces string

Account Title (no spaces)

accountSecretKey string

Account Secret Key

qrCodeWidth int

QR Code Width

qrCodeHeight int

QR Code Height

Returns

SetupCode

SetupCode object

GenerateSetupCode(string, string, string, int, int, bool)

Generate a setup code for a Google Authenticator user to scan (with issuer ID).

public SetupCode GenerateSetupCode(string issuer, string accountTitleNoSpaces, string accountSecretKey, int qrCodeWidth, int qrCodeHeight, bool useHttps)

Parameters

issuer string

Issuer ID (the name of the system, i.e. 'MyApp')

accountTitleNoSpaces string

Account Title (no spaces)

accountSecretKey string

Account Secret Key

qrCodeWidth int

QR Code Width

qrCodeHeight int

QR Code Height

useHttps bool

Use HTTPS instead of HTTP

Returns

SetupCode

SetupCode object

GetCurrentPIN(string)

public string GetCurrentPIN(string accountSecretKey)

Parameters

accountSecretKey string

Returns

string

GetCurrentPIN(string, DateTime)

public string GetCurrentPIN(string accountSecretKey, DateTime now)

Parameters

accountSecretKey string

now DateTime

Returns

string

GetCurrentPINs(string)

public string[] GetCurrentPINs(string accountSecretKey)

Parameters

accountSecretKey string

Returns

string[]

GetCurrentPINs(string, TimeSpan)

public string[] GetCurrentPINs(string accountSecretKey, TimeSpan timeTolerance)

Parameters

accountSecretKey string

timeTolerance TimeSpan

Returns

string[]

ValidateTwoFactorPIN(string, string)

public bool ValidateTwoFactorPIN(string accountSecretKey, string twoFactorCodeFromClient)

Parameters

accountSecretKey string

twoFactorCodeFromClient string

Returns

bool

ValidateTwoFactorPIN(string, string, TimeSpan)

public bool ValidateTwoFactorPIN(string accountSecretKey, string twoFactorCodeFromClient, TimeSpan timeTolerance)

Parameters

accountSecretKey string

twoFactorCodeFromClient string

timeTolerance TimeSpan

Returns

bool