View Source

Class BackOfficeUserManager<T>

Generic Back office user manager

Inheritance

System.Object

Namespace: Umbraco.Web.Security

Assembly: Umbraco.Web.dll

Syntax

public class BackOfficeUserManager<T> : UserManager<T, int> where T : BackOfficeIdentityUser

Type Parameters

Name	Description
T

Constructors

BackOfficeUserManager(IUserStore<T, Int32>)

Declaration

public BackOfficeUserManager(IUserStore<T, int> store)

Parameters

Type	Name	Description
IUserStore<T, System.Int32>	store

Properties

BackOfficeUserPasswordChecker

Gets/sets the default back office user password checker

Declaration

public IBackOfficeUserPasswordChecker BackOfficeUserPasswordChecker { get; set; }

Property Value

Type	Description
IBackOfficeUserPasswordChecker

SupportsQueryableUsers

Declaration

public override bool SupportsQueryableUsers { get; }

Property Value

Type	Description
System.Boolean

SupportsUserClaim

Declaration

public override bool SupportsUserClaim { get; }

Property Value

Type	Description
System.Boolean

SupportsUserPhoneNumber

Declaration

public override bool SupportsUserPhoneNumber { get; }

Property Value

Type	Description
System.Boolean

SupportsUserTwoFactor

Developers will need to override this to support custom 2 factor auth

Declaration

public override bool SupportsUserTwoFactor { get; }

Property Value

Type	Description
System.Boolean

Methods

AccessFailedAsync(Int32)

Declaration

public override async Task<IdentityResult> AccessFailedAsync(int userId)

Parameters

Type	Name	Description
System.Int32	userId

Returns

Type	Description
System.Threading.Tasks.Task<IdentityResult>

ChangePasswordAsync(Int32, String, String)

Declaration

public override Task<IdentityResult> ChangePasswordAsync(int userId, string currentPassword, string newPassword)

Parameters

Type	Name	Description
System.Int32	userId
System.String	currentPassword
System.String	newPassword

Returns

Type	Description
System.Threading.Tasks.Task<IdentityResult>

ChangePasswordWithResetAsync(Int32, String, String)

This is a special method that will reset the password but will raise the Password Changed event instead of the reset event

Declaration

public Task<IdentityResult> ChangePasswordWithResetAsync(int userId, string token, string newPassword)

Parameters

Type	Name	Description
System.Int32	userId
System.String	token
System.String	newPassword

Returns

Type	Description
System.Threading.Tasks.Task<IdentityResult>

Remarks

We use this because in the back office the only way an admin can change another user's password without first knowing their password is to generate a token and reset it, however, when we do this we want to track a password change, not a password reset

CheckPasswordAsync(T, String)

Logic used to validate a username and password

Declaration

public override async Task<bool> CheckPasswordAsync(T user, string password)

Parameters

Type	Name	Description
T	user
System.String	password

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

Remarks

By default this uses the standard ASP.Net Identity approach which is:

• Get password store
• Call VerifyPasswordAsync with the password store + user + password
• Uses the PasswordHasher.VerifyHashedPassword to compare the stored password

In some cases people want simple custom control over the username/password check, for simplicity sake, developers would like the users to simply validate against an LDAP directory but the user data remains stored inside of Umbraco. See: http://issues.umbraco.org/issue/U4-7032 for the use cases.

We've allowed this check to be overridden with a simple callback so that developers don't actually have to implement/override this class.

GeneratePassword()

Helper method to generate a password for a user based on the current password validator

Declaration

public string GeneratePassword()

Returns

Type	Description
System.String

GenerateUserIdentityAsync(T)

Declaration

public virtual async Task<ClaimsIdentity> GenerateUserIdentityAsync(T user)

Parameters

Type	Name	Description
T	user

Returns

Type	Description
System.Threading.Tasks.Task<System.Security.Claims.ClaimsIdentity>

GetCurrentRequestIpAddress()

Returns the current request IP address for logging if there is one

Declaration

