Models.UserSecrets Class
Namespace: Nucleus.Abstractions.Models
Assembly: Nucleus.Abstractions.dll
Represents password and other user-login information.
Properties
EncryptedTotpSecretKey Property
Secret key for multifactor authentication using TOTP (RFC6238).
FailedPasswordAnswerAttemptCount Property
Not in use
FailedPasswordAnswerWindowStart Property
Not in use
FailedPasswordAttemptCount Property
Gets or sets the number of times that the user has entered the wrong password, within the configured time window.
FailedPasswordWindowStart Property
Gets or sets the date/time of the first password attempt failure, within the configured time window.
IsLockedOut Property
Gets or sets whether the user is locked out.
LastLockoutDate Property
Date/Time of the last lockout for the user.
Remarks
Users are locked out for a configurable period of time after a configurable number of failed password attempts.
LastLoginDate Property
Date/time of the last successful login.
LastPasswordChangedDate Property
Date/time that the user last changed their password.
PasswordAnswer Property
Not in use
PasswordExpiryDate Property
Expiry date/time for the password. When a password is expired, the user must enter a new password the next time they log in.
PasswordHash Property
User's password hash.
PasswordHashAlgorithm Property
Algorithm used to create the PasswordHash.
PasswordQuestion Property
Not in use
PasswordResetToken Property
Auto-generated token used for password resets.
PasswordResetTokenExpiryDate Property
Expiry date/time for PasswordResetToken
Salt Property
Random value used by the hash algorithm.
TotpDigits Property
Determines how many numeric characters are in the one-time passcode.
TotpPeriod Property
Number of seconds that a one-time passcode is valid for.
TotpSecretKeyEncryptionAlgorithm Property
Algorithm used to encrypt the EncryptedTotpSecretKey.
VerificationToken Property
Auto-generated token used for new user verification.
VerificationTokenExpiryDate Property
Expiry date/time for VerificationToken
Methods
SetPassword (String) Method
SetPassword (String newPassword)
Set the password for the user.
Parameters
| Name | Type |
|---|---|
| newPassword | String |
Remarks
Use SetPassword rather than this function. The UserManager method sets other properties like the password expiry date.
VerifyPassword (String) Method
VerifyPassword (String password)
Compare the submitted password with the user's saved password.
Parameters
| Name | Type |
|---|---|
| password | String |
Remarks
Login modules should use Nucleus.Core.UserManager.VerifyPassword rather than calling this function directly, because UserManager.VerifyPassword tracks login failures and manages account suspension. If the user 'secrets' record has a blank password or blank password hash algorithm, this function always returns false, because users without a password cannot login using the login module. Users can have no password if they are authenticated by a different method such as OAuth, or an Authenticator app.