https://github.com/hawxy/auth0net.dependencyinjection
Dependency Injection, HttpClientFactory & ASP.NET Core extensions for Auth0.NET
https://github.com/hawxy/auth0net.dependencyinjection
asp auth0 auth0-api auth0-net grpc httpclient httpclientfactory
Last synced: 25 days ago
JSON representation
Dependency Injection, HttpClientFactory & ASP.NET Core extensions for Auth0.NET
- Host: GitHub
- URL: https://github.com/hawxy/auth0net.dependencyinjection
- Owner: Hawxy
- License: mit
- Created: 2020-11-17T13:04:04.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-05-12T14:35:33.000Z (12 months ago)
- Last Synced: 2025-06-18T21:43:42.086Z (10 months ago)
- Topics: asp, auth0, auth0-api, auth0-net, grpc, httpclient, httpclientfactory
- Language: C#
- Homepage:
- Size: 202 KB
- Stars: 48
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Auth0.NET Dependency Injection Extensions
[](https://www.nuget.org/packages/Auth0Net.DependencyInjection)
[](https://www.nuget.org/packages/Auth0Net.DependencyInjection)
Integrating [Auth0.NET](https://github.com/auth0/auth0.net) into your project whilst following idiomatic .NET conventions can be cumbersome and involve a sizable amount of boilerplate shared between projects.
This library hopes to solve that problem, featuring:
:white_check_mark: Extensions for `Microsoft.Extensions.DependencyInjection`.
:white_check_mark: Automatic access token caching & renewal for the Management API and your own REST & Grpc services
:white_check_mark: [HttpClientFactory](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/http-requests) integration for centralized extensibility and management of the internal HTTP handlers.
:white_check_mark: `IHttpClientBuilder` extensions, providing handlers to automatically append access tokens to outgoing requests.
This library is compatible with .NET 8+ as well as .NET Framework 4.8 and is suitable for use in ASP.NET Core and standalone .NET Generic Host applications.
## Install
Add `Auth0Net.DependencyInjection` to your project:
```
dotnet add package Auth0Net.DependencyInjection
```
## Scenarios
### Authentication Client Only
If you're simply using the `AuthenticationApiClient` and nothing else, you can call `AddAuth0AuthenticationClient` and pass in your Auth0 Domain. This integration is lightweight and does not support any other features of this library.
```csharp
services.AddAuth0AuthenticationClient("your-auth0-domain.auth0.com");
```
You can then request the `IAuthenticationApiClient` within your class:
```csharp
public class AuthController : ControllerBase
{
private readonly IAuthenticationApiClient _authenticationApiClient;
public AuthController(IAuthenticationApiClient authenticationApiClient)
{
_authenticationApiClient = authenticationApiClient;
}
```
### Authentication Client + Management Client
Add the `AuthenticationApiClient` with `AddAuth0AuthenticationClient`, and provide a [machine-to-machine application](https://auth0.com/docs/applications/set-up-an-application/register-machine-to-machine-applications) configuration that will be consumed by the Management Client, Token Cache and IHttpClientBuilder integrations. This extension **must** be called before using any other extensions within this library:
```csharp
services.AddAuth0AuthenticationClient(config =>
{
config.Domain = builder.Configuration["Auth0:Domain"];
config.ClientId = builder.Configuration["Auth0:ClientId"];
config.ClientSecret = builder.Configuration["Auth0:ClientSecret"];
});
```
Add the `ManagementApiClient` with `AddAuth0ManagementClient()`. The client will attach the Access Token automatically:
```csharp
services.AddAuth0ManagementClient();
```
Ensure your Machine-to-Machine application is authorized to request tokens from the Managment API and it has the correct scopes for the features you wish to use.
You can then request the `IManagementApiClient` (or `IAuthenticationApiClient`) within your services:
```csharp
public class MyAuth0Service : IAuth0Service
{
private readonly IManagementApiClient _managementApiClient;
public MyAuth0Service(IManagementApiClient managementApiClient)
{
_managementApiClient = managementApiClient;
}
```
#### Handling Custom Domains
If you're using a custom domain with your Auth0 tenant, and it's being specified when calling `AddAuth0AuthenticationClient`, you will run into a problem whereby the `audience` of the Management API is being incorrectly set. You can override this via the `Audience` property:
```cs
services.AddAuth0ManagementClient(c =>
{
// Set the audience to your default Auth0 domain.
c.Audience = "my-tenant.au.auth0.com";
});
```
### External HttpClient & Grpc Services (Machine-To-Machine Tokens)
**Note:** This feature relies on `services.AddAuth0AuthenticationClient(config => ...)` being called and configured as outlined in the previous section.
This library includes a delegating handler - effectively middleware for your HttpClient - that will append an access token to all outbound requests. This is useful for calling other services that are protected by Auth0. This integration requires your service implementation to use `IHttpClientFactory` as part of its registration. You can read more about it [here](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/http-requests)
#### HttpClient
Use `AddAccessToken` along with the required audience:
```csharp
services.AddHttpClient(x => x.BaseAddress = new Uri(builder.Configuration["MyHttpService:Url"]))
.AddAccessToken(config => config.Audience = builder.Configuration["MyHttpService:Audience"]);
```
#### Grpc
This extension is compatible with any registration that returns a `IHttpClientBuilder`, thus it can be used with [Grpc's client factory](https://docs.microsoft.com/en-us/aspnet/core/grpc/clientfactory):
```csharp
services.AddGrpcClient(x => x.Address = new Uri(builder.Configuration["MyGrpcService:Url"]))
.AddAccessToken(config => config.Audience = builder.Configuration["MyGrpcService:Audience"]);
```
#### Advanced
`AddAccessToken` also has an option for passing in a func that can resolve the audience at runtime. This can be useful if your expected audiences always follow a pattern, or if you rely on service discovery, such as from [Steeltoe.NET](https://docs.steeltoe.io/api/v3/discovery/discovering-services.html):
```csharp
services.AddHttpClient(x=> x.BaseAddress = new Uri("https://MyServiceName/"))
.AddServiceDiscovery()
.AddAccessToken(config => config.AudienceResolver = request => request.RequestUri.GetLeftPart(UriPartial.Authority));
```
### M2M Organizations Support
This library includes support for [Machine-to-Machine (M2M) Access for Organizations](https://auth0.com/docs/manage-users/organizations/organizations-for-m2m-applications), including static and dynamic scenarios.
This feature is important if your internal or third-party services expect a token to be scoped to a specific Auth0 organization.
Orgs support must be enabled for your combination of client/api/org(s) before usage.
#### Static Organization
Clients that simply require a single organization for a specific client can do so via setting the `Organization` property when configuring the access token:
```csharp
builder.Services
.AddGrpcClient(x => x.Address = new Uri(builder.Configuration["MyApi:Url"]!))
.AddAccessToken(config =>
{
config.Audience = builder.Configuration["MyApi:Audience"];
config.Organization = builder.Configuration["MyApi:Organization"];
});
```
#### Dynamic Organization via Request Metadata
If you already include org metadata as part of your network request or via the request options and would like to easily migrate to Org-scoped tokens, you can choose to resolve the organization at runtime via the `OrganizationResolver`:
```csharp
builder.Services
.AddGrpcClient(x => x.Address = new Uri(builder.Configuration["MyApi:Url"]!))
.AddAccessToken(config =>
{
config.Audience = builder.Configuration["MyApi:Audience"];
config.OrganizationResolver = x =>
x.Headers.TryGetValues("org-id", out var values)
? values.SingleOrDefault()
: null;
});
```
#### Dynamic Organization via Client Scope (Experimental)
If your organization source is scoped to the usage of your service, such as an ASP.NET Core request, then you'll want the ability to freely set the Organization.
You can achieve this by injecting your client via `OrganizationScopeFactory` and then creating an organization scope via `.CreateScope`:
```csharp
// Inject the factory around your remote client
private readonly OrganizationScopeFactory _scopeFactory;
public QueryUsersService(OrganizationScopeFactory scopeFactory)
{
_scopeFactory = scopeFactory;
}
public async Task CreateUserAsync(User user, string orgId)
{
// Create the scope so the MTM token is generated with the current OrgId
using var orgScope = _scopeFactory.CreateScope(orgId);
await orgScope.Client.CreateUser(user, stoppingToken);
}
```
ALWAYS ensure you dispose of the scope when finished.
There's a few limitations if you're using this functionality, as it uses `AsyncLocal` internally:
- Never use multiple client scopes at the same time, either with the same or different client types. This will throw an exception.
- Never call any other client that utilizes `.AddAccessToken` within a client scope. This may cause the wrong Organization ID/Name being used for a given request.
If you have a use-case for either of these items, please open an issue with an example.
This functionality is marked as experimental, and you must `#pragma warning disable AUTH0_EXPERIMENTAL` to use it.
## Additional Functionality
### Utility
This library exposes a simple string extension, `ToHttpsUrl()`, that can be used to format the naked Auth0 domain sitting in your configuration into a proper URL.
This is identical to `https://{Configuration["Auth0:Domain"]}/` that you usually end up writing _somewhere_ in your `Program.cs`.
For example, formatting the domain for the JWT Authority:
```csharp
.AddJwtBearer(options =>
{
// "my-tenant.auth0.com" -> "https://my-tenant.auth0.com/"
options.Authority = builder.Configuration["Auth0:Domain"].ToHttpsUrl();
//...
});
```
## Internals
### Client Lifetimes
Both the authentication and authorization clients are registered as singletons and are suitable for injection into any other lifetime.
### Samples
Both a .NET Generic Host and ASP.NET Core examples are available in the [samples](https://github.com/Hawxy/Auth0Net.DependencyInjection/tree/main/samples) directory.
### Internal Cache
The `Auth0TokenCache` will cache a token for a given audience until at least 95% of the expiry time. If a request to the cache is made between 95% and 99% of expiry, the token will be refreshed in the background before expiry is reached.
An additional 1% of lifetime is removed to protect against clock drift between distributed systems.
In some situations you might want to request an access token from Auth0 manually. You can achieve this by injecting `IAuth0TokenCache` into a class and calling `GetTokenAsync` with the audience of the API you're requesting the token for.
An in-memory-only instance of [FusionCache](https://github.com/ZiggyCreatures/FusionCache) is used as the caching implementation. This instance is _named_ and will not impact other usages of FusionCache.
If you want to use your own implementation of FusionCache, specify `FusionCacheInstance` when configurating the authentication client:
```csharp
services.AddAuth0AuthenticationClient(x =>
{
//...
// Use the default FusionCache instance registered via `.AddFusionCache()`
x.FusionCacheInstance = FusionCacheOptions.DefaultCacheName
});
```
## Disclaimer
I am not affiliated with nor represent Auth0. All implementation issues regarding the underlying `ManagementApiClient` and `AuthenticationApiClient` should go to the official [Auth0.NET Respository](https://github.com/auth0/auth0.net).
### License notices
Icons used under the [MIT License](https://github.com/auth0/identicons/blob/master/LICENSE) from the [Identicons](https://github.com/auth0/identicons) pack.