README
¶
RSA PKCS#1 v1.5 Signature Provider
Test coverage: Fully tested using unit tests and integration tests. No static tests of signing and verification. Signing and verification manually validated against jwt.io.
This package implements a verification and siging provider using the RSA PKCS#1 v1.5 algorithms for JWT / JWS as specified in RFC 7518.
How to initialize
const (
RS256 = 1
RS384 = 2
RS512 = 3
)
NewProvider(algorithm int) (Provider, error)
NewProviderWithKeyURL(algorithm int, keyURL string) (Provider, error)
NewSettings(key []byte, keyID string) (Settings, error)
NewSettingsWithKeyURL(key []byte, keyID, keyURL string) (Settings, error)
LoadProvider(settings Settings, algorithm int) (Provider, error)
There are two ways to initialize this package:
- Generate a new key using
NewProviderwhich optionally may also include a key URL. Note that you will need to upload the public key to the key store manually. - Load an existing key by creating a new
Settingsstruct usingNewSettingssupplying the key as a byte slice (encoded as PKCS8 or PKCS1 private key) and then callingLoadProviderwith the settings.
The provider has to be registered using the name RSxxx to be compliant with RFC 7518. It will be able to sign and verify keys for the specified byte size only.
Managing public keys
provider.CurrentKey() publickey.PublicKey
provider.AddPublicKey(key publickey.PublicKey) error
provider.RemovePublicKey(keyID string)
To retrieve the public key corresponding to the private key used for signing, use provider.CurrentKey.
Adding a public key is done via provider.AddPublicKey while removing works via provider.RemovePublicKey.
Documentation
¶
Index ¶
- Constants
- type Provider
- func (p *Provider) AddPublicKey(key publickey.PublicKey) error
- func (p Provider) CurrentKey() publickey.PublicKey
- func (p Provider) Header(h *jwt.Header)
- func (p *Provider) RemovePublicKey(keyid string)
- func (p Provider) Sign(c []byte) ([]byte, error)
- func (p Provider) Verify(data, sig []byte, h jwt.Header) error
- type Settings
Constants ¶
const ( // RS256 is RSA PKCS#1 v1.5 using SHA256 RS256 = 1 // RS384 is RSA PKCS#1 v1.5 using SHA384 RS384 = 2 // RS512 is RSA PKCS#1 v1.5 using SHA512 RS512 = 3 )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Provider ¶
type Provider struct {
// contains filtered or unexported fields
}
Provider provides RSA PKCS#1 v1.5 using the selected hashing algorithm JWS signing and verification
func LoadProvider ¶
LoadProvider returns a Provider using the supplied keypairs
func NewProvider ¶
NewProvider creates a new Provider generating the necessary keypairs
func NewProviderWithKeyURL ¶
NewProviderWithKeyURL works just like NewProvider but also sets the key URL of the generated keys
func (*Provider) AddPublicKey ¶
AddPublicKey adds a public key for verification
func (Provider) CurrentKey ¶
CurrentKey returns the public key belonging to the private key used for signing.
func (Provider) Header ¶
func (p Provider) Header(h *jwt.Header)
Header sets the necessary JWT header fields
func (*Provider) RemovePublicKey ¶
RemovePublicKey removes a public key by it's key ID from the verification set
type Settings ¶
type Settings struct {
// contains filtered or unexported fields
}
Settings stores the key for an algorithm
func NewSettings ¶
NewSettings creates new signature settings for the parameters
Source Files