AspNetCore.Docs/aspnetcore/security/authorization/resourcebased.md

139 lines
7.8 KiB
Markdown
Raw Normal View History

2016-10-29 01:35:15 +08:00
---
title: Resource-based authorization in ASP.NET Core
author: scottaddie
description: Learn how to implement resource-based authorization in an ASP.NET Core app when an Authorize attribute won't suffice.
ms.author: scaddie
ms.custom: mvc
ms.date: 11/15/2018
2016-10-29 01:35:15 +08:00
uid: security/authorization/resourcebased
---
# Resource-based authorization in ASP.NET Core
2016-10-29 01:35:15 +08:00
Authorization strategy depends upon the resource being accessed. Consider a document that has an author property. Only the author is allowed to update the document. Consequently, the document must be retrieved from the data store before authorization evaluation can occur.
2016-10-29 01:35:15 +08:00
Attribute evaluation occurs before data binding and before execution of the page handler or action that loads the document. For these reasons, declarative authorization with an `[Authorize]` attribute doesn't suffice. Instead, you can invoke a custom authorization method—a style known as *imperative authorization*.
2016-10-29 01:35:15 +08:00
[View or download sample code](https://github.com/aspnet/AspNetCore.Docs/tree/master/aspnetcore/security/authorization/resourcebased/samples) ([how to download](xref:index#how-to-download-a-sample)).
2016-10-29 01:35:15 +08:00
[Create an ASP.NET Core app with user data protected by authorization](xref:security/authorization/secure-data) contains a sample app that uses resource-based authorization.
## Use imperative authorization
Authorization is implemented as an [IAuthorizationService](/dotnet/api/microsoft.aspnetcore.authorization.iauthorizationservice) service and is registered in the service collection within the `Startup` class. The service is made available via [dependency injection](xref:fundamentals/dependency-injection) to page handlers or actions.
2016-10-29 01:35:15 +08:00
[!code-csharp[](resourcebased/samples/ResourceBasedAuthApp2/Controllers/DocumentController.cs?name=snippet_IAuthServiceDI&highlight=6)]
`IAuthorizationService` has two `AuthorizeAsync` method overloads: one accepting the resource and the policy name and the other accepting the resource and a list of requirements to evaluate.
2016-10-29 01:35:15 +08:00
::: moniker range=">= aspnetcore-2.0"
```csharp
Task<AuthorizationResult> AuthorizeAsync(ClaimsPrincipal user,
object resource,
IEnumerable<IAuthorizationRequirement> requirements);
Task<AuthorizationResult> AuthorizeAsync(ClaimsPrincipal user,
object resource,
string policyName);
```
::: moniker-end
::: moniker range="<= aspnetcore-1.1"
2016-11-18 13:03:07 +08:00
```csharp
2016-10-29 01:35:15 +08:00
Task<bool> AuthorizeAsync(ClaimsPrincipal user,
object resource,
IEnumerable<IAuthorizationRequirement> requirements);
Task<bool> AuthorizeAsync(ClaimsPrincipal user,
object resource,
string policyName);
```
2016-10-29 01:35:15 +08:00
::: moniker-end
2017-10-14 04:50:30 +08:00
<a name="security-authorization-resource-based-imperative"></a>
2016-10-29 01:35:15 +08:00
In the following example, the resource to be secured is loaded into a custom `Document` object. An `AuthorizeAsync` overload is invoked to determine whether the current user is allowed to edit the provided document. A custom "EditPolicy" authorization policy is factored into the decision. See [Custom policy-based authorization](xref:security/authorization/policies) for more on creating authorization policies.
2016-10-29 01:35:15 +08:00
> [!NOTE]
> The following code samples assume authentication has run and set the `User` property.
2016-10-29 01:35:15 +08:00
::: moniker range=">= aspnetcore-2.0"
2018-05-11 08:58:40 +08:00
[!code-csharp[](resourcebased/samples/ResourceBasedAuthApp2/Pages/Document/Edit.cshtml.cs?name=snippet_DocumentEditHandler)]
2016-10-29 01:35:15 +08:00
::: moniker-end
::: moniker range="<= aspnetcore-1.1"
2018-05-11 08:58:40 +08:00
[!code-csharp[](resourcebased/samples/ResourceBasedAuthApp1/Controllers/DocumentController.cs?name=snippet_DocumentEditAction)]
2016-10-29 01:35:15 +08:00
::: moniker-end
2018-05-11 08:58:40 +08:00
## Write a resource-based handler
2016-10-29 01:35:15 +08:00
Writing a handler for resource-based authorization isn't much different than [writing a plain requirements handler](xref:security/authorization/policies#security-authorization-policies-based-authorization-handler). Create a custom requirement class, and implement a requirement handler class. For more information on creating a requirement class, see [Requirements](xref:security/authorization/policies#requirements).
The handler class specifies both the requirement and resource type. For example, a handler utilizing a `SameAuthorRequirement` and a `Document` resource follows:
2016-10-29 01:35:15 +08:00
::: moniker range=">= aspnetcore-2.0"
2018-05-11 08:58:40 +08:00
[!code-csharp[](resourcebased/samples/ResourceBasedAuthApp2/Services/DocumentAuthorizationHandler.cs?name=snippet_HandlerAndRequirement)]
2016-10-29 01:35:15 +08:00
::: moniker-end
::: moniker range="<= aspnetcore-1.1"
2018-05-11 08:58:40 +08:00
[!code-csharp[](resourcebased/samples/ResourceBasedAuthApp1/Services/DocumentAuthorizationHandler.cs?name=snippet_HandlerAndRequirement)]
2016-10-29 01:35:15 +08:00
::: moniker-end
In the preceding example, imagine that `SameAuthorRequirement` is a special case of a more generic `SpecificAuthorRequirement` class. The `SpecificAuthorRequirement` class (not shown) contains a `Name` property representing the name of the author. The `Name` property could be set to the current user.
2018-05-11 08:58:40 +08:00
Register the requirement and handler in `Startup.ConfigureServices`:
2016-10-29 01:35:15 +08:00
[!code-csharp[](resourcebased/samples/ResourceBasedAuthApp2/Startup.cs?name=snippet_ConfigureServicesSample&highlight=3-7,9)]
### Operational requirements
2018-05-11 08:58:40 +08:00
If you're making decisions based on the outcomes of CRUD (Create, Read, Update, Delete) operations, use the [OperationAuthorizationRequirement](/dotnet/api/microsoft.aspnetcore.authorization.infrastructure.operationauthorizationrequirement) helper class. This class enables you to write a single handler instead of an individual class for each operation type. To use it, provide some operation names:
[!code-csharp[](resourcebased/samples/ResourceBasedAuthApp2/Services/DocumentAuthorizationCrudHandler.cs?name=snippet_OperationsClass)]
The handler is implemented as follows, using an `OperationAuthorizationRequirement` requirement and a `Document` resource:
::: moniker range=">= aspnetcore-2.0"
2018-05-11 08:58:40 +08:00
[!code-csharp[](resourcebased/samples/ResourceBasedAuthApp2/Services/DocumentAuthorizationCrudHandler.cs?name=snippet_Handler)]
::: moniker-end
::: moniker range="<= aspnetcore-1.1"
2018-05-11 08:58:40 +08:00
[!code-csharp[](resourcebased/samples/ResourceBasedAuthApp1/Services/DocumentAuthorizationCrudHandler.cs?name=snippet_Handler)]
::: moniker-end
2018-05-11 08:58:40 +08:00
The preceding handler validates the operation using the resource, the user's identity, and the requirement's `Name` property.
To call an operational resource handler, specify the operation when invoking `AuthorizeAsync` in your page handler or action. The following example determines whether the authenticated user is permitted to view the provided document.
> [!NOTE]
> The following code samples assume authentication has run and set the `User` property.
::: moniker range=">= aspnetcore-2.0"
2018-05-11 08:58:40 +08:00
[!code-csharp[](resourcebased/samples/ResourceBasedAuthApp2/Pages/Document/View.cshtml.cs?name=snippet_DocumentViewHandler&highlight=10-11)]
If authorization succeeds, the page for viewing the document is returned. If authorization fails but the user is authenticated, returning `ForbidResult` informs any authentication middleware that authorization failed. A `ChallengeResult` is returned when authentication must be performed. For interactive browser clients, it may be appropriate to redirect the user to a login page.
::: moniker-end
::: moniker range="<= aspnetcore-1.1"
2018-05-11 08:58:40 +08:00
[!code-csharp[](resourcebased/samples/ResourceBasedAuthApp1/Controllers/DocumentController.cs?name=snippet_DocumentViewAction&highlight=11-12)]
If authorization succeeds, the view for the document is returned. If authorization fails, returning `ChallengeResult` informs any authentication middleware that authorization failed, and the middleware can take the appropriate response. An appropriate response could be returning a 401 or 403 status code. For interactive browser clients, it could mean redirecting the user to a login page.
::: moniker-end