53 lines
2.5 KiB
C#
53 lines
2.5 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.Security.Claims;
|
|
using System.Threading.Tasks;
|
|
using Microsoft.AspNetCore.Http;
|
|
|
|
namespace Microsoft.AspNetCore.Authentication
|
|
{
|
|
/// <summary>
|
|
/// Used to provide authentication.
|
|
/// </summary>
|
|
public interface IAuthenticationService
|
|
{
|
|
/// <summary>
|
|
/// Authenticate for the specified authentication scheme.
|
|
/// </summary>
|
|
/// <param name="context">The <see cref="HttpContext"/>.</param>
|
|
/// <param name="scheme">The name of the authentication scheme.</param>
|
|
/// <returns>The result.</returns>
|
|
Task<AuthenticateResult> AuthenticateAsync(HttpContext context, string scheme);
|
|
|
|
/// <summary>
|
|
/// Challenge the specified authentication scheme.
|
|
/// </summary>
|
|
/// <param name="context">The <see cref="HttpContext"/>.</param>
|
|
/// <param name="scheme">The name of the authentication scheme.</param>
|
|
/// <param name="properties">The <see cref="AuthenticationProperties"/>.</param>
|
|
/// <param name="behavior">The <see cref="ChallengeBehavior"/>.</param>
|
|
/// <returns>A task.</returns>
|
|
Task ChallengeAsync(HttpContext context, string scheme, AuthenticationProperties properties, ChallengeBehavior behavior);
|
|
|
|
/// <summary>
|
|
/// Sign a principal in for the specified authentication scheme.
|
|
/// </summary>
|
|
/// <param name="context">The <see cref="HttpContext"/>.</param>
|
|
/// <param name="scheme">The name of the authentication scheme.</param>
|
|
/// <param name="principal">The <see cref="ClaimsPrincipal"/> to sign in.</param>
|
|
/// <param name="properties">The <see cref="AuthenticationProperties"/>.</param>
|
|
/// <returns>A task.</returns>
|
|
Task SignInAsync(HttpContext context, string scheme, ClaimsPrincipal principal, AuthenticationProperties properties);
|
|
|
|
/// <summary>
|
|
/// Sign out the specified authentication scheme.
|
|
/// </summary>
|
|
/// <param name="context">The <see cref="HttpContext"/>.</param>
|
|
/// <param name="scheme">The name of the authentication scheme.</param>
|
|
/// <param name="properties">The <see cref="AuthenticationProperties"/>.</param>
|
|
/// <returns>A task.</returns>
|
|
Task SignOutAsync(HttpContext context, string scheme, AuthenticationProperties properties);
|
|
}
|
|
}
|