| File: AssertionRequirement.cs | Web Access |
| Project: src\aspnetcore\src\Security\Authorization\Core\src\Microsoft.AspNetCore.Authorization.csproj (Microsoft.AspNetCore.Authorization) |
// Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. using System; using System.Threading.Tasks; using Microsoft.AspNetCore.Shared; namespace Microsoft.AspNetCore.Authorization.Infrastructure; /// <summary> /// Implements an <see cref="IAuthorizationHandler"/> and <see cref="IAuthorizationRequirement"/> /// that takes a user specified assertion. /// </summary> public class AssertionRequirement : IAuthorizationHandler, IAuthorizationRequirement { /// <summary> /// Function that is called to handle this requirement. /// </summary> public Func<AuthorizationHandlerContext, Task<bool>> Handler { get; } /// <summary> /// Creates a new instance of <see cref="AssertionRequirement"/>. /// </summary> /// <param name="handler">Function that is called to handle this requirement.</param> public AssertionRequirement(Func<AuthorizationHandlerContext, bool> handler) { ArgumentNullThrowHelper.ThrowIfNull(handler); Handler = context => Task.FromResult(handler(context)); } /// <summary> /// Creates a new instance of <see cref="AssertionRequirement"/>. /// </summary> /// <param name="handler">Function that is called to handle this requirement.</param> public AssertionRequirement(Func<AuthorizationHandlerContext, Task<bool>> handler) { ArgumentNullThrowHelper.ThrowIfNull(handler); Handler = handler; } /// <summary> /// Calls <see cref="AssertionRequirement.Handler"/> to see if authorization is allowed. /// </summary> /// <param name="context">The authorization information.</param> public async Task HandleAsync(AuthorizationHandlerContext context) { if (await Handler(context).ConfigureAwait(false)) { context.Succeed(this); } } /// <summary> /// Returns a string representation of the requirement. /// </summary> /// <returns>A description of the assertion requirement.</returns> public override string ToString() { return $"{nameof(Handler)} assertion should evaluate to true."; } }