jwkserve-cli 0.6.8

docs.rs failed to build jwkserve-cli-0.6.8
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.

JWKServe CLI

A fake authentication service to speed up local development for JWT consumers.

This HTTP server provides several endpoints for JWT development:

  • GET / - Health check and service status
  • GET /.well-known/openid-configuration - OpenID Connect discovery
  • GET /.well-known/jwks.json - JSON Web Key Set
  • GET /protocol/openid-connect/certs - JSON Web Key Set
  • POST /sign - Generate JWT tokens

Also available as sbstjn/jwkserve on DockerHub for easy usage. See jwkserve for the library; contribution is possible via sbstjn/jwkserve on GitHub.

Installation

$ > cargo install jwkserve-cli

Quick Start

# Start the service
$ > jwkserve

# In another terminal, test the endpoints
$ > curl http://localhost:3000/
$ > curl http://localhost:3000/.well-known/jwks.json
$ > curl http://localhost:3000/.well-known/openid-configuration
$ > curl http://localhost:3000/protocol/openid-connect/certs

Token Generation

When having jwkserve running, you can generate a JWT with matching signature using curl e.g.

$ > curl -X POST http://localhost:3000/sign \
    -H "Content-Type: application/json" \
    -d '{
        "aud": "my-app",
        "exp": 1735689600,
        "iat": 1704067200,
        "iss": "my-issuer",
        "nbf": 1704067200,
        "sub": "user-12345"
    }'

{"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUz …"}

Note: If the iss field is not set in your request, it will be automatically added matching the WEB_ISSUER envionment variable.

Configuration

You can configure the service using environment variables:

  • APP_HOST - HTTP listener host (default: 0.0.0.0)
  • APP_PORT - HTTP listener port (default: 3000)
  • KEY_FILE - Path to existing PKCS8 private key file (optional)
  • WEB_ISSUER - HTTP address for issuer (default: http://${APP_HOST}:${APP_PORT})

On start, the binary will generate a random 2048-bit RSA private key if no KEY_FILE is provided.

# Basic usage
$ > jwkserve

# With custom host and existing key
$ > KEY_FILE=fixtures/test-key-pkcs8.pem \
    jwkserve