Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use fallback key ID when key version is empty #3482

Merged
merged 4 commits into from
May 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions internal/crypto/engine.go
Original file line number Diff line number Diff line change
Expand Up @@ -194,12 +194,6 @@ func (e *engine) decrypt(data EncryptedData) ([]byte, error) {
return nil, fmt.Errorf("%w: %s", algorithms.ErrUnknownAlgorithm, e.defaultAlgorithm)
}

// for backwards compatibility with encrypted data which doesn't have the
// key ID stored in the DB.
if data.KeyVersion == "" {
data.KeyVersion = e.defaultKeyID
}

key, err := e.keystore.GetKey(data.KeyVersion)
if err != nil {
// error from keystore is good enough - we do not need more context
Expand Down
20 changes: 18 additions & 2 deletions internal/crypto/engine_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,22 @@ func TestDecryptBadAlgorithm(t *testing.T) {
func TestDecryptBadEncoding(t *testing.T) {
t.Parallel()

engine, err := NewEngineFromConfig(config)
require.NoError(t, err)
encryptedToken := EncryptedData{
Algorithm: algorithms.Aes256Cfb,
EncodedData: "abc",
KeyVersion: "test_encryption_key",
}
require.NoError(t, err)

_, err = engine.DecryptString(encryptedToken)
require.ErrorContains(t, err, "error decoding secret")
}

func TestDecryptNoVersionNoFallback(t *testing.T) {
t.Parallel()

engine, err := NewEngineFromConfig(config)
require.NoError(t, err)
encryptedToken := EncryptedData{
Expand All @@ -187,7 +203,7 @@ func TestDecryptBadEncoding(t *testing.T) {
require.NoError(t, err)

_, err = engine.DecryptString(encryptedToken)
require.ErrorContains(t, err, "error decoding secret")
require.ErrorContains(t, err, "empty key ID with no config defined")
}

func TestDecryptFailedDecryption(t *testing.T) {
Expand All @@ -199,7 +215,7 @@ func TestDecryptFailedDecryption(t *testing.T) {
Algorithm: algorithms.Aes256Cfb,
// too small of a value - will trigger the ciphertext length check
EncodedData: "abcdef0123456789",
KeyVersion: "",
KeyVersion: "test_encryption_key",
}
require.NoError(t, err)

Expand Down
19 changes: 15 additions & 4 deletions internal/crypto/keystores/keystore.go
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,10 @@ func NewKeyStoreFromConfig(config serverconfig.CryptoConfig) (KeyStore, error) {
// Join the default key to the fallback keys to assemble the full
// set of keys to load.
keyIDs := []string{config.Default.KeyID}
fallbackKeyID := ""
if config.Fallback.KeyID != "" {
keyIDs = append(keyIDs, config.Fallback.KeyID)
fallbackKeyID = config.Fallback.KeyID
}
keys := make(keysByID, len(keyIDs))
for _, keyID := range keyIDs {
Expand All @@ -68,21 +70,30 @@ func NewKeyStoreFromConfig(config serverconfig.CryptoConfig) (KeyStore, error) {
}

return &localFileKeyStore{
keys: keys,
keys: keys,
fallbackKeyID: fallbackKeyID,
}, nil
}

// NewKeyStoreFromMap constructs a keystore from a map of key ID to key bytes.
// This is mostly useful for testing.
func NewKeyStoreFromMap(keys keysByID) KeyStore {
return &localFileKeyStore{keys}
func NewKeyStoreFromMap(keys keysByID, fallbackID string) KeyStore {
return &localFileKeyStore{keys, fallbackID}
}

type localFileKeyStore struct {
keys keysByID
keys keysByID
fallbackKeyID string
}

func (l *localFileKeyStore) GetKey(id string) ([]byte, error) {
if id == "" {
if l.fallbackKeyID != "" {
id = l.fallbackKeyID
} else {
return nil, errors.New("empty key ID with no config defined")
}
}
key, ok := l.keys[id]
if !ok {
return nil, fmt.Errorf("%w: %s", ErrUnknownKeyID, id)
Expand Down
53 changes: 47 additions & 6 deletions internal/crypto/keystores/keystore_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -96,12 +96,12 @@ func TestNewKeyStoreFromConfig(t *testing.T) {
func TestLocalFileKeyStore_GetKey(t *testing.T) {
t.Parallel()

keyID := "my_key"
key := []byte{0, 1, 2, 3, 4, 5, 6, 7, 8, 9}

keystore := keystores.NewKeyStoreFromMap(map[string][]byte{
keyID: key,
})
keystore := keystores.NewKeyStoreFromMap(
map[string][]byte{
keyID: key,
},
"",
)

result, err := keystore.GetKey(keyID)
require.NoError(t, err)
Expand All @@ -110,3 +110,44 @@ func TestLocalFileKeyStore_GetKey(t *testing.T) {
_, err = keystore.GetKey("foobar")
require.ErrorIs(t, err, keystores.ErrUnknownKeyID)
}

func TestLocalFileKeyStore_GetKeyEmptyString(t *testing.T) {
t.Parallel()

keystore := keystores.NewKeyStoreFromMap(
map[string][]byte{
keyID: key,
},
keyID,
)

result, err := keystore.GetKey("")
require.NoError(t, err)
require.Equal(t, key, result)

result, err = keystore.GetKey(keyID)
require.NoError(t, err)
require.Equal(t, key, result)
}

func TestLocalFileKeyStore_GetKeyEmptyStringNoFallback(t *testing.T) {
t.Parallel()

keystore := keystores.NewKeyStoreFromMap(
map[string][]byte{
keyID: key,
},
"",
)

_, err := keystore.GetKey("")
require.ErrorContains(t, err, "empty key ID with no config defined")
}

const (
keyID = "my_key"
)

var (
key = []byte{0, 1, 2, 3, 4, 5, 6, 7, 8, 9}
)