mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
feat: enable key rotation (#15066)
This PR contains the remaining logic necessary to hook up key rotation to the product.
This commit is contained in:
@@ -65,6 +65,12 @@ func Encrypt(ctx context.Context, e EncryptKeyProvider, claims Claims) (string,
|
||||
return compact, nil
|
||||
}
|
||||
|
||||
func WithDecryptExpected(expected jwt.Expected) func(*DecryptOptions) {
|
||||
return func(opts *DecryptOptions) {
|
||||
opts.RegisteredClaims = expected
|
||||
}
|
||||
}
|
||||
|
||||
// DecryptOptions are options for decrypting a JWE.
|
||||
type DecryptOptions struct {
|
||||
RegisteredClaims jwt.Expected
|
||||
@@ -100,7 +106,7 @@ func Decrypt(ctx context.Context, d DecryptKeyProvider, token string, claims Cla
|
||||
|
||||
kid := object.Header.KeyID
|
||||
if kid == "" {
|
||||
return xerrors.Errorf("expected %q header to be a string", keyIDHeaderKey)
|
||||
return ErrMissingKeyID
|
||||
}
|
||||
|
||||
key, err := d.DecryptingKey(ctx, kid)
|
||||
|
||||
+61
-1
@@ -10,10 +10,27 @@ import (
|
||||
"golang.org/x/xerrors"
|
||||
)
|
||||
|
||||
var ErrMissingKeyID = xerrors.New("missing key ID")
|
||||
|
||||
const (
|
||||
keyIDHeaderKey = "kid"
|
||||
)
|
||||
|
||||
// RegisteredClaims is a convenience type for embedding jwt.Claims. It should be
|
||||
// preferred over embedding jwt.Claims directly since it will ensure that certain fields are set.
|
||||
type RegisteredClaims jwt.Claims
|
||||
|
||||
func (r RegisteredClaims) Validate(e jwt.Expected) error {
|
||||
if r.Expiry == nil {
|
||||
return xerrors.Errorf("expiry is required")
|
||||
}
|
||||
if e.Time.IsZero() {
|
||||
return xerrors.Errorf("expected time is required")
|
||||
}
|
||||
|
||||
return (jwt.Claims(r)).Validate(e)
|
||||
}
|
||||
|
||||
// Claims defines the payload for a JWT. Most callers
|
||||
// should embed jwt.Claims
|
||||
type Claims interface {
|
||||
@@ -24,6 +41,11 @@ const (
|
||||
signingAlgo = jose.HS512
|
||||
)
|
||||
|
||||
type SigningKeyManager interface {
|
||||
SigningKeyProvider
|
||||
VerifyKeyProvider
|
||||
}
|
||||
|
||||
type SigningKeyProvider interface {
|
||||
SigningKey(ctx context.Context) (id string, key interface{}, err error)
|
||||
}
|
||||
@@ -75,6 +97,12 @@ type VerifyOptions struct {
|
||||
SignatureAlgorithm jose.SignatureAlgorithm
|
||||
}
|
||||
|
||||
func WithVerifyExpected(expected jwt.Expected) func(*VerifyOptions) {
|
||||
return func(opts *VerifyOptions) {
|
||||
opts.RegisteredClaims = expected
|
||||
}
|
||||
}
|
||||
|
||||
// Verify verifies that a token was signed by the provided key. It unmarshals into the provided claims.
|
||||
func Verify(ctx context.Context, v VerifyKeyProvider, token string, claims Claims, opts ...func(*VerifyOptions)) error {
|
||||
options := VerifyOptions{
|
||||
@@ -105,7 +133,7 @@ func Verify(ctx context.Context, v VerifyKeyProvider, token string, claims Claim
|
||||
|
||||
kid := signature.Header.KeyID
|
||||
if kid == "" {
|
||||
return xerrors.Errorf("expected %q header to be a string", keyIDHeaderKey)
|
||||
return ErrMissingKeyID
|
||||
}
|
||||
|
||||
key, err := v.VerifyingKey(ctx, kid)
|
||||
@@ -125,3 +153,35 @@ func Verify(ctx context.Context, v VerifyKeyProvider, token string, claims Claim
|
||||
|
||||
return claims.Validate(options.RegisteredClaims)
|
||||
}
|
||||
|
||||
// StaticKey fulfills the SigningKeycache and EncryptionKeycache interfaces. Useful for testing.
|
||||
type StaticKey struct {
|
||||
ID string
|
||||
Key interface{}
|
||||
}
|
||||
|
||||
func (s StaticKey) SigningKey(_ context.Context) (string, interface{}, error) {
|
||||
return s.ID, s.Key, nil
|
||||
}
|
||||
|
||||
func (s StaticKey) VerifyingKey(_ context.Context, id string) (interface{}, error) {
|
||||
if id != s.ID {
|
||||
return nil, xerrors.Errorf("invalid id %q", id)
|
||||
}
|
||||
return s.Key, nil
|
||||
}
|
||||
|
||||
func (s StaticKey) EncryptingKey(_ context.Context) (string, interface{}, error) {
|
||||
return s.ID, s.Key, nil
|
||||
}
|
||||
|
||||
func (s StaticKey) DecryptingKey(_ context.Context, id string) (interface{}, error) {
|
||||
if id != s.ID {
|
||||
return nil, xerrors.Errorf("invalid id %q", id)
|
||||
}
|
||||
return s.Key, nil
|
||||
}
|
||||
|
||||
func (StaticKey) Close() error {
|
||||
return nil
|
||||
}
|
||||
|
||||
@@ -236,11 +236,11 @@ func TestJWS(t *testing.T) {
|
||||
ctx = testutil.Context(t, testutil.WaitShort)
|
||||
db, _ = dbtestutil.NewDB(t)
|
||||
_ = dbgen.CryptoKey(t, db, database.CryptoKey{
|
||||
Feature: database.CryptoKeyFeatureOidcConvert,
|
||||
Feature: database.CryptoKeyFeatureOIDCConvert,
|
||||
StartsAt: time.Now(),
|
||||
})
|
||||
log = slogtest.Make(t, nil)
|
||||
fetcher = &cryptokeys.DBFetcher{DB: db, Feature: database.CryptoKeyFeatureOidcConvert}
|
||||
fetcher = &cryptokeys.DBFetcher{DB: db}
|
||||
)
|
||||
|
||||
cache, err := cryptokeys.NewSigningCache(ctx, log, fetcher, codersdk.CryptoKeyFeatureOIDCConvert)
|
||||
@@ -326,15 +326,15 @@ func TestJWE(t *testing.T) {
|
||||
ctx = testutil.Context(t, testutil.WaitShort)
|
||||
db, _ = dbtestutil.NewDB(t)
|
||||
_ = dbgen.CryptoKey(t, db, database.CryptoKey{
|
||||
Feature: database.CryptoKeyFeatureWorkspaceApps,
|
||||
Feature: database.CryptoKeyFeatureWorkspaceAppsAPIKey,
|
||||
StartsAt: time.Now(),
|
||||
})
|
||||
log = slogtest.Make(t, nil)
|
||||
|
||||
fetcher = &cryptokeys.DBFetcher{DB: db, Feature: database.CryptoKeyFeatureWorkspaceApps}
|
||||
fetcher = &cryptokeys.DBFetcher{DB: db}
|
||||
)
|
||||
|
||||
cache, err := cryptokeys.NewEncryptionCache(ctx, log, fetcher, codersdk.CryptoKeyFeatureWorkspaceApp)
|
||||
cache, err := cryptokeys.NewEncryptionCache(ctx, log, fetcher, codersdk.CryptoKeyFeatureWorkspaceAppsAPIKey)
|
||||
require.NoError(t, err)
|
||||
|
||||
claims := testClaims{
|
||||
|
||||
Reference in New Issue
Block a user