Skip to content

feat(policy): Add UnsafeUpdateKey implementation #3731

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.

Sign up for GitHub

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

Open
c-r33d wants to merge 14 commits into
base: main
Choose a base branch
from
Open

feat(policy): Add UnsafeUpdateKey implementation #3731

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
cac768e
feat(policy): Add UnsafeUpdateKey rpc.
c-r33d Jul 7, 2026
0307fa6
feat(policy): allow unsafe key provider config updates
c-r33d Jul 7, 2026
3f22b8a
feat(policy): validate unsafe key provider config id
c-r33d Jul 7, 2026
5d7bedc
feat(policy): Add UnsafeUpdateKey rpc.
c-r33d Jul 7, 2026
c4e4b75
add integration tests.
c-r33d Jul 7, 2026
a253c3a
fix(policy): enforce unsafe key provider rules in service
c-r33d Jul 8, 2026
3903990
fix(proto): relax unsafe key provider validation
c-r33d Jul 8, 2026
e432d74
Merge branch 'unsafe-update-key' into unsafe-update-key-impl
c-r33d Jul 8, 2026
b226894
Merge branch 'main' into unsafe-update-key-impl
c-r33d Jul 21, 2026
ded9cd8
comments.
c-r33d Jul 21, 2026
c67f8f8
fix linting.
c-r33d Jul 21, 2026
79469b6
coderabbit commnet.
c-r33d Jul 21, 2026
0955d4f
fix unsafe test.
c-r33d Jul 21, 2026
654c6f1
update proto/sdk.
c-r33d Jul 21, 2026
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
192 changes: 192 additions & 0 deletions service/integration/kas_registry_key_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
"github.com/opentdf/platform/service/pkg/db"
"github.com/stretchr/testify/suite"
"google.golang.org/protobuf/encoding/protojson"
"google.golang.org/protobuf/proto"
)

const (
Expand Down Expand Up @@ -458,6 +459,147 @@
s.Equal(s.kasKeys[1].ID, resp.GetKey().GetId())
}

func (s *KasRegistryKeySuite) Test_UnsafeUpdateKey_PublicKeyOnlyToRemote_Success() {
providerConfig := s.createUnsafeUpdateKeyProviderConfig("unsafe-update-key-remote")
createdKey := s.createUnsafeUpdateKeyTestKey(policy.KeyMode_KEY_MODE_PUBLIC_KEY_ONLY, "")
s.T().Cleanup(func() {
s.cleanupUnsafeUpdateKeyTestResources([]string{createdKey.GetKey().GetId()}, []string{providerConfig.GetId()})
})
expectedKey := proto.Clone(createdKey).(*policy.KasKey)

Check failure on line 468 in service/integration/kas_registry_key_test.go

View workflow job for this annotation

GitHub Actions / go (service) 

Error return value is not checked (errcheck)
expectedKey.GetKey().KeyMode = policy.KeyMode_KEY_MODE_REMOTE
expectedKey.GetKey().ProviderConfig = providerConfig

updatedKey, err := s.db.PolicyClient.UnsafeUpdateKey(s.ctx, createdKey, &unsafe.UnsafeUpdateKeyRequest{
Id: createdKey.GetKey().GetId(),
TargetKeyMode: policy.KeyMode_KEY_MODE_REMOTE,
ProviderConfigId: providerConfig.GetId(),
})
s.Require().NoError(err)
s.Require().NotNil(updatedKey)
expectedKey.GetKey().GetMetadata().UpdatedAt = updatedKey.GetKey().GetMetadata().GetUpdatedAt()
s.True(proto.Equal(expectedKey, updatedKey))

gotKey, err := s.db.PolicyClient.GetKey(s.ctx, &kasregistry.GetKeyRequest_Id{
Id: createdKey.GetKey().GetId(),
})
s.Require().NoError(err)
s.True(proto.Equal(expectedKey, gotKey))
}

