Schick.Authentication.OneTimeToken
1.0.0
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package Schick.Authentication.OneTimeToken --version 1.0.0
NuGet\Install-Package Schick.Authentication.OneTimeToken -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Schick.Authentication.OneTimeToken" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Schick.Authentication.OneTimeToken --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Schick.Authentication.OneTimeToken, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Schick.Authentication.OneTimeToken as a Cake Addin
#addin nuget:?package=Schick.Authentication.OneTimeToken&version=1.0.0
// Install Schick.Authentication.OneTimeToken as a Cake Tool
#tool nuget:?package=Schick.Authentication.OneTimeToken&version=1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
ASP.NET One-Time Token Authentication
Provides an authentication scheme for one-time access tokens to support file download via direct link for protected resources
Frameworks supported
- ASP.NET Core 6.0
Demo
A demo applikation can be found in folder FS.Authentication.OneTimeToken.Demo
Installation
Install from NuGet package
Install-Package Schick.Authentication.OneTimeToken
Getting Started
Add Authorize
attribute with one-time token authentication scheme to controller / minimal API
// Authenticate via one-time access token.
[Authorize(AuthenticationSchemes = OneTimeTokenDefaults.AuthenticationScheme)]
internal static string RequireOneTimeTokenAuthentication()
=> "Hello, you are authenticated";
Register one-time access token authorization scheme
// Add default authentication, e.g. NTLM/Windows, JWT, ...
builder.Services.AddAuthorization();
...
// Add one-time access token authentication.
builder.Services.Configure<OneTimeTokenOptions>(config => { /* your options here */ });
builder.Services.AddOneTimeTokenAuthentication();
Tokens can be generated via IOneTimeTokenService.CreateToken
<serviceProvider>.GetRequiredService<IOneTimeTokenService>().CreateToken(/* required roles */);
Full Sample
using FS.Authentication.OneTimeToken.Abstractions.Interfaces;
using FS.Authentication.OneTimeToken.Abstractions.Models;
using FS.Authentication.OneTimeToken.Extensions;
using FS.Authentication.OneTimeToken.Models;
using Microsoft.AspNetCore.Authentication.Negotiate;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.DependencyInjection;
using Swashbuckle.AspNetCore.Annotations;
using System.ComponentModel;
namespace FS.Authentication.OneTimeToken.Demo;
public class Program
{
public const string DEFAULT_ROLE = "DefaultUser";
// Authenticate / authorize via default authentication, e.g. NTLM/Windows, JWT, ...
[Authorize]
internal static string GetOneTimeToken(HttpContext httpContext, [FromQuery][DefaultValue(DEFAULT_ROLE)][SwaggerParameter(Required = false)] string role)
=> httpContext.RequestServices.GetRequiredService<IOneTimeTokenService>().CreateToken(role);
// Authenticate via one-time access token.
[Authorize(AuthenticationSchemes = OneTimeTokenDefaults.AuthenticationScheme)]
internal static string RequireOneTimeTokenAuthentication([FromQuery] string accessToken)
=> "Hello, you are authenticated";
// Authenticate /authorize via one-time access token.
[Authorize(AuthenticationSchemes = OneTimeTokenDefaults.AuthenticationScheme, Roles = DEFAULT_ROLE)]
internal static string RequireOneTimeTokenAuthorization([FromQuery] string accessToken)
=> "Hello, you are authorized";
public static void Main(string[] args)
{
var builder = WebApplication.CreateBuilder(args);
// Add default authentication, e.g. NTLM/Windows, JWT, ...
builder.Services.AddAuthorization();
builder.Services.AddAuthentication(NegotiateDefaults.AuthenticationScheme).AddNegotiate();
builder.Services.AddAuthorization(options => options.FallbackPolicy = options.DefaultPolicy);
// Add one-time access token authentication.
builder.Services.Configure<OneTimeTokenOptions>(config => { /* your options here */ });
builder.Services.AddOneTimeTokenAuthentication();
AddSwagger(builder);
var app = builder.Build();
app.UseAuthentication();
app.UseAuthorization();
app.MapGet(nameof(GetOneTimeToken), GetOneTimeToken);
app.MapGet(nameof(RequireOneTimeTokenAuthentication), RequireOneTimeTokenAuthentication);
app.MapGet(nameof(RequireOneTimeTokenAuthorization), RequireOneTimeTokenAuthorization);
AddSwaggerUi(app);
app.Run();
}
private static void AddSwagger(WebApplicationBuilder builder)
{
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen(config => config.EnableAnnotations());
}
private static void AddSwaggerUi(WebApplication app)
{
app.UseSwagger();
app.UseSwaggerUI(options =>
{
options.DisplayRequestDuration();
options.EnableDeepLinking();
options.EnableTryItOutByDefault();
options.ConfigObject.AdditionalItems.Add("requestSnippetsEnabled", true);
});
}
}
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net6.0
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.