ashb commented on a change in pull request #7741: [AIRFLOW-7076] Add support for HashiCorp Vault as Secrets Backend URL: https://github.com/apache/airflow/pull/7741#discussion_r395299828
########## File path: airflow/providers/hashicorp/secrets/vault.py ########## @@ -0,0 +1,214 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. +""" +Objects relating to sourcing connections from Hashicorp Vault +""" +from typing import List, Optional + +import hvac +from cached_property import cached_property +from hvac.exceptions import InvalidPath, VaultError + +from airflow import AirflowException +from airflow.models import Connection +from airflow.secrets import BaseSecretsBackend +from airflow.utils.log.logging_mixin import LoggingMixin + + +class VaultSecrets(BaseSecretsBackend, LoggingMixin): + """ + Retrieves Connection object from Hashicorp Vault + + Configurable via ``airflow.cfg`` as follows: + + .. code-block:: ini + + [secrets] + backend = airflow.providers.hashicorp.secrets.vault.VaultSecrets + backend_kwargs = {"path":"connections","url":"http://127.0.0.1:8200","mount_point":"airflow"} + + For example, if your keys are under ``connections`` path in ``airflow`` mount_point, this + would be accessible if you provide ``{"path": "connections"}`` and request + conn_id ``smtp_default``. + + :param connections_path: Specifies the path of the secret to read to get Connections. + :type connections_path: str + :param url: Base URL for the Vault instance being addressed. + :type url: str + :param auth_type: Authentication Type for Vault (one of 'token', 'ldap', 'userpass', 'approle', + 'github', 'gcp). Default is ``token``. + :type auth_type: str + :param mount_point: The "path" the secret engine was mounted on. (Default: ``secret``) + :type mount_point: str + :param token: Authentication token to include in requests sent to Vault. + (for ``token`` and ``github`` auth_type) + :type token: str + :param kv_engine_version: Select the version of the engine to run (``1`` or ``2``, default: ``2``) + :type kv_engine_version: int + :param username: Username for Authentication (for ``ldap`` and ``userpass`` auth_type) + :type username: str + :param password: Password for Authentication (for ``ldap`` and ``userpass`` auth_type) + :type password: str + :param role_id: Role ID for Authentication (for ``approle`` auth_type) + :type role_id: str + :param secret_id: Secret ID for Authentication (for ``approle`` auth_type) + :type secret_id: str + :param gcp_key_path: Path to GCP Credential JSON file (for ``gcp`` auth_type) + :type gcp_key_path: str + :param gcp_scopes: Comma-separated string containing GCP scopes (for ``gcp`` auth_type) + :type gcp_scopes: str + """ + def __init__( # pylint: disable=too-many-arguments + self, + connections_path: str, + url: Optional[str] = None, + auth_type: str = 'token', + mount_point: str = 'secret', + kv_engine_version: int = 2, + token: Optional[str] = None, + username: Optional[str] = None, + password: Optional[str] = None, + role_id: Optional[str] = None, + secret_id: Optional[str] = None, + gcp_key_path: Optional[str] = None, + gcp_scopes: Optional[str] = None, + **kwargs + ): + super().__init__(**kwargs) + self.connections_path = connections_path.rstrip('/') + self.url = url + self.auth_type = auth_type + self.kwargs = kwargs + self.token = token + self.username = username + self.password = password + self.role_id = role_id + self.secret_id = secret_id + self.mount_point = mount_point + self.kv_engine_version = kv_engine_version + self.gcp_key_path = gcp_key_path + self.gcp_scopes = gcp_scopes + + @cached_property + def client(self) -> hvac.Client: + """ + Return an authenticated Hashicorp Vault client + """ + + _client = hvac.Client(url=self.url, **self.kwargs) + if self.auth_type == "token": + _client.token = self.token + elif self.auth_type == "ldap": + _client.auth.ldap.login( + username=self.username, password=self.password) + elif self.auth_type == "userpass": + _client.auth_userpass(username=self.username, password=self.password) + elif self.auth_type == "approle": + _client.auth_approle(role_id=self.role_id, secret_id=self.secret_id) + elif self.auth_type == "github": + _client.auth.github.login(token=self.token) + elif self.auth_type == "gcp": + credentials = self._get_gcp_credentials() + _client.auth.gcp.configure(credentials=credentials) + else: + raise AirflowException(f"Authentication type '{self.auth_type}' not supported") + + if _client.is_authenticated(): + return _client + else: + raise VaultError("Vault Authentication Error!") + + def build_path(self, conn_id: str): + """ + Given conn_id, build path for Vault Secret + + :param conn_id: connection id + :type conn_id: str + """ + return self.connections_path + "/" + conn_id + + def get_conn_uri(self, conn_id: str) -> Optional[str]: + """ + Get secret value from Vault. Store the secret in the form of URI + + :param conn_id: connection id + :type conn_id: str + """ + self.log.debug("Path: %s", self.connections_path) + self.log.debug("Mount Point: %s", self.mount_point) Review comment: Do we need to log this everytime (even if it is debug it still seems verbose. to have it on every secret fetch request) ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