protected virtual string GetCurrentRequestIpAddress()

Returns

Type	Description
System.String

GetDefaultPasswordHasher(MembershipProviderBase)

This will determine which password hasher to use based on what is defined in config

Declaration

protected virtual IPasswordHasher GetDefaultPasswordHasher(MembershipProviderBase provider)

Parameters

Type	Name	Description
MembershipProviderBase	provider

Returns

Type	Description
IPasswordHasher

InitUserManager(BackOfficeUserManager<T>, MembershipProviderBase, IDataProtectionProvider, IContentSection)

Initializes the user manager with the correct options

Declaration

protected void InitUserManager(BackOfficeUserManager<T> manager, MembershipProviderBase membershipProvider, IDataProtectionProvider dataProtectionProvider, IContentSection contentSectionConfig)

Parameters

Type	Name	Description
BackOfficeUserManager<T>	manager
MembershipProviderBase	membershipProvider	The MembershipProviderBase for the users called UsersMembershipProvider
IDataProtectionProvider	dataProtectionProvider
IContentSection	contentSectionConfig

IsLockedOutAsync(Int32)

Override to check the user approval value as well as the user lock out date, by default this only checks the user's locked out date

Declaration

public override async Task<bool> IsLockedOutAsync(int userId)

Parameters

Type	Name	Description
System.Int32	userId

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

Remarks

In the ASP.NET Identity world, there is only one value for being locked out, in Umbraco we have 2 so when checking this for Umbraco we need to check both values

OnAccountLocked(IdentityAuditEventArgs)

Declaration

protected virtual void OnAccountLocked(IdentityAuditEventArgs e)

Parameters

Type	Name	Description
IdentityAuditEventArgs	e

OnAccountUnlocked(IdentityAuditEventArgs)

Declaration

protected virtual void OnAccountUnlocked(IdentityAuditEventArgs e)

Parameters

Type	Name	Description
IdentityAuditEventArgs	e

OnForgotPasswordChangedSuccess(IdentityAuditEventArgs)

Declaration

protected virtual void OnForgotPasswordChangedSuccess(IdentityAuditEventArgs e)

Parameters

Type	Name	Description
IdentityAuditEventArgs	e

OnForgotPasswordRequested(IdentityAuditEventArgs)

Declaration

protected virtual void OnForgotPasswordRequested(IdentityAuditEventArgs e)

Parameters

Type	Name	Description
IdentityAuditEventArgs	e

OnLoginFailed(IdentityAuditEventArgs)

Declaration

protected virtual void OnLoginFailed(IdentityAuditEventArgs e)

Parameters

Type	Name	Description
IdentityAuditEventArgs	e

OnLoginRequiresVerification(IdentityAuditEventArgs)

Declaration

protected virtual void OnLoginRequiresVerification(IdentityAuditEventArgs e)

Parameters

Type	Name	Description
IdentityAuditEventArgs	e

OnLoginSuccess(IdentityAuditEventArgs)

Declaration

protected virtual void OnLoginSuccess(IdentityAuditEventArgs e)

Parameters

Type	Name	Description
IdentityAuditEventArgs	e

OnLogoutSuccess(IdentityAuditEventArgs)

Declaration

protected virtual void OnLogoutSuccess(IdentityAuditEventArgs e)

Parameters

Type	Name	Description
IdentityAuditEventArgs	e

OnPasswordChanged(IdentityAuditEventArgs)

Declaration

protected virtual void OnPasswordChanged(IdentityAuditEventArgs e)

Parameters

Type	Name	Description
IdentityAuditEventArgs	e

OnPasswordReset(IdentityAuditEventArgs)

Declaration

protected virtual void OnPasswordReset(IdentityAuditEventArgs e)

Parameters

Type	Name	Description
IdentityAuditEventArgs	e

OnResetAccessFailedCount(IdentityAuditEventArgs)

Declaration

protected virtual void OnResetAccessFailedCount(IdentityAuditEventArgs e)

Parameters

Type	Name	Description
IdentityAuditEventArgs	e

