forked from GoogleCloudPlatform/nodejs-docs-samples
-
Notifications
You must be signed in to change notification settings - Fork 0
feat(storage): add samples and system tests for bucket encryption enforcement #3
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
thiyaguk09
wants to merge
9
commits into
main
Choose a base branch
from
bucket-encryption-config
base: main
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.
Open
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
622dafd
feat(storage): add samples and system tests for bucket encryption enf…
thiyaguk09 21daffe
code refactor
thiyaguk09 69a6b0d
Merge branch 'main' into bucket-encryption-config
thiyaguk09 be2f205
Merge branch 'main' into bucket-encryption-config
iennae bc1acc1
Merge branch 'main' into bucket-encryption-config
thiyaguk09 2f0a2ce
test(storage): refactor encryption tests to assert state over strings
thiyaguk09 7777583
fix(livestream): stop all channels before pool update to avoid FAILED…
angelcaamal 986878c
Merge branch 'main' into bucket-encryption-config
thiyaguk09 1999532
test: skip bucket encryption enforcement tests if defaultKmsKeyName i…
thiyaguk09 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,76 @@ | ||
| // Copyright 2026 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| 'use strict'; | ||
|
|
||
| // sample-metadata: | ||
| // title: Get Bucket Encryption Enforcement | ||
| // description: Retrieves the current encryption enforcement configurations for a bucket. | ||
| // usage: node getBucketEncryptionEnforcementConfig.js <BUCKET_NAME> | ||
|
|
||
| function main(bucketName = 'my-bucket') { | ||
| // [START storage_get_encryption_enforcement_config] | ||
| /** | ||
| * TODO(developer): Uncomment the following lines before running the sample. | ||
| */ | ||
| // The ID of your GCS bucket | ||
| // const bucketName = 'your-unique-bucket-name'; | ||
|
|
||
| // Imports the Google Cloud client library | ||
| const {Storage} = require('@google-cloud/storage'); | ||
|
|
||
| // Creates a client | ||
| const storage = new Storage(); | ||
|
|
||
| async function getBucketEncryptionEnforcementConfig() { | ||
| const [metadata] = await storage.bucket(bucketName).getMetadata(); | ||
|
|
||
| console.log( | ||
| `Encryption enforcement configuration for bucket ${bucketName}.` | ||
| ); | ||
| const enc = metadata.encryption; | ||
| if (!enc) { | ||
| console.log( | ||
| 'No encryption configuration found (Default GMEK is active).' | ||
| ); | ||
| return; | ||
| } | ||
| console.log(`Default KMS Key: ${enc.defaultKmsKeyName || 'None'}`); | ||
|
|
||
| const printConfig = (label, config) => { | ||
| if (config) { | ||
| console.log(`${label}:`); | ||
| console.log(` Mode: ${config.restrictionMode}`); | ||
| console.log(` Effective: ${config.effectiveTime}`); | ||
| } | ||
| }; | ||
|
|
||
| printConfig( | ||
| 'Google Managed (GMEK) Enforcement', | ||
| enc.googleManagedEncryptionEnforcementConfig | ||
| ); | ||
| printConfig( | ||
| 'Customer Managed (CMEK) Enforcement', | ||
| enc.customerManagedEncryptionEnforcementConfig | ||
| ); | ||
| printConfig( | ||
| 'Customer Supplied (CSEK) Enforcement', | ||
| enc.customerSuppliedEncryptionEnforcementConfig | ||
| ); | ||
| } | ||
|
|
||
| getBucketEncryptionEnforcementConfig().catch(console.error); | ||
| // [END storage_get_encryption_enforcement_config] | ||
| } | ||
| main(...process.argv.slice(2)); |
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,93 @@ | ||
| // Copyright 2026 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| 'use strict'; | ||
|
|
||
| // sample-metadata: | ||
| // title: Set Bucket Encryption Enforcement | ||
| // description: Configures a bucket to enforce specific encryption types (e.g., CMEK-only). | ||
| // usage: node setBucketEncryptionEnforcementConfig.js <BUCKET_NAME> <KMS_KEY_NAME> | ||
|
|
||
| function main( | ||
| bucketName = 'my-bucket', | ||
| defaultKmsKeyName = process.env.GOOGLE_CLOUD_KMS_KEY_ASIA | ||
| ) { | ||
| // [START storage_set_encryption_enforcement_config] | ||
| /** | ||
| * TODO(developer): Uncomment the following lines before running the sample. | ||
| */ | ||
| // The ID of your GCS bucket | ||
| // const bucketName = 'your-unique-bucket-name'; | ||
|
|
||
| // The name of the KMS key to be used as the default | ||
| // const defaultKmsKeyName = 'my-key'; | ||
|
|
||
| // Imports the Google Cloud client library | ||
| const {Storage} = require('@google-cloud/storage'); | ||
|
|
||
| // Creates a client | ||
| const storage = new Storage(); | ||
|
|
||
| async function setBucketEncryptionEnforcementConfig() { | ||
| const options = { | ||
| encryption: { | ||
| defaultKmsKeyName, | ||
| googleManagedEncryptionEnforcementConfig: { | ||
| restrictionMode: 'FullyRestricted', | ||
| }, | ||
| customerSuppliedEncryptionEnforcementConfig: { | ||
| restrictionMode: 'FullyRestricted', | ||
| }, | ||
| customerManagedEncryptionEnforcementConfig: { | ||
| restrictionMode: 'NotRestricted', | ||
| }, | ||
| }, | ||
| }; | ||
|
|
||
| const [metadata] = await storage.bucket(bucketName).setMetadata(options); | ||
|
|
||
| console.log( | ||
| `Encryption enforcement configuration updated for bucket ${bucketName}.` | ||
| ); | ||
| const enc = metadata.encryption; | ||
| if (enc) { | ||
| console.log(`Default KMS Key: ${enc.defaultKmsKeyName}`); | ||
|
|
||
| const logEnforcement = (label, config) => { | ||
| if (config) { | ||
| console.log(`${label}:`); | ||
| console.log(` Mode: ${config.restrictionMode}`); | ||
| console.log(` Effective: ${config.effectiveTime}`); | ||
| } | ||
| }; | ||
|
|
||
| logEnforcement( | ||
| 'Google Managed (GMEK) Enforcement', | ||
| enc.googleManagedEncryptionEnforcementConfig | ||
| ); | ||
| logEnforcement( | ||
| 'Customer Managed (CMEK) Enforcement', | ||
| enc.customerManagedEncryptionEnforcementConfig | ||
| ); | ||
| logEnforcement( | ||
| 'Customer Supplied (CSEK) Enforcement', | ||
| enc.customerSuppliedEncryptionEnforcementConfig | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| setBucketEncryptionEnforcementConfig().catch(console.error); | ||
| // [END storage_set_encryption_enforcement_config] | ||
| } | ||
| main(...process.argv.slice(2)); |
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,143 @@ | ||
| // Copyright 2019 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| 'use strict'; | ||
|
|
||
| const {Storage} = require('@google-cloud/storage'); | ||
| const {assert} = require('chai'); | ||
| const {before, after, afterEach, it} = require('mocha'); | ||
| const cp = require('child_process'); | ||
| const uuid = require('uuid'); | ||
|
|
||
| const execSync = cmd => cp.execSync(cmd, {encoding: 'utf-8'}); | ||
|
|
||
| const storage = new Storage(); | ||
| const samplesTestBucketPrefix = `nodejs-storage-samples-${uuid.v4()}`; | ||
| const bucketName = `${samplesTestBucketPrefix}-a`; | ||
| const defaultKmsKeyName = process.env.GOOGLE_CLOUD_KMS_KEY_ASIA; | ||
| const bucket = storage.bucket(bucketName); | ||
|
|
||
| before(async () => { | ||
| await storage.createBucket(bucketName); | ||
| }); | ||
|
|
||
| async function deleteAllBucketsAsync() { | ||
| const [buckets] = await storage.getBuckets({prefix: samplesTestBucketPrefix}); | ||
|
|
||
| for (const bucket of buckets) { | ||
| await bucket.deleteFiles({force: true}); | ||
| await bucket.delete({ignoreNotFound: true}); | ||
| } | ||
| } | ||
|
|
||
| after(deleteAllBucketsAsync); | ||
| afterEach(async () => { | ||
| await new Promise(res => setTimeout(res, 1000)); | ||
| }); | ||
|
|
||
| it('should set bucket encryption enforcement configuration', async function () { | ||
| if (!defaultKmsKeyName) { | ||
| this.skip(); | ||
| } | ||
| const output = execSync( | ||
| `node setBucketEncryptionEnforcementConfig.js ${bucketName} ${defaultKmsKeyName}` | ||
| ); | ||
|
|
||
| assert.include( | ||
| output, | ||
| `Encryption enforcement configuration updated for bucket ${bucketName}.` | ||
| ); | ||
|
|
||
| assert.include(output, `Default KMS Key: ${defaultKmsKeyName}`); | ||
|
|
||
| assert.include(output, 'Google Managed (GMEK) Enforcement:'); | ||
| assert.include(output, 'Mode: FullyRestricted'); | ||
|
|
||
| assert.include(output, 'Customer Managed (CMEK) Enforcement:'); | ||
| assert.include(output, 'Mode: NotRestricted'); | ||
|
|
||
| assert.include(output, 'Customer Supplied (CSEK) Enforcement:'); | ||
| assert.include(output, 'Mode: FullyRestricted'); | ||
|
|
||
| assert.match(output, new RegExp('Effective:')); | ||
|
|
||
| const [metadata] = await bucket.getMetadata(); | ||
| const encryption = metadata.encryption || {}; | ||
| assert.strictEqual( | ||
| encryption.googleManagedEncryptionEnforcementConfig?.restrictionMode, | ||
| 'FullyRestricted' | ||
| ); | ||
| assert.strictEqual( | ||
| encryption.customerManagedEncryptionEnforcementConfig?.restrictionMode, | ||
| 'NotRestricted' | ||
| ); | ||
| assert.strictEqual( | ||
| encryption.customerSuppliedEncryptionEnforcementConfig?.restrictionMode, | ||
| 'FullyRestricted' | ||
| ); | ||
| }); | ||
|
|
||
| it('should get bucket encryption enforcement configuration', async function () { | ||
| if (!defaultKmsKeyName) { | ||
| this.skip(); | ||
| } | ||
| const output = execSync( | ||
| `node getBucketEncryptionEnforcementConfig.js ${bucketName}` | ||
| ); | ||
|
|
||
| assert.include( | ||
| output, | ||
| `Encryption enforcement configuration for bucket ${bucketName}.` | ||
| ); | ||
| assert.include(output, `Default KMS Key: ${defaultKmsKeyName}`); | ||
|
|
||
| assert.include(output, 'Google Managed (GMEK) Enforcement:'); | ||
| assert.include(output, 'Mode: FullyRestricted'); | ||
| assert.match(output, /Effective:/); | ||
|
|
||
| const [metadata] = await bucket.getMetadata(); | ||
| const encryption = metadata.encryption || {}; | ||
|
|
||
| assert.strictEqual(encryption.defaultKmsKeyName, defaultKmsKeyName); | ||
| assert.strictEqual( | ||
| encryption.googleManagedEncryptionEnforcementConfig?.restrictionMode, | ||
| 'FullyRestricted' | ||
| ); | ||
| assert.strictEqual( | ||
| encryption.customerManagedEncryptionEnforcementConfig?.restrictionMode, | ||
| 'NotRestricted' | ||
| ); | ||
| assert.strictEqual( | ||
| encryption.customerSuppliedEncryptionEnforcementConfig?.restrictionMode, | ||
| 'FullyRestricted' | ||
| ); | ||
| }); | ||
|
|
||
| it('should update and then remove bucket encryption enforcement configuration', async () => { | ||
| const output = execSync( | ||
| `node updateBucketEncryptionEnforcementConfig.js ${bucketName}` | ||
| ); | ||
|
|
||
| assert.include( | ||
| output, | ||
| `Google-managed encryption enforcement set to FullyRestricted for ${bucketName}.` | ||
| ); | ||
| assert.include( | ||
| output, | ||
| `All encryption enforcement configurations removed from bucket ${bucketName}.` | ||
| ); | ||
|
|
||
| const [metadata] = await bucket.getMetadata(); | ||
| assert.ok(!metadata.encryption); | ||
| }); | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.