diff options
Diffstat (limited to 'src/Security/src/Microsoft.AspNetCore.Authorization/AuthorizationHandlerContext.cs')
| -rw-r--r-- | src/Security/src/Microsoft.AspNetCore.Authorization/AuthorizationHandlerContext.cs | 98 |
1 files changed, 98 insertions, 0 deletions
diff --git a/src/Security/src/Microsoft.AspNetCore.Authorization/AuthorizationHandlerContext.cs b/src/Security/src/Microsoft.AspNetCore.Authorization/AuthorizationHandlerContext.cs new file mode 100644 index 0000000000..b6378e4073 --- /dev/null +++ b/src/Security/src/Microsoft.AspNetCore.Authorization/AuthorizationHandlerContext.cs @@ -0,0 +1,98 @@ +// 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.Collections.Generic; +using System.Linq; +using System.Security.Claims; + +namespace Microsoft.AspNetCore.Authorization +{ + /// <summary> + /// Contains authorization information used by <see cref="IAuthorizationHandler"/>. + /// </summary> + public class AuthorizationHandlerContext + { + private HashSet<IAuthorizationRequirement> _pendingRequirements; + private bool _failCalled; + private bool _succeedCalled; + + /// <summary> + /// Creates a new instance of <see cref="AuthorizationHandlerContext"/>. + /// </summary> + /// <param name="requirements">A collection of all the <see cref="IAuthorizationRequirement"/> for the current authorization action.</param> + /// <param name="user">A <see cref="ClaimsPrincipal"/> representing the current user.</param> + /// <param name="resource">An optional resource to evaluate the <paramref name="requirements"/> against.</param> + public AuthorizationHandlerContext( + IEnumerable<IAuthorizationRequirement> requirements, + ClaimsPrincipal user, + object resource) + { + if (requirements == null) + { + throw new ArgumentNullException(nameof(requirements)); + } + + Requirements = requirements; + User = user; + Resource = resource; + _pendingRequirements = new HashSet<IAuthorizationRequirement>(requirements); + } + + /// <summary> + /// The collection of all the <see cref="IAuthorizationRequirement"/> for the current authorization action. + /// </summary> + public virtual IEnumerable<IAuthorizationRequirement> Requirements { get; } + + /// <summary> + /// The <see cref="ClaimsPrincipal"/> representing the current user. + /// </summary> + public virtual ClaimsPrincipal User { get; } + + /// <summary> + /// The optional resource to evaluate the <see cref="AuthorizationHandlerContext.Requirements"/> against. + /// </summary> + public virtual object Resource { get; } + + /// <summary> + /// Gets the requirements that have not yet been marked as succeeded. + /// </summary> + public virtual IEnumerable<IAuthorizationRequirement> PendingRequirements { get { return _pendingRequirements; } } + + /// <summary> + /// Flag indicating whether the current authorization processing has failed. + /// </summary> + public virtual bool HasFailed { get { return _failCalled; } } + + /// <summary> + /// Flag indicating whether the current authorization processing has succeeded. + /// </summary> + public virtual bool HasSucceeded + { + get + { + return !_failCalled && _succeedCalled && !PendingRequirements.Any(); + } + } + + /// <summary> + /// Called to indicate <see cref="AuthorizationHandlerContext.HasSucceeded"/> will + /// never return true, even if all requirements are met. + /// </summary> + public virtual void Fail() + { + _failCalled = true; + } + + /// <summary> + /// Called to mark the specified <paramref name="requirement"/> as being + /// successfully evaluated. + /// </summary> + /// <param name="requirement">The requirement whose evaluation has succeeded.</param> + public virtual void Succeed(IAuthorizationRequirement requirement) + { + _succeedCalled = true; + _pendingRequirements.Remove(requirement); + } + } +}
\ No newline at end of file |