OnSendingUserInvite(UserInviteEventArgs)

Declaration

protected virtual void OnSendingUserInvite(UserInviteEventArgs e)

Parameters

Type	Name	Description
UserInviteEventArgs	e

ResetAccessFailedCountAsync(Int32)

Declaration

public override async Task<IdentityResult> ResetAccessFailedCountAsync(int userId)

Parameters

Type	Name	Description
System.Int32	userId

Returns

Type	Description
System.Threading.Tasks.Task<IdentityResult>

ResetPasswordAsync(Int32, String, String)

Declaration

public override Task<IdentityResult> ResetPasswordAsync(int userId, string token, string newPassword)

Parameters

Type	Name	Description
System.Int32	userId
System.String	token
System.String	newPassword

Returns

Type	Description
System.Threading.Tasks.Task<IdentityResult>

SetLockoutEndDateAsync(Int32, DateTimeOffset)

Declaration

public override async Task<IdentityResult> SetLockoutEndDateAsync(int userId, DateTimeOffset lockoutEnd)

Parameters

Type	Name	Description
System.Int32	userId
System.DateTimeOffset	lockoutEnd

Returns

Type	Description
System.Threading.Tasks.Task<IdentityResult>

UpdatePassword(IUserPasswordStore<T, Int32>, T, String)

Override to determine how to hash the password

Declaration

protected override async Task<IdentityResult> UpdatePassword(IUserPasswordStore<T, int> passwordStore, T user, string newPassword)

Parameters

Type	Name	Description
IUserPasswordStore<T, System.Int32>	passwordStore
T	user
System.String	newPassword

Returns

Type	Description
System.Threading.Tasks.Task<IdentityResult>

Remarks

This method is called anytime the password needs to be hashed for storage (i.e. including when reset password is used)

ValidateSessionIdAsync(Int32, String)

Used to validate a user's session

Declaration

public virtual async Task<bool> ValidateSessionIdAsync(int userId, string sessionId)

Parameters

Type	Name	Description
System.Int32	userId
System.String	sessionId

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

VerifyPasswordAsync(IUserPasswordStore<T, Int32>, T, String)

Override to determine how to hash the password

Declaration

protected override async Task<bool> VerifyPasswordAsync(IUserPasswordStore<T, int> store, T user, string password)

Parameters

Type	Name	Description
IUserPasswordStore<T, System.Int32>	store
T	user
System.String	password

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

Events

AccountLocked

Declaration

public static event EventHandler AccountLocked

Event Type

Type	Description
System.EventHandler

AccountUnlocked

Declaration

public static event EventHandler AccountUnlocked

Event Type

Type	Description
System.EventHandler

ForgotPasswordChangedSuccess

Declaration

public static event EventHandler ForgotPasswordChangedSuccess

Event Type

Type	Description
System.EventHandler

ForgotPasswordRequested

Declaration

public static event EventHandler ForgotPasswordRequested

Event Type

Type	Description
System.EventHandler

LoginFailed

Declaration

public static event EventHandler LoginFailed

Event Type

Type	Description
System.EventHandler

LoginRequiresVerification

Declaration

public static event EventHandler LoginRequiresVerification

Event Type

Type	Description
System.EventHandler

LoginSuccess

Declaration

public static event EventHandler LoginSuccess

Event Type

Type	Description
System.EventHandler

LogoutSuccess

Declaration

public static event EventHandler LogoutSuccess

Event Type

Type	Description
System.EventHandler

PasswordChanged

Declaration

public static event EventHandler PasswordChanged

Event Type

Type	Description
System.EventHandler

PasswordReset

Declaration

public static event EventHandler PasswordReset

Event Type

Type	Description
System.EventHandler

ResetAccessFailedCount

Declaration

public static event EventHandler ResetAccessFailedCount

Event Type

Type	Description
System.EventHandler

SendingUserInvite

Raised when a user is invited

Declaration

public static event EventHandler SendingUserInvite

Event Type

Type	Description
System.EventHandler