Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samhammerag/oauth2authenticator
OAuth2 client for obtaining and refreshing of access tokens.
https://github.com/samhammerag/oauth2authenticator
csharp dotnet oauth2 oauth2-client token-management
Last synced: about 1 month ago
JSON representation
OAuth2 client for obtaining and refreshing of access tokens.
- Host: GitHub
- URL: https://github.com/samhammerag/oauth2authenticator
- Owner: SamhammerAG
- License: apache-2.0
- Created: 2022-05-19T10:22:34.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-08T12:34:26.000Z (3 months ago)
- Last Synced: 2024-11-08T09:48:32.193Z (2 months ago)
- Topics: csharp, dotnet, oauth2, oauth2-client, token-management
- Language: C#
- Homepage:
- Size: 66.4 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OAuth2Authenticator
[](https://github.com/SamhammerAG/OAuth2Authenticator)
OAuth2 client for retrieving OAuth2 tokens and common token handling logic such as refresh and client credentials.
[Nuget Package](https://www.nuget.org/packages/OAuth2Authenticator)
## Currently supported grant types
* [Password](https://oauth.net/2/grant-types/password/)
* [Refresh Token](https://oauth.net/2/grant-types/refresh-token/)
* [Client Credentials](https://oauth.net/2/grant-types/client-credentials/)
## Setup
Initialize the client service in the application startup.
```cs
public void ConfigureServices(IServiceCollection services)
{
services.InitOAuth2Authenticator();
}
```
## Usage
### OAuth2Authenticator
This class holds the request logic for all OAuth2 grant types. Injectable over the `IOAuth2Authenticator` interface.
```cs
private readonly IOAuth2Authenticator _authenticator;
await _authenticator.PasswordGrant(url, clientId, username, password);
await _authenticator.RefreshTokenGrant(url, clientId, refreshToken);
await _authenticator.ClientCredentialsGrant(url, clientId, clientSecret);
```
After the request, a `OAuth2TokenResponse` or `null` returns.
### OAuth2TokenHandler
This class holds common logic which is needed for token handling. Injectable over the `IOAuth2TokenHandler` interface.
#### RefreshHandler
The refresh handler checks whether the access token is about to expire or has already expired and automatically attempts to renew the token with the refresh token. If a renewal with the refresh token is not possible, a new token is retrieved via the specified callback. The handler always attempts to return a valid token.
```cs
private readonly IOAuth2TokenHandler _handler;
private static OAuth2TokenResponse token; // Save the last token somewhere static or distributed.
token = await _handler.RefreshHandler(
token,
url,
clientId,
async (url, clientId, cancellationToken) =>
{
// Is executed to obtain a new token if an refresh was not possible or none exists yet.
return await _authenticator.PasswordGrant(url, clientId, username, password);
});
```
#### ClientCredentialsHandler
The client credentials handler checks whether the access token is about to expire or has already expired and automatically requests a new token.
```cs
private readonly IOAuth2TokenHandler _handler;
private static OAuth2TokenResponse token; // Save the last token somewhere static or distributed.
token = await _handler.ClientCredentialsHandler(
token,
url,
clientId,
clientSecret);
```
### OAuth2TokenResponseExtension
Checks if the token request was successful.
```cs
token.Successful()
```
Checks that the token is not expired.
```cs
token.Valid()
```
## API Reference
* [OAuth2Authenticator](https://www.fuget.org/packages/OAuth2Authenticator)