8000 Add IAM custom roles and access snippets by awkoren · Pull Request #1692 · GoogleCloudPlatform/python-docs-samples · GitHub
[go: up one dir, main page]

Skip to content

Add IAM custom roles and access snippets #1692

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 4 commits into from
Nov 2, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
132 changes: 132 additions & 0 deletions iam/api-client/access.py
10000
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
# !/usr/bin/env python
#
# Copyright 2018 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.

"""Demonstrates how to perform basic access management with Google Cloud IAM.

For more information, see the documentation at
https://cloud.google.com/iam/docs/granting-changing-revoking-access.
"""

import argparse
import os

from google.oauth2 import service_account
import googleapiclient.discovery


credentials = service_account.Credentials.from_service_account_file(
filename=os.environ['GOOGLE_APPLICATION_CREDENTIALS'],
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why read from the environment variable directly instead of using google.auth.default(scopes)?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the documented approach: https://developers.google.com/api-client-library/python/auth/service-accounts
google.auth.default() does not seem to work.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Odd. It should do the same thing if the environment variable is set.

Note that its signature is slightly different: google.auth.default() returns a tuple with the credentials and a default project ID.

scopes=['https://www.googleapis.com/auth/cloud-platform'])
service = googleapiclient.discovery.build(
'cloudresourcemanager', 'v1', credentials=credentials)


# [START iam_get_policy]
def get_policy(project_id):
"""Gets IAM policy for a project."""

# pylint: disable=no-member
policy = service.projects().getIamPolicy(
resource=project_id, body={}).execute()
print(policy)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please introspect in the objects so that we see the relevant fields in the actual code. e.g.

print(policy['some_relevant_field_name'])

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

print(policy) dumps the policy object as JSON. This is good since users need to understand and manipulate this object to edit IAM policy. This is explained in the companion article: https://cloud.google.com/iam/docs/granting-changing-revoking-access#overview_of_cloud_iam_policy

return policy
# [END iam_get_policy]


# [START iam_modify_policy_add_member]
def modify_policy_add_member(policy, role, member):
"""Adds a new member to a role binding."""
binding = next(b for b in policy['bindings'] if b['role'] == role)
binding['members'].append(member)
print(binding)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this missing an API request to actually update the policy?

Copy link
Contributor Author
@awkoren awkoren Nov 1, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The set_policy() method on line 72 demonstrates that.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I find that a bit strange to separate them. Most how-to guides that I've seen try to keep each code snippet self-contained, but you're right that this matches the docs.

return policy
# [END iam_modify_policy_add_member]


# [START iam_modify_policy_add_role]
def modify_policy_add_role(policy, role, member):
"""Adds a new role binding to a policy."""
binding = {
'role': role,
'members': [member]
}
policy['bindings'].append(binding)
print(policy)
return policy
# [END iam_modify_policy_add_role]


# [START iam_set_policy]
def set_policy(project_id, policy):
"""Sets IAM policy for a project."""

# pylint: disable=no-member
policy = service.projects().setIamPolicy(
resource=project_id, body={
'policy': policy
}).execute()
print(policy)
return policy
# [END iam_set_policy]


def main():
parser = argparse.ArgumentParser(
description=__doc__,
formatter_class=argparse.RawDescriptionHelpFormatter)

subparsers = parser.add_subparsers(dest='command')

# Get
get_parser = subparsers.add_parser(
'get', help=get_policy.__doc__)
get_parser.add_argument('project_id')

# Modify: add member
modify_member_parser = subparsers.add_parser(
'modify_member', help=get_policy.__doc__)
modify_member_parser.add_argument('project_id')
modify_member_parser.add_argument('role')
modify_member_parser.add_argument('member')

# Modify: add role
modify_role_parser = subparsers.add_parser(
'modify_role', help=get_policy.__doc__)
modify_role_parser.add_argument('project_id')
modify_role_parser.add_argument('project_id')
modify_role_parser.add_argument('role')
modify_role_parser.add_argument('member')

# Set
set_parser = subparsers.add_parser(
'set', help=set_policy.__doc__)
set_parser.add_argument('project_id')
set_parser.add_argument('policy')

args = parser.parse_args()

if args.command == 'get':
get_policy(args.project_id)
elif args.command == 'set':
set_policy(args.project_id, args.policy)
elif args.command == 'add_member':
modify_policy_add_member(args.policy, args.role, args.member)
elif args.command == 'add_binding':
modify_policy_add_role(args.policy, args.role, args.member)


if __name__ == '__main__':
main()
29 changes: 29 additions & 0 deletions iam/api-client/access_test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Copyright 2018 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
# distribut 6BE8 ed 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

import access


def test_access(capsys):
project = os.environ['GCLOUD_PROJECT']

policy = access.get_policy(project)
out, _ = capsys.readouterr()
assert 'etag' in out

policy = access.set_policy(project, policy)
out, _ = capsys.readouterr()
assert 'etag' in out
Loading
0