HewStandard Library

Module std::crypto::jwt

JSON Web Token encoding and validation.

Encode, decode, and validate JWTs using HMAC algorithms.

Examples

import std.crypto.jwt;

fn main() {
    match jwt.encode("{\"sub\":\"1234\"}", "secret", "HS256") {
        .Ok(token) => println(token),
        .Err(err) => println(err),
    }
}

Contents

Functions

Function last_error

pub fn last_error() -> JwtError

Return the last JWT error observed on this thread.

Function encode

pub fn encode(payload: string, secret: string, algorithm: string) -> Result<string, JwtError>

Encode a JSON payload into a signed JWT string.

Returns Err(JwtError) when the payload, key, algorithm, or allocation path fails.

Function decode

pub fn decode(token: string, secret: string, algorithm: string) -> Result<string, JwtError>

Decode and verify a JWT, returning its payload as a JSON string.

Returns Err(JwtError) when the token is malformed, expired, signed with a different key, or cannot be allocated.

Function decode_insecure

pub fn decode_insecure(token: string) -> string

Decode a JWT without verifying its signature.

Warning: This does not validate the token. Only use for inspecting untrusted tokens when you don't need authenticity.

Examples

import std.crypto.jwt;

fn main() {
    let token = jwt.encode("{\"sub\":\"1234\"}", "secret", "HS256") handle error {
        println(f"operation failed: {error}");
        return;
    };
    let payload = jwt.decode_insecure(token);
    println(payload);
}

Function validate

pub fn validate(token: string, secret: string, algorithm: string) -> bool

Validate a JWT signature and expiration.

Returns true if the token is valid, false otherwise.

Examples

import std.crypto.jwt;

fn main() {
    let token = jwt.encode("{\"sub\":\"1234\"}", "my_secret", "HS256") handle error {
        println(f"operation failed: {error}");
        return;
    };
    if jwt.validate(token, "my_secret", "HS256") {
        println("valid");
    }
}

Types

Enum JwtError

Structured JWT errors surfaced by the native C ABI.

Variants

None
AlgorithmUnsupported
InvalidKey
TokenMalformed
SignatureInvalid
ClaimsExpired
AllocationFailure