-
Notifications
You must be signed in to change notification settings - Fork 6.6k
Add bucket-level IAM samples #919
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
Merged
Merged
Changes from all commits
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,95 @@ | ||
#!/usr/bin/env python | ||
|
||
# Copyright 2017 Google, Inc. | ||
# | ||
# 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. | ||
|
||
"""This application demonstrates how to get and set IAM policies on Google | ||
Cloud Storage buckets. | ||
|
||
For more information, see the documentation at | ||
https://cloud.google.com/storage/docs/access-control/using-iam-permissions. | ||
""" | ||
|
||
import argparse | ||
|
||
from google.cloud import storage | ||
|
||
|
||
def view_bucket_iam_members(bucket_name): | ||
storage_client = storage.Client() | ||
bucket = storage_client.bucket(bucket_name) | ||
|
||
policy = bucket.get_iam_policy() | ||
|
||
for role in policy: | ||
members = policy[role] | ||
print('Role: {}, Members: {}'.format(role, members)) | ||
|
||
|
||
def add_bucket_iam_member(bucket_name, role, member): | ||
storage_client = storage.Client() | ||
bucket = storage_client.bucket(bucket_name) | ||
|
||
policy = bucket.get_iam_policy() | ||
|
||
policy[role].add(member) | ||
|
||
bucket.set_iam_policy(policy) | ||
|
||
print('Added {} with role {} to {}.'.format( | ||
member, role, bucket_name)) | ||
|
||
|
||
def remove_bucket_iam_member(bucket_name, role, member): | ||
storage_client = storage.Client() | ||
bucket = storage_client.bucket(bucket_name) | ||
|
||
policy = bucket.get_iam_policy() | ||
|
||
policy[role].discard(member) | ||
|
||
bucket.set_iam_policy(policy) | ||
|
||
print('Removed {} with role {} from {}.'.format( | ||
member, role, bucket_name)) | ||
|
||
|
||
if __name__ == '__main__': | ||
parser = argparse.ArgumentParser( | ||
description=__doc__, | ||
formatter_class=argparse.RawDescriptionHelpFormatter) | ||
parser.add_argument('bucket_name', help='Your Cloud Storage bucket name.') | ||
subparsers = parser.add_subparsers(dest='command') | ||
|
||
subparsers.add_parser( | ||
'view-bucket-iam-members', help=view_bucket_iam_members.__doc__) | ||
|
||
add_member_parser = subparsers.add_parser( | ||
'add-bucket-iam-member', help=add_bucket_iam_member.__doc__) | ||
add_member_parser.add_argument('role') | ||
add_member_parser.add_argument('member') | ||
|
||
remove_member_parser = subparsers.add_parser( | ||
'remove-bucket-iam-member', help=remove_bucket_iam_member.__doc__) | ||
remove_member_parser.add_argument('role') | ||
remove_member_parser.add_argument('member') | ||
|
||
args = parser.parse_args() | ||
|
||
if args.command == 'view-bucket-iam-members': | ||
view_bucket_iam_members(args.bucket_name) | ||
elif args.command == 'add-bucket-iam-member': | ||
add_bucket_iam_member(args.bucket_name, args.role, args.member) | ||
elif args.command == 'remove-bucket-iam-member': | ||
remove_bucket_iam_member(args.bucket_name, args.role, args.member) |
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,45 @@ | ||
# Copyright 2017 Google, Inc. | ||
# | ||
# 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. | ||
|
||
import os | ||
|
||
from google.cloud import storage | ||
import pytest | ||
|
||
import iam | ||
|
||
BUCKET = os.environ['CLOUD_STORAGE_BUCKET'] | ||
MEMBER = 'group:dpebot@google.com' | ||
ROLE = 'roles/storage.legacyBucketReader' | ||
|
||
|
||
@pytest.fixture | ||
def bucket(): | ||
yield storage.Client().bucket(BUCKET) | ||
|
||
|
||
def test_view_bucket_iam_members(): | ||
iam.view_bucket_iam_members(BUCKET) | ||
|
||
|
||
def test_add_bucket_iam_member(bucket): | ||
iam.add_bucket_iam_member( | ||
BUCKET, ROLE, MEMBER) | ||
assert MEMBER in bucket.get_iam_policy()[ROLE] | ||
|
||
|
||
def test_remove_bucket_iam_member(bucket): | ||
iam.remove_bucket_iam_member( | ||
BUCKET, ROLE, MEMBER) | ||
assert MEMBER not in bucket.get_iam_policy()[ROLE] |
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,2 +1,2 @@ | ||
google-cloud-storage==1.0.0 | ||
google-cloud-pubsub==0.24.0 | ||
google-cloud-storage==1.1.0 | ||
google-cloud-pubsub==0.25.0 |
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.
Why iterate over the keys and then do a dictionary lookup, instead of iterating over key, value using items()?
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.
Because it's not a dictionary, see https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/core/google/cloud/iam.py#L64
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.
Oh, ick.
If beginners like me are likely to read this code, maybe adding a comment about that here would prevent confusion. Up to you though, I don't have a lot of context yet.