From ba7ee232982897e5401371d388feeed7f0eb045d Mon Sep 17 00:00:00 2001 From: jessicamack Date: Tue, 13 May 2025 10:05:24 -0400 Subject: [PATCH] [backport][4.6] Update Azure Key Vault plugin to use Managed Identity (#6939) * Bug on file name. Commiting to remove it. * Update azure_kv plugin to use ManagedIdentity. Add testing. --- awx/main/credential_plugins/azure_kv.py | 69 ++++++- .../functional/test_credential_plugins.py | 77 +++++++- licenses/pynacl.txt | 174 ------------------ 3 files changed, 139 insertions(+), 181 deletions(-) delete mode 100644 licenses/pynacl.txt diff --git a/awx/main/credential_plugins/azure_kv.py b/awx/main/credential_plugins/azure_kv.py index 8910a0726d..ee487a4fdf 100644 --- a/awx/main/credential_plugins/azure_kv.py +++ b/awx/main/credential_plugins/azure_kv.py @@ -1,5 +1,10 @@ from azure.keyvault.secrets import SecretClient -from azure.identity import ClientSecretCredential +from azure.identity import ( + ClientSecretCredential, + CredentialUnavailableError, + ManagedIdentityCredential, +) +from azure.core.credentials import TokenCredential from msrestazure import azure_cloud from .plugin import CredentialPlugin @@ -50,14 +55,66 @@ azure_keyvault_inputs = { 'help_text': _('Used to specify a specific secret version (if left empty, the latest version will be used).'), }, ], - 'required': ['url', 'client', 'secret', 'tenant', 'secret_field'], + 'required': ['url', 'secret_field'], } -def azure_keyvault_backend(**kwargs): - csc = ClientSecretCredential(tenant_id=kwargs['tenant'], client_id=kwargs['client'], client_secret=kwargs['secret']) - kv = SecretClient(credential=csc, vault_url=kwargs['url']) - return kv.get_secret(name=kwargs['secret_field'], version=kwargs.get('secret_version', '')).value +def _initialize_credential( + tenant: str = '', + client: str = '', + secret: str = '', +) -> TokenCredential: + explicit_credentials_provided = all((tenant, client, secret)) + + if explicit_credentials_provided: + return ClientSecretCredential( + tenant_id=tenant, + client_id=client, + client_secret=secret, + ) + + return ManagedIdentityCredential() + + +def azure_keyvault_backend( + *, + url: str, + client: str = '', + secret: str = '', + tenant: str = '', + secret_field: str, + secret_version: str = '', +) -> str | None: + """Get a credential and retrieve a secret from an Azure Key Vault. + + An empty string for an optional parameter counts as not provided. + + :param url: An Azure Key Vault URI. + :param client: The Client ID (optional). + :param secret: The Client Secret (optional). + :param tenant: The Tenant ID (optional). + :param secret_field: The name of the secret to retrieve from the + vault. + :param secret_version: The version of the secret to retrieve + (optional). + :returns: The secret from the Key Vault. + :raises RuntimeError: If the software is not being run on an Azure + VM. + """ + chosen_credential = _initialize_credential(tenant, client, secret) + keyvault = SecretClient(credential=chosen_credential, vault_url=url) + try: + keyvault_secret = keyvault.get_secret( + name=secret_field, + version=secret_version, + ) + except CredentialUnavailableError as secret_lookup_err: + raise RuntimeError( + 'You are not operating on an Azure VM, so the Managed Identity ' + 'feature is unavailable. Please provide the full Client ID, ' + 'Client Secret, and Tenant ID or run the software on an Azure VM.', + ) from secret_lookup_err + return keyvault_secret.value azure_keyvault_plugin = CredentialPlugin('Microsoft Azure Key Vault', inputs=azure_keyvault_inputs, backend=azure_keyvault_backend) diff --git a/awx/main/tests/functional/test_credential_plugins.py b/awx/main/tests/functional/test_credential_plugins.py index 3ee29e9ce3..ecfb77c3b8 100644 --- a/awx/main/tests/functional/test_credential_plugins.py +++ b/awx/main/tests/functional/test_credential_plugins.py @@ -1,6 +1,12 @@ import pytest from unittest import mock -from awx.main.credential_plugins import hashivault +from awx.main.credential_plugins import hashivault, azure_kv + +from azure.keyvault.secrets import ( + KeyVaultSecret, + SecretClient, + SecretProperties, +) def test_imported_azure_cloud_sdk_vars(): @@ -140,3 +146,72 @@ class TestDelineaImports: for cls in (DomainPasswordGrantAuthorizer, PasswordGrantAuthorizer, SecretServer, ServerSecret): # assert this module as opposed to older thycotic.secrets.server assert cls.__module__ == 'delinea.secrets.server' + + +class _FakeSecretClient(SecretClient): + def get_secret( + self: '_FakeSecretClient', + name: str, + version: str | None = None, + **kwargs: str, + ) -> KeyVaultSecret: + props = SecretProperties(None, None) + return KeyVaultSecret(properties=props, value='test-secret') + + +def test_azure_kv_invalid_env() -> None: + """Test running outside of Azure raises error.""" + error_msg = ( + 'You are not operating on an Azure VM, so the Managed Identity ' + 'feature is unavailable. Please provide the full Client ID, ' + 'Client Secret, and Tenant ID or run the software on an Azure VM.' + ) + + with pytest.raises( + RuntimeError, + match=error_msg, + ): + azure_kv.azure_keyvault_backend( + url='https://test.vault.azure.net', + client='', + secret='client-secret', + tenant='tenant-id', + secret_field='secret', + secret_version='', + ) + + +@pytest.mark.parametrize( + ('client', 'secret', 'tenant'), + ( + pytest.param('', '', '', id='managed-identity'), + pytest.param( + 'client-id', + 'client-secret', + 'tenant-id', + id='client-secret-credential', + ), + ), +) +def test_azure_kv_valid_auth( + monkeypatch: pytest.MonkeyPatch, + client: str, + secret: str, + tenant: str, +) -> None: + """Test successful Azure authentication via Managed Identity and credentials.""" + monkeypatch.setattr( + azure_kv, + 'SecretClient', + _FakeSecretClient, + ) + + keyvault_secret = azure_kv.azure_keyvault_backend( + url='https://test.vault.azure.net', + client=client, + secret=secret, + tenant=tenant, + secret_field='secret', + secret_version='', + ) + assert keyvault_secret == 'test-secret' diff --git a/licenses/pynacl.txt b/licenses/pynacl.txt deleted file mode 100644 index fa694622e3..0000000000 --- a/licenses/pynacl.txt +++ /dev/null @@ -1,174 +0,0 @@ - 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. \ No newline at end of file