Administre JSON Web Tokens en desarrollo con dotnet user-jwts

Por Rick Anderson

La herramienta de línea de comandos dotnet user-jwts puede crear y administrar tokens web JSON (JWT) locales específicos de la aplicación.

En este artículo se proporcionan detalles de sintaxis para el comando y ejemplos.

Sinopsis

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

Descripción

Crea y administra tokens web JSON locales específicos del proyecto.

Argumentos

PROJECT | SOLUTION

Proyecto de MSBuild en el que se va a aplicar un comando. Si no se especifica un proyecto, MSBuild busca en el directorio de trabajo actual un archivo que tiene una extensión de archivo que termina en proj. A continuación, usa ese archivo para obtener la información del proyecto para el comando .

Comandos:

Opciones para el comando create

Uso: dotnet user-jwts create [options]

dotnet user-jwts create --file app.cs

Ejemplos

Ejecute los siguientes comandos para crear un proyecto web vacío y agregar el paquete NuGet Microsoft.AspNetCore.Authentication.JwtBearer:

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

Reemplace el contenido del archivo Program.cs por el código siguiente:

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();

En el código anterior, una solicitud GET al /secret punto de conexión devuelve un 401 Unauthorized error. Una aplicación de producción podría obtener el JWT de un servicio de token de seguridad, quizás en respuesta a iniciar sesión con credenciales. Cuando se usa la API durante el desarrollo local, se puede usar la dotnet user-jwts herramienta de línea de comandos para crear y administrar JWT locales específicos de la aplicación.

La user-jwts herramienta es similar en concepto a la herramienta de secretos de usuario . Se puede usar para administrar los valores de la aplicación que solo son válidos para el desarrollador en el equipo local. De hecho, la user-jwts herramienta utiliza la user-secrets infraestructura para administrar la clave con la que se firman los JWT. Este enfoque garantiza que la clave se almacena de forma segura en el perfil de usuario.

La herramienta user-jwts oculta los detalles de implementación, como dónde y cómo se almacenan los valores. La herramienta se puede usar sin conocer los detalles de implementación.

Los valores se almacenan en un archivo JSON en la carpeta de perfil de usuario de la máquina local:

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

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

Crear un JWT

El siguiente comando crea un JWT local:

dotnet user-jwts create

El comando anterior crea un JWT y actualiza el archivo de proyecto appsettings.Development.json con JSON similar al ejemplo siguiente:

{
  "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"
      }
    }
  }
}

Copie el JWT y el ID creados en el comando anterior. Usa una herramienta como Curl para probar el /secret punto de conexión, donde {token} es el JWT generado anteriormente:

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

Mostrar información de seguridad JWT

El siguiente comando muestra la JWT información de seguridad, incluida la expiración, los ámbitos, los roles, el encabezado del token y el payload, y el token compacto:

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

Crear un token para un usuario y un ámbito específicos

El comando siguiente crea un JWT para un usuario denominado MyTestUser. Para ver las opciones admitidas create , consulte la sección Opciones para el comando create .

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

El comando anterior tiene una salida similar a la del ejemplo siguiente:

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

Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.{Remaining token deleted}

El token anterior se puede usar para probar el punto de conexión de /secret2 en el código siguiente:

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();

Contenido relacionado

• Microsoft. AspNetCore.Authentication.JwtBearer
• JSON Web Tokens