Export (0) Print
Expand All

ClaimsAuthorizationManager.CheckAccess Method

.NET Framework 4.5

When implemented in a derived class, checks authorization for the subject in the specified context to perform the specified action on the specified resource.

Namespace:  System.Security.Claims
Assembly:  System.IdentityModel (in System.IdentityModel.dll)

public virtual bool CheckAccess(
	AuthorizationContext context
)

Parameters

context
Type: System.Security.Claims.AuthorizationContext

The authorization context that contains the subject, resource, and action for which authorization is to be checked.

Return Value

Type: System.Boolean
true if the subject is authorized to perform the specified action on the specified resource; otherwise, false.

The base implementation always returns true, which authorizes access. You can override this method in a derived class to authorize access based on the requirements of your RP application. If this method returns false, Windows Identity Foundation (WIF) returns an unauthorized error to the caller; otherwise, execution is passed to the RP application.

The code examples that are used in the ClaimsAuthorizationManager topics are taken from the Claims Based Authorization sample. This sample provides a custom claims authorization manager that can authorize subjects based on a policy that is specified in configuration. The custom claims authorization manager consists of three basic components: a class derived from ClaimsAuthorizationManager that implements the manager, the ResourceAction class that pairs a resource and an action, and a policy reader that reads and compiles policy that is specified in the configuration file. This compiled policy can then be used by the claims authorization manager to evaluate a principal in order to authorize access to resources. Not all elements are shown for the sake of brevity. For information about this sample and other samples available for WIF and about where to download them, see WIF Code Sample Index.

The following code shows the override of the CheckAccess method. This method grants or denies access based on a policy read and compiled from the configuration file.

static Dictionary<ResourceAction, Func<ClaimsPrincipal, bool>> _policies = new Dictionary<ResourceAction, Func<ClaimsPrincipal, bool>>();
PolicyReader _policyReader = new PolicyReader();


...


    /// <summary> 
    /// Checks if the principal specified in the authorization context is authorized to perform action specified in the authorization context  
    /// on the specified resoure 
    /// </summary> 
    /// <param name="pec">Authorization context</param>
    /// <returns>true if authorized, false otherwise</returns> 
    public override bool CheckAccess(AuthorizationContext pec)
    {
        // 
        // Evaluate the policy against the claims of the  
        // principal to determine access 
        // 
        bool access = false;
        try
        {
            ResourceAction ra = new ResourceAction(pec.Resource.First<Claim>().Value, pec.Action.First<Claim>().Value);

            access = _policies[ra](pec.Principal);
        }
        catch (Exception)
        {
            access = false;
        }

        return access;
    }
}

The following code shows the ResourceAction class used by the custom claims manager.


using System;

namespace ClaimsAuthorizationLibrary
{
    /// <summary> 
    /// Class to encapsulate resource/action pair 
    /// </summary> 
    public class ResourceAction
    {
        public string Resource;
        public string Action;

        /// <summary> 
        /// Checks if the current instance is equal to the given object by comparing the resource and action values 
        /// </summary> 
        /// <param name="obj">object to compare to</param>
        /// <returns>True if equal, else false.</returns> 
        public override bool Equals(object obj)
        {
            ResourceAction ra = obj as ResourceAction;
            if (ra != null)
            {
                return ((string.Compare(ra.Resource, Resource, true) == 0) && (string.Compare(ra.Action, Action, true) == 0));
            }

            return base.Equals(obj);
        }

        /// <summary> 
        /// Gets the hash code. 
        /// </summary> 
        /// <returns>The hash code.</returns> 
        public override int GetHashCode()
        {
            return (Resource + Action).ToLower().GetHashCode();
        }

        /// <summary> 
        /// Creates an instance of ResourceAction class. 
        /// </summary> 
        /// <param name="resource">The resource name.</param>
        /// <param name="action">The action.</param>
        /// <exception cref="ArgumentNullException">when <paramref name="resource"/> is null</exception>
        public ResourceAction(string resource, string action)
        {
            if (string.IsNullOrEmpty(resource))
            {
                throw new ArgumentNullException("resource");
            }

            Resource = resource;
            Action = action;
        }
    }
}

The policy used by the claims authorization manager is specified by custom <policy> elements under the <claimsAuthorizationManager> element. This policy is read and compiled by the LoadCustomConfiguration method. In the first policy, the principal must possess one of the specified claims in order to perform the specified action on the specified resource. In the second policy, the principal must possess both claims to be able to perform the specified action on the specified resource. In all others, the principal is automatically granted access regardless of the claims it possesses.

  <system.identityModel>
    <identityConfiguration>
      <claimsAuthorizationManager type="ClaimsAuthorizationLibrary.MyClaimsAuthorizationManager, ClaimsAuthorizationLibrary">
        <policy resource="http://localhost:28491/Developers.aspx" action="GET">
          <or>
            <claim claimType="http://schemas.microsoft.com/ws/2008/06/identity/claims/role" claimValue="developer" />
            <claim claimType="http://schemas.xmlsoap.org/claims/Group" claimValue="Administrator" />
          </or>
        </policy>
        <policy resource="http://localhost:28491/Administrators.aspx" action="GET">
          <and>
            <claim claimType="http://schemas.xmlsoap.org/claims/Group" claimValue="Administrator" />
            <claim claimType="http://schemas.xmlsoap.org/ws/2005/05/identity/claims/country" claimValue="USA" />
          </and>
        </policy>
        <policy resource="http://localhost:28491/Default.aspx" action="GET">
        </policy>
        <policy resource="http://localhost:28491/" action="GET">
        </policy>
        <policy resource="http://localhost:28491/Claims.aspx" action="GET">
        </policy>
      </claimsAuthorizationManager>
      
      ...
            
    </identityConfiguration>
  </system.identityModel>

.NET Framework

Supported in: 4.6, 4.5
Show:
© 2015 Microsoft