// 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.Linq;
using System.Security.Claims;
using System.Threading.Tasks;
namespace Microsoft.AspNetCore.Authorization
{
///
/// Extension methods for .
///
public static class AuthorizationServiceExtensions
{
///
/// Checks if a user meets a specific requirement for the specified resource
///
/// The providing authorization.
/// The user to evaluate the policy against.
/// The resource to evaluate the policy against.
/// The requirement to evaluate the policy against.
///
/// A flag indicating whether requirement evaluation has succeeded or failed.
/// This value is true when the user fulfills the policy, otherwise false.
///
public static Task AuthorizeAsync(this IAuthorizationService service, ClaimsPrincipal user, object resource, IAuthorizationRequirement requirement)
{
if (service == null)
{
throw new ArgumentNullException(nameof(service));
}
if (requirement == null)
{
throw new ArgumentNullException(nameof(requirement));
}
return service.AuthorizeAsync(user, resource, new IAuthorizationRequirement[] { requirement });
}
///
/// Checks if a user meets a specific authorization policy against the specified resource.
///
/// The providing authorization.
/// The user to evaluate the policy against.
/// The resource to evaluate the policy against.
/// The policy to evaluate.
///
/// A flag indicating whether policy evaluation has succeeded or failed.
/// This value is true when the user fulfills the policy, otherwise false.
///
public static Task AuthorizeAsync(this IAuthorizationService service, ClaimsPrincipal user, object resource, AuthorizationPolicy policy)
{
if (service == null)
{
throw new ArgumentNullException(nameof(service));
}
if (policy == null)
{
throw new ArgumentNullException(nameof(policy));
}
return service.AuthorizeAsync(user, resource, policy.Requirements.ToArray());
}
///
/// Checks if a user meets a specific authorization policy against the specified resource.
///
/// The providing authorization.
/// The user to evaluate the policy against.
/// The policy to evaluate.
///
/// A flag indicating whether policy evaluation has succeeded or failed.
/// This value is true when the user fulfills the policy, otherwise false.
///
public static Task AuthorizeAsync(this IAuthorizationService service, ClaimsPrincipal user, AuthorizationPolicy policy)
{
if (service == null)
{
throw new ArgumentNullException(nameof(service));
}
if (policy == null)
{
throw new ArgumentNullException(nameof(policy));
}
return service.AuthorizeAsync(user, resource: null, policy: policy);
}
///
/// Checks if a user meets a specific authorization policy against the specified resource.
///
/// The providing authorization.
/// The user to evaluate the policy against.
/// The name of the policy to evaluate.
///
/// A flag indicating whether policy evaluation has succeeded or failed.
/// This value is true when the user fulfills the policy, otherwise false.
///
public static Task AuthorizeAsync(this IAuthorizationService service, ClaimsPrincipal user, string policyName)
{
if (service == null)
{
throw new ArgumentNullException(nameof(service));
}
if (policyName == null)
{
throw new ArgumentNullException(nameof(policyName));
}
return service.AuthorizeAsync(user, resource: null, policyName: policyName);
}
}
}