-
Notifications
You must be signed in to change notification settings - Fork 1k
feat(storage): add Cloud Storage bucket IP filtering samples #2221
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
salilg-eng
wants to merge
2
commits into
GoogleCloudPlatform:main
Choose a base branch
from
salilg-eng:feat/bucket-ip-filter
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 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| <?php | ||
| /** | ||
| * 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. | ||
| */ | ||
|
|
||
| /** | ||
| * For instructions on how to run the full sample: | ||
| * | ||
| * @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/main/storage/README.md | ||
| */ | ||
|
|
||
| namespace Google\Cloud\Samples\Storage; | ||
|
|
||
| # [START storage_delete_ip_filtering_rules] | ||
| use Google\Cloud\Storage\StorageClient; | ||
|
|
||
| /** | ||
| * Delete IP filtering rules from a bucket. | ||
| * | ||
| * @param string $bucketName The name of your Cloud Storage bucket. | ||
| * (e.g. 'my-bucket') | ||
| */ | ||
| function delete_ip_filtering_rules(string $bucketName): void | ||
| { | ||
| $storage = new StorageClient(); | ||
| $bucket = $storage->bucket($bucketName); | ||
|
|
||
| $info = $bucket->info(); | ||
| if (!isset($info['ipFilter'])) { | ||
| printf('No IP Filter configuration found for bucket %s.' . PHP_EOL, $bucketName); | ||
| return; | ||
| } | ||
|
|
||
| $ipFilter = $info['ipFilter']; | ||
| $updated = false; | ||
|
|
||
| if (isset($ipFilter['publicNetworkSource']['allowedIpCidrRanges'])) { | ||
| $ranges = $ipFilter['publicNetworkSource']['allowedIpCidrRanges']; | ||
| $filteredRanges = array_filter($ranges, function ($range) { | ||
| return $range !== '1.2.3.0/24'; | ||
| }); | ||
| if (count($ranges) !== count($filteredRanges)) { | ||
| $ipFilter['publicNetworkSource']['allowedIpCidrRanges'] = array_values($filteredRanges); | ||
| $updated = true; | ||
| } | ||
| } | ||
|
|
||
| if ($updated) { | ||
| $bucket->update(['ipFilter' => $ipFilter]); | ||
| printf('Specific IP filtering rules deleted for bucket %s' . PHP_EOL, $bucketName); | ||
| } else { | ||
| printf('No matching IP filtering rules found to delete for bucket %s.' . PHP_EOL, $bucketName); | ||
| } | ||
| } | ||
| # [END storage_delete_ip_filtering_rules] | ||
|
|
||
| // The following 2 lines are only needed to run the samples | ||
| require_once __DIR__ . '/../../testing/sample_helpers.php'; | ||
| \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv); |
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,52 @@ | ||
| <?php | ||
| /** | ||
| * 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. | ||
| */ | ||
|
|
||
| /** | ||
| * For instructions on how to run the full sample: | ||
| * | ||
| * @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/main/storage/README.md | ||
| */ | ||
|
|
||
| namespace Google\Cloud\Samples\Storage; | ||
|
|
||
| # [START storage_disable_ip_filtering] | ||
| use Google\Cloud\Storage\StorageClient; | ||
|
|
||
| /** | ||
| * Disable IP filtering on a bucket. | ||
| * | ||
| * @param string $bucketName The name of your Cloud Storage bucket. | ||
| * (e.g. 'my-bucket') | ||
| */ | ||
| function disable_ip_filtering(string $bucketName): void | ||
| { | ||
| $storage = new StorageClient(); | ||
| $bucket = $storage->bucket($bucketName); | ||
|
|
||
| $bucket->update([ | ||
| 'ipFilter' => [ | ||
| 'mode' => 'Disabled' | ||
| ] | ||
| ]); | ||
|
|
||
| printf('Disabled IP filtering Rules for bucket %s' . PHP_EOL, $bucketName); | ||
| } | ||
| # [END storage_disable_ip_filtering] | ||
|
|
||
| // The following 2 lines are only needed to run the samples | ||
| require_once __DIR__ . '/../../testing/sample_helpers.php'; | ||
| \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv); |
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,69 @@ | ||
| <?php | ||
| /** | ||
| * 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. | ||
| */ | ||
|
|
||
| /** | ||
| * For instructions on how to run the full sample: | ||
| * | ||
| * @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/main/storage/README.md | ||
| */ | ||
|
|
||
| namespace Google\Cloud\Samples\Storage; | ||
|
|
||
| # [START storage_enable_ip_filtering] | ||
| use Google\Cloud\Storage\StorageClient; | ||
|
|
||
| /** | ||
| * Enable IP filtering on a bucket. | ||
| * | ||
| * @param string $projectId The ID of your Google Cloud project. | ||
| * (e.g. 'my-project-id') | ||
| * @param string $bucketName The name of your Cloud Storage bucket. | ||
| * (e.g. 'my-bucket') | ||
| */ | ||
| function enable_ip_filtering(string $projectId, string $bucketName): void | ||
| { | ||
| $storage = new StorageClient(); | ||
| $bucket = $storage->bucket($bucketName); | ||
|
|
||
| $ipFilter = [ | ||
| // Set to 'Enabled' to enforce the IP filters. | ||
| // We use 'Disabled' here to prevent locking out the test runner. | ||
| 'mode' => 'Disabled', | ||
| 'allowAllServiceAgentAccess' => true, | ||
| 'publicNetworkSource' => [ | ||
| 'allowedIpCidrRanges' => ['1.2.3.0/24'] | ||
| ], | ||
| 'vpcNetworkSources' => [ | ||
| [ | ||
| 'network' => sprintf('projects/%s/global/networks/default', $projectId), | ||
| 'allowedIpCidrRanges' => ['10.0.0.0/24'] | ||
| ] | ||
| ] | ||
| ]; | ||
|
|
||
| $info = $bucket->update(['ipFilter' => $ipFilter]); | ||
|
|
||
| printf( | ||
| 'Enabled IP filtering Rules for the Bucket: %s' . PHP_EOL, | ||
| $bucketName | ||
| ); | ||
| } | ||
| # [END storage_enable_ip_filtering] | ||
|
|
||
| // The following 2 lines are only needed to run the samples | ||
| require_once __DIR__ . '/../../testing/sample_helpers.php'; | ||
| \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv); | ||
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,77 @@ | ||
| <?php | ||
| /** | ||
| * 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. | ||
| */ | ||
|
|
||
| /** | ||
| * For instructions on how to run the full sample: | ||
| * | ||
| * @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/main/storage/README.md | ||
| */ | ||
|
|
||
| namespace Google\Cloud\Samples\Storage; | ||
|
|
||
| # [START storage_get_ip_filtering] | ||
| use Google\Cloud\Storage\StorageClient; | ||
|
|
||
| /** | ||
| * Retrieve the IP filtering rules for the bucket. | ||
| * | ||
| * @param string $bucketName The name of your Cloud Storage bucket. | ||
| * (e.g. 'my-bucket') | ||
| */ | ||
| function get_ip_filtering(string $bucketName): void | ||
| { | ||
| $storage = new StorageClient(); | ||
| $bucket = $storage->bucket($bucketName); | ||
|
|
||
| $info = $bucket->info(); | ||
|
|
||
| if (!isset($info['ipFilter'])) { | ||
| printf('Bucket %s has no IP Filter configured.' . PHP_EOL, $bucketName); | ||
| return; | ||
| } | ||
|
|
||
| $ipFilter = $info['ipFilter']; | ||
|
|
||
| printf('IP Filter Configuration for the Bucket %s:' . PHP_EOL, $bucketName); | ||
| printf('Mode: %s' . PHP_EOL, $ipFilter['mode']); | ||
|
|
||
| printf('Allow All Service Agent Access: %s' . PHP_EOL, var_export($ipFilter['allowAllServiceAgentAccess'] ?? false, true)); | ||
|
|
||
| if (isset($ipFilter['publicNetworkSource']['allowedIpCidrRanges'])) { | ||
| printf('Allowed Public CIDR Ranges:' . PHP_EOL); | ||
| foreach ($ipFilter['publicNetworkSource']['allowedIpCidrRanges'] as $range) { | ||
| printf('- %s' . PHP_EOL, $range); | ||
| } | ||
| } | ||
|
|
||
| printf('Allow Cross Organization VPCs Access: %s' . PHP_EOL, var_export($ipFilter['allowCrossOrgVpcs'] ?? false, true)); | ||
|
|
||
| if (isset($ipFilter['vpcNetworkSources'])) { | ||
| printf('Allowed VPC Network:' . PHP_EOL); | ||
| foreach ($ipFilter['vpcNetworkSources'] as $vpcNetwork) { | ||
| printf('- Network: %s' . PHP_EOL, $vpcNetwork['network']); | ||
| if (isset($vpcNetwork['allowedIpCidrRanges'])) { | ||
| printf('Allowed VPC CIDR Ranges: %s' . PHP_EOL, implode(', ', $vpcNetwork['allowedIpCidrRanges'])); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| # [END storage_get_ip_filtering] | ||
|
|
||
| // The following 2 lines are only needed to run the samples | ||
| require_once __DIR__ . '/../../testing/sample_helpers.php'; | ||
| \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv); |
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,53 @@ | ||
| <?php | ||
| /** | ||
| * 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. | ||
| */ | ||
|
|
||
| /** | ||
| * For instructions on how to run the full sample: | ||
| * | ||
| * @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/main/storage/README.md | ||
| */ | ||
|
|
||
| namespace Google\Cloud\Samples\Storage; | ||
|
|
||
| # [START storage_list_buckets_ip_filtering] | ||
| use Google\Cloud\Storage\StorageClient; | ||
|
|
||
| /** | ||
| * Lists all buckets including their IP filtering status. | ||
| * | ||
| * @param string $projectId The ID of your Google Cloud project. | ||
| * (e.g. 'my-project-id') | ||
| */ | ||
| function list_buckets_ip_filtering(string $projectId): void | ||
| { | ||
| $storage = new StorageClient([ | ||
| 'projectId' => $projectId | ||
| ]); | ||
|
|
||
| printf('Buckets:' . PHP_EOL); | ||
| foreach ($storage->buckets() as $bucket) { | ||
|
salilg-eng marked this conversation as resolved.
Outdated
|
||
| $info = $bucket->info(); | ||
| $mode = $info['ipFilter']['mode'] ?? 'Not Configured'; | ||
|
|
||
| printf('Bucket Name: %s, IP Filtering Mode: %s' . PHP_EOL, $bucket->name(), $mode); | ||
| } | ||
| } | ||
| # [END storage_list_buckets_ip_filtering] | ||
|
|
||
| // The following 2 lines are only needed to run the samples | ||
| require_once __DIR__ . '/../../testing/sample_helpers.php'; | ||
| \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv); | ||
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.