├── .gitignore ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── keyrotator ├── __init__.py ├── cleanup.py ├── create.py ├── delete.py ├── iam_service.py ├── keyrotator.py ├── list.py └── version.py └── setup.py /.gitignore: -------------------------------------------------------------------------------- 1 | .*swp 2 | .DS_Store 3 | *.pyc 4 | build/ 5 | dist/ 6 | *.egg-info 7 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | Want to contribute? Great! First, read this page (including the small print at the end). 2 | 3 | ### Before you contribute 4 | Before we can use your code, you must sign the 5 | [Google Individual Contributor License Agreement] 6 | (https://cla.developers.google.com/about/google-individual) 7 | (CLA), which you can do online. The CLA is necessary mainly because you own the 8 | copyright to your changes, even after your contribution becomes part of our 9 | codebase, so we need your permission to use and distribute your code. We also 10 | need to be sure of various other things—for instance that you'll tell us if you 11 | know that your code infringes on other people's patents. You don't have to sign 12 | the CLA until after you've submitted your code for review and a member has 13 | approved it, but you must do it before we can put your code into our codebase. 14 | Before you start working on a larger contribution, you should get in touch with 15 | us first through the issue tracker with your idea so that we can help out and 16 | possibly guide you. Coordinating up front makes it much easier to avoid 17 | frustration later on. 18 | 19 | ### Code reviews 20 | All submissions, including submissions by project members, require review. We 21 | use Github pull requests for this purpose. 22 | 23 | ### The small print 24 | Contributions made by corporations are covered by a different agreement than 25 | the one above, the 26 | [Software Grant and Corporate Contributor License Agreement] 27 | (https://cla.developers.google.com/about/google-corporate). 28 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # keyrotator 2 | This is a CLI utility to help with key rotation. 3 | 4 | ## Install 5 | 6 | Install with 7 | 8 | ```sh 9 | $ python setup.py install 10 | ``` 11 | 12 | ## Uninstall 13 | 14 | Uninstall with 15 | 16 | ```sh 17 | $ pip uninstall keyrotator 18 | ``` 19 | 20 | ## Usage 21 | 22 | You may need to auth your application default credentials prior to working with the service account keys: 23 | 24 | ```sh 25 | $ gcloud auth application-default login 26 | ``` 27 | 28 | From the command line, run (this will show the commands for keyrotator): 29 | 30 | ```sh 31 | $ keyrotator 32 | ``` 33 | 34 | ## Contributing 35 | 36 | Pull requests and stars are always welcome. For bugs and feature requests, 37 | [please create an issue](https://github.com/GoogleCloudPlatform). 38 | 39 | ## License 40 | 41 | Apache 2.0. See [LICENSE]() for more information. 42 | 43 | ## Disclaimer 44 | 45 | This is not an official Google product. 46 | -------------------------------------------------------------------------------- /keyrotator/__init__.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # Copyright 2016 Google Inc. All Rights Reserved. 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | -------------------------------------------------------------------------------- /keyrotator/cleanup.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # Copyright 2016 Google Inc. All Rights Reserved. 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | """keyrotator Cleanup command.""" 16 | 17 | from datetime import datetime 18 | from datetime import timedelta 19 | import logging 20 | 21 | from dateutil import parser 22 | from delete import DeleteCommand 23 | from list import ListCommand 24 | import pytz 25 | 26 | 27 | class CleanupCommand(object): 28 | """Implementation of the keyrotator cleanup command.""" 29 | 30 | def run(self, project_id, iam_account, key_max_age): 31 | """Runs the list and delete commands for keyrotator. 32 | 33 | Args: 34 | project_id: The project_id for which to create the key. 35 | iam_account: The IAM account for which to create the key. 36 | key_max_age: An integer in units of days for which to find keys to delete. 37 | 38 | Returns: 39 | An integer indicating status. 40 | """ 41 | current_keys = ListCommand().run( 42 | project_id, iam_account, return_results=True) 43 | 44 | signed_key_max_age = abs(int(key_max_age)) 45 | current_datetime = datetime.now(pytz.utc) 46 | 47 | invalid_keys = [] 48 | 49 | for key in current_keys: 50 | try: 51 | key_creation_time = parser.parse(key["validAfterTime"]) 52 | except ValueError as e: 53 | logging.error("Ooops, unable to convert creation time: %s", e) 54 | 55 | diff_time = current_datetime - key_creation_time 56 | 57 | if diff_time.days > signed_key_max_age: 58 | logging.info("Found invalid key %s created %s", key["name"], 59 | key_creation_time) 60 | invalid_keys.append(key) 61 | 62 | for key in invalid_keys: 63 | DeleteCommand().run(project_id, iam_account, key["name"]) 64 | 65 | if not invalid_keys: 66 | logging.info("No keys to cleanup.") 67 | 68 | return 0 69 | -------------------------------------------------------------------------------- /keyrotator/create.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # Copyright 2016 Google Inc. All Rights Reserved. 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | """keyrotator Create command.""" 16 | 17 | import json 18 | import logging 19 | import iam_service 20 | 21 | 22 | DEFAULT_KEY_TYPE = "TYPE_GOOGLE_CREDENTIALS_FILE" 23 | DEFAULT_KEY_ALGO = "KEY_ALG_RSA_2048" 24 | 25 | 26 | class CreateCommand(object): 27 | """Implementation of the keyrotator create command.""" 28 | 29 | def run(self, project_id, iam_account, key_type=DEFAULT_KEY_TYPE, 30 | key_algorithm=DEFAULT_KEY_ALGO, output_file=None): 31 | """Runs the create command for keyrotator.""" 32 | response = iam_service.create_key(project_id, iam_account, 33 | key_type, key_algorithm) 34 | 35 | if output_file: 36 | self._write_key(path=output_file, payload=response) 37 | else: 38 | logging.info("Key successfully created.") 39 | logging.debug("Key details: %s", 40 | json.dumps(response, sort_keys=True, 41 | indent=4, separators=(",", ": "))) 42 | 43 | return 0 44 | 45 | def _write_key(self, path, payload): 46 | """Writes the key out to the filesystem.""" 47 | with open(path, "w") as outfile: 48 | json.dump(payload, outfile) 49 | -------------------------------------------------------------------------------- /keyrotator/delete.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # Copyright 2016 Google Inc. All Rights Reserved. 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | """keyrotator Delete command.""" 16 | 17 | import logging 18 | import iam_service 19 | 20 | 21 | class DeleteCommand(object): 22 | """Implementation of the keyrotator delete commmand.""" 23 | 24 | def run(self, project_id, iam_account, key_id): 25 | """Runs the delete command for keyrotator.""" 26 | iam_service.delete_key(project_id, iam_account, key_id) 27 | 28 | logging.info("Deleted key %s for %s/%s.", key_id, 29 | iam_account, project_id) 30 | return 0 31 | -------------------------------------------------------------------------------- /keyrotator/iam_service.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # Copyright 2016 Google Inc. All Rights Reserved. 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | """Module to interact with Google Cloud Platform IAM.""" 16 | 17 | import logging 18 | import re 19 | 20 | from apiclient import discovery 21 | from apiclient import errors 22 | from oauth2client.client import GoogleCredentials 23 | from retrying import retry 24 | 25 | RETRY_MULTIPLIER_MS = 1000 26 | RETRY_MAX_SEC = 10000 27 | 28 | 29 | def _get_iam_service(): 30 | """Get the IAM service. 31 | 32 | Returns: 33 | An apiclient service object. 34 | """ 35 | credentials = GoogleCredentials.get_application_default() 36 | return discovery.build( 37 | serviceName="iam", version="v1", credentials=credentials) 38 | 39 | 40 | def retry_if_500_error(exception): 41 | """Allow retry if we get a 500 error from IAM API.""" 42 | logging.info("Received %s, retrying...", exception) 43 | return (isinstance(exception, errors.HttpError) 44 | and exception.resp.status >= 500 45 | and exception.resp.status < 600) 46 | 47 | 48 | @retry(wait_exponential_multiplier=RETRY_MULTIPLIER_MS, 49 | stop_max_delay=RETRY_MAX_SEC, 50 | retry_on_exception=retry_if_500_error) 51 | def list_keys(project_id, service_account_id): 52 | """List the keys for a service account. 53 | 54 | Args: 55 | project_id: String of a project id. Should contain the specified service 56 | account. 57 | service_account_id: String of a service account id. Should be in the 58 | specified project. 59 | 60 | Returns: 61 | Dict of a newly created instance of ServiceAccountKey. 62 | """ 63 | full_name = "projects/{0}/serviceAccounts/{1}".format(project_id, 64 | service_account_id) 65 | keys = _get_iam_service().projects().serviceAccounts().keys() 66 | request = keys.list(name=full_name, keyTypes="USER_MANAGED") 67 | return request.execute() 68 | 69 | 70 | @retry(wait_exponential_multiplier=RETRY_MULTIPLIER_MS, 71 | stop_max_delay=RETRY_MAX_SEC, 72 | retry_on_exception=retry_if_500_error) 73 | def create_key(project_id, service_account_id, key_type, key_algorithm): 74 | """Create a key for a service account. 75 | 76 | Args: 77 | project_id: String of a project id. Should contain the specified service 78 | account. 79 | service_account_id: String of a service account id. Should be in the 80 | specified project. 81 | key_type: String of a type of key to create. 82 | https://goo.gl/i4iLsi 83 | key_algorithm: String of the key's algorithm strength. 84 | https://goo.gl/zCchyg 85 | 86 | Returns: 87 | Dict of a newly created instance of ServiceAccountKey. 88 | Base64 decode "privateKeyData" to obtain credentials JSON. 89 | """ 90 | full_name = "projects/{0}/serviceAccounts/{1}".format(project_id, 91 | service_account_id) 92 | body = {"privateKeyType": key_type, "keyAlgorithm": key_algorithm} 93 | keys = _get_iam_service().projects().serviceAccounts().keys() 94 | request = keys.create(name=full_name, body=body) 95 | return request.execute() 96 | 97 | 98 | @retry(wait_exponential_multiplier=RETRY_MULTIPLIER_MS, 99 | stop_max_delay=RETRY_MAX_SEC, 100 | retry_on_exception=retry_if_500_error) 101 | def delete_key(project_id, service_account_id, key_id): 102 | """Delete a key from a service account. 103 | 104 | Args: 105 | project_id: String of a project id. Should contain the specified service 106 | account. 107 | service_account_id: String of a service account id. Should be in the 108 | specified project. 109 | key_id: String of the key id. Should belong to the specified service 110 | account. 111 | 112 | Returns: 113 | Dict. If successful, the dict will be empty. 114 | """ 115 | if not re.match("projects/(.*)/serviceAccounts/(.*)/keys/(.*)$", key_id): 116 | logging.debug("Key id %s is not properly formatted.", key_id) 117 | key_id = "projects/{0}/serviceAccounts/{1}/keys/{2}".format( 118 | project_id, service_account_id, key_id) 119 | keys = _get_iam_service().projects().serviceAccounts().keys() 120 | request = keys.delete(name=key_id) 121 | return request.execute() 122 | 123 | -------------------------------------------------------------------------------- /keyrotator/keyrotator.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # Copyright 2016 Google Inc. All Rights Reserved. 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | """keyrotator: GCP access key management utility. 16 | 17 | Usage: 18 | keyrotator cleanup (--project-id ) (--iam-account ) 19 | (--key-max-age ) 20 | keyrotator create (--project-id ) (--iam-account ) 21 | [--key-type ] [--key-algorithm ] [--output-file ] 22 | keyrotator delete (--project-id ) (--iam-account ) 23 | (--key-id ) 24 | keyrotator list (--project-id ) (--iam-account ) 25 | keyrotator (-h | --help) 26 | keyrotator (--version) 27 | 28 | Options: 29 | --project-id PROJECTID The project id of the key. 30 | --iam-account ACCOUNT The IAM service account id. 31 | --key-max-age DAYS An integer in the unit of days for which to 32 | delete a key if it is greather than. 33 | --key-algorithm ALGORITHM The algorithm of the key to create. 34 | --key-id KEYID The id of the key to delete. 35 | --key-type TYPE The type of private key to create. 36 | --output-file FILE The file name of the newly created key. 37 | -h --help Display the usage. 38 | --version Show the version number. 39 | 40 | """ 41 | 42 | import logging 43 | import sys 44 | import time 45 | 46 | from cleanup import CleanupCommand 47 | from create import CreateCommand 48 | from delete import DeleteCommand 49 | from docopt_dispatch import dispatch 50 | from list import ListCommand 51 | from version import __version__ 52 | 53 | 54 | def main(): 55 | log_filename = "keyrotator" + time.strftime("-%Y-%m-%d-%H%M") + ".log" 56 | logging.basicConfig(filename=log_filename, level=logging.INFO) 57 | logging.getLogger("").addHandler(logging.StreamHandler()) 58 | logging.info("Logging established in %s.", log_filename) 59 | 60 | dispatch(__doc__, version=__version__) 61 | 62 | 63 | @dispatch.on("cleanup") 64 | def Cleanup(project_id, iam_account, key_max_age, **kwargs): 65 | """For the specifed project, account, and key age delete invalid keys. 66 | 67 | 1) List keys for the given GCP Project ID and Service Account. 68 | 2) Determine Key IDs that meet the key_max_age requirement. 69 | 3) Perform a delete for the matching Key IDs. 70 | 71 | Args: 72 | project_id: The project_id for which to create the key. 73 | iam_account: The IAM account for which to create the key. 74 | key_max_age: A positive integer (in days) for which to find keys to delete. 75 | **kwargs: Additional parameters for the list command. 76 | """ 77 | _ = kwargs 78 | command = CleanupCommand() 79 | sys.exit(command.run(project_id, iam_account, key_max_age)) 80 | 81 | 82 | @dispatch.on("create") 83 | def Create(project_id, iam_account, **kwargs): 84 | """Creates a new key for an account with the specified key type and algorithm. 85 | 86 | If no key type or key algorithm is provided, it will default the key type to 87 | TYPE_GOOGLE_CREDENTIALS_FILE format and the key algorithm to KEY_ALG_RSA_4096. 88 | The resulting key will be output to stdout by default. 89 | 90 | Args: 91 | project_id: The project_id for which to create the key. 92 | iam_account: The IAM account for which to create the key. 93 | **kwargs: Additional parameters for the create command. 94 | """ 95 | command = CreateCommand() 96 | sys.exit(command.run(project_id, iam_account, key_type=kwargs["key_type"], 97 | key_algorithm=kwargs["key_algorithm"], 98 | output_file=kwargs["output_file"])) 99 | 100 | 101 | @dispatch.on("delete") 102 | def Delete(project_id, iam_account, key_id, **kwargs): 103 | """Deletes a specific key for an account. 104 | 105 | Args: 106 | project_id: The project_id for which to delete the key. 107 | iam_account: The IAM account for which to delete the key. 108 | key_id: The ID of the key to delete. 109 | **kwargs: Additional parameters for the delete command. 110 | """ 111 | _ = kwargs 112 | command = DeleteCommand() 113 | sys.exit(command.run(project_id, iam_account, key_id)) 114 | 115 | 116 | @dispatch.on("list") 117 | def List(project_id, iam_account, **kwargs): 118 | """List keys for service account. 119 | 120 | Args: 121 | project_id: The project_id for which to list keys. 122 | iam_account: The IAM account for which to list keys. 123 | **kwargs: Additional parameters for the list command. 124 | """ 125 | _ = kwargs 126 | command = ListCommand() 127 | sys.exit(command.run(project_id, iam_account)) 128 | 129 | 130 | if __name__ == "__main__": 131 | main() 132 | -------------------------------------------------------------------------------- /keyrotator/list.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # Copyright 2016 Google Inc. All Rights Reserved. 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | """keyrotator List command.""" 16 | 17 | import logging 18 | import re 19 | 20 | import iam_service 21 | 22 | 23 | class ListCommand(object): 24 | """Implementation of the keyrotator list command.""" 25 | keyname_pattern = re.compile("keys/(.*)$") 26 | 27 | def run(self, project_id, iam_account, return_results=False): 28 | """Runs the list_keys command for keyrotator. 29 | 30 | Args: 31 | project_id: The project_id for which to create the key. 32 | iam_account: The IAM account for which to create the key. 33 | return_results: Boolean to return results or exit code. 34 | 35 | Returns: 36 | An integer indicating status or a dictionary containing 37 | key data given an input parameters. 38 | """ 39 | response = iam_service.list_keys(project_id, iam_account) 40 | 41 | if response and "keys" in response: 42 | logging.info("Current key listing:") 43 | for key in response["keys"]: 44 | key_path = self.keyname_pattern.search(key["name"]) 45 | logging.info("Key: %s\n\tCreated: %s\n\tExpires: %s", 46 | key_path.group(1), key["validAfterTime"], 47 | key["validBeforeTime"]) 48 | 49 | if return_results: 50 | return response["keys"] 51 | 52 | return 0 53 | -------------------------------------------------------------------------------- /keyrotator/version.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # Copyright 2016 Google Inc. All Rights Reserved. 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | """keyrotator version.""" 16 | 17 | __version__ = "0.0.2" 18 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # Copyright 2016 Google Inc. All Rights Reserved. 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | """keyrotator setup file.""" 16 | 17 | from keyrotator.version import __version__ 18 | from setuptools import find_packages 19 | from setuptools import setup 20 | 21 | setup( 22 | name="keyrotator", 23 | version=__version__, 24 | url="http://github.com/GoogleCloudPlatform/keyrotator", 25 | license="Apache 2.0", 26 | author="Google, Inc.", 27 | author_email="cloud-service-account-key-utility@google.com", 28 | description=("Command line utility for managing Google Cloud" 29 | "service account access keys."), 30 | classifiers=[ 31 | # Classifiers to categorize the project. Full listing 32 | # of available options at: 33 | # https://pypi.python.org/pypi?%3Aaction=list_classifiers 34 | "Development Status :: 2 - Pre-Alpha", 35 | "Environment :: Console", 36 | "License :: OSI Approved :: Apache Software License" 37 | ], 38 | keywords="gcp google cloud key management", 39 | packages=find_packages(), 40 | install_requires=["docopt", 41 | "docopt-dispatch", 42 | "google-api-python-client", 43 | "pytz", 44 | "python-dateutil", 45 | "retrying",], 46 | entry_points={ 47 | "console_scripts": ["keyrotator = keyrotator.keyrotator:main"] 48 | }) 49 | --------------------------------------------------------------------------------