Phoesion.DevJwt 0.1.7

Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package Phoesion.DevJwt --version 0.1.7                
NuGet\Install-Package Phoesion.DevJwt -Version 0.1.7                
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="Phoesion.DevJwt" Version="0.1.7" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Phoesion.DevJwt --version 0.1.7                
#r "nuget: Phoesion.DevJwt, 0.1.7"                
#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 Phoesion.DevJwt as a Cake Addin
#addin nuget:?package=Phoesion.DevJwt&version=0.1.7

// Install Phoesion.DevJwt as a Cake Tool
#tool nuget:?package=Phoesion.DevJwt&version=0.1.7                

Phoesion.DevJwt

Library and dotnet-tool for developing and testing web api services with JWT authorization. Create custom tokens that can be used localy, without an external authority.

How to use in your service

  1. Install the Phoesion.DevJwt NuGet package
dotnet add package Phoesion.DevJwt
  1. Enable dev-jwt on your JWT authorization services using the UseDevJwt() extension
services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
        .AddJwtBearer(o => o.UseDevJwt(builder.Environment));
  1. Configure in appsetting.Development.json
"Authentication": {
   "Schemes": {
      "Bearer": {
         "ValidAudience": "myApi",
         "ValidIssuer": "phoesion.devjwt"
      }
   }
}

Generate a jwt

  1. Install the dotnet tool
dotnet tool install --global phoesion.devjwt.cli
  1. Generate token using
dotnet devjwt create myApi --email user@mail.com --sub 42

console screenshot You can now use the token for your requests.

General Information

The UseDevJwt() extension configures an ISecurityTokenValidator that validates the token. Using the HostingEnvironment, it checks that the handler is only added for Development and Testing environments.

Samples

The repository contains the following samples projects in the Samples folder :

  • SampleWebApi : an ASP.Net core web api application
  • SampleGlowMicroservice : a Phoesion Glow microservice
  • TokenGeneratorSample : a console application that demononstrates how to generate token programmatically

Custom signing key

By default, the generator and validator use a predefined key for signing/veryfing the token. This way it will pass validation and you don't need to care about where/how the token was generated (doesn't use UserSecrets store), which is fine since it's for local development and testing.

You can however generate/validate tokens using a custom key like so :

  • In the tool specify a key to be used for signing the token using the --signkey parameter :
dotnet devjwt create myApi --email user@mail.com --sub 42 --signkey thiskeyisverylargetobreak
  • In the service authentication setup, provide the key to the UseDevJwt() function
services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
        .AddJwtBearer(o => o.UseDevJwt(builder.Environment, "thiskeyisverylargetobreak"));
Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  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 is compatible.  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.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.0 479 11/19/2024
1.0.1 9,779 11/24/2023
0.2.1 374 4/27/2023
0.2.0 165 4/27/2023
0.1.9 288 4/27/2023
0.1.8 172 4/27/2023
0.1.7 262 4/26/2023
0.1.6 154 4/26/2023
0.1.5 172 4/26/2023
0.1.4 186 4/26/2023
0.1.3 176 4/26/2023
0.1.2 173 4/25/2023