Skip to content

Commit

Permalink
Merge pull request trustbloc#1715 from mishasizov-SK/feat-remove-key-…
Browse files Browse the repository at this point in the history
…from-aws-kms

feat: delete key from aws kms
  • Loading branch information
fqutishat authored May 2, 2024
2 parents 7d48e80 + f0b4f70 commit c37a16a
Show file tree
Hide file tree
Showing 4 changed files with 90 additions and 1 deletion.
16 changes: 16 additions & 0 deletions pkg/kms/aws/service.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ type awsClient interface {
optFns ...func(*kms.Options)) (*kms.CreateAliasOutput, error)
Encrypt(ctx context.Context, params *kms.EncryptInput, optFns ...func(*kms.Options)) (*kms.EncryptOutput, error)
Decrypt(ctx context.Context, params *kms.DecryptInput, optFns ...func(*kms.Options)) (*kms.DecryptOutput, error)
ScheduleKeyDeletion(ctx context.Context, params *kms.ScheduleKeyDeletionInput,
optFns ...func(*kms.Options)) (*kms.ScheduleKeyDeletionOutput, error)
}

type metricsProvider interface {
Expand Down Expand Up @@ -393,6 +395,20 @@ func (s *Service) CreateAndExportPubKeyBytes(kt arieskms.KeyType, _ ...arieskms.
return keyID, pubKeyBytes, nil
}

// Remove removes kms key referenced by keyURI from KMS.
func (s *Service) Remove(keyURI string) error {
keyID, err := s.getKeyID(keyURI)
if err != nil {
return err
}

_, err = s.client.ScheduleKeyDeletion(context.Background(), &kms.ScheduleKeyDeletionInput{
KeyId: aws.String(keyID),
})

return err
}

// ImportPrivateKey private key.
func (s *Service) ImportPrivateKey(_ interface{}, _ arieskms.KeyType,
_ ...arieskms.PrivateKeyOpts) (string, interface{}, error) {
Expand Down
20 changes: 20 additions & 0 deletions pkg/kms/aws/service_mocks.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

53 changes: 53 additions & 0 deletions pkg/kms/aws/service_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -396,6 +396,59 @@ func TestCreate(t *testing.T) {
})
}

func TestRemove(t *testing.T) {
awsConfig := &aws.Config{
Region: "ca",
}

t.Run("success", func(t *testing.T) {
ctr := gomock.NewController(t)

metric := NewMockmetricsProvider(ctr)
client := NewMockawsClient(ctr)

keyURI := "aws-kms://arn:aws:kms:ca-central-1:111122223333:key/800d5768-3fd7-4edd-a4b8-4c81c3e4c147"
expectedKeyID := "800d5768-3fd7-4edd-a4b8-4c81c3e4c147"

client.EXPECT().ScheduleKeyDeletion(gomock.Any(), &kms.ScheduleKeyDeletionInput{KeyId: &expectedKeyID}).
Return(nil, nil)

svc := New(awsConfig, metric, "", WithAWSClient(client))

err := svc.Remove(keyURI)
require.NoError(t, err)
})

t.Run("failed to parse key id", func(t *testing.T) {
metric := NewMockmetricsProvider(gomock.NewController(t))

svc := New(awsConfig, metric, "", []Opts{}...)

err := svc.Remove("aws-kms://arn:aws:kms:key1")
require.Error(t, err)
require.Contains(t, err.Error(), "extracting key id from URI failed")
})

t.Run("failed to schedule key deletion", func(t *testing.T) {
ctr := gomock.NewController(t)

metric := NewMockmetricsProvider(ctr)
client := NewMockawsClient(ctr)

keyURI := "aws-kms://arn:aws:kms:ca-central-1:111122223333:key/800d5768-3fd7-4edd-a4b8-4c81c3e4c147"
expectedKeyID := "800d5768-3fd7-4edd-a4b8-4c81c3e4c147"

client.EXPECT().ScheduleKeyDeletion(gomock.Any(), &kms.ScheduleKeyDeletionInput{KeyId: &expectedKeyID}).
Return(nil, errors.New("some error"))

svc := New(awsConfig, metric, "", WithAWSClient(client))

err := svc.Remove(keyURI)
require.Error(t, err)
require.Contains(t, err.Error(), "some error")
})
}

func TestGet(t *testing.T) {
awsConfig := aws.Config{
Region: "ca",
Expand Down
2 changes: 1 addition & 1 deletion pkg/service/issuecredential/issuecredential_service.go
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ func (s *Service) IssueCredential(
f(options)
}

kms, err := s.kmsRegistry.GetKeyManager(profile.KMSConfig)
kms, err := s.kmsRegistry.GetKeyManager(profile.KMSConfig) // If nil - default config is used.
if err != nil {
return nil, fmt.Errorf("get kms: %w", err)
}
Expand Down

0 comments on commit c37a16a

Please sign in to comment.