README.md

jwkgen - JSON Web Key Generator

Overview

jwkgen is a small command-line tool that generates asymmetric JSON Web Keys for the following algorithms and curves:

• RSA
• Curve25519 (ECDH, RFC 8037 compliant)
• Ed25519 (EdDSA, RFC 8037 compliant)
• P-256 (ECDSA and ECDH)
• P-384 (ECDSA and ECDH)
• P-521 (ECDSA and ECDH)

Installation

On Mac, you can easily install jwkgen using Homebrew:

> brew tap rakutentech/tap
> brew install jwkgen

On Windows, you can use scoop

> scoop bucket add rakutentech https://github.com/rakutentech/scoop-bucket.git
scoop install jwkgen

On other platforms, you can just download the latest release archive for your platform and extract the binary to any location.

If you have Go installed, you can also install the latest version from master branch:

> go install github.com/rakutentech/jwkgen@latest

Usage

jwkgen [options] [filename]

Positional arguments

• key type: (optional) Key type to generate: oct, rsa, ec (default=ec)
• filename: Output filename (without extension)

Options

-h, --help

Show context-sensitive help (also try --help-long and --help-man).

--allow-unsafe

Allow unsafe parameters

--color

Use color in JSON output (true by default)

-e, --curve="Ed25519"

Named elliptic curve to use to generate a key. Valid values are P256, P384, P521, X25519, Ed25519

-b, --bits=2048

Number of bits to use when generating RSA or octet keys

--pem

Output only PEM format (useful for pipelining results and shell scripting)

--jwk

Output only JWK format (useful for pipelining results and shell scripting)

--version

Show jwkgen version.