func (s *KasRegistryKeySuite) Test_UnsafeUpdateKey_RemoteToPublicKeyOnly_Success() {
providerConfig := s.createUnsafeUpdateKeyProviderConfig("unsafe-update-key-public")
createdKey := s.createUnsafeUpdateKeyTestKey(policy.KeyMode_KEY_MODE_REMOTE, providerConfig.GetId())
s.T().Cleanup(func() {
s.cleanupUnsafeUpdateKeyTestResources([]string{createdKey.GetKey().GetId()}, []string{providerConfig.GetId()})
})
expectedKey := proto.Clone(createdKey).(*policy.KasKey)

Check failure on line 495 in service/integration/kas_registry_key_test.go

View workflow job for this annotation

GitHub Actions / go (service) 

Error return value is not checked (errcheck)
expectedKey.GetKey().KeyMode = policy.KeyMode_KEY_MODE_PUBLIC_KEY_ONLY
expectedKey.GetKey().ProviderConfig = nil

updatedKey, err := s.db.PolicyClient.UnsafeUpdateKey(s.ctx, createdKey, &unsafe.UnsafeUpdateKeyRequest{
Id: createdKey.GetKey().GetId(),
TargetKeyMode: policy.KeyMode_KEY_MODE_PUBLIC_KEY_ONLY,
})
s.Require().NoError(err)
s.Require().NotNil(updatedKey)
expectedKey.GetKey().GetMetadata().UpdatedAt = updatedKey.GetKey().GetMetadata().GetUpdatedAt()
s.True(proto.Equal(expectedKey, updatedKey))

gotKey, err := s.db.PolicyClient.GetKey(s.ctx, &kasregistry.GetKeyRequest_Id{
Id: createdKey.GetKey().GetId(),
})
s.Require().NoError(err)
s.True(proto.Equal(expectedKey, gotKey))
}

func (s *KasRegistryKeySuite) Test_UnsafeUpdateKey_ChangeProviderConfig_Success() {
originalProviderConfig := s.createUnsafeUpdateKeyProviderConfig("unsafe-update-key-original-provider")
updatedProviderConfig := s.createUnsafeUpdateKeyProviderConfig("unsafe-update-key-updated-provider")
createdKey := s.createUnsafeUpdateKeyTestKey(policy.KeyMode_KEY_MODE_REMOTE, originalProviderConfig.GetId())
s.T().Cleanup(func() {
s.cleanupUnsafeUpdateKeyTestResources(
[]string{createdKey.GetKey().GetId()},
[]string{originalProviderConfig.GetId(), updatedProviderConfig.GetId()},
)
})
expectedKey := proto.Clone(createdKey).(*policy.KasKey)

Check failure on line 525 in service/integration/kas_registry_key_test.go

View workflow job for this annotation

GitHub Actions / go (service) 

Error return value is not checked (errcheck)
expectedKey.GetKey().ProviderConfig = updatedProviderConfig

updatedKey, err := s.db.PolicyClient.UnsafeUpdateKey(s.ctx, createdKey, &unsafe.UnsafeUpdateKeyRequest{
Id: createdKey.GetKey().GetId(),
ProviderConfigId: updatedProviderConfig.GetId(),
})
s.Require().NoError(err)
s.Require().NotNil(updatedKey)
expectedKey.GetKey().GetMetadata().UpdatedAt = updatedKey.GetKey().GetMetadata().GetUpdatedAt()
s.True(proto.Equal(expectedKey, updatedKey))

gotKey, err := s.db.PolicyClient.GetKey(s.ctx, &kasregistry.GetKeyRequest_Id{
Id: createdKey.GetKey().GetId(),
})
s.Require().NoError(err)
s.True(proto.Equal(expectedKey, gotKey))
}

func (s *KasRegistryKeySuite) Test_UnsafeUpdateKey_NonexistentProviderConfig_Fails() {
createdKey := s.createUnsafeUpdateKeyTestKey(policy.KeyMode_KEY_MODE_PUBLIC_KEY_ONLY, "")
s.T().Cleanup(func() {
s.cleanupUnsafeUpdateKeyTestResources([]string{createdKey.GetKey().GetId()}, nil)
})

updatedKey, err := s.db.PolicyClient.UnsafeUpdateKey(s.ctx, createdKey, &unsafe.UnsafeUpdateKeyRequest{
Id: createdKey.GetKey().GetId(),
TargetKeyMode: policy.KeyMode_KEY_MODE_REMOTE,
ProviderConfigId: uuid.NewString(),
})
s.Require().Error(err)
s.Nil(updatedKey)
s.Require().ErrorIs(err, db.ErrUnsafeUpdateKeyProviderConfigNotFound)

gotKey, err := s.db.PolicyClient.GetKey(s.ctx, &kasregistry.GetKeyRequest_Id{
Id: createdKey.GetKey().GetId(),
})
s.Require().NoError(err)
s.True(proto.Equal(createdKey, gotKey))
}

