JWT Validation - Wacht API Documentation

Overview

The Wacht Rust SDK provides robust JWT (JSON Web Token) validation for authenticating requests. The validation process ensures tokens are properly signed, not expired, and contain valid claims.

Validation Process

1. Token Extraction

The SDK extracts tokens from the Authorization header:

Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...

2. Algorithm Detection

The token header is decoded to determine the signing algorithm:

{
  "alg": "RS256",
  "typ": "JWT"
}

3. Signature Verification

Based on the algorithm, the appropriate verification method is used:

Algorithm	Type	Key Type	Description
HS256	HMAC	Symmetric	HMAC with SHA-256
HS384	HMAC	Symmetric	HMAC with SHA-384
HS512	HMAC	Symmetric	HMAC with SHA-512
RS256	RSA	Asymmetric	RSA Signature with SHA-256
RS384	RSA	Asymmetric	RSA Signature with SHA-384
RS512	RSA	Asymmetric	RSA Signature with SHA-512
ES256	ECDSA	Asymmetric	ECDSA using P-256 and SHA-256
ES384	ECDSA	Asymmetric	ECDSA using P-384 and SHA-384

4. Claims Validation

The SDK validates standard JWT claims:

exp (Expiration Time) - Token must not be expired
nbf (Not Before) - Token must be valid for use
iat (Issued At) - Token issue time
iss (Issuer) - Optional issuer verification

Configuration Options

Clock Skew Tolerance

Allow for small time differences between servers:

let auth_layer = AuthLayer::new()
    .allowed_clock_skew(10); // 10 seconds tolerance

Disable Expiration Check

For testing or special cases:

let auth_layer = AuthLayer::new()
    .validate_exp(false); // Don't check expiration

Require Specific Issuer

Ensure tokens come from a trusted source:

let auth_layer = AuthLayer::new()
    .required_issuer("https://wacht.io");

Public Key Management

Automatic Fetching

By default, the SDK fetches the public key from your deployment:

// Fetches from https://your-app.wacht.io/.well-known/jwk
wacht::init_from_env().await?;

Manual Configuration

Provide the public key directly:

use wacht::{WachtConfig, init};

let config = WachtConfig::new(
    "api-key".to_string(),
    "https://your-app.wacht.io".to_string()
)
.with_public_key("-----BEGIN PUBLIC KEY-----\nMIIBIjANBg...\n-----END PUBLIC KEY-----");

init(config)?;

Environment Variable

Set via environment:

export WACHT_PUBLIC_SIGNING_KEY="-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA...
-----END PUBLIC KEY-----"

Token Structure

{
  "alg": "RS256",
  "typ": "JWT",
  "kid": "key-id"
}

Payload (Claims)

{
  "iss": "https://wacht.io",
  "sub": "52057194421551105",
  "iat": 1699564800,
  "exp": 1699568400,
  "nbf": 1699564800,
  "session_id": "session_abc123",
  "organization": "org_123",
  "organization_permissions": ["users:read", "users:write"],
  "workspace": "ws_456",
  "workspace_permissions": ["projects:manage"]
}

Validation Errors

Common Error Scenarios

Error	HTTP Status	Description
Missing Authorization Header	401	No token provided
Invalid Token Format	401	Not a valid JWT
Expired Token	401	Token exp claim has passed
Invalid Signature	401	Token signature doesn’t match
Unsupported Algorithm	401	Algorithm not in allowed list
Invalid Public Key	500	Server configuration error

Error Response Format

{
  "error": "Invalid token: ExpiredSignature",
  "message": "Token has expired"
}

Headers:

X-Auth-Error: Invalid token: ExpiredSignature
WWW-Authenticate: Bearer

Security Considerations

Algorithm Restrictions

The SDK only accepts specific algorithms to prevent attacks:

// These algorithms are blocked:
// - None (no signature)
// - Weak algorithms
// - Non-standard algorithms

Key Validation

Public keys are validated before use:

// RSA keys must be valid PEM format
// EC keys must use supported curves
// HMAC secrets must be provided as-is

Time-Based Security

// Default configuration
AuthConfig {
    allowed_clock_skew: 5,    // 5 seconds
    validate_exp: true,       // Check expiration
    validate_nbf: true,       // Check not-before
}

Debugging JWT Issues

Enable Debug Logging

use tracing_subscriber;

tracing_subscriber::fmt()
    .with_env_filter("wacht=debug")
    .init();

Common Issues and Solutions

Token Expired

Invalid Signature

Unsupported Algorithm

Clock Skew

Testing JWT Validation

Create Test Tokens

use jsonwebtoken::{encode, Header, EncodingKey};
use chrono::Utc;

fn create_test_token() -> String {
    let claims = TokenClaims {
        iss: "test".to_string(),
        sub: "user123".to_string(),
        iat: Utc::now().timestamp(),
        exp: Utc::now().timestamp() + 3600,
        session_id: "session123".to_string(),
        organization: Some("org123".to_string()),
        organization_permissions: Some(vec!["read".to_string()]),
        workspace: None,
        workspace_permissions: None,
        custom_claims: Default::default(),
    };

    let header = Header::new(Algorithm::RS256);
    let key = EncodingKey::from_rsa_pem(PRIVATE_KEY.as_bytes()).unwrap();

    encode(&header, &claims, &key).unwrap()
}

Validate Custom Tokens

use wacht::middleware::AuthLayer;

// Use custom public key for testing
let auth_layer = AuthLayer::with_public_key(TEST_PUBLIC_KEY)
    .validate_exp(false); // Disable expiration for tests

Best Practices

Always Use HTTPS - Tokens can be intercepted over HTTP
Short Token Lifetime - Reduce window for compromised tokens
Validate All Claims - Don’t skip expiration or other checks
Secure Key Storage - Protect private keys, rotate regularly
Monitor Failures - Log and alert on validation failures

Next Steps

Token Claims - Understanding claim structure
Auth Layer - Implementing authentication
Error Handling - Handling validation errors

Configuration

Middleware

JWT

​Overview

​Validation Process

​1. Token Extraction

​2. Algorithm Detection

​3. Signature Verification

​4. Claims Validation

​Configuration Options

​Clock Skew Tolerance

​Disable Expiration Check

​Require Specific Issuer

​Public Key Management

​Automatic Fetching

​Manual Configuration

​Environment Variable

​Token Structure

​Header

​Payload (Claims)

​Validation Errors

​Common Error Scenarios

​Error Response Format

​Security Considerations

​Algorithm Restrictions

​Key Validation

​Time-Based Security

​Debugging JWT Issues

​Enable Debug Logging

​Common Issues and Solutions

​Testing JWT Validation

​Create Test Tokens

​Validate Custom Tokens

​Best Practices

​Next Steps