├── .gitignore ├── LICENSE ├── README.md ├── awscli_plugin_endpoint └── __init__.py ├── setup.cfg └── setup.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | 27 | # PyInstaller 28 | # Usually these files are written by a python script from a template 29 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 30 | *.manifest 31 | *.spec 32 | 33 | # Installer logs 34 | pip-log.txt 35 | pip-delete-this-directory.txt 36 | 37 | # Unit test / coverage reports 38 | htmlcov/ 39 | .tox/ 40 | .coverage 41 | .coverage.* 42 | .cache 43 | nosetests.xml 44 | coverage.xml 45 | *,cover 46 | .hypothesis/ 47 | 48 | # Translations 49 | *.mo 50 | *.pot 51 | 52 | # Django stuff: 53 | *.log 54 | local_settings.py 55 | 56 | # Flask stuff: 57 | instance/ 58 | .webassets-cache 59 | 60 | # Scrapy stuff: 61 | .scrapy 62 | 63 | # Sphinx documentation 64 | docs/_build/ 65 | 66 | # PyBuilder 67 | target/ 68 | 69 | # IPython Notebook 70 | .ipynb_checkpoints 71 | 72 | # pyenv 73 | .python-version 74 | 75 | # celery beat schedule file 76 | celerybeat-schedule 77 | 78 | # dotenv 79 | .env 80 | 81 | # virtualenv 82 | venv/ 83 | ENV/ 84 | 85 | # Spyder project settings 86 | .spyderproject 87 | 88 | # Rope project settings 89 | .ropeproject 90 | -------------------------------------------------------------------------------- /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 | awscli-plugin-endpoint 2 | ============= 3 | 4 | This awscli plugin provides service endpoint configuration **per service** on profile. 5 | 6 | ------------ 7 | Installation 8 | ------------ 9 | 10 | The easiest way to install awscli-plugin-endpoint is to use `pip`: 11 | 12 | $ pip install awscli-plugin-endpoint 13 | 14 | You can also install the latest package from GitHub source which can contain changes not yet pushed to PyPI: 15 | 16 | $ pip install git+https://github.com/wbingli/awscli-plugin-endpoint.git 17 | 18 | or, if you install `awscli` via Homebrew, which bundles its own python, install as following: 19 | 20 | $ /usr/local/opt/awscli/libexec/bin/pip install awscli-plugin-endpoint 21 | 22 | Regardless of the installation method, make note of the package installation path (e.g. `~/Library/Python/3.7/lib/python/site-packages`). It will be needed if you are using AWS CLI v2. 23 | 24 | --------------- 25 | Getting Started 26 | --------------- 27 | 28 | Before using awscli-plugin-endpoint plugin, you need to [configure awscli](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) first. 29 | 30 | **MUST**: Once that's done, to enable `awscli-plugin-endpoint` plugin, you can run: 31 | 32 | $ aws configure set plugins.endpoint awscli_plugin_endpoint 33 | 34 | The above command adds below section to your aws config file. You can also directly edit your `~/.aws/config` with below configuration. 35 | 36 | [plugins] 37 | endpoint = awscli_plugin_endpoint 38 | 39 | If you are configuring AWS CLI v2 to use the endpoint plugin, you will need to add an additional configuration setting, replacing "site-packages-path" with the installation path noted above: 40 | 41 | $ aws configure set plugins.cli_legacy_plugin_path site-packages-path 42 | 43 | The configuration file will now have two values in the plugin section: 44 | 45 | [plugins] 46 | endpoint = awscli_plugin_endpoint 47 | cli_legacy_plugin_path = site-packages-path 48 | 49 | To add endpoint configure to a profile(assuming you have a **local** profile), you can run: 50 | 51 | $ aws configure --profile local set dynamodb.endpoint_url http://localhost:8000 52 | 53 | The above command adds below section to your profile: 54 | 55 | [profile local] 56 | dynamodb = 57 | endpoint_url = http://localhost:8000 58 | 59 | Now you can access your local dynamodb just use profile: 60 | 61 | $ aws dynamodb list-tables --profile local 62 | 63 | ## One more example with S3 configuration 64 | 65 | Add endpoint configuration to the profile: 66 | 67 | $ aws configure --profile wasabi set s3.endpoint_url https://s3.wasabisys.com 68 | 69 | The profile will looks like below: 70 | 71 | [profile wasabi] 72 | region = us-east-1 73 | s3 = 74 | endpoint_url = https://s3.wasabisys.com 75 | 76 | Now you can use `aws s3` command with this profile as following: 77 | 78 | $ aws s3 ls --profile wasabi 79 | 80 | One more thing, the endpoint is technically per **sub command**. Take S3 as example, above S3 configuration will not work for S3 low level CLI `aws s3api`. To make `s3api` work with this endpoint, you should add endpoint to this sub command as well: 81 | 82 | [profile wasabi] 83 | region = us-east-1 84 | s3 = 85 | endpoint_url = https://s3.wasabisys.com 86 | s3api = 87 | endpoint_url = https://s3.wasabisys.com 88 | 89 | Now you can use `aws s3api` command with this profile as following: 90 | 91 | $ aws s3api --profile wasabi list-buckets 92 | 93 | 94 | Working with Secure Connections 95 | ------------------ 96 | By default, awscli verifies the certificates presented for all HTTPS requests. 97 | There are two options for working with self-signed or otherwise untrusted 98 | certificates: 99 | 100 | * `ca_bundle` 101 | 102 | If the certificate is long-lived, or any new certificates will be issued by 103 | a long-lived certificate authority, you may want to provide an alternate 104 | set of trusted certificates with `ca_bundle`. This is comparable to the 105 | `--ca-bundle` command line option, and may be specified either per-profile 106 | or per-subcommand: 107 | 108 | [profile local1] 109 | ca_bundle = /path/to/bundle.crt 110 | s3 = 111 | endpoint_url = https://localhost:8000 112 | 113 | [profile local2] 114 | ec2 = 115 | ca_bundle = /path/to/another-bundle.crt 116 | endpoint_url = https://localhost:8888 117 | 118 | * `verify_ssl` 119 | 120 | If the certificate will be frequently refreshed, you may want to simply 121 | disable verification with `verify_ssl = false`. This is comparable to the 122 | `--no-verify-ssl` command line option: 123 | 124 | [profile local] 125 | dynamodb = 126 | verify_ssl = false 127 | endpoint_url = https://localhost:8000 128 | 129 | 130 | -------------------------------------------------------------------------------- /awscli_plugin_endpoint/__init__.py: -------------------------------------------------------------------------------- 1 | import warnings 2 | 3 | ENDPOINT_URL = 'endpoint_url' 4 | VERIFY_SSL = 'verify_ssl' 5 | CA_BUNDLE = 'ca_bundle' 6 | 7 | def str2bool(value): 8 | return str(value).lower() in ['1', 'yes', 'y', 'true', 'on'] 9 | 10 | def get_verify_from_profile(profile, command): 11 | verify = True 12 | if command in profile: 13 | if VERIFY_SSL in profile[command]: 14 | verify = str2bool(profile[command][VERIFY_SSL]) 15 | return verify 16 | 17 | def get_ca_bundle_from_profile(profile, command): 18 | return profile.get(command, {}).get(CA_BUNDLE) 19 | 20 | def get_endpoint_from_profile(profile, command): 21 | endpoint = None 22 | if command in profile: 23 | if ENDPOINT_URL in profile[command]: 24 | endpoint = profile[command][ENDPOINT_URL] 25 | return endpoint 26 | 27 | def set_endpoint_from_profile(parsed_args, **kwargs): 28 | endpoint_url = parsed_args.endpoint_url 29 | command = parsed_args.command 30 | # If endpoint set on CLI option, use CLI endpoint 31 | if endpoint_url is None: 32 | session = kwargs['session'] 33 | # Set profile to session so we can load profile from config 34 | if parsed_args.profile: 35 | session.set_config_variable('profile', parsed_args.profile) 36 | service_endpoint = get_endpoint_from_profile(session.get_scoped_config(), command) 37 | if service_endpoint is not None: 38 | parsed_args.endpoint_url = service_endpoint 39 | 40 | def set_verify_from_profile(parsed_args, **kwargs): 41 | verify_ssl = parsed_args.verify_ssl 42 | command = parsed_args.command 43 | # By default verify_ssl is set to true 44 | # if --no-verify-ssl is specified, parsed_args.verify_ssl is False 45 | # so keep it 46 | if verify_ssl: 47 | session = kwargs['session'] 48 | # Set profile to session so we can load profile from config 49 | if parsed_args.profile: 50 | session.set_config_variable('profile', parsed_args.profile) 51 | service_verify = get_verify_from_profile(session.get_scoped_config(), command) 52 | if service_verify is not None: 53 | parsed_args.verify_ssl = service_verify 54 | if not service_verify: 55 | warnings.filterwarnings('ignore', 'Unverified HTTPS request') 56 | 57 | def set_ca_bundle_from_profile(parsed_args, **kwargs): 58 | # Respect command line arg if present 59 | if parsed_args.ca_bundle: 60 | return 61 | 62 | command = parsed_args.command 63 | session = kwargs['session'] 64 | # Set profile to session so we can load profile from config 65 | if parsed_args.profile: 66 | session.set_config_variable('profile', parsed_args.profile) 67 | parsed_args.ca_bundle = get_ca_bundle_from_profile(session.get_scoped_config(), command) 68 | 69 | def awscli_initialize(cli): 70 | cli.register('top-level-args-parsed', set_endpoint_from_profile) 71 | cli.register('top-level-args-parsed', set_verify_from_profile) 72 | cli.register('top-level-args-parsed', set_ca_bundle_from_profile) 73 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [metadata] 2 | description-file = README.md 3 | 4 | [bdist_wheel] 5 | universal = True 6 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | import sys 3 | from setuptools import setup 4 | 5 | requires = ['awscli>=1.11.0'] 6 | 7 | setup( 8 | name='awscli-plugin-endpoint', 9 | packages=['awscli_plugin_endpoint'], 10 | version='0.4', 11 | description='Endpoint plugin for AWS CLI', 12 | long_description=open('README.md').read(), 13 | long_description_content_type='text/markdown', 14 | author='Wenbing Li', 15 | author_email='wbingli@gmail.com', 16 | url='https://github.com/wbingli/awscli-plugin-endpoint', 17 | download_url='https://github.com/wbingli/awscli-plugin-endpoint/tarball/0.4', 18 | keywords=['awscli', 'plugin', 'endpoint'], 19 | install_requires=requires, 20 | classifiers = [] 21 | ) 22 | --------------------------------------------------------------------------------