├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── main.py └── requirements.txt /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # How to Contribute 2 | 3 | We'd love to accept your patches and contributions to this project. There are 4 | just a few small guidelines you need to follow. 5 | 6 | ## Contributor License Agreement 7 | 8 | Contributions to this project must be accompanied by a Contributor License 9 | Agreement. You (or your employer) retain the copyright to your contribution; 10 | this simply gives us permission to use and redistribute your contributions as 11 | part of the project. Head over to to see 12 | your current agreements on file or to sign a new one. 13 | 14 | You generally only need to submit a CLA once, so if you've already submitted one 15 | (even if it was for a different project), you probably don't need to do it 16 | again. 17 | 18 | ## Code reviews 19 | 20 | All submissions, including submissions by project members, require review. We 21 | use GitHub pull requests for this purpose. Consult 22 | [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more 23 | information on using pull requests. 24 | 25 | ## Community Guidelines 26 | 27 | This project follows [Google's Open Source Community 28 | Guidelines](https://opensource.google.com/conduct/). 29 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Removing domain-wide visibility for Drive files using Cloud Functions 2 | This is not an officially supported Google product, though support will be provided on a best-effort basis. 3 | 4 | Copyright 2018 Google LLC 5 | 6 | Licensed under the Apache License, Version 2.0 (the "License"); 7 | you may not use this file except in compliance with the License. 8 | You may obtain a copy of the License at 9 | 10 | https://www.apache.org/licenses/LICENSE-2.0 11 | 12 | Unless required by applicable law or agreed to in writing, software 13 | distributed under the License is distributed on an "AS IS" BASIS, 14 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | See the License for the specific language governing permissions and 16 | limitations under the License. 17 | 18 | ### Introduction 19 | 20 | This sample Cloud Function code is designed to remove permissions from a Drive file where the file is visible across the entire domain. The Function is triggered against a Pub/Sub payload that contains Drive document metadata and sharing events that would prompt the Function to execute. 21 | 22 | ##### Google Cloud Products Used or Referenced: 23 | 24 | - GSuite and Google Drive 25 | - Google Cloud Functions 26 | - Google Cloud Pub/Sub 27 | 28 | ##### General Architecture 29 | 30 | The scope of this package **only pertains to parts 5 and 6** in the graphic below. For previous parts 1-4, please refer to this [repository](https://github.com/ocervell/terraform-google-gsuite-export) to get those elements set up. 31 | 32 |

33 | 34 |

35 | 36 | ##### Definitions 37 | - **GSuite Admin console** - Accessed from admin.google.com from a GSuite administrator account. Used to give API scopes to service accounts and set up security dashboarding and audit investigations. 38 | - **Google Cloud Platform (GCP) project** - organizational unit within GCP that houses public cloud services such as VMs, logging and monitoring, data streaming, and serverless compute. “Projects” sit under an “Organization” that controls billing accounts and umbrella IAM policies for the domain. 39 | - **GCP Console** - User interface to control GCP resources, accessed from console.cloud.google.com 40 | - **Service Account** - an Identity and Access Management (IAM) role that is given specific permissions in order to fulfill an automated task, usually. 41 | - **Stackdriver** - native logging, monitoring, and error reporting tool in GCP 42 | - **Pub/Sub** (“Publisher/Subscriber”) - asynchronous, serverless messaging service, analogous to Apache Kafka. In this case, used to carry Stackdriver log entries to Cloud Functions. 43 | - **Cloud Functions** - Serverless, autoscaling function-as-a-service that executes python or javascript code against a trigger, in this case, Pub/Sub messages 44 | 45 | ### Getting Started 46 | 47 | ##### Step 1: Create a GCP Project 48 | 49 | In this step, we will create a GCP project (unless you already created one using while setting up this [Terraform repository](https://github.com/ocervell/terraform-google-gsuite-export)) and we will give the GSuite administrator the Project Owner role. 50 | 51 | So let's create the project by going to [console.cloud.google.com](console.cloud.google.com) and sign in using your GSuite administrator's email. We will refer to this email as **{gsuite-admin-email}** from now on. You will need a billing account to enable the APIs in later steps. 52 | 53 | From the sidebar menu, go to **IAM & admin** and click **IAM**. 54 | 55 |

56 | 57 |

58 | 59 | Click **"Add"** 60 | 61 |

62 | 63 |

64 | 65 | Give **{gsuite-admin-email}** the Project Owner role. 66 | 67 |

68 | 69 |

70 | 71 | ##### Step 2: Enable APIs 72 | 73 | Enable the following APIs in your GCP project: 74 | - Admin SDK 75 | - Google Drive 76 | - Service Usage 77 | - Resource Manager 78 | - Stackdriver 79 | - IAM 80 | - IAM Service Account Credentials 81 | - Token Service 82 | - Pub/Sub 83 | - Functions 84 | - Compute Engine 85 | 86 |

87 | 88 |

