kit-jwt

JSON Web Token (JWT)-Kodierung und -Dekodierung für Kit

[TOC]

Dateien

Abhängigkeiten

• Kit-Paketabhängigkeit: crypto
• Kit-Standardmodul: Encoding.Base64
• Native Bibliothek: OpenSSL libcrypto für RS256-, RS384- und RS512-Helfer
• Erforderliche Fähigkeit: ffi

Das Paket ist als ffi-zig deklariert, da RSA-Signieren und -Verifizieren zig/jwt_rsa.zig verwenden. HS256 verwendet crypto.hmac-sha256.

Installation

kit add gitlab.com/kit-lang/packages/kit-jwt.git

Verwendung

import Kit.Jwt as JWT

main = fn =>
  secret = "my-super-secret-key-at-least-32-chars"
  claims = "{\"sub\":\"user123\",\"name\":\"John Doe\",\"admin\":true,\"iat\":1700000000}"

  match JWT.encode claims secret
    | Err e ->
      println "Fehler beim Erstellen des Tokens:"
      println e
    | Ok token ->
      println "JWT:"
      println token

      if JWT.verify? token secret then
        println "Token ist gültig"
      else
        println "Token ist ungültig"

      match JWT.decode token secret
        | Ok decoded ->
          println "Header:"
          println decoded.header
          println "Payload:"
          println decoded.payload
        | Err e ->
          println "Dekodierung fehlgeschlagen:"
          println e

main

Unterstützte Signier- und Verifikationshilfen:

Für das Debuggen von Token ohne Signaturverifikation stehen auch unsichere Inspektionshelfer zur Verfügung:

• decode-unsafe
• get-claims-unsafe
• get-header-unsafe

Verwenden Sie keine unsicheren Helfer für Autorisierungsentscheidungen.

Entwicklung

Beispiele ausführen

Führen Sie das Basisbeispiel mit dem Interpreter aus:

kit run examples/basic.kit --allow=ffi

Kompilieren Sie das Beispiel zu einer nativen Binärdatei:

kit build examples/basic.kit --allow=ffi && ./basic

Tests ausführen

Führen Sie die aktive Testsuite aus:

kit test --allow=ffi

Führen Sie die aktive Testsuite mit Codeabdeckung aus:

kit test --coverage --allow=ffi

Führen Sie die optionalen RSA-Testdateien direkt aus:

kit test tests/rs256.kit.disabled --allow=ffi
kit test tests/rs384.kit.disabled --allow=ffi
kit test tests/rs512.kit.disabled --allow=ffi

kit dev ausführen

Führen Sie den Standard-Entwicklungsworkflow aus (Formatierung, Prüfung, Tests):

kit dev

Dies wird:

1. Formatierung der Kit-Quell- und Beispieldateien prüfen
2. Quellen und Beispiele typüberprüfen
3. Aktive Tests mit Codeabdeckung ausführen

Paritätstests ausführen

Führen Sie Interpreter/Compiler-Paritätsprüfungen für Beispiele aus:

kit parity --failures-only

Paritätsprüfungen stellen sicher, dass Beispiele im Interpreter laufen, erfolgreich kompilieren, erfolgreich ausgeführt werden und übereinstimmende Ausgaben liefern.

Dokumentation generieren

Generieren Sie API-Dokumentation aus Dok-Kommentaren:

kit doc src/jwt.kit

Hinweis: Kit-Quellen mit Dok-Kommentaren (##) generieren HTML-Dokumentation.

Build-Artefakte bereinigen

Entfernen Sie generierte Dateien, Caches und Build-Artefakte:

kit task clean

Hinweis: Definiert in kit.toml.

Lokale Installation

Um dieses Paket lokal für die Entwicklung zu installieren:

kit install

Dadurch wird das Paket in ~/.kit/packages/@kit/jwt/ installiert und steht in anderen Projekten als Kit.Jwt zur Verfügung.

Sicherheitshinweise

• Verwenden Sie starke, zufällige HS256-Geheimnisse. Es werden mindestens 256 Bits empfohlen.
• Übergeben Sie niemals private Schlüssel oder Produktions-JWT-Geheimnisse.
• Validieren Sie Anwendungs-Claims wie exp, nbf, iat, iss und aud nach der Dekodierung.
• Bevorzugen Sie kurzlebige Token und rotieren Sie Schlüssel gemäß dem Bedrohungsmodell Ihrer Anwendung.
• Verwenden Sie HTTPS, wenn JWTs über ein Netzwerk übertragen werden.

Lizenz

Dieses Paket wird unter der MIT-Lizenz veröffentlicht – siehe LICENSE für Details.