-
Notifications
You must be signed in to change notification settings - Fork 120
CNTRLPLANE-3364: add the kms suite and migrate the kms tests of auth-o to ote #895
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
Open
sandeepknd
wants to merge
1
commit into
openshift:master
Choose a base branch
from
sandeepknd:kms-suite-auth
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+108
−77
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| package e2e_encryption_kms | ||
|
|
||
| import ( | ||
| "context" | ||
| "math/rand/v2" | ||
| "testing" | ||
|
|
||
| g "github.com/onsi/ginkgo/v2" | ||
| "k8s.io/apimachinery/pkg/runtime" | ||
|
|
||
| configv1 "github.com/openshift/api/config/v1" | ||
| operatorencryption "github.com/openshift/cluster-authentication-operator/test/library/encryption" | ||
| library "github.com/openshift/library-go/test/library/encryption" | ||
| librarykms "github.com/openshift/library-go/test/library/encryption/kms" | ||
| ) | ||
|
|
||
| var _ = g.Describe("[sig-auth] cluster-authentication-operator", func() { | ||
| g.It("TestKMSEncryptionOnOff [OCPFeatureGate:KMSEncryption][Serial][Timeout:120m]", func() { | ||
| testKMSEncryptionOnOff(g.GinkgoTB()) | ||
| }) | ||
|
|
||
| g.It("TestKMSEncryptionProvidersMigration [OCPFeatureGate:KMSEncryption][Serial][Timeout:120m]", func() { | ||
| testKMSEncryptionProvidersMigration(g.GinkgoTB()) | ||
| }) | ||
| }) | ||
|
|
||
| // testKMSEncryptionOnOff tests KMS encryption on/off cycle. | ||
| // This test: | ||
| // 2. Creates a test OAuth access token (TokenOfLife) | ||
| // 3. Enables KMS encryption | ||
| // 4. Verifies token is encrypted | ||
| // 5. Disables encryption (Identity) | ||
| // 6. Verifies token is NOT encrypted | ||
| // 7. Re-enables KMS encryption | ||
| // 8. Verifies token is encrypted again | ||
| // 9. Disables encryption (Identity) again | ||
| // 10. Verifies token is NOT encrypted again | ||
| func testKMSEncryptionOnOff(t testing.TB) { | ||
| librarykms.DeployUpstreamMockKMSPlugin(context.Background(), t, library.GetClients(t).Kube, librarykms.WellKnownUpstreamMockKMSPluginNamespace, librarykms.WellKnownUpstreamMockKMSPluginImage, librarykms.DefaultKMSPluginCount) | ||
| library.TestEncryptionTurnOnAndOff(t, library.OnOffScenario{ | ||
| BasicScenario: library.BasicScenario{ | ||
| Namespace: "openshift-config-managed", | ||
| LabelSelector: "encryption.apiserver.operator.openshift.io/component" + "=" + "openshift-oauth-apiserver", | ||
| EncryptionConfigSecretName: "encryption-config-openshift-oauth-apiserver", | ||
| EncryptionConfigSecretNamespace: "openshift-config-managed", | ||
| OperatorNamespace: "openshift-authentication-operator", | ||
| TargetGRs: operatorencryption.DefaultTargetGRs, | ||
| AssertFunc: operatorencryption.AssertTokens, | ||
| }, | ||
| CreateResourceFunc: func(t testing.TB, _ library.ClientSet, namespace string) runtime.Object { | ||
| return operatorencryption.CreateAndStoreTokenOfLife(context.TODO(), t, operatorencryption.GetClients(t)) | ||
| }, | ||
| AssertResourceEncryptedFunc: operatorencryption.AssertTokenOfLifeEncrypted, | ||
| AssertResourceNotEncryptedFunc: operatorencryption.AssertTokenOfLifeNotEncrypted, | ||
| ResourceFunc: func(t testing.TB, _ string) runtime.Object { return operatorencryption.TokenOfLife(t) }, | ||
| ResourceName: "TokenOfLife", | ||
| EncryptionProvider: configv1.APIServerEncryption{ | ||
| Type: configv1.EncryptionTypeKMS, | ||
| KMS: librarykms.DefaultFakeKMSPluginConfig, | ||
| }, | ||
| }) | ||
| } | ||
|
|
||
| // testKMSEncryptionProvidersMigration tests migration between KMS and AES encryption providers. | ||
| // This test: | ||
| // 1. Deploys the mock KMS plugin | ||
| // 2. Creates a test OAuth access token (TokenOfLife) | ||
| // 3. Randomly picks one AES encryption provider (AESGCM or AESCBC) | ||
| // 4. Shuffles the selected AES provider with KMS to create a randomized migration order | ||
| // 5. Migrates between the providers in the shuffled order | ||
| // 6. Verifies token is correctly encrypted after each migration | ||
| func testKMSEncryptionProvidersMigration(t testing.TB) { | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. were there any changes to this test ?
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. the latest changes made to this test (multiline parameters) has been pulled in this PR as well. |
||
| librarykms.DeployUpstreamMockKMSPlugin(context.Background(), t, library.GetClients(t).Kube, librarykms.WellKnownUpstreamMockKMSPluginNamespace, librarykms.WellKnownUpstreamMockKMSPluginImage, librarykms.DefaultKMSPluginCount) | ||
| library.TestEncryptionProvidersMigration(t, library.ProvidersMigrationScenario{ | ||
| BasicScenario: library.BasicScenario{ | ||
| Namespace: "openshift-config-managed", | ||
| LabelSelector: "encryption.apiserver.operator.openshift.io/component" + "=" + "openshift-oauth-apiserver", | ||
| EncryptionConfigSecretName: "encryption-config-openshift-oauth-apiserver", | ||
| EncryptionConfigSecretNamespace: "openshift-config-managed", | ||
| OperatorNamespace: "openshift-authentication-operator", | ||
| TargetGRs: operatorencryption.DefaultTargetGRs, | ||
| AssertFunc: operatorencryption.AssertTokens, | ||
| }, | ||
| CreateResourceFunc: func(t testing.TB, _ library.ClientSet, namespace string) runtime.Object { | ||
| return operatorencryption.CreateAndStoreTokenOfLife(context.TODO(), t, operatorencryption.GetClients(t)) | ||
| }, | ||
| AssertResourceEncryptedFunc: operatorencryption.AssertTokenOfLifeEncrypted, | ||
| AssertResourceNotEncryptedFunc: operatorencryption.AssertTokenOfLifeNotEncrypted, | ||
| ResourceFunc: func(t testing.TB, _ string) runtime.Object { return operatorencryption.TokenOfLife(t) }, | ||
| ResourceName: "TokenOfLife", | ||
| EncryptionProviders: library.ShuffleEncryptionProviders([]configv1.APIServerEncryption{ | ||
| {Type: configv1.EncryptionTypeKMS, KMS: librarykms.DefaultFakeKMSPluginConfig}, | ||
| library.SupportedStaticEncryptionProviders[rand.IntN(len(library.SupportedStaticEncryptionProviders))], | ||
| }), | ||
| }) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,88 +1,13 @@ | ||
| package e2e_encryption_kms | ||
|
|
||
| import ( | ||
| "context" | ||
| "math/rand/v2" | ||
| "testing" | ||
|
|
||
| "k8s.io/apimachinery/pkg/runtime" | ||
|
|
||
| configv1 "github.com/openshift/api/config/v1" | ||
| operatorencryption "github.com/openshift/cluster-authentication-operator/test/library/encryption" | ||
| library "github.com/openshift/library-go/test/library/encryption" | ||
| librarykms "github.com/openshift/library-go/test/library/encryption/kms" | ||
| ) | ||
|
|
||
| // TestKMSEncryptionOnOff tests KMS encryption on/off cycle. | ||
|
sandeepknd marked this conversation as resolved.
|
||
| // This test: | ||
| // 2. Creates a test OAuth access token (TokenOfLife) | ||
| // 3. Enables KMS encryption | ||
| // 4. Verifies token is encrypted | ||
| // 5. Disables encryption (Identity) | ||
| // 6. Verifies token is NOT encrypted | ||
| // 7. Re-enables KMS encryption | ||
| // 8. Verifies token is encrypted again | ||
| // 9. Disables encryption (Identity) again | ||
| // 10. Verifies token is NOT encrypted again | ||
| func TestKMSEncryptionOnOff(t *testing.T) { | ||
| // Deploy the mock KMS plugin for testing. | ||
|
sandeepknd marked this conversation as resolved.
|
||
| // NOTE: This manual deployment is only required for KMS v1. In the future, | ||
| // the platform will manage the KMS plugins, and this code will no longer be needed. | ||
| librarykms.DeployUpstreamMockKMSPlugin(context.Background(), t, library.GetClients(t).Kube, librarykms.WellKnownUpstreamMockKMSPluginNamespace, librarykms.WellKnownUpstreamMockKMSPluginImage, librarykms.DefaultKMSPluginCount) | ||
| library.TestEncryptionTurnOnAndOff(t, library.OnOffScenario{ | ||
| BasicScenario: library.BasicScenario{ | ||
| Namespace: "openshift-config-managed", | ||
| LabelSelector: "encryption.apiserver.operator.openshift.io/component" + "=" + "openshift-oauth-apiserver", | ||
| EncryptionConfigSecretName: "encryption-config-openshift-oauth-apiserver", | ||
| EncryptionConfigSecretNamespace: "openshift-config-managed", | ||
| OperatorNamespace: "openshift-authentication-operator", | ||
| TargetGRs: operatorencryption.DefaultTargetGRs, | ||
| AssertFunc: operatorencryption.AssertTokens, | ||
| }, | ||
| CreateResourceFunc: func(t testing.TB, _ library.ClientSet, namespace string) runtime.Object { | ||
| return operatorencryption.CreateAndStoreTokenOfLife(context.TODO(), t, operatorencryption.GetClients(t)) | ||
| }, | ||
| AssertResourceEncryptedFunc: operatorencryption.AssertTokenOfLifeEncrypted, | ||
| AssertResourceNotEncryptedFunc: operatorencryption.AssertTokenOfLifeNotEncrypted, | ||
| ResourceFunc: func(t testing.TB, _ string) runtime.Object { return operatorencryption.TokenOfLife(t) }, | ||
| ResourceName: "TokenOfLife", | ||
| EncryptionProvider: configv1.APIServerEncryption{ | ||
| Type: configv1.EncryptionTypeKMS, | ||
| KMS: librarykms.DefaultFakeKMSPluginConfig, | ||
| }, | ||
| }) | ||
| testKMSEncryptionOnOff(t) | ||
| } | ||
|
|
||
| // TestKMSEncryptionProvidersMigration tests migration between KMS and AES encryption providers. | ||
|
sandeepknd marked this conversation as resolved.
|
||
| // This test: | ||
| // 1. Deploys the mock KMS plugin | ||
| // 2. Creates a test OAuth access token (TokenOfLife) | ||
| // 3. Randomly picks one AES encryption provider (AESGCM or AESCBC) | ||
| // 4. Shuffles the selected AES provider with KMS to create a randomized migration order | ||
| // 5. Migrates between the providers in the shuffled order | ||
| // 6. Verifies token is correctly encrypted after each migration | ||
| func TestKMSEncryptionProvidersMigration(t *testing.T) { | ||
| librarykms.DeployUpstreamMockKMSPlugin(context.Background(), t, library.GetClients(t).Kube, librarykms.WellKnownUpstreamMockKMSPluginNamespace, librarykms.WellKnownUpstreamMockKMSPluginImage, librarykms.DefaultKMSPluginCount) | ||
| library.TestEncryptionProvidersMigration(t, library.ProvidersMigrationScenario{ | ||
| BasicScenario: library.BasicScenario{ | ||
| Namespace: "openshift-config-managed", | ||
| LabelSelector: "encryption.apiserver.operator.openshift.io/component" + "=" + "openshift-oauth-apiserver", | ||
| EncryptionConfigSecretName: "encryption-config-openshift-oauth-apiserver", | ||
| EncryptionConfigSecretNamespace: "openshift-config-managed", | ||
| OperatorNamespace: "openshift-authentication-operator", | ||
| TargetGRs: operatorencryption.DefaultTargetGRs, | ||
| AssertFunc: operatorencryption.AssertTokens, | ||
| }, | ||
| CreateResourceFunc: func(t testing.TB, _ library.ClientSet, namespace string) runtime.Object { | ||
| return operatorencryption.CreateAndStoreTokenOfLife(context.TODO(), t, operatorencryption.GetClients(t)) | ||
| }, | ||
| AssertResourceEncryptedFunc: operatorencryption.AssertTokenOfLifeEncrypted, | ||
| AssertResourceNotEncryptedFunc: operatorencryption.AssertTokenOfLifeNotEncrypted, | ||
| ResourceFunc: func(t testing.TB, _ string) runtime.Object { return operatorencryption.TokenOfLife(t) }, | ||
| ResourceName: "TokenOfLife", | ||
| EncryptionProviders: library.ShuffleEncryptionProviders([]configv1.APIServerEncryption{ | ||
| {Type: configv1.EncryptionTypeKMS, KMS: librarykms.DefaultFakeKMSPluginConfig}, | ||
| library.SupportedStaticEncryptionProviders[rand.IntN(len(library.SupportedStaticEncryptionProviders))], | ||
| }), | ||
| }) | ||
| testKMSEncryptionProvidersMigration(t) | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
were there any changes to this test ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the latest changes made to this test has been pulled in this PR as well.