CookieAuthenticationOptions Classe

Définition

Options de configuration pour CookieAuthenticationOptions.

public ref class CookieAuthenticationOptions : Microsoft::AspNetCore::Authentication::AuthenticationSchemeOptions
public class CookieAuthenticationOptions : Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions
type CookieAuthenticationOptions = class
    inherit AuthenticationSchemeOptions
Public Class CookieAuthenticationOptions
Inherits AuthenticationSchemeOptions
Héritage
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 est utilisée par le gestionnaire pour la cible de redirection lors de la gestion d’ForbidAsync.

ClaimsIssuer

Obtient ou définit l’émetteur qui doit être utilisé pour toutes les revendications créées

(Hérité de AuthenticationSchemeOptions)
Cookie

Détermine les paramètres utilisés pour créer le cookie.

CookieDomain
Obsolète.

Cette propriété est obsolète et sera supprimée dans une version ultérieure. L’alternative recommandée est sur Cookie.

Détermine le domaine utilisé pour créer le cookie. N'est pas fourni par défaut.

CookieHttpOnly
Obsolète.
Obsolète.

Cette propriété est obsolète et sera supprimée dans une version ultérieure. L’alternative recommandée est sur Cookie.

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
Obsolète.
Obsolète.

Cette propriété est obsolète et sera supprimée dans une version ultérieure. L’alternative recommandée est sur Cookie.

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 le gestionnaire d’authentification par cookie plusieurs fois.

CookiePath
Obsolète.

Cette propriété est obsolète et sera supprimée dans une version ultérieure. L’alternative recommandée est sur Cookie.

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
Obsolète.

Cette propriété est obsolète et sera supprimée dans une version ultérieure. L’alternative recommandée est sur Cookie.

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 CookieAuthenticationHandler pour la protection des données.

Events

Le Fournisseur peut être attribué à une instance d'objet créé par l'application au démarrage. Le gestionnaire 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.

EventsType

S’il est défini, sera utilisé comme type de service pour obtenir les instance d’événements au lieu de la propriété .

(Hérité de AuthenticationSchemeOptions)
ExpireTimeSpan

Contrôle la durée pendant laquelle le ticket d’authentification stocké dans le cookie restera valide à partir du moment où il est créé. Les informations d’expiration sont stockées dans le ticket de cookie protégé. Pour cette raison, un cookie expiré sera ignoré même s’il est passé au serveur après que le navigateur l’ait vidé.

Cette valeur est distincte de la valeur de Expires, qui spécifie la durée pendant laquelle le navigateur conservera le cookie.

ForwardAuthenticate

Si cette option est définie, elle spécifie le schéma cible auquel ce schéma doit transférer les appels AuthenticateAsync. Par exemple Context.AuthenticateAsync(« ThisScheme ») => Context.AuthenticateAsync(« ForwardAuthenticateValue »); Définissez la cible sur le schéma actuel pour désactiver le transfert et autoriser un traitement normal.

(Hérité de AuthenticationSchemeOptions)
ForwardChallenge

Si cette option est définie, elle spécifie le schéma cible auquel ce schéma doit transférer les appels ChallengeAsync. Par exemple Context.ChallengeAsync(« ThisScheme ») => Context.ChallengeAsync(« ForwardChallengeValue »); Définissez la cible sur le schéma actuel pour désactiver le transfert et autoriser un traitement normal.

(Hérité de AuthenticationSchemeOptions)
ForwardDefault

Si cette option est définie, elle spécifie un schéma par défaut auquel les gestionnaires d’authentification doivent transférer toutes les opérations d’authentification par défaut. La logique de transfert par défaut case activée d’abord le paramètre ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut le plus spécifique, suivi de ForwardDefaultSelector, puis de ForwardDefault. Le premier résultat non null sera utilisé comme schéma cible à transférer.

(Hérité de AuthenticationSchemeOptions)
ForwardDefaultSelector

Permet de sélectionner un schéma par défaut pour la demande actuelle à laquelle les gestionnaires d’authentification doivent transférer toutes les opérations d’authentification par défaut. La logique de transfert par défaut case activée d’abord le paramètre ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut le plus spécifique, suivi de ForwardDefaultSelector, puis de ForwardDefault. Le premier résultat non null sera utilisé comme schéma cible à transférer.

(Hérité de AuthenticationSchemeOptions)
ForwardForbid

Si cette option est définie, elle spécifie le schéma cible auquel ce schéma doit transférer les appels ForbidAsync. Par exemple Context.ForbidAsync(« ThisScheme ») => Context.ForbidAsync(« ForwardForbidValue »); Définissez la cible sur le schéma actuel pour désactiver le transfert et autoriser un traitement normal.

(Hérité de AuthenticationSchemeOptions)
ForwardSignIn

S’il est défini, spécifie le schéma cible auquel ce schéma doit transférer les appels SignInAsync. Par exemple Context.SignInAsync(« ThisScheme ») => Context.SignInAsync(« ForwardSignInValue »); Définissez la cible sur le schéma actuel pour désactiver le transfert et autoriser un traitement normal.

(Hérité de AuthenticationSchemeOptions)
ForwardSignOut

Si cette option est définie, elle spécifie le schéma cible auquel ce schéma doit transférer les appels SignOutAsync. Par exemple Context.SignOutAsync(« ThisScheme ») => Context.SignOutAsync(« ForwardSignOutValue »); Définissez la cible sur le schéma actuel pour désactiver le transfert et autoriser un traitement normal.

(Hérité de AuthenticationSchemeOptions)
LoginPath

La propriété LoginPath est utilisée par le gestionnaire pour la cible de redirection lors de la gestion de ChallengeAsync. URL actuelle qui est ajoutée à LoginPath en tant que paramètre de chaîne de requête nommé par 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’URL d’origine.

LogoutPath

Si logoutPath est fourni au gestionnaire, une requête vers ce chemin d’accès est redirigée en fonction de ReturnUrlParameter.

ReturnUrlParameter

ReturnUrlParameter détermine le nom du paramètre de chaîne de requête qui est ajouté par le gestionnaire lors d’un défi. 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

L’objet SlidingExpiration est défini sur true pour indiquer au gestionnaire de réécrire un nouveau cookie avec un nouveau délai d’expiration chaque fois qu’il traite une demande qui se trouve à plus de la moitié de la fenêtre d’expiration.

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 sera créé à l’aide de DataProtectionProvider.

TimeProvider

Utilisé pour les tests.

(Hérité de AuthenticationSchemeOptions)

Méthodes

Validate()

Vérifiez que les options sont valides. Doit lever une exception si les choses ne sont pas correctes.

(Hérité de AuthenticationSchemeOptions)
Validate(String)

Vérifie que les options sont valides pour un schéma spécifique

(Hérité de AuthenticationSchemeOptions)

S’applique à