jwt-block

command module
v0.0.1-alpha9 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 27, 2023 License: MIT Imports: 2 Imported by: 0

README

JWT Block

Go Reference GitHub Workflow Status

Exploring the feasability and performance of a JWT blocklist.

About

JWT Block is a blocklist & auth proxy service for JWTs, to support immediate termination of access, since access tokens cannot truly be revoked.

It is a standalone binary that requires a Redis instance to store the blocklist.

Installation

Download the binary release for your platform, and place it in the executable path.

JWT Block is also available as a Docker image.

docker run -it --rm divergentcodes/jwt-block:latest

Usage

JWT Block is a blocklist & auth proxy service for JWTs, to support immediate termination of access, since access tokens cannot truly be revoked.

Usage:
  jwt-block [command]

Available Commands:
  block       Block a JWT
  check       Check if a JWT is blocked
  completion  Generate the autocompletion script for the specified shell
  flush       Empty the blocklist
  help        Help about any command
  list        List blocked JWT hashes
  serve       Serve the web API
  status      Get status of the blocklist
  unblock     Unblock a JWT
  version     Print the version of jwt-block

Flags:
      --config string       config file (default is ./jwt-block.yaml)
      --debug               Enable debug mode
  -h, --help                help for jwt-block
      --json                Use JSON output
  -q, --quiet               Quiet CLI output
      --redis-dbnum int     Redis DB number
      --redis-host string   Redis host (default "localhost")
      --redis-noverify      Skip Redis TLS certificate verification
      --redis-pass string   Redis password
      --redis-port int      Redis port (default 6379)
      --redis-tls           Connect to Redis over TLS (default true)
      --redis-user string   Redis username
      --verbose             Verbose CLI output

Use "jwt-block [command] --help" for more information about a command.

Configuration

There are a few ways to configure JWT Block (in order of precedence):

  • CLI argument flags.
  • Environment variables.
  • Configuration file.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
jwt-block
JWT Block is a blocklist & auth proxy service for JWTs, to support immediate termination of access, since access tokens cannot truly be revoked.
JWT Block is a blocklist & auth proxy service for JWTs, to support immediate termination of access, since access tokens cannot truly be revoked.
internal
blocklist
Package blocklist manages inspecting tokens and interacting with the cache
Package blocklist manages inspecting tokens and interacting with the cache
cache
Package cache implements a standardized, pre-configured Redis cache client.
Package cache implements a standardized, pre-configured Redis cache client.
core
Package core implements cross-functional features used across the application
Package core implements cross-functional features used across the application
crypto
Package crypto contains utility functions for hashing and JWTs
Package crypto contains utility functions for hashing and JWTs
Package web contains the web API for the JWT blocklist service.
Package web contains the web API for the JWT blocklist service.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL