CookieAuthenticationOptions Class¶

Inheritance Hierarchy¶

• System.Object
• Microsoft.AspNetCore.Builder.AuthenticationOptions
• Microsoft.AspNetCore.Builder.CookieAuthenticationOptions

Syntax¶

public class CookieAuthenticationOptions : AuthenticationOptions, IOptions<CookieAuthenticationOptions>

class Microsoft.AspNetCore.Builder.CookieAuthenticationOptions

Constructors¶

CookieAuthenticationOptions()¶

Create an instance of the options initialized with the default values

public CookieAuthenticationOptions()

Properties¶

Microsoft.AspNetCore.Builder.CookieAuthenticationOptions.AccessDeniedPath¶

The AccessDeniedPath property informs the middleware that it should change an outgoing 403 Forbidden status code into a 302 redirection onto the given path.

Return type:	Microsoft.AspNetCore.Http.PathString

public PathString AccessDeniedPath { get; set; }

Microsoft.AspNetCore.Builder.CookieAuthenticationOptions.CookieDomain¶

Determines the domain used to create the cookie. Is not provided by default.

Return type:	System.String

public string CookieDomain { get; set; }

Microsoft.AspNetCore.Builder.CookieAuthenticationOptions.CookieHttpOnly¶

Determines if the browser should allow the cookie to be accessed by client-side javascript. The default is true, which means the cookie will only be passed to http requests and is not made available to script on the page.

Return type:	System.Boolean

public bool CookieHttpOnly { get; set; }

Microsoft.AspNetCore.Builder.CookieAuthenticationOptions.CookieManager¶

The component used to get cookies from the request or set them on the response.

ChunkingCookieManager will be used by default.

Return type:	Microsoft.AspNetCore.Authentication.Cookies.ICookieManager

public ICookieManager CookieManager { get; set; }

Microsoft.AspNetCore.Builder.CookieAuthenticationOptions.CookieName¶

Determines the cookie name used to persist the identity. The default value is ”.AspNetCore.Cookies”. This value should be changed if you change the name of the AuthenticationScheme, especially if your system uses the cookie authentication middleware multiple times.

Return type:	System.String

public string CookieName { get; set; }

Microsoft.AspNetCore.Builder.CookieAuthenticationOptions.CookiePath¶

Determines the path used to create the cookie. The default value is “/” for highest browser compatibility.

Return type:	System.String

public string CookiePath { get; set; }

Microsoft.AspNetCore.Builder.CookieAuthenticationOptions.CookieSecure¶

Determines if the cookie should only be transmitted on HTTPS request. The default is to limit the cookie to HTTPS requests if the page which is doing the SignIn is also HTTPS. If you have an HTTPS sign in page and portions of your site are HTTP you may need to change this value.

Return type:	Microsoft.AspNetCore.Http.CookieSecurePolicy

public CookieSecurePolicy CookieSecure { get; set; }

Microsoft.AspNetCore.Builder.CookieAuthenticationOptions.DataProtectionProvider¶

If set this will be used by the CookieAuthenticationMiddleware for data protection.

Return type:	Microsoft.AspNetCore.DataProtection.IDataProtectionProvider

public IDataProtectionProvider DataProtectionProvider { get; set; }

Microsoft.AspNetCore.Builder.CookieAuthenticationOptions.Events¶

The Provider may be assigned to an instance of an object created by the application at startup time. The middleware calls methods on the provider which give the application control at certain points where processing is occurring. If it is not provided a default instance is supplied which does nothing when the methods are called.

Return type:	Microsoft.AspNetCore.Authentication.Cookies.ICookieAuthenticationEvents

public ICookieAuthenticationEvents Events { get; set; }

Microsoft.AspNetCore.Builder.CookieAuthenticationOptions.ExpireTimeSpan¶

Controls how much time the cookie will remain valid from the point it is created. The expiration information is in the protected cookie ticket. Because of that an expired cookie will be ignored even if it is passed to the server after the browser should have purged it

Return type:	System.TimeSpan

public TimeSpan ExpireTimeSpan { get; set; }

Microsoft.AspNetCore.Builder.CookieAuthenticationOptions.LoginPath¶

The LoginPath property informs the middleware that it should change an outgoing 401 Unauthorized status code into a 302 redirection onto the given login path. The current url which generated the 401 is added to the LoginPath as a query string parameter named by the ReturnUrlParameter. Once a request to the LoginPath grants a new SignIn identity, the ReturnUrlParameter value is used to redirect the browser back to the url which caused the original unauthorized status code.

Return type:	Microsoft.AspNetCore.Http.PathString

public PathString LoginPath { get; set; }

Microsoft.AspNetCore.Builder.CookieAuthenticationOptions.LogoutPath¶

If the LogoutPath is provided the middleware then a request to that path will redirect based on the ReturnUrlParameter.

Return type:	Microsoft.AspNetCore.Http.PathString

public PathString LogoutPath { get; set; }

Microsoft.AspNetCore.Builder.CookieAuthenticationOptions.Value¶

Return type:	Microsoft.AspNetCore.Builder.CookieAuthenticationOptions

CookieAuthenticationOptions IOptions<CookieAuthenticationOptions>.Value { get; }

Microsoft.AspNetCore.Builder.CookieAuthenticationOptions.ReturnUrlParameter¶

The ReturnUrlParameter determines the name of the query string parameter which is appended by the middleware when a 401 Unauthorized status code is changed to a 302 redirect onto the login path. This is also the query string parameter looked for when a request arrives on the login path or logout path, in order to return to the original url after the action is performed.

Return type:	System.String

public string ReturnUrlParameter { get; set; }

Microsoft.AspNetCore.Builder.CookieAuthenticationOptions.SessionStore¶

An optional container in which to store the identity across requests. When used, only a session identifier is sent to the client. This can be used to mitigate potential problems with very large identities.

Return type:	Microsoft.AspNetCore.Authentication.Cookies.ITicketStore

public ITicketStore SessionStore { get; set; }

Microsoft.AspNetCore.Builder.CookieAuthenticationOptions.SlidingExpiration¶

The SlidingExpiration is set to true to instruct the middleware to re-issue a new cookie with a new expiration time any time it processes a request which is more than halfway through the expiration window.

Return type:	System.Boolean

public bool SlidingExpiration { get; set; }

Microsoft.AspNetCore.Builder.CookieAuthenticationOptions.SystemClock¶

For testing purposes only.

Return type:	Microsoft.AspNetCore.Authentication.ISystemClock

[EditorBrowsable(EditorBrowsableState.Never)]
public ISystemClock SystemClock { get; set; }

Microsoft.AspNetCore.Builder.CookieAuthenticationOptions.TicketDataFormat¶

The TicketDataFormat is used to protect and unprotect the identity and other properties which are stored in the cookie value. If it is not provided a default data handler is created using the data protection service contained in the IApplicationBuilder.Properties. The default data protection service is based on machine key when running on ASP.NET, and on DPAPI when running in a different process.

Return type:	Microsoft.AspNetCore.Authentication.ISecureDataFormat<Microsoft.AspNetCore.Authentication.AuthenticationTicket>

public ISecureDataFormat<AuthenticationTicket> TicketDataFormat { get; set; }