A .NET API supports Hmac and Hawk authentication.
Client：
dotnet add package Alastack.Authentication.HmacAuth
AspNetCore：
dotnet add package Alastack.Authentication.HmacAuth.AspNetCore
The following code snippet demonstrates creating a Hmac authentication client:
var authHandler = new HmacDelegatingHandler("id123", "3@uo45er?")
{
InnerHandler = new SocketsHttpHandler
{
ConnectTimeout = TimeSpan.FromSeconds(10),
PooledConnectionLifetime = TimeSpan.FromSeconds(1000),
SslOptions = new SslClientAuthenticationOptions()
{
RemoteCertificateValidationCallback = (sender, certificate, chain, errors) => true
},
UseCookies = false
}
};
var client = new HttpClient(authHandler, disposeHandler: false)
{
BaseAddress = new Uri("https://localhost:5001/")
};The following code snippet demonstrates creating a Hmac authentication client with dependency injection and then invoking it:
var host = new HostBuilder()
.ConfigureServices(services =>
{
services.Configure<HmacSettings>(options =>
{
options.AppId = "id123";
options.AppKey = "3@uo45er?";
});
services.AddSingleton<IValidateOptions<HmacSettings>, HmacSettingsValidation>();
services.AddTransient<HmacDelegatingHandler>();
services.AddHttpClient<ApiClient>("ApiClient", httpClient =>
httpClient.BaseAddress = "https://localhost:5001/")
.AddHttpMessageHandler<HmacDelegatingHandler>();
}).Build();
var apiClient = host.Services.GetRequiredService<ApiClient>();
await apiClient.CreateTodoItemAsync(new TodoItem { Name = "walk dog" });The following code will add Hmac authentication for AspNetCore:
builder.Services.AddAuthentication()
.AddHmac(options =>
{
var credential = new HmacCredential { AppId = "id123", AppKey = "3@uo45er?" };
var dict = new Dictionary<string, HmacCredential> { { "id123", credential } };
options.CredentialProvider = new MemoryCredentialProvider<HmacCredential>(dict);
});You can use Postman as Hawk authentication client. For more information see Authenticate with Hawk access authentication.
The following code snippet demonstrates creating a Hawk authentication client:
var authHandler = new HawkDelegatingHandler("id123", "3@uo45er?")
{
InnerHandler = new SocketsHttpHandler
{
ConnectTimeout = TimeSpan.FromSeconds(10),
PooledConnectionLifetime = TimeSpan.FromSeconds(1000),
SslOptions = new SslClientAuthenticationOptions()
{
RemoteCertificateValidationCallback = (sender, certificate, chain, errors) => true
},
UseCookies = false
}
};
var client = new HttpClient(authHandler, disposeHandler: false)
{
BaseAddress = new Uri("https://localhost:5001/")
};The following code snippet demonstrates creating a Hawk authentication client with dependency injection and then invoking it:
var host = new HostBuilder()
.ConfigureServices(services =>
{
services.Configure<HawkSettings>(options =>
{
options.AuthId = "id123";
options.AuthKey = "3@uo45er?";
});
services.AddSingleton<IValidateOptions<HawkSettings>, HawkSettingsValidation>();
services.AddTransient<HawkDelegatingHandler>();
services.AddHttpClient<ApiClient>("ApiClient", httpClient =>
httpClient.BaseAddress = "https://localhost:5001/")
.AddHttpMessageHandler<HawkDelegatingHandler>();
}).Build();
var apiClient = host.Services.GetRequiredService<ApiClient>();
await apiClient.CreateTodoItemAsync(new TodoItem { Name = "walk dog" });The following code will add Hawk authentication for AspNetCore:
builder.Services.AddAuthentication()
.AddHawk(options =>
{
var credential = new HawkCredential { AuthId = "id123", AuthKey = "3@uo45er?" };
var dict = new Dictionary<string, HawkCredential> { { "id123", credential } };
options.CredentialProvider = new MemoryCredentialProvider<HawkCredential>(dict);
});This repo builds the following packages.
| Package | Version | Description |
|---|---|---|
| Alastack.Authentication.HmacAuth |  |
Hmac and Hawk authentication client. |
| Alastack.Authentication.HmacAuth.AspNetCore |  |
Hmac and Hawk authentication for ASP.NET Core. |
| Alastack.Authentication.HmacAuth.Sql |  |
Sql CredentialProvider. |
| Alastack.Authentication.HmacAuth.MongoDB |  |
MongoDB CredentialProvider. |
| Alastack.Authentication.HmacAuth.EntityFrameworkCore |  |
EntityFrameworkCore CredentialProvider. |
| Alastack.Authentication.HmacAuth.LiteDB |  |
LiteDB CredentialProvider. |
- Hmac -
HmacSettingsfor authentication client,HmacOptionsfor AspNetCoe. - Hawk -
HawkSettingsfor authentication client,HawkOptionsfor AspNetCoe.
ICredentialCache<TCredential>defines credential cache abstraction.CredentialCache<TCredential>is the default implementation.IDataCacheinstance stores credential data.CacheKeyPrefixandCredentialCacheTimeoptions configure cache parameters.
ICrypto
A hash algorithms abstraction. DefaultCrypto is the default implementation.
ICryptoFactory
A factory abstraction for a component that can create ICrypto instances. DefaultCryptoFactory is the default implementation.
INonceGenerator
A nonce generator abstraction. NonceGenerator is the default implementation.
ITimestampCalculator
A timestamp calculator abstraction. TimestampCalculator is the default implementation.
IAuthorizationParameterExtractor
a HTTP Authorization header parameter extractor abstraction. HmacParameterExtractor is the Hmac authentication implementation. HawkParameterExtractor is the Hawk authentication implementation.
IHostResolver
A host resolver abstraction. DefaultHostResolver is the default implementation. DefaultHostResolver supports forwarded header. HmacOptions.ForwardIndex and HawkOptions.ForwardIndex is used to set the reverse host index of the forwarding header.
The following HTTP headers display X-Forwarded information.
X-Forwarded-Host: 192.168.1.103, 192.168.1.102:1080, 192.168.1.103:2080, 192.168.1.102, 192.168.1.103:3080
X-Forwarded-Proto: http, http, http, https, httpIf ForwardIndex is 3, DefaultHostResolver will return 192.168.1.102:1080.
IReplayRequestValidator
A HTTP replay request Validator abstraction. ReplayRequestValidator is the default implementation.
ICredentialProvider<TCredential>
A credential provider abstraction. MemoryCredentialProvider<TCredential> is a in-memory implementation.
IDataCache
A data cache abstraction. DataCache integrates in-memory and distributing cache implementation.
Visit the samples folder.