CookieAuthenticationOptions Classe

Définition

Espace de noms:

Microsoft.AspNetCore.Builder

Assembly:

Microsoft.AspNetCore.Authentication.Cookies.dll

Paquet:

Microsoft.AspNetCore.Authentication.Cookies v1.1.0

Options de configuration pour CookieAuthenticationMiddleware.

public ref class CookieAuthenticationOptions : Microsoft::AspNetCore::Builder::AuthenticationOptions, Microsoft::Extensions::Options::IOptions<Microsoft::AspNetCore::Builder::CookieAuthenticationOptions ^>

public class CookieAuthenticationOptions : Microsoft.AspNetCore.Builder.AuthenticationOptions, Microsoft.Extensions.Options.IOptions<Microsoft.AspNetCore.Builder.CookieAuthenticationOptions>

type CookieAuthenticationOptions = class
    inherit AuthenticationOptions
    interface IOptions<CookieAuthenticationOptions>

Public Class CookieAuthenticationOptions
Inherits AuthenticationOptions
Implements IOptions(Of CookieAuthenticationOptions)

Héritage

Object

AuthenticationOptions

CookieAuthenticationOptions

Implémente

IOptions<CookieAuthenticationOptions>

Constructeurs

CookieAuthenticationOptions()

Crée une instance des options initialisées avec les valeurs par défaut.

Propriétés

AccessDeniedPath	La propriété AccessDeniedPath informe le middleware qu’il doit modifier un code status 403 Forbidden sortant en redirection 302 sur le chemin donné.
AuthenticationScheme	AuthenticationScheme dans les options correspond au nom logique d’un schéma d’authentification particulier. Une valeur différente peut être attribuée afin d'utiliser le même type d'intergiciel (middleware) d'authentification plus d'une fois dans un pipeline. (Hérité de AuthenticationOptions)
AutomaticAuthenticate	Si la valeur est true, l’intergiciel d’authentification modifie l’utilisateur de demande entrant. Si la valeur est false, l’intergiciel d’authentification fournit l’identité uniquement lorsqu’il est explicitement indiqué par authenticationScheme. (Hérité de AuthenticationOptions)
AutomaticChallenge	Si la valeur est true, l’intergiciel d’authentification doit gérer la demande automatique. Si la valeur est false, l’intergiciel d’authentification modifie les réponses uniquement lorsqu’il est explicitement indiqué par authenticationScheme. (Hérité de AuthenticationOptions)
ClaimsIssuer	Obtient ou définit l’émetteur qui doit être utilisé pour toutes les revendications créées (Hérité de AuthenticationOptions)
CookieDomain	Détermine le domaine utilisé pour créer le cookie. N'est pas fourni par défaut.
CookieHttpOnly	Détermine si le navigateur doit autoriser le javascript côté client à accéder au cookie. La valeur par défaut est true. Cela signifie que le cookie est transmis uniquement aux demandes HTTP, et est inaccessible aux scripts figurant dans la page.
CookieManager	Composant utilisé pour obtenir les cookies de la demande ou les définir dans la réponse. ChunkingCookieManager est utilisé par défaut.
CookieName	Détermine le nom de cookie utilisé pour conserver l'identité. La valeur par défaut est . AspNetCore.Cookies ». Cette valeur doit être modifiée si vous modifiez le nom de AuthenticationScheme, en particulier si votre système utilise l’intergiciel d’authentification par cookie plusieurs fois.
CookiePath	Détermine le chemin utilisé pour créer le cookie. La valeur par défaut est « / » pour la compatibilité de navigateur la plus élevée.
CookieSecure	Détermine si le cookie doit être transmis uniquement sur une demande HTTPS. La valeur par défaut sert à limiter le cookie aux demandes HTTPS si la page établissant la connexion est également de type HTTPS. Si vous avez une page de connexion HTTPS et si des portions de votre site sont de type HTTP, il se peut que vous deviez modifier cette valeur.
DataProtectionProvider	Si cette option est définie, elle sera utilisée par CookieAuthenticationMiddleware pour la protection des données.
Description	Informations supplémentaires sur le type d'authentification qui est mis à la disposition de l'application. (Hérité de AuthenticationOptions)
Events	Le Fournisseur peut être attribué à une instance d'objet créé par l'application au démarrage. L’intergiciel appelle des méthodes sur le fournisseur qui donnent à l’application le contrôle à certains points où le traitement se produit. En l'absence de spécification, une instance par défaut est fournie, qui n'exécute aucune action lors de l'appel des méthodes.
ExpireTimeSpan	Contrôle la période de validité du cookie après sa création. Les informations d'expiration figurent dans le ticket du cookie protégé. Par conséquent, un cookie expiré est ignoré, même s'il est transmis au serveur après que le navigateur aurait dû l'avoir purgé.
LoginPath	La propriété LoginPath informe l'intergiciel (middleware) de la nécessité de modifier un code d'état Non autorisé 401 sortant en une redirection 302 sur le chemin d'accès de connexion donné. L'URL qui a généré le code 401 est ajoutée au LoginPath en tant que paramètre de chaîne de requête nommé par le ReturnUrlParameter. Une fois qu’une demande adressée à LoginPath a accordé une nouvelle identité SignIn, la valeur ReturnUrlParameter est utilisée pour rediriger le navigateur vers l’arrière à l’URL qui a provoqué le code d’status non autorisé d’origine.
LogoutPath	Si la valeur de LogoutPath est fournie à l'intergiciel (middleware), une demande à ce chemin d'accès redirige sur la base de la valeur de ReturnUrlParameter.
ReturnUrlParameter	La valeur ReturnUrlParameter détermine le nom du paramètre de chaîne de requête que l'intergiciel (middleware) ajoute en cas de modification d'un code d'état Non autorisé 401 en redirection 302 sur le chemin d'accès de connexion. Il s'agit également du paramètre de chaîne de requête recherché quand une demande arrive sur le chemin d'accès de connexion ou de déconnexion, afin de retourner à l'URL d'origine une fois l'action effectuée.
SessionStore	Conteneur facultatif dans lequel stocker l'identité des demandes. Quand il est utilisé, seul un identificateur de session est envoyé au client. Il peut être utilisé pour atténuer les éventuels problèmes liés aux identités très grandes.
SlidingExpiration	La valeur de SlidingExpiration est true pour donner pour instruction à l'intergiciel (middleware) de ré-émettre un nouveau cookie avec une nouvelle heure d'expiration chaque fois qu'il traite une demande ayant dépassé la moitié du délai d'expiration.
SystemClock	For testing purposes only. (Hérité de AuthenticationOptions)
TicketDataFormat	TicketDataFormat permet de protéger et de déprotéger l'identité et d'autres propriétés enregistrées dans la valeur du cookie. S’il n’est pas fourni, un gestionnaire de données par défaut est créé à l’aide du service de protection des données contenu dans IApplicationBuilder.Properties. Le service de protection de données par défaut est basé sur une clé ordinateur lors de l'exécution sur ASP.NET, et sur DPAPI lors de l'exécution dans le cadre d'un autre processus.

Implémentations d’interfaces explicites

IOptions<CookieAuthenticationOptions>.Value

Options de configuration pour CookieAuthenticationMiddleware.