From a317b6bedeb37873ab596845b43feeb7d1dfc5bf Mon Sep 17 00:00:00 2001 From: Adam Migus Date: Thu, 8 Apr 2021 02:01:05 -0400 Subject: [PATCH 1/8] Add Thycotic DevOps Secrets Vault support --- awx/main/credential_plugins/dsv.py | 71 ++++++++++++++++++++++++++++++ awx/settings/defaults.py | 6 +++ requirements/requirements.in | 1 + requirements/requirements.txt | 3 ++ setup.py | 1 + 5 files changed, 82 insertions(+) create mode 100644 awx/main/credential_plugins/dsv.py diff --git a/awx/main/credential_plugins/dsv.py b/awx/main/credential_plugins/dsv.py new file mode 100644 index 0000000000..7fca6a81f7 --- /dev/null +++ b/awx/main/credential_plugins/dsv.py @@ -0,0 +1,71 @@ +from .plugin import CredentialPlugin + +from django.conf import settings +from django.utils.translation import get_language, to_locale, ugettext_lazy as _ +from thycotic.secrets.vault import SecretsVault + + +dsv_inputs = { + 'fields': [ + { + 'id': 'tenant', + 'label': _('Tenant'), + 'help_text': _('The tenant e.g. "ex" when the URL is https://ex.secretservercloud.com'), + 'type': 'string', + }, + {'id': 'client_id', 'label': _('Client ID'), 'type': 'string'}, + { + 'id': 'client_secret', + 'label': _('Client Secret'), + 'type': 'string', + 'secret': True, + }, + ], + 'metadata': [ + { + 'id': 'path', + 'label': _('Secret Path'), + 'type': 'string', + 'help_text': _('The secret path e.g. /test/secret1'), + }, + { + 'id': 'expr', + 'label': _('Attribute Expression'), + 'type': 'string', + 'help_text': _('A Python expression on the dict representation of the secret e.g. "data.username"'), + }, + ], + 'required': ['tenant', 'client_id', 'client_secret', 'path'], +} + +if settings.DEBUG: + dsv_inputs['fields'].append( + { + 'id': 'url_template', + 'label': _('URL template'), + 'type': 'string', + 'default': 'https://{}.secretsvaultcloud.{}/v1', + } + ) + +if to_locale(get_language()) != 'en_US': + dsv_inputs['fields'].append( + { + 'id': 'tld', + 'label': _('Top-level Domain (TLD)'), + 'help_text': _('The Top-level domain of the tenant e.g. "com" when the URL is https://ex.secretservercloud.com'), + 'type': 'string', + 'default': 'com', + 'choices': ['ca', 'com', 'com.au', 'com.sg', 'eu'], + } + ) + + +dsv_plugin = CredentialPlugin( + 'Thycotic DevOps Secrets Vault', + dsv_inputs, + lambda **kwargs: eval( + kwargs['expr'], + SecretsVault(**{k: v for (k, v) in kwargs.items() if k in [field['id'] for field in dsv_inputs['fields']]}).get_secret(kwargs['path']), + ), +) diff --git a/awx/settings/defaults.py b/awx/settings/defaults.py index d1b38a2c1e..046392c3e9 100644 --- a/awx/settings/defaults.py +++ b/awx/settings/defaults.py @@ -701,6 +701,12 @@ SATELLITE6_INSTANCE_ID_VAR = 'foreman_id' INSIGHTS_INSTANCE_ID_VAR = 'insights_id' INSIGHTS_EXCLUDE_EMPTY_GROUPS = False +# --------------------- +# --- Thycotic DSV ---- +# --------------------- +DSV_SHOW_TLD = False # overridden when LOCALE != en_US +DSV_SHOW_URL_TEMPLATE = False + # --------------------- # ----- Custom ----- # --------------------- diff --git a/requirements/requirements.in b/requirements/requirements.in index c990767f63..d1b4d1a406 100644 --- a/requirements/requirements.in +++ b/requirements/requirements.in @@ -42,6 +42,7 @@ psutil pygerduty pyparsing python3-saml +python-dsv-sdk python-ldap>=3.3.1 # https://github.com/python-ldap/python-ldap/issues/270 pyyaml>=5.4.1 # minimum to fix https://github.com/yaml/pyyaml/issues/478 receptorctl diff --git a/requirements/requirements.txt b/requirements/requirements.txt index 0498e5694e..b82437bce3 100644 --- a/requirements/requirements.txt +++ b/requirements/requirements.txt @@ -274,6 +274,8 @@ python-dateutil==2.8.1 # adal # kubernetes # receptorctl +python-dsv-sdk==0.0.1 + # via -r /awx_devel/requirements/requirements.in python-ldap==3.3.1 # via # -r /awx_devel/requirements/requirements.in @@ -316,6 +318,7 @@ requests==2.23.0 # django-oauth-toolkit # kubernetes # msrest + # python-dsv-sdk # requests-oauthlib # slackclient # social-auth-core diff --git a/setup.py b/setup.py index a318cb34e9..8c28f28a43 100755 --- a/setup.py +++ b/setup.py @@ -130,6 +130,7 @@ setup( 'azure_kv = awx.main.credential_plugins.azure_kv:azure_keyvault_plugin', 'aim = awx.main.credential_plugins.aim:aim_plugin', 'centrify_vault_kv = awx.main.credential_plugins.centrify_vault:centrify_plugin', + 'thycotic_dsv = awx.main.credential_plugins.dsv:dsv_plugin', ], }, data_files=proc_data_files( From 9679c154f3371245dde3bd1fd79656f42472a7b4 Mon Sep 17 00:00:00 2001 From: Adam Migus Date: Wed, 26 May 2021 16:14:16 -0400 Subject: [PATCH 2/8] Backout accidential changes to settings/defaults --- awx/settings/defaults.py | 6 ------ 1 file changed, 6 deletions(-) diff --git a/awx/settings/defaults.py b/awx/settings/defaults.py index 046392c3e9..d1b38a2c1e 100644 --- a/awx/settings/defaults.py +++ b/awx/settings/defaults.py @@ -701,12 +701,6 @@ SATELLITE6_INSTANCE_ID_VAR = 'foreman_id' INSIGHTS_INSTANCE_ID_VAR = 'insights_id' INSIGHTS_EXCLUDE_EMPTY_GROUPS = False -# --------------------- -# --- Thycotic DSV ---- -# --------------------- -DSV_SHOW_TLD = False # overridden when LOCALE != en_US -DSV_SHOW_URL_TEMPLATE = False - # --------------------- # ----- Custom ----- # --------------------- From c169cf6d58a4ca6289c525b46c105db159c67865 Mon Sep 17 00:00:00 2001 From: Adam Migus Date: Wed, 26 May 2021 16:30:46 -0400 Subject: [PATCH 3/8] Fix test_credential.py - Add 'thycotic_dsv' to the list of expected credential types --- awx/main/tests/functional/test_credential.py | 1 + 1 file changed, 1 insertion(+) diff --git a/awx/main/tests/functional/test_credential.py b/awx/main/tests/functional/test_credential.py index 2d96a25a5f..b36603275c 100644 --- a/awx/main/tests/functional/test_credential.py +++ b/awx/main/tests/functional/test_credential.py @@ -96,6 +96,7 @@ def test_default_cred_types(): 'satellite6', 'scm', 'ssh', + 'thycotic_dsv', 'tower', 'vault', 'vmware', From bfd1abd79c53f53fc085bb3c85946d090df1566e Mon Sep 17 00:00:00 2001 From: Adam Migus Date: Wed, 26 May 2021 16:54:43 -0400 Subject: [PATCH 4/8] Add license for python-dsv-sdk to docs/licenses --- docs/licenses/python-dsv-sdk.txt | 201 +++++++++++++++++++++++++++++++ 1 file changed, 201 insertions(+) create mode 100644 docs/licenses/python-dsv-sdk.txt diff --git a/docs/licenses/python-dsv-sdk.txt b/docs/licenses/python-dsv-sdk.txt new file mode 100644 index 0000000000..2c80369a92 --- /dev/null +++ b/docs/licenses/python-dsv-sdk.txt @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2019 Thycotic + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. From 86c91509b32747b202f89e422eefb017004bd6ca Mon Sep 17 00:00:00 2001 From: Adam Migus Date: Thu, 8 Apr 2021 02:01:05 -0400 Subject: [PATCH 5/8] Add Thycotic DevOps Secrets Vault support --- awx/settings/defaults.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/awx/settings/defaults.py b/awx/settings/defaults.py index d1b38a2c1e..046392c3e9 100644 --- a/awx/settings/defaults.py +++ b/awx/settings/defaults.py @@ -701,6 +701,12 @@ SATELLITE6_INSTANCE_ID_VAR = 'foreman_id' INSIGHTS_INSTANCE_ID_VAR = 'insights_id' INSIGHTS_EXCLUDE_EMPTY_GROUPS = False +# --------------------- +# --- Thycotic DSV ---- +# --------------------- +DSV_SHOW_TLD = False # overridden when LOCALE != en_US +DSV_SHOW_URL_TEMPLATE = False + # --------------------- # ----- Custom ----- # --------------------- From 67d828cf8043cc8a042f4835c4ced8f335d584a5 Mon Sep 17 00:00:00 2001 From: Adam Migus Date: Wed, 26 May 2021 16:14:16 -0400 Subject: [PATCH 6/8] Backout accidential changes to settings/defaults --- awx/settings/defaults.py | 6 ------ 1 file changed, 6 deletions(-) diff --git a/awx/settings/defaults.py b/awx/settings/defaults.py index 046392c3e9..d1b38a2c1e 100644 --- a/awx/settings/defaults.py +++ b/awx/settings/defaults.py @@ -701,12 +701,6 @@ SATELLITE6_INSTANCE_ID_VAR = 'foreman_id' INSIGHTS_INSTANCE_ID_VAR = 'insights_id' INSIGHTS_EXCLUDE_EMPTY_GROUPS = False -# --------------------- -# --- Thycotic DSV ---- -# --------------------- -DSV_SHOW_TLD = False # overridden when LOCALE != en_US -DSV_SHOW_URL_TEMPLATE = False - # --------------------- # ----- Custom ----- # --------------------- From 1ee241199ebbddf59cabe8752fc8003fc44b4358 Mon Sep 17 00:00:00 2001 From: Adam Migus Date: Sun, 6 Jun 2021 21:13:51 -0400 Subject: [PATCH 7/8] Refactor to simplify - Remove eval and the expression metadata attribute - Remove locale conditional on the tld field --- awx/main/credential_plugins/dsv.py | 31 ++++++++---------------------- 1 file changed, 8 insertions(+), 23 deletions(-) diff --git a/awx/main/credential_plugins/dsv.py b/awx/main/credential_plugins/dsv.py index 7fca6a81f7..8e8f11a98a 100644 --- a/awx/main/credential_plugins/dsv.py +++ b/awx/main/credential_plugins/dsv.py @@ -13,6 +13,13 @@ dsv_inputs = { 'help_text': _('The tenant e.g. "ex" when the URL is https://ex.secretservercloud.com'), 'type': 'string', }, + { + 'id': 'tld', + 'label': _('Top-level Domain (TLD)'), + 'help_text': _('The TLD of the tenant e.g. "com" when the URL is https://ex.secretservercloud.com'), + 'choices': ['ca', 'com', 'com.au', 'com.sg', 'eu'], + 'default': 'com', + }, {'id': 'client_id', 'label': _('Client ID'), 'type': 'string'}, { 'id': 'client_secret', @@ -28,12 +35,6 @@ dsv_inputs = { 'type': 'string', 'help_text': _('The secret path e.g. /test/secret1'), }, - { - 'id': 'expr', - 'label': _('Attribute Expression'), - 'type': 'string', - 'help_text': _('A Python expression on the dict representation of the secret e.g. "data.username"'), - }, ], 'required': ['tenant', 'client_id', 'client_secret', 'path'], } @@ -48,24 +49,8 @@ if settings.DEBUG: } ) -if to_locale(get_language()) != 'en_US': - dsv_inputs['fields'].append( - { - 'id': 'tld', - 'label': _('Top-level Domain (TLD)'), - 'help_text': _('The Top-level domain of the tenant e.g. "com" when the URL is https://ex.secretservercloud.com'), - 'type': 'string', - 'default': 'com', - 'choices': ['ca', 'com', 'com.au', 'com.sg', 'eu'], - } - ) - - dsv_plugin = CredentialPlugin( 'Thycotic DevOps Secrets Vault', dsv_inputs, - lambda **kwargs: eval( - kwargs['expr'], - SecretsVault(**{k: v for (k, v) in kwargs.items() if k in [field['id'] for field in dsv_inputs['fields']]}).get_secret(kwargs['path']), - ), + lambda **kwargs: SecretsVault(**{k: v for (k, v) in kwargs.items() if k in [field['id'] for field in dsv_inputs['fields']]}).get_secret(kwargs['path']), ) From 5509686f5bbb08d86269d6a2564e88265714d713 Mon Sep 17 00:00:00 2001 From: Adam Migus Date: Sun, 6 Jun 2021 22:14:06 -0400 Subject: [PATCH 8/8] Remove unused imports to fix build. --- awx/main/credential_plugins/dsv.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/awx/main/credential_plugins/dsv.py b/awx/main/credential_plugins/dsv.py index 8e8f11a98a..d256b27647 100644 --- a/awx/main/credential_plugins/dsv.py +++ b/awx/main/credential_plugins/dsv.py @@ -1,7 +1,7 @@ from .plugin import CredentialPlugin from django.conf import settings -from django.utils.translation import get_language, to_locale, ugettext_lazy as _ +from django.utils.translation import ugettext_lazy as _ from thycotic.secrets.vault import SecretsVault