rakutentech / jwkgen

Small command-line tool that generates asymmetric JSON Web Keys for the following algorithms and curves

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 get -u github.com/rakutentech/jwkgen

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.

jwkgen's Issues

Generated RSA key has invalid exponent?

I generate the key like:

$ jwkgen rsa --jwk

Example output:

{
  "kid": "Urv7E0SAY2vo-fk5cT26i89TmRgWJZAQ4kxRTPq-4-Q",
  "kty": "RSA",
  "n": "q_6BBpjyQHzOFIE13Rv7G5JDL5CqOJpSGVlB9HoiAW4lCdGxnRB5Zbr8FioQwxJYmaEjqQfBXX7ZUYalFdoxKWRcD8ISNc9u5gjOmL_hi0UR0oB7DfiHsQSZKaOM1lXPwF3thM1y7XKoM1ftW7tFHHeJbe5sxzqCjmSqeio-teUnQ_tQSgJ4ck7l8HVbZgqGG4cHGyPpCYyMQ2VvYIr6qL5CElqMQGvwKeRewaSCV9YTiTThLikaueTA4oo6R2F658VfZG8Ds7tuCqqEAnF4J5frhdzpnbQLN5aP9G0yvJBE0Xlqa9G5bD3OJDBLhMcxbddOlM2avAQocIqaQK4ofw",
  "e": "AAAAAAA",
  "d": "Gt5RTbSK86QLlYxx267JVY9Ny5pv3RPOi4M0GHsT4OFSC-ykMIMoU8oYI2ZC5BZznNxdc8RwYqi0TlYYaAeD8pFpCFUq_xj-nBT4IUiodVc-54GGt7IBkJfFTYntMHaLU-PYfQyTTaDBwfOUcuYYb9AEuhWrDJyJVLFJKHh8_3EhV5LtOmpjEeyo27OsXPRj7PgzTwwg4kYZr6woi4nFgQmUotZvY1SZ6jIUNYXmyArik-VyONLLta15YOUf_Jl3VPzTAyqWFaE618RJPJLEfJlD0_O0RANqS1xg_fp69ULzyhaY7qSJlFqTCfSDv6WI9s1WBbYAiSx7eTBEpMKB4Q",
  "p": "0qtuz-qCqOQq3ft13RoYt2FzkIokX7SP_YU5L_c5bVET-wE5Y6tovq5X4cL3cMkV4WvCogWGgymSIKRDFV710EsYPBZ5epzjSseczp2QCjrRF6KI_dy6JcvGEQ8ijWycgpT1Tudvk9QwBt56N-ny0xyAkdk7GX6wpWjIXuNKSNc",
  "q": "0QCplks0dXrX_yVxtsrAIDVybLu4eWs3Xr05_rTTTSjg_xenbdn56QxtXz-8afnuFtcU-b0J5h4FVZ6ViZWeOmD1877XWSyqasA_8Xv8KHopFhIMc5ZgNV4Lf5Y9RQzKkw0Y3Gx98lyWns0ZTamAFjH5pgCI_y9MS1PhSsrIYJk"
}

When I try to load it using gopkg.in/square/go-jose.v2, I get the following error:

crypto/rsa: public exponent too small

This is strange because it looks like AAAAAAA is pretty large. Maybe too large?

Brew install error

Device

Apple M1

Command

brew tap rakutentech/tap

brew install jwkgen

Error: jwkgen: wrong number of arguments (given 1, expected 0)

[Security] Workflow build.yml is using vulnerable action actions/checkout

The workflow build.yml is referencing action actions/checkout using references v1. However this reference is missing the commit a6747255bd19d7a757dbdda8c654a9f84db19839 which may contain fix to the some vulnerability.
The vulnerability fix that is missing by actions version could be related to:
(1) CVE fix
(2) upgrade of vulnerable dependency
(3) fix to secret leak and others.
Please consider to update the reference to the action.

Brew tap

==> Tapping rakutentech/tap
Cloning into '/usr/local/Homebrew/Library/Taps/rakutentech/homebrew-tap'...
remote: Enumerating objects: 27, done.
remote: Counting objects: 100% (12/12), done.
remote: Compressing objects: 100% (9/9), done.
remote: Total 27 (delta 2), reused 0 (delta 0), pack-reused 15
Receiving objects: 100% (27/27), done.
Resolving deltas: 100% (4/4), done.
Error: Invalid formula: /usr/local/Homebrew/Library/Taps/rakutentech/homebrew-tap/Formula/jwkgen.rb
jwkgen: Calling bottle :unneeded is disabled! There is no replacement.
Please report this issue to the rakutentech/tap tap (not Homebrew/brew or Homebrew/core):
/usr/local/Homebrew/Library/Taps/rakutentech/homebrew-tap/Formula/jwkgen.rb:8

Error: Cannot tap rakutentech/tap: invalid syntax in tap!

MacOs 12.3.1 (21E258)
Homebrew 3.4.7

Typo in homebrew installation

Should be

brew tap rakutentech/tap
brew install jwkgen