Cross-platform RSA & EC keypair generation, signing and verification - suitable for JWT, JOSE, and asymmetric cryptography.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
AJ ONeal 88a0b05c2f update usage example 11 months ago
cmd/keypairs update usage example 11 months ago
examples update documented import path 1 year ago
fixtures friendlier error reporting 2 years ago
keyfetch transitioning to go1.15 PublicKey interface 1 year ago
keyserve transitioning to go1.15 PublicKey interface 1 year ago
.gitignore fix flag parsing 1 year ago
.goreleaser.yml add goreleaser 1 year ago
AUTHORS update doc links and author info 1 year ago
LICENSE add MIT license 2 years ago
README.md doc: update README and help 1 year ago
cli_test.sh add verify subcommand 1 year ago
doc.go update canonical import path 1 year ago
generate.go add verify subcommand 1 year ago
go.mod update canonical import path 1 year ago
jwk.go add verify subcommand 1 year ago
jws.go add verify subcommand 1 year ago
keypairs.go transitioning to go1.15 PublicKey interface 1 year ago
keypairs_test.go friendlier error reporting 2 years ago
marshal.go transitioning to go1.15 PublicKey interface 1 year ago
mock.go add verify subcommand 1 year ago
sign.go transitioning to go1.15 PublicKey interface 1 year ago
verify.go transitioning to go1.15 PublicKey interface 1 year ago

README.md

keypairs

A cross-platform Command Line Tool and Golang Library that works with RSA, ECDSA, PEM, DER, JWK, and the JOSE suite.

Keypairs CLI

Generates, signs, and verifies with NIST-strength asymmetric keys.

# Generate JSON Web Keys (JWKs)
keypairs gen > key.jwk.json 2> pub.jwk.json

# Generate PEM (or DER) Keys, by extension
keypairs gen --key key.pem --pub pub.pem

# Sign a payload
keypairs sign key.jwk.json --exp 1h '{ "sub": "me@example.com" }' > token.jwt 2> sig.jws

# Verify a signature
keypairs verify pub.jwk.json token.jwt

Cheat Sheet at https://webinstall.dev/keypairs.

Install

Mac, Linux:

curl -sS https://webinstall.dev/keypairs | bash

Windows 10:

curl.exe -A MS https://webinstall.dev/keypairs | powershell

Keypairs Go Library

JSON Web Key (JWK) support and type safety lightly placed over top of Go's crypto/ecdsa and crypto/rsa

Useful for JWT, JOSE, etc.

key, err := keypairs.ParsePrivateKey(bytesForJWKOrPEMOrDER)

pub, err := keypairs.ParsePublicKey(bytesForJWKOrPEMOrDER)

jwk, err := keypairs.MarshalJWKPublicKey(pub, time.Now().Add(2 * time.Day))

kid, err := keypairs.ThumbprintPublicKey(pub)

GoDoc API Documentation

See https://pkg.go.dev/git.rootprojects.org/root/keypairs

Philosophy

Go's standard library is great.

Go has excellent crytography support and provides wonderful primitives for dealing with them.

I prefer to stay as close to Go's crypto package as possible, just adding a light touch for JWT support and type safety.

Type Safety

crypto.PublicKey is a "marker interface", meaning that it is not typesafe!

go-keypairs defines type keypairs.PrivateKey interface { Public() crypto.PublicKey }, which is implemented by crypto/rsa and crypto/ecdsa (but not crypto/dsa, which we really don't care that much about).

Go1.15 will add [PublicKey.Equal(crypto.PublicKey)](https://github.com/golang/go/issues/21704), which will make it possible to remove the additional wrapper over PublicKey and use an interface instead.

Since there are no common methods between rsa.PublicKey and ecdsa.PublicKey, go-keypairs lightly wraps each to implement Thumbprint() string (part of the JOSE/JWK spec).

JSON Web Key (JWK) as a "codec"

Although there are many, many ways that JWKs could be interpreted (possibly why they haven't made it into the standard library), go-keypairs follows the basic pattern of encoding/x509 to Parse and Marshal only the most basic and most meaningful parts of a key.

I highly recommend that you use Thumbprint() for KeyID you also get the benefit of not losing information when encoding and decoding between the ASN.1, x509, PEM, and JWK formats.

LICENSE

Copyright (c) 2020-present AJ ONeal
Copyright (c) 2018-2019 Big Squid, Inc.

This work is licensed under the terms of the MIT license.
For a copy, see https://opensource.org/licenses/MIT.