Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/graphql-dotnet/authorization
A toolset for authorizing access to graph types for GraphQL .NET.
https://github.com/graphql-dotnet/authorization
authorization graphql
Last synced: 7 days ago
JSON representation
A toolset for authorizing access to graph types for GraphQL .NET.
- Host: GitHub
- URL: https://github.com/graphql-dotnet/authorization
- Owner: graphql-dotnet
- License: mit
- Created: 2017-07-27T04:06:30.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-08-22T05:52:24.000Z (4 months ago)
- Last Synced: 2024-12-15T20:11:49.137Z (14 days ago)
- Topics: authorization, graphql
- Language: C#
- Homepage:
- Size: 360 KB
- Stars: 159
- Watchers: 13
- Forks: 38
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# GraphQL Authorization
[](LICENSE.md)
[](https://codecov.io/gh/graphql-dotnet/authorization)
[](https://www.nuget.org/packages/GraphQL.Authorization)
[](https://www.nuget.org/packages/GraphQL.Authorization)
[](https://github.com/graphql-dotnet/authorization/releases)
[](https://github.com/graphql-dotnet/authorization/commits/master)
[](https://github.com/graphql-dotnet/authorization/graphs/contributors)
A toolset for authorizing access to graph types for [GraphQL.NET](https://github.com/graphql-dotnet/graphql-dotnet).
Provides the following packages:
| Package | Downloads | NuGet Latest |
| --------------------- | ----------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| GraphQL.Authorization | [](https://www.nuget.org/packages/GraphQL.Authorization) | [](https://www.nuget.org/packages/GraphQL.Authorization) |
You can get all preview versions from [GitHub Packages](https://github.com/orgs/graphql-dotnet/packages?repo_name=authorization).
Note that GitHub requires authentication to consume the feed. See [here](https://docs.github.com/en/free-pro-team@latest/packages/publishing-and-managing-packages/about-github-packages#authenticating-to-github-packages).
# Usage
- Register the authorization classes in your DI container - call `AddAuthorization` on the provided `IGraphQLBuilder` inside `AddGraphQL` extension method.
- Provide the `ClaimsPrincipal` through `ExecutionOptions.User`.
- Add policies to the `AuthorizationSettings`.
- Apply a policy to a GraphType or Field - both implement `IProvideMetadata`:
- using `AuthorizeWithPolicy(string policy)` extension method
- or with `AuthorizeAttribute` attribute if using Schema + Handler syntax.
- The `AuthorizationValidationRule` will run and verify the policies based on the registered policies.
- You can write your own `IAuthorizationRequirement`.
# Limitations
`@skip` and `@include` directives are ignored; all selected fields of the selected operation will
be checked for authentication requirements, including referenced fragments. (Other operations
in the same document will correctly be skipped.)
This authorization framework only supports policy-based authorization. It does not support role-based authorization, or the
`[AllowAnonymous]` attribute/extension, or the `[Authorize]` attribute/extension indicating authorization is required
but without specifying a policy. It also does not integrate with ASP.NET Core's authorization framework.
The [GraphQL.Server](https://www.github.com/graphql-dotnet/server) repository contains an authorization rule which has the above
missing features, intended for use with ASP.NET Core. It may also be tailored with custom authentication code if desired, rather than
relying on ASP.NET Core's authentication framework.
# Examples
1. Fully functional basic [Console sample](src/BasicSample/Program.cs).
2. Fully functional [ASP.NET Core sample](src/Harness/Program.cs).
3. GraphType first syntax - use `AuthorizeWithPolicy` extension method on `IGraphType` or `IFieldType`.
```csharp
public class MyType : ObjectGraphType
{
public MyType()
{
this.AuthorizeWithPolicy("AdminPolicy");
Field("name").AuthorizeWithPolicy("SomePolicy");
}
}
```
4. Schema first syntax - use `AuthorizeAttribute` attribute on type, method or property.
```csharp
[Authorize("MyPolicy")]
public class MutationType
{
[Authorize("AnotherPolicy")]
public async Task CreateSomething(MyInput input)
{
return await SomeMethodAsync(input);
}
[Authorize("SuperPolicy")]
public string SomeProperty => Guid.NewGuid().ToString();
}
```
# Known Issues
- It is currently not possible to add a policy to Input objects using Schema first approach.