Hantera JSON-webbtoken under utveckling med dotnet user-jwts

Av Rick Anderson

Kommandoradsverktyget dotnet user-jwts kan skapa och hantera appspecifika lokala JSON-webbtoken (JWT).

Den här artikeln innehåller syntaxinformation för kommandon och exempel.

Sammanfattning

dotnet user-jwts [<PROJECT>] [command]
dotnet user-jwts [command] -h|--help

Description

Skapar och hanterar projektspecifika lokala JSON-webbtoken.

Arguments

PROJECT | SOLUTION

MSBuild-projektet som du vill använda ett kommando på. Om ett projekt inte har angetts söker MSBuild i den aktuella arbetskatalogen efter en fil som har ett filnamnstillägg som slutar med proj. Den använder sedan filen för att hämta projektinformationen för kommandot.

Commands

Alternativ för kommandot create

Användning: dotnet user-jwts create [options]

Examples

Kör följande kommandon för att skapa ett tomt webbprojekt och lägg till NuGet-paketet Microsoft.AspNetCore.Authentication.JwtBearer :

dotnet new web -o MyJWT
cd MyJWT
dotnet add package Microsoft.AspNetCore.Authentication.JwtBearer

Ersätt innehållet i Program.cs-filen med följande kod:

using System.Security.Claims;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddAuthorization();
builder.Services.AddAuthentication("Bearer").AddJwtBearer();

var app = builder.Build();

app.UseAuthorization();

app.MapGet("/", () => "Hello, World!");
app.MapGet("/secret", (ClaimsPrincipal user) => $"Hello {user.Identity?.Name}. My secret")
    .RequireAuthorization();

app.Run();

I föregående kod returnerar en GET-begäran till /secret slutpunkten ett 401 Unauthorized fel. En produktionsapp kan hämta JWT från en säkerhetstokentjänst, kanske som svar på inloggning med autentiseringsuppgifter. När du använder API:et under lokal utveckling dotnet user-jwts kan kommandoradsverktyget användas för att skapa och hantera appspecifika lokala JWT:er.

Verktyget user-jwts liknar verktyget användarhemligheter . Den kan användas för att hantera värden för appen som endast är giltiga för utvecklaren på den lokala datorn. I själva verket använder verktyget user-jwts infrastrukturen user-secrets för att hantera nyckeln som JWT:erna signeras med. Den här metoden säkerställer att nyckeln lagras på ett säkert sätt i användarprofilen.

Verktyget user-jwts döljer implementeringsinformation, till exempel var och hur värdena lagras. Verktyget kan användas utan att känna till implementeringsinformationen.

Värdena lagras i en JSON-fil i den lokala datorns användarprofilmapp:

• Windows: %APPDATA%\Microsoft\UserSecrets<secrets_GUID>\user-jwts.json

• Linux/macOS: ~/.microsoft/usersecrets/<secrets_GUID>/user-jwts.json

Skapa en JWT

Följande kommando skapar en lokal JWT:

dotnet user-jwts create

Föregående kommando skapar en JWT och uppdaterar projektfilen appsettings.Development.json med JSON som liknar följande exempel:

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "Authentication": {
    "Schemes": {
      "Bearer": {
        "ValidAudiences": [
          "http://localhost:8401",
          "https://localhost:44308",
          "http://localhost:5182",
          "https://localhost:7076"
        ],
        "ValidIssuer": "dotnet-user-jwts"
      }
    }
  }
}

Kopiera JWT och ID som skapades i föregående kommando. Använd ett verktyg som Curl för att testa /secret slutpunkten, där {token} är den tidigare genererade JWT:en:

curl -i -H "Authorization: Bearer {token}" https://localhost:{port}/secret

Visa JWT-säkerhetsinformation

Följande kommando visar JWT-säkerhetsinformationen, inklusive förfallodatum, omfång, roller, tokenhuvud och nyttolast samt den kompakta token:

dotnet user-jwts print {ID} --show-all

Skapa en token för en specifik användare och omfång

Följande kommando skapar en JWT för en användare med namnet MyTestUser. Information om de alternativ som stöds create finns i avsnittet Alternativ för kommandot create.

dotnet user-jwts create --name MyTestUser --scope "myapi:secrets"

Föregående kommando har utdata som liknar följande exempel:

New JWT saved with ID '43e0b748'.
Name: MyTestUser
Scopes: myapi:secrets

Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.{Remaining token deleted}

Föregående token kan användas för att testa /secret2 slutpunkten i följande kod:

using System.Security.Claims;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddAuthorization();
builder.Services.AddAuthentication("Bearer").AddJwtBearer();

var app = builder.Build();

app.MapGet("/", () => "Hello, World!");
app.MapGet("/secret", (ClaimsPrincipal user) => $"Hello {user.Identity?.Name}. My secret")
    .RequireAuthorization();
app.MapGet("/secret2", () => "This is a different secret!")
    .RequireAuthorization(p => p.RequireClaim("scope", "myapi:secrets"));

app.Run();

Relaterat innehåll

• Microsoft. AspNetCore.Authentication.JwtBearer
• JSON-webbtoken