func (s *KasRegistryKeySuite) Test_UnsafeUpdateKey_UnsupportedExistingKeyMode_Fails() {
providerConfig := s.createUnsafeUpdateKeyProviderConfig("unsafe-update-key-unsupported-mode")
keyResp, err := s.db.PolicyClient.CreateKey(s.ctx, &kasregistry.CreateKeyRequest{
KasId: s.kasKeys[0].KeyAccessServerID,
KeyId: uuid.NewString(),
KeyAlgorithm: policy.Algorithm_ALGORITHM_RSA_2048,
KeyMode: policy.KeyMode_KEY_MODE_CONFIG_ROOT_KEY,
PublicKeyCtx: &policy.PublicKeyCtx{Pem: keyCtx},
PrivateKeyCtx: &policy.PrivateKeyCtx{
KeyId: validKeyID1,
WrappedKey: keyCtx,
},
})
s.Require().NoError(err)
s.Require().NotNil(keyResp)
createdKey := keyResp.GetKasKey()
s.Require().NotNil(createdKey)
s.T().Cleanup(func() {
s.cleanupUnsafeUpdateKeyTestResources([]string{createdKey.GetKey().GetId()}, []string{providerConfig.GetId()})
})

updatedKey, err := s.db.PolicyClient.UnsafeUpdateKey(s.ctx, createdKey, &unsafe.UnsafeUpdateKeyRequest{
Id: createdKey.GetKey().GetId(),
TargetKeyMode: policy.KeyMode_KEY_MODE_REMOTE,
ProviderConfigId: providerConfig.GetId(),
})
s.Require().Error(err)
s.Nil(updatedKey)
s.Require().ErrorIs(err, db.ErrUnsafeUpdateKeyExistingModeUnsupported)

gotKey, err := s.db.PolicyClient.GetKey(s.ctx, &kasregistry.GetKeyRequest_Id{
Id: createdKey.GetKey().GetId(),
})
s.Require().NoError(err)
s.True(proto.Equal(createdKey, gotKey))
}

func (s *KasRegistryKeySuite) Test_ListKeys_InvalidLimit_Fail() {
req := kasregistry.ListKeysRequest{
Pagination: &policy.PageRequest{
Expand Down Expand Up @@ -2739,6 +2881,56 @@
}
}

func (s *KasRegistryKeySuite) createUnsafeUpdateKeyProviderConfig(namePrefix string) *policy.KeyProviderConfig {
providerConfig, err := s.db.PolicyClient.CreateProviderConfig(s.ctx, &keymanagement.CreateProviderConfigRequest{
Name: namePrefix + "-" + uuid.NewString(),
Manager: "opentdf.io/basic",
ConfigJson: validProviderConfig,
})
s.Require().NoError(err)
s.Require().NotNil(providerConfig)
return providerConfig
}

func (s *KasRegistryKeySuite) createUnsafeUpdateKeyTestKey(keyMode policy.KeyMode, providerConfigID string) *policy.KasKey {
keyResp, err := s.db.PolicyClient.CreateKey(s.ctx, &kasregistry.CreateKeyRequest{
KasId: s.kasKeys[0].KeyAccessServerID,
KeyId: uuid.NewString(),
KeyAlgorithm: policy.Algorithm_ALGORITHM_RSA_2048,
KeyMode: keyMode,
PublicKeyCtx: &policy.PublicKeyCtx{Pem: keyCtx},
ProviderConfigId: providerConfigID,
})
s.Require().NoError(err)
s.Require().NotNil(keyResp)
s.Require().NotNil(keyResp.GetKasKey())
return keyResp.GetKasKey()
}

func (s *KasRegistryKeySuite) cleanupUnsafeUpdateKeyTestResources(keyIDs []string, providerConfigIDs []string) {
for _, id := range keyIDs {
key, err := s.db.PolicyClient.GetKey(s.ctx, &kasregistry.GetKeyRequest_Id{
Id: id,
})
if err != nil {
s.Require().ErrorContains(err, db.ErrNotFound.Error())
continue
}

_, err = s.db.PolicyClient.UnsafeDeleteKey(s.ctx, key, &unsafe.UnsafeDeleteKasKeyRequest{
Id: key.GetKey().GetId(),
KasUri: key.GetKasUri(),
Kid: key.GetKey().GetKeyId(),
})
s.Require().NoError(err)
}

for _, id := range providerConfigIDs {
_, err := s.db.PolicyClient.DeleteProviderConfig(s.ctx, id)
s.Require().NoError(err)
}
}

func listKeysSearchIDs(keyIDsByKID map[string]string) []string {
keyIDs := make([]string, 0, len(keyIDsByKID))
for _, id := range keyIDsByKID {
Expand Down
Loading
Loading