From 68ab6e485382ef02d4e9112c04589d24ab03777f Mon Sep 17 00:00:00 2001 From: Ricky White Date: Thu, 24 Jun 2021 16:07:56 -0400 Subject: [PATCH 01/14] Added python-tss-sdk to requirements --- requirements/requirements.in | 1 + requirements/requirements.txt | 5 +++++ 2 files changed, 6 insertions(+) diff --git a/requirements/requirements.in b/requirements/requirements.in index 8a857a2522..b39d7b9af3 100644 --- a/requirements/requirements.in +++ b/requirements/requirements.in @@ -43,6 +43,7 @@ pygerduty pyparsing python3-saml python-dsv-sdk +python-tss-sdk==0.0.6 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==1.0.0 diff --git a/requirements/requirements.txt b/requirements/requirements.txt index a64e7e641c..b34399247f 100644 --- a/requirements/requirements.txt +++ b/requirements/requirements.txt @@ -76,6 +76,8 @@ daphne==2.4.1 # via # -r /awx_devel/requirements/requirements.in # channels +dataclasses==0.6 + # via python-tss-sdk defusedxml==0.6.0 # via # python3-openid @@ -282,6 +284,8 @@ python-ldap==3.3.1 # django-auth-ldap python-string-utils==1.0.0 # via openshift +python-tss-sdk==0.0.6 + # via -r /awx_devel/requirements/requirements.in python3-openid==3.1.0 # via social-auth-core python3-saml==1.9.0 @@ -314,6 +318,7 @@ requests==2.23.0 # kubernetes # msrest # python-dsv-sdk + # python-tss-sdk # requests-oauthlib # slackclient # social-auth-core From d6621470b371a649d83389fbf7cf10fd130e3025 Mon Sep 17 00:00:00 2001 From: Ricky White Date: Thu, 24 Jun 2021 16:08:34 -0400 Subject: [PATCH 02/14] Added tss credential plugin --- setup.py | 1 + 1 file changed, 1 insertion(+) diff --git a/setup.py b/setup.py index 9b6a43cbc5..7ca1d590a1 100755 --- a/setup.py +++ b/setup.py @@ -131,6 +131,7 @@ setup( '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', + 'thycotic_tss = awx.main.credential_plugins.tss:tss_plugin', ], }, data_files=proc_data_files( From f06c6d349cee1b2d3b40e0f26671d4ec8b0e8d51 Mon Sep 17 00:00:00 2001 From: Ricky White Date: Thu, 24 Jun 2021 16:10:46 -0400 Subject: [PATCH 03/14] Added base tss plugin code. Not tested --- awx/main/credential_plugins/tss.py | 45 ++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 awx/main/credential_plugins/tss.py diff --git a/awx/main/credential_plugins/tss.py b/awx/main/credential_plugins/tss.py new file mode 100644 index 0000000000..d5e9752e7f --- /dev/null +++ b/awx/main/credential_plugins/tss.py @@ -0,0 +1,45 @@ +from .plugin import CredentialPlugin +from django.utils.translation import ugettext_lazy as _ + +from thycotic.secrets.server import SecretServer, PasswordGrantAuthorizer + +tss_inputs = { + 'fields': [ + { + 'id': 'server_url', + 'label': _('Secret Server URL'), + 'help_text': _(''), + 'type': 'string', + }, + { + 'id': 'username', + 'label': _('Username'), + 'help_text': _(''), + 'type': 'string', + }, + { + 'id': 'password', + 'label': _('Password'), + 'help_text': _(''), + 'type': 'string', + 'secret': True, + }, + ], + 'metadata': [ + { + 'id': 'secret_id', + 'label': _('Secret ID'), + 'help_text': _(''), + 'type': 'int', + }, + ], + 'required': ['server_url', 'secret_id', 'username', 'password'], +} + + +authorizer = PasswordGrantAuthorizer( + f"{tss_inputs['fields'][0]}", f"{tss_inputs['fields'][1]}", f"{tss_inputs['fields'][2]}" # server_url # username # password +) + + +tss_plugin = CredentialPlugin('Thycotic Secret Server', inputs=tss_inputs, backend=SecretServer(authorizer).get_secret(tss_inputs['metadata'][0])) From 14b767abc3840fd74a81f25dd9678e327a43981b Mon Sep 17 00:00:00 2001 From: Ricky White Date: Fri, 25 Jun 2021 16:47:01 +0000 Subject: [PATCH 04/14] Added thycotic_tss to test credential --- 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 b3c8dca5db..ae5d99730f 100644 --- a/awx/main/tests/functional/test_credential.py +++ b/awx/main/tests/functional/test_credential.py @@ -98,6 +98,7 @@ def test_default_cred_types(): 'scm', 'ssh', 'thycotic_dsv', + 'thycotic_tss', 'vault', 'vmware', ] From 0cc6bf9b60da62875e17dd98214560611c372edb Mon Sep 17 00:00:00 2001 From: Ricky White Date: Fri, 25 Jun 2021 16:48:14 +0000 Subject: [PATCH 05/14] Updated backend code --- awx/main/credential_plugins/tss.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/awx/main/credential_plugins/tss.py b/awx/main/credential_plugins/tss.py index d5e9752e7f..2c8ab6a18a 100644 --- a/awx/main/credential_plugins/tss.py +++ b/awx/main/credential_plugins/tss.py @@ -33,13 +33,13 @@ tss_inputs = { 'type': 'int', }, ], - 'required': ['server_url', 'secret_id', 'username', 'password'], + 'required': ['server_url', 'username', 'password', 'secret_id'], } -authorizer = PasswordGrantAuthorizer( - f"{tss_inputs['fields'][0]}", f"{tss_inputs['fields'][1]}", f"{tss_inputs['fields'][2]}" # server_url # username # password -) +def tss_backend(**kwargs): + authorizer = PasswordGrantAuthorizer(kwargs['server_url'], kwargs['username'], kwargs['password']) + return SecretServer(authorizer).get_secret(kwargs['secret_id']) -tss_plugin = CredentialPlugin('Thycotic Secret Server', inputs=tss_inputs, backend=SecretServer(authorizer).get_secret(tss_inputs['metadata'][0])) +tss_plugin = CredentialPlugin('Thycotic Secret Server', inputs=tss_inputs, backend=tss_backend) From b0b295ba1e651e940a759e0e36eb3985ac3cc268 Mon Sep 17 00:00:00 2001 From: "Adam C. Migus" Date: Mon, 28 Jun 2021 18:41:04 +0000 Subject: [PATCH 06/14] My changes. --- awx/main/credential_plugins/tss.py | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/awx/main/credential_plugins/tss.py b/awx/main/credential_plugins/tss.py index 2c8ab6a18a..41ab72c28e 100644 --- a/awx/main/credential_plugins/tss.py +++ b/awx/main/credential_plugins/tss.py @@ -8,19 +8,19 @@ tss_inputs = { { 'id': 'server_url', 'label': _('Secret Server URL'), - 'help_text': _(''), + 'help_text': _('The Base URL of Secret Server e.g. https://myserver/SecretServer or https://mytenant.secretservercloud.com'), 'type': 'string', }, { 'id': 'username', 'label': _('Username'), - 'help_text': _(''), + 'help_text': _('The (Application) user username'), 'type': 'string', }, { 'id': 'password', 'label': _('Password'), - 'help_text': _(''), + 'help_text': _('The corresponding password'), 'type': 'string', 'secret': True, }, @@ -29,17 +29,17 @@ tss_inputs = { { 'id': 'secret_id', 'label': _('Secret ID'), - 'help_text': _(''), + 'help_text': _('The integer ID of the secret'), 'type': 'int', }, ], 'required': ['server_url', 'username', 'password', 'secret_id'], } - -def tss_backend(**kwargs): - authorizer = PasswordGrantAuthorizer(kwargs['server_url'], kwargs['username'], kwargs['password']) - return SecretServer(authorizer).get_secret(kwargs['secret_id']) - - -tss_plugin = CredentialPlugin('Thycotic Secret Server', inputs=tss_inputs, backend=tss_backend) +tss_plugin = CredentialPlugin( + 'Thycotic Secret Server', + tss_inputs, + lambda **kwargs: SecretServer( + PasswordGrantAuthorizer(**{k: v for (k, v) in kwargs.items() if k in [field['id'] for field in tss_inputs['fields']]}) + ).get_secret(kwargs['secret_id']), +) From 7ec56a56e53dad5bc0d211f7d274914ce4b01fab Mon Sep 17 00:00:00 2001 From: Adam Migus Date: Tue, 29 Jun 2021 15:37:36 -0400 Subject: [PATCH 07/14] Fixed it. --- awx/main/credential_plugins/tss.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/awx/main/credential_plugins/tss.py b/awx/main/credential_plugins/tss.py index 41ab72c28e..df4d3e7793 100644 --- a/awx/main/credential_plugins/tss.py +++ b/awx/main/credential_plugins/tss.py @@ -1,7 +1,7 @@ from .plugin import CredentialPlugin from django.utils.translation import ugettext_lazy as _ -from thycotic.secrets.server import SecretServer, PasswordGrantAuthorizer +from thycotic.secrets.server import SecretServerV1 as SecretServer, PasswordGrantAuthorizer tss_inputs = { 'fields': [ @@ -30,7 +30,7 @@ tss_inputs = { 'id': 'secret_id', 'label': _('Secret ID'), 'help_text': _('The integer ID of the secret'), - 'type': 'int', + 'type': 'string', }, ], 'required': ['server_url', 'username', 'password', 'secret_id'], @@ -40,6 +40,6 @@ tss_plugin = CredentialPlugin( 'Thycotic Secret Server', tss_inputs, lambda **kwargs: SecretServer( - PasswordGrantAuthorizer(**{k: v for (k, v) in kwargs.items() if k in [field['id'] for field in tss_inputs['fields']]}) + kwargs['server_url'], PasswordGrantAuthorizer(kwargs['server_url'].rstrip('/') + '/oauth2/token', kwargs['username'], kwargs['password']) ).get_secret(kwargs['secret_id']), ) From 28de50f14e792f49dc8aeb3097b28d91e188677b Mon Sep 17 00:00:00 2001 From: endlesstrax Date: Tue, 13 Jul 2021 17:04:47 +0000 Subject: [PATCH 08/14] Updated the required sdk version to latest release v1.0.0 --- requirements/requirements.in | 2 +- requirements/requirements.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/requirements/requirements.in b/requirements/requirements.in index b39d7b9af3..523606e228 100644 --- a/requirements/requirements.in +++ b/requirements/requirements.in @@ -43,7 +43,7 @@ pygerduty pyparsing python3-saml python-dsv-sdk -python-tss-sdk==0.0.6 +python-tss-sdk==1.0.0 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==1.0.0 diff --git a/requirements/requirements.txt b/requirements/requirements.txt index b34399247f..fe3f5c2d7a 100644 --- a/requirements/requirements.txt +++ b/requirements/requirements.txt @@ -284,7 +284,7 @@ python-ldap==3.3.1 # django-auth-ldap python-string-utils==1.0.0 # via openshift -python-tss-sdk==0.0.6 +python-tss-sdk==1.0.0 # via -r /awx_devel/requirements/requirements.in python3-openid==3.1.0 # via social-auth-core From e6ed7f95f1e15a50ed2d862c32e18788acf2a93c Mon Sep 17 00:00:00 2001 From: endlesstrax Date: Tue, 13 Jul 2021 17:14:57 +0000 Subject: [PATCH 09/14] Added licences fro dataclasses and python-tss-sdk --- docs/licenses/dataclasses.txt | 201 +++++++++++++++++++++++++++++++ docs/licenses/python-tss-sdk.txt | 201 +++++++++++++++++++++++++++++++ 2 files changed, 402 insertions(+) create mode 100644 docs/licenses/dataclasses.txt create mode 100644 docs/licenses/python-tss-sdk.txt diff --git a/docs/licenses/dataclasses.txt b/docs/licenses/dataclasses.txt new file mode 100644 index 0000000000..3d33284651 --- /dev/null +++ b/docs/licenses/dataclasses.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 [yyyy] [name of copyright owner] + + 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. \ No newline at end of file diff --git a/docs/licenses/python-tss-sdk.txt b/docs/licenses/python-tss-sdk.txt new file mode 100644 index 0000000000..2aafae0ba6 --- /dev/null +++ b/docs/licenses/python-tss-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. \ No newline at end of file From fa7867e8a77190468c50f144c62f24c5b6e6f739 Mon Sep 17 00:00:00 2001 From: endlesstrax Date: Tue, 13 Jul 2021 23:49:53 +0000 Subject: [PATCH 10/14] Fixed import error --- awx/main/credential_plugins/tss.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/awx/main/credential_plugins/tss.py b/awx/main/credential_plugins/tss.py index df4d3e7793..c96adb5d31 100644 --- a/awx/main/credential_plugins/tss.py +++ b/awx/main/credential_plugins/tss.py @@ -1,7 +1,7 @@ from .plugin import CredentialPlugin from django.utils.translation import ugettext_lazy as _ -from thycotic.secrets.server import SecretServerV1 as SecretServer, PasswordGrantAuthorizer +from thycotic.secrets.server import SecretServer, PasswordGrantAuthorizer tss_inputs = { 'fields': [ From 9dc84d69d5efcf5ee76eac986d887ebcd10671ba Mon Sep 17 00:00:00 2001 From: endlesstrax Date: Wed, 14 Jul 2021 14:49:23 +0000 Subject: [PATCH 11/14] Update required for SDK v1 compatability --- awx/main/credential_plugins/tss.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/awx/main/credential_plugins/tss.py b/awx/main/credential_plugins/tss.py index c96adb5d31..f6b6a8a250 100644 --- a/awx/main/credential_plugins/tss.py +++ b/awx/main/credential_plugins/tss.py @@ -39,7 +39,7 @@ tss_inputs = { tss_plugin = CredentialPlugin( 'Thycotic Secret Server', tss_inputs, - lambda **kwargs: SecretServer( - kwargs['server_url'], PasswordGrantAuthorizer(kwargs['server_url'].rstrip('/') + '/oauth2/token', kwargs['username'], kwargs['password']) - ).get_secret(kwargs['secret_id']), + lambda **kwargs: SecretServer(kwargs['server_url'], PasswordGrantAuthorizer(kwargs['server_url'], kwargs['username'], kwargs['password'])).get_secret( + kwargs['secret_id'] + ), ) From 77ab35e7a8b1d7507033e644f00186a107e85c98 Mon Sep 17 00:00:00 2001 From: Adam Migus Date: Wed, 14 Jul 2021 17:24:52 -0400 Subject: [PATCH 12/14] Extract the field from the secret. --- awx/main/credential_plugins/tss.py | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/awx/main/credential_plugins/tss.py b/awx/main/credential_plugins/tss.py index f6b6a8a250..f3927f6658 100644 --- a/awx/main/credential_plugins/tss.py +++ b/awx/main/credential_plugins/tss.py @@ -1,7 +1,7 @@ from .plugin import CredentialPlugin from django.utils.translation import ugettext_lazy as _ -from thycotic.secrets.server import SecretServer, PasswordGrantAuthorizer +from thycotic.secrets.server import PasswordGrantAuthorizer, SecretServer, ServerSecret tss_inputs = { 'fields': [ @@ -32,14 +32,22 @@ tss_inputs = { 'help_text': _('The integer ID of the secret'), 'type': 'string', }, + { + 'id': 'secret_field', + 'label': _('Secret Field'), + 'help_text': _('The field to extract from the secret'), + 'type': 'string', + }, ], - 'required': ['server_url', 'username', 'password', 'secret_id'], + 'required': ['server_url', 'username', 'password', 'secret_id', 'secret_field'], } tss_plugin = CredentialPlugin( 'Thycotic Secret Server', tss_inputs, - lambda **kwargs: SecretServer(kwargs['server_url'], PasswordGrantAuthorizer(kwargs['server_url'], kwargs['username'], kwargs['password'])).get_secret( - kwargs['secret_id'] - ), + lambda **kwargs: ServerSecret( + **SecretServer(kwargs['server_url'], PasswordGrantAuthorizer(kwargs['server_url'], kwargs['username'], kwargs['password'])).get_secret( + kwargs['secret_id'] + ) + ).fields[kwargs['secret_field']], ) From 2025426a1bcb43ed03c8af3790945210f9976f6a Mon Sep 17 00:00:00 2001 From: Adam Migus Date: Wed, 21 Jul 2021 15:18:54 -0400 Subject: [PATCH 13/14] Use a callable function instead of a lambda. --- awx/main/credential_plugins/tss.py | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/awx/main/credential_plugins/tss.py b/awx/main/credential_plugins/tss.py index f3927f6658..e68a7601d9 100644 --- a/awx/main/credential_plugins/tss.py +++ b/awx/main/credential_plugins/tss.py @@ -42,12 +42,17 @@ tss_inputs = { 'required': ['server_url', 'username', 'password', 'secret_id', 'secret_field'], } -tss_plugin = CredentialPlugin( - 'Thycotic Secret Server', - tss_inputs, - lambda **kwargs: ServerSecret( + +def tss_backend(**kwargs): + return ServerSecret( **SecretServer(kwargs['server_url'], PasswordGrantAuthorizer(kwargs['server_url'], kwargs['username'], kwargs['password'])).get_secret( kwargs['secret_id'] ) - ).fields[kwargs['secret_field']], + ).fields[kwargs['secret_field']] + + +tss_plugin = CredentialPlugin( + 'Thycotic Secret Server', + tss_inputs, + tss_backend, ) From edd3554c36ab7d07ec95f0503302944703e8d61f Mon Sep 17 00:00:00 2001 From: Adam Migus Date: Wed, 21 Jul 2021 16:25:04 -0400 Subject: [PATCH 14/14] Breakdown the compound statement in tss_backend --- awx/main/credential_plugins/tss.py | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/awx/main/credential_plugins/tss.py b/awx/main/credential_plugins/tss.py index e68a7601d9..bf83693860 100644 --- a/awx/main/credential_plugins/tss.py +++ b/awx/main/credential_plugins/tss.py @@ -44,11 +44,12 @@ tss_inputs = { def tss_backend(**kwargs): - return ServerSecret( - **SecretServer(kwargs['server_url'], PasswordGrantAuthorizer(kwargs['server_url'], kwargs['username'], kwargs['password'])).get_secret( - kwargs['secret_id'] - ) - ).fields[kwargs['secret_field']] + authorizer = PasswordGrantAuthorizer(kwargs['server_url'], kwargs['username'], kwargs['password']) + secret_server = SecretServer(kwargs['server_url'], authorizer) + secret_dict = secret_server.get_secret(kwargs['secret_id']) + secret = ServerSecret(**secret_dict) + + return secret.fields[kwargs['secret_field']] tss_plugin = CredentialPlugin(