89 | 90 | ##### Step 3. Configure service account for the Cloud Functions 91 | 92 | Go back to **IAM & admin** and click **Service Accounts**. 93 | 94 |

95 | 96 |

97 | 98 | Find the App Engine default service account. We will use **{service-account-name}** to reference it and it should end with "@appspot.gserviceaccount.com"). 99 | 100 | Create a JSON key and download the credential. We'll refer to this file as **{credential-file}**. 101 | 102 | Give the service account domain-wide delegation, by first clicking **Edit** on the right-side options menu. 103 | 104 |

105 | 106 |

107 | 108 | Click **Show Domain-Wide Delegation** and enable. 109 | 110 |

111 | 112 |

113 | 114 | From the project dropdown at the top of the console, click the Organization that matches the domain you're working under and click **IAM & admin**. 115 | 116 | Find the App Engine default service account and give it the “Service Account Token Creator” and "Project Editor" roles. 117 | 118 | ##### Step 4. Setup service account scopes in the GSuite admin console 119 | 120 | Log into the [GSuite Admin console](admin.google.com) using **{gsuite-admin-email}**, then go to **Security** -> **Advanced Settings** -> **Manage API Scopes** 121 | 122 |

123 | 124 |

125 | 126 |

127 | 128 |

129 | 130 | For **{service-account-name}**, set the following scopes by pasting the service account's Unique ID number, e.g., 100518674616449638338, in the name field and pasting this into the scopes field: 131 | https://www.googleapis.com/auth/admin.directory.user,https://www.googleapis.com/auth/drive,https://www.googleapis.com/auth/iam 132 | 133 | ##### Step 5. Package the Zip file 134 | 135 | You can retrieve this project's source code by running the following command: 136 | `git clone https://github.com/google/cloud-function-edit-drive-permissions.git` 137 | 138 | You need to update the following variables in the **main.py** file: 139 | - Line 36: Change **{path-to-credential-file}** 140 | - Line 39: Change **{gsuite-admin-email}** 141 | - Line 68: Change **{OU}** if you want some Organizational Units to be exempt 142 | 143 | From here, package the files in your current directory into a Zip file. At a minimum, this should include main.py, requirements.txt, and **{credential-file}** 144 | 145 | Upload this Zip into a bucket using Cloud Storage. We'll reference this bucket as **{bucket-name}**. 146 | 147 | 148 | ##### Step 6. Create your Cloud Function 149 | 150 | We will finally set up the Cloud Function that will strip domain-visibility from Drive documents. 151 | 152 | Go to left menu and hit “Cloud Functions” then create a new Function. 153 | 154 | 155 | Set **Trigger** to the Pub/Sub topic that is carrying the drive audit events. Again, this can be set up using this [Terraform](https://github.com/ocervell/terraform-google-gsuite-export). 156 | 157 | Set Source Code to be from **ZIP from Cloud Storage** and link to the right **{bucket-name}**. 158 | 159 | Click **Create** 160 | 161 | To observe what’s happening, feel free to look at Logging from Stackdriver. 162 | -------------------------------------------------------------------------------- /main.py: -------------------------------------------------------------------------------- 1 | '''Copyright 2018 Google LLC 2 | 3 | Licensed under the Apache License, Version 2.0 (the "License"); 4 | you may not use this file except in compliance with the License. 5 | You may obtain a copy of the License at 6 | 7 | https://www.apache.org/licenses/LICENSE-2.0 8 | 9 | Unless required by applicable law or agreed to in writing, software 10 | distributed under the License is distributed on an "AS IS" BASIS, 11 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | See the License for the specific language governing permissions and 13 | limitations under the License.''' 14 | 15 | import os 16 | import cgi 17 | import html 18 | import json 19 | import base64 20 | import logging 21 | import google.auth 22 | import urllib.parse 23 | from google.auth import iam 24 | from google.cloud import pubsub_v1 25 | from googleapiclient import discovery 26 | from google.oauth2 import service_account 27 | from google.auth.transport import requests 28 | from google.auth.credentials import with_scopes_if_required 29 | from google.auth._default import _load_credentials_from_file 30 | 31 | #different Drive scopes that will be used in this Cloud Function 32 | SCOPES = ["https://www.googleapis.com/auth/drive"] 33 | SCOPES2 = ["https://www.googleapis.com/auth/admin.directory.user"] 34 | 35 | #credentials file to include as part of Cloud Function package, e.g. 'credenials.json' 36 | CREDENTIALS_PATH = '{path-to-credential-file}' 37 | 38 | #email of GSuite admin, e.g., 'admin@domain.com' 39 | ADMIN_EMAIL = '{gsuite-admin-email}' 40 | 41 | def hello_pubsub(event, context): 42 | """Triggered from a message on a Cloud Pub/Sub topic. 43 | Args: 44 | event (dict): Event payload. 45 | context (google.cloud.functions.Context): Metadata for the event. 46 | """ 47 | pubsub_message = base64.b64decode(event['data']).decode('utf-8') 48 | #Printing contents of decoded Pub/Sub payload to Stackdriver 49 | print(pubsub_message) 50 | #Taking Pub/Sub payload and creating JSON 51 | json_payload = json.loads(pubsub_message) 52 | parameters = json_payload["jsonPayload"]["parameters"] 53 | 54 | #Printing owner of Drive file to Stackdriver logs 55 | for i in parameters: 56 | if i["name"] == "owner": 57 | print("Found doc owner:%s" % i["value"]) 58 | doc_owner = i["value"] 59 | 60 | ''' 61 | #Uncomment this block of code if you want this Cloud Function to skip certain OUs 62 | #Building Drive service object to obtain file owner's OU, if needed 63 | driveObj = build_service("admin","directory_v1",credentials_path=CREDENTIALS_PATH,user_email=ADMIN_EMAIL, scopes=SCOPES2) 64 | results = driveObj.users().get(userKey=doc_owner).execute() 65 | print(results['orgUnitPath']) 66 | OU = results['orgUnitPath'] 67 | 68 | #If file owner's OU is exempt from this Cloud Function, use the if statement 69 | if OU != "/{OU}" and not OU.startswith('/{OU}/'): 70 | ''' 71 | for i in parameters: 72 | if i["name"] == "visibility" and (i["value"] == "people_within_domain_with_link" or i["value"] == "public_in_the_domain"): 73 | for p in parameters: 74 | if p["name"] == "doc_id": 75 | print("Found doc id:%s" % p["value"]) 76 | doc_id = p["value"] 77 | #Removing permissions from this Drive file 78 | delete_access(doc_id,doc_owner) 79 | 80 | def delete_access(fileId,USER_EMAIL): 81 | driveObj = build_service("drive","v3",credentials_path=CREDENTIALS_PATH, user_email=USER_EMAIL, scopes=SCOPES) 82 | getpermissions = driveObj.permissions().list(fileId=fileId).execute() 83 | print(getpermissions['permissions']) 84 | 85 | for key in getpermissions['permissions']: 86 | print(key['type']) 87 | if key['type'] == "domain": 88 | permissionId = key['id'] 89 | print(permissionId) 90 | chngObj = driveObj.permissions().delete(fileId = fileId,permissionId = permissionId).execute() 91 | print(chngObj) 92 | 93 | logger = logging.getLogger(__name__) 94 | 95 | _TOKEN_URI = 'https://accounts.google.com/o/oauth2/token' 96 | _TOKEN_SCOPE = frozenset(['https://www.googleapis.com/auth/iam']) 97 | 98 | def build_service(api, version, credentials_path=None, user_email=None, scopes=None): 99 | """Build and returns a service object. 100 | Allows delegation of GSuite permissions to the service account when the `user_email` argument is passed. 101 | Args: 102 | api (str): The Admin SDK API to use. 103 | version (str): The Admin SDK API version to use. 104 | credentials_path (str, optional): The path to the service account credentials. 105 | user_email (str): The email of the user. Needs permissions to access the Admin APIs. 106 | scopes (list, optional): A list of scopes to authenticate the request with. 107 | Returns: 108 | Google Service object. 109 | """ 110 | if credentials_path is not None: 111 | logger.info("Getting credentials from file '%s' ...", credentials_path) 112 | credentials, _ = _load_credentials_from_file(credentials_path) 113 | else: 114 | logger.info("Getting default application credentials ...") 115 | credentials, _ = google.auth.default() 116 | 117 | if user_email is not None: # make delegated credentials 118 | credentials = _make_delegated_credentials( 119 | credentials, 120 | user_email, 121 | scopes) 122 | 123 | return discovery.build(api, version, credentials=credentials) 124 | 125 | def _make_delegated_credentials(credentials, user_email, scopes): 126 | """Make delegated credentials. 127 | Allows a service account to impersonate the user passed in `user_email`, 128 | using a restricted set of scopes. 129 | Args: 130 | credentials (service_account.Credentials): The service account credentials. 131 | user_email (str): The email for the user to impersonate. 132 | scopes (list): A list of scopes. 133 | Returns: 134 | service_account.Credentials: The delegated credentials 135 | """ 136 | request = requests.Request() 137 | credentials = with_scopes_if_required(credentials, _TOKEN_SCOPE) 138 | credentials.refresh(request) 139 | email = credentials.service_account_email 140 | signer = iam.Signer( 141 | request, 142 | credentials, 143 | email) 144 | return service_account.Credentials( 145 | signer, 146 | email, 147 | _TOKEN_URI, 148 | scopes=scopes, 149 | subject=user_email) 150 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | google-cloud-pubsub==0.38.0 2 | google-api-python-client==1.7.4 3 | google-auth==1.5.1 4 | google-oauth==1.0.1 5 | oauth2client==3.0.0 6 | --------------------------------------------------------------------------------