Class BackOfficeCookieManager

Namespace

Umbraco.Cms.Web.BackOffice.Security

Assembly

Umbraco.Web.BackOffice.dll

A custom cookie manager that is used to read the cookie from the request.

public class BackOfficeCookieManager : ChunkingCookieManager, ICookieManager

Inheritance

object

ChunkingCookieManager

BackOfficeCookieManager

Implements

ICookieManager

Inherited Members

ChunkingCookieManager.DefaultChunkSize

ChunkingCookieManager.GetRequestCookie(HttpContext, string)

ChunkingCookieManager.AppendResponseCookie(HttpContext, string, string, CookieOptions)

ChunkingCookieManager.DeleteCookie(HttpContext, string, CookieOptions)

ChunkingCookieManager.ChunkSize

ChunkingCookieManager.ThrowForPartialCookies

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

Umbraco's back office cookie needs to be read on two paths: /umbraco and /install, therefore we cannot just set the cookie path to be /umbraco, instead we'll specify our own cookie manager and return null if the request isn't for an acceptable path.

Constructors

BackOfficeCookieManager(IUmbracoContextAccessor, IRuntimeState, IEnumerable<string>?, UmbracoRequestPaths, IBasicAuthService)

Initializes a new instance of the BackOfficeCookieManager class.

public BackOfficeCookieManager(IUmbracoContextAccessor umbracoContextAccessor, IRuntimeState runtime, IEnumerable<string>? explicitPaths, UmbracoRequestPaths umbracoRequestPaths, IBasicAuthService basicAuthService)

Parameters

umbracoContextAccessor IUmbracoContextAccessor

runtime IRuntimeState

explicitPaths IEnumerable<string>

umbracoRequestPaths UmbracoRequestPaths

basicAuthService IBasicAuthService

BackOfficeCookieManager(IUmbracoContextAccessor, IRuntimeState, UmbracoRequestPaths, IBasicAuthService)

Initializes a new instance of the BackOfficeCookieManager class.

public BackOfficeCookieManager(IUmbracoContextAccessor umbracoContextAccessor, IRuntimeState runtime, UmbracoRequestPaths umbracoRequestPaths, IBasicAuthService basicAuthService)

Parameters

umbracoContextAccessor IUmbracoContextAccessor

runtime IRuntimeState

umbracoRequestPaths UmbracoRequestPaths

basicAuthService IBasicAuthService

Methods

ShouldAuthenticateRequest(string)

Determines if we should authenticate the request

public bool ShouldAuthenticateRequest(string absPath)

Parameters

absPath string

Returns

bool

true if the request should be authenticated

Remarks

We auth the request when:

• it is a back office request
• it is an installer request
• it is a preview request