├── .github └── workflows │ └── test-tox-plugin.yml ├── .gitignore ├── CONTRIBUTING.md ├── HISTORY.md ├── LICENSE ├── README.md ├── google_artifactregistry_auth └── tox_bootstrap.py ├── keyrings └── gauth.py ├── setup.cfg ├── setup.py └── tests └── tox-plugin ├── setup.py └── tox.ini /.github/workflows/test-tox-plugin.yml: -------------------------------------------------------------------------------- 1 | on: [push, pull_request] 2 | jobs: 3 | build: 4 | runs-on: ubuntu-latest 5 | strategy: 6 | matrix: 7 | python-version: [ '3.8', '3.9', '3.10' ] 8 | tox-version: [ '3.*', '4.*' ] 9 | name: Tox ${{ matrix.tox-version }} plugin - Python ${{ matrix.python-version }} 10 | steps: 11 | - uses: actions/checkout@v2 12 | - name: Setup python 13 | uses: actions/setup-python@v2 14 | with: 15 | python-version: ${{ matrix.python-version }} 16 | - name: Run tox 17 | working-directory: tests/tox-plugin 18 | run: | 19 | python -m pip install "tox==${{ matrix.tox-version }}" 20 | python -m tox 21 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | dist/ 2 | build/ 3 | .eggs/ 4 | *.egg-info/ 5 | -------------------------------------------------------------------------------- /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 28 | [Google's Open Source Community Guidelines](https://opensource.google.com/conduct/). 29 | -------------------------------------------------------------------------------- /HISTORY.md: -------------------------------------------------------------------------------- 1 | 1.1.2 2 | --- 3 | * Add support for tox v4. 4 | 5 | 1.1.1 6 | --- 7 | * Remove unused keyring import to prevent keyring dependency issues. 8 | 9 | 1.1.0 10 | --- 11 | * Update keyring import to be compatible with keyring 23.9.0. 12 | 13 | 1.0.0 14 | --- 15 | * Upgrading tool to version 1.0.0 since Artifact Registry Python Repositories is now in GA. 16 | 17 | 0.0.3 18 | --- 19 | 20 | * Allow project to bootstrap itself with tox 21 | https://github.com/GoogleCloudPlatform/artifact-registry-python-tools/issues/7 22 | * Update classname and python endpoints 23 | 24 | 0.0.2 25 | --- 26 | 27 | * Fixed None reference when parsing a service which is not a proper URL 28 | https://github.com/GoogleCloudPlatform/artifact-registry-python-tools/issues/4 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 | # Artifact Registry tools for Python 2 | This repository contains an alternate [keyring](https://pypi.python.org/pypi/keyring) backend implementation to help with interacting with Python repositories hosted on Artifact Registry. 3 | 4 | ## Authentication 5 | `keyrings.google-artifactregistry-auth` is a Python package which allows you to configure keyring to interact with Python repositories stored in Artifact Registry. 6 | 7 | The backend automatically searches for credentials from the environment and authenticates to Artifact Registry. It looks for credentials in the following order: 8 | 9 | 1. [Google Application Default Credentials](https://developers.google.com/accounts/docs/application-default-credentials). 10 | 2. From the `gcloud` SDK. (i.e., the access token printed via `gcloud config config-helper --format='value(credential.access_token)'`) 11 | * Hint: You can see which account is active with the command `gcloud config config-helper --format='value(configuration.properties.core.account)'` 12 | 3. If neither of them exist, an error occurs. 13 | 14 | To use the keyring backend: 15 | 16 | 1. Log in 17 | 18 | Option 1: log in as a service account: 19 | 20 | (1). Using a JSON file that contains a service account key: 21 | 22 | ``` 23 | $ export GOOGLE_APPLICATION_CREDENTIALS=[path/to/key.json] 24 | ``` 25 | 26 | (2). Or using `gcloud`: 27 | 28 | ``` 29 | $ gcloud auth application-default login 30 | ``` 31 | 32 | Option 2: log in as an end user via `gcloud`: 33 | 34 | ``` 35 | $ gcloud auth login 36 | ``` 37 | 38 | 2. Configure twine (`.pypirc`) and pip (`pip.conf`) tools to connect to the repository. Use the output from the following command: 39 | 40 | $ gcloud artifacts print-settings python 41 | 42 | In your `.pypirc` file add: 43 | 44 | ```ini 45 | [disutils] 46 | index-servers = 47 | REPOSITORY_ID 48 | 49 | [REPOSITORY_ID] 50 | repository = https://LOCATION-python.pkg.dev/PROJECT_ID/REPOSITORY_ID/ 51 | ``` 52 | 53 | In your `pip.conf` file add: 54 | 55 | ```ini 56 | [global] 57 | index-url = https://LOCATION-python.pkg.dev/PROJECT_ID/REPOSITORY_ID/simple/ 58 | ``` 59 | 3. Install the `keyrings.google-artifactregistry-auth` package 60 | 61 | ``` 62 | $ pip install keyrings.google-artifactregistry-auth 63 | ``` 64 | 65 | List backends to confirm the installation. 66 | 67 | ``` 68 | $ keyring --list-backends 69 | ``` 70 | 71 | The list should include 72 | 73 | * `keyrings.gauth.GooglePythonAuth (priority: 9)` 74 | * `keyring.backends.chainer.ChainerBackend (priority: -1)` 75 | * `keyring.backends.fail.Keyring (priority: 0)` 76 | 77 | ## Usage with other tools 78 | 79 | ### Usage with `tox` 80 | 81 | The [`tox` tool](https://pypi.org/project/tox/) is a testing and automation tool. 82 | 83 | Because the credential helper needs to be installed _before_ any private 84 | dependencies are installed, it needs to be bootstrapped into the `tox` 85 | environment via a plugin. 86 | 87 | To do this, specify the `keyrings.google-artifactregistry-auth` package via the 88 | [`requires`](https://tox.readthedocs.io/en/latest/config.html#conf-requires) 89 | requirement in your `tox.ini` file: 90 | 91 | ```ini 92 | [tox] 93 | envlist = py 94 | requires = keyrings.google-artifactregistry-auth 95 | 96 | [testenv] 97 | deps = -r requirements.txt 98 | ``` 99 | 100 | You can then configure your `requirement.txt` file to use the Artifact Registry repo as 101 | the index: 102 | 103 | ``` 104 | --index-url https://[REGION]-python.pkg.dev/[PROJECT_ID]/[REPOSITORY]/simple 105 | 106 | # mypackage will be installed from the Artifact Registry repository 107 | mypackage 108 | ``` 109 | -------------------------------------------------------------------------------- /google_artifactregistry_auth/tox_bootstrap.py: -------------------------------------------------------------------------------- 1 | import logging 2 | 3 | import pluggy 4 | 5 | from tox import __version__ 6 | 7 | hookimpl = pluggy.HookimplMarker("tox") 8 | 9 | tox_version_major = int(__version__.split(".")[0]) 10 | package_name = "keyrings.google-artifactregistry-auth" 11 | 12 | if tox_version_major > 3: 13 | 14 | @hookimpl 15 | def tox_on_install(tox_env): 16 | req = extract_requirement_from_tox_requires(tox_env) 17 | 18 | if req: 19 | tox_env.installer.install( 20 | [req], 21 | "GoogleArtifactRegistry", 22 | "keyring_deps", 23 | ) 24 | 25 | 26 | def extract_requirement_from_tox_requires(tox_env): 27 | req = None 28 | try: 29 | req = next( 30 | req for req in tox_env.core["requires"] if req.name == package_name 31 | ) 32 | except KeyError: 33 | pass 34 | except StopIteration: 35 | pass 36 | if not req: 37 | logging.warning( 38 | "Tox core option 'requires' is missing or does not specify" 39 | " %s. Package will not be installed in testenv", 40 | package_name, 41 | ) 42 | return req 43 | 44 | else: 45 | 46 | @hookimpl 47 | def tox_testenv_install_deps(venv, action): 48 | venv._install(venv.envconfig.config.requires, action=action) 49 | -------------------------------------------------------------------------------- /keyrings/gauth.py: -------------------------------------------------------------------------------- 1 | """ 2 | Copyright 2021 Google LLC 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 | https://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 | """ 16 | 17 | import google 18 | from google.auth.transport import requests 19 | from google.auth.exceptions import DefaultCredentialsError 20 | 21 | import keyring 22 | from keyring import backend 23 | from keyring import credentials 24 | from urllib.parse import urlparse 25 | 26 | import json 27 | import logging 28 | import subprocess 29 | 30 | class GooglePythonAuth(backend.KeyringBackend): 31 | priority = 9 32 | 33 | """ 34 | Higher priority than typical recommended backends - but one less priority than Chainer Backend. 35 | """ 36 | 37 | def get_password(self,service,username): 38 | url = urlparse(service) 39 | if url.hostname is None or not url.hostname.endswith(".pkg.dev"): 40 | return 41 | 42 | #trying application default credentials otherwise fall back to gcloud credentials command 43 | try: 44 | CREDENTIAL_SCOPES =["https://www.googleapis.com/auth/cloud-platform"] 45 | credentials, project_id = google.auth.default(scopes=CREDENTIAL_SCOPES) 46 | credentials.refresh(requests.Request()) 47 | return credentials.token 48 | except Exception as e: 49 | logging.warning("Failed to retrieve Application Default Credentials: {0}".format(e)) 50 | 51 | try: 52 | credentials = get_gcloud_credential() 53 | return credentials 54 | except Exception as e: 55 | logging.warning("Failed to retrieve credentials from gcloud: {0}".format(e)) 56 | 57 | logging.warning("Artifact Registry PyPI Keyring: No credentials could be found.") 58 | raise Exception("Failed to find credentials, Please run: `gcloud auth application-default login or export GOOGLE_APPLICATION_CREDENTIALS=`") 59 | 60 | def set_password(self,service,username,password): 61 | raise NotImplementedError() 62 | 63 | def delete_password(self,service,username): 64 | raise NotImplementedError() 65 | 66 | def get_credential(self,service,username): 67 | password = self.get_password(service,username) 68 | if password is not None: 69 | return credentials.SimpleCredential("oauth2accesstoken",password) 70 | return None 71 | 72 | 73 | def get_gcloud_credential(): 74 | 75 | # fall back to fetching credentials from gcloud if Application Default Credentials fails 76 | try: 77 | logging.warning("Trying to retrieve credentials from gcloud...") 78 | command = subprocess.run(['gcloud','config','config-helper','--format=json(credential)'], check=True, stdout=subprocess.PIPE, universal_newlines=True) 79 | except Exception as e: 80 | raise Exception ("gcloud command exited with status: {0}".format(e)) 81 | result = json.loads(command.stdout) 82 | credential = result.get("credential") 83 | if credential is None: 84 | raise Exception("No credential returned from gcloud") 85 | if "access_token" not in credential or "token_expiry" not in credential: 86 | raise Exception("Malformed response from gcloud") 87 | return credential.get("access_token") 88 | 89 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [metadata] 2 | license_file = LICENSE 3 | name = keyrings.google-artifactregistry-auth 4 | version = 1.1.2 5 | author = Megan Kuo 6 | author_email = megankuo@google.com 7 | description = Keyring backend for Google Auth tokens 8 | long_description = file:README.md 9 | long_description_content_type = text/markdown 10 | url = https://github.com/GoogleCloudPlatform/artifact-registry-python-tools 11 | classifiers = 12 | Development Status :: 5 - Production/Stable 13 | Intended Audience :: Developers 14 | License :: OSI Approved :: Apache Software License 15 | Programming Language :: Python :: 3 16 | Programming Language :: Python :: 3 :: Only 17 | 18 | [options] 19 | packages = find_namespace: 20 | include_package_data = true 21 | python_requires = >=3.6 22 | install_requires = 23 | keyring 24 | google-auth 25 | pluggy 26 | setup_requires = setuptools_scm[toml] >= 3.4.1 27 | 28 | [options.extras_require] 29 | tox = tox 30 | testing = 31 | # upstream 32 | pytest >= 3.5, !=3.7.3 33 | pytest-checkdocs >= 1.2.3 34 | pytest-flake8 35 | pytest-black >= 0.3.7; python_implementation != "PyPy" 36 | pytest-cov 37 | pytest-mypy; python_implementation != "PyPy" 38 | 39 | # local 40 | 41 | [options.entry_points] 42 | keyring.backends = 43 | Google Auth = keyrings.gauth 44 | tox = 45 | tox_bootstrap = google_artifactregistry_auth.tox_bootstrap 46 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import setuptools 2 | 3 | if __name__ == "__main__": 4 | setuptools.setup() 5 | -------------------------------------------------------------------------------- /tests/tox-plugin/setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup 2 | 3 | setup() 4 | -------------------------------------------------------------------------------- /tests/tox-plugin/tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | envlist = py 3 | requires = keyrings.google-artifactregistry-auth @ file:///home/runner/work/artifact-registry-python-tools/artifact-registry-python-tools 4 | 5 | [testenv] 6 | commands = python -m pip show keyrings.google-artifactregistry-auth --------------------------------------------------------------------------------