74 lines
2.6 KiB
C#
74 lines
2.6 KiB
C#
// Copyright (c) .NET Foundation. All rights reserved.
|
|
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
|
|
|
|
using System;
|
|
using System.Security.Claims;
|
|
using Microsoft.AspNetCore.Http;
|
|
|
|
namespace Microsoft.AspNetCore.Authentication.Cookies
|
|
{
|
|
/// <summary>
|
|
/// Context object passed to the CookieAuthenticationEvents ValidatePrincipal method.
|
|
/// </summary>
|
|
public class CookieValidatePrincipalContext : BaseCookieContext
|
|
{
|
|
/// <summary>
|
|
/// Creates a new instance of the context object.
|
|
/// </summary>
|
|
/// <param name="context"></param>
|
|
/// <param name="scheme"></param>
|
|
/// <param name="ticket">Contains the initial values for identity and extra data</param>
|
|
/// <param name="options"></param>
|
|
public CookieValidatePrincipalContext(HttpContext context, AuthenticationScheme scheme, AuthenticationTicket ticket, CookieAuthenticationOptions options)
|
|
: base(context, scheme, options, ticket?.Properties)
|
|
{
|
|
if (context == null)
|
|
{
|
|
throw new ArgumentNullException(nameof(context));
|
|
}
|
|
|
|
if (ticket == null)
|
|
{
|
|
throw new ArgumentNullException(nameof(ticket));
|
|
}
|
|
|
|
if (options == null)
|
|
{
|
|
throw new ArgumentNullException(nameof(options));
|
|
}
|
|
|
|
Principal = ticket.Principal;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Contains the claims principal arriving with the request. May be altered to change the
|
|
/// details of the authenticated user.
|
|
/// </summary>
|
|
public ClaimsPrincipal Principal { get; private set; }
|
|
|
|
/// <summary>
|
|
/// If true, the cookie will be renewed
|
|
/// </summary>
|
|
public bool ShouldRenew { get; set; }
|
|
|
|
/// <summary>
|
|
/// Called to replace the claims principal. The supplied principal will replace the value of the
|
|
/// Principal property, which determines the identity of the authenticated request.
|
|
/// </summary>
|
|
/// <param name="principal">The <see cref="ClaimsPrincipal"/> used as the replacement</param>
|
|
public void ReplacePrincipal(ClaimsPrincipal principal)
|
|
{
|
|
Principal = principal;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Called to reject the incoming principal. This may be done if the application has determined the
|
|
/// account is no longer active, and the request should be treated as if it was anonymous.
|
|
/// </summary>
|
|
public void RejectPrincipal()
|
|
{
|
|
Principal = null;
|
|
}
|
|
}
|
|
}
|