This repository was archived by the owner on Mar 6, 2026. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 348
feat: Add mTLS configuration via x.509 for asynchronous session in google-auth #1958
Closed
Closed
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
f1f7c45
feat: Add helper methods for async mTLS support for google-auth
agrawalradhika-cell 0d45640
fix: Add test cases for helper method
agrawalradhika-cell 07d7818
chore: Correct lint and imports, plus add testcases for exceptions check
agrawalradhika-cell be10a50
chore: Add dependencies and async function related wrapper
agrawalradhika-cell 7f23594
fix: Update based on gemini-assit comments to make robust callback by…
agrawalradhika-cell 8110a6f
chore: Correct based on minor comments
agrawalradhika-cell 8269318
feat: Add mTLS configuration for async session in google-auth
agrawalradhika-cell ae799f0
chore: Refractors with respect to gemini review comments and keeping …
agrawalradhika-cell 8bb0ea5
fix: fix lint errors
agrawalradhika-cell b560507
chore: Add mtls flag check
agrawalradhika-cell 0ec1bff
fix: test-fix
agrawalradhika-cell 6eda8c1
fix: test fixes for the unit test3.9
agrawalradhika-cell File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,226 @@ | ||
| # Copyright 2026 Google LLC | ||
| # | ||
| # 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. | ||
|
|
||
| """ | ||
| Helper functions for mTLS in async for discovery of certs. | ||
| """ | ||
|
|
||
| import asyncio | ||
| import contextlib | ||
| import logging | ||
| import os | ||
| from os import getenv, path | ||
| import ssl | ||
| import tempfile | ||
| from typing import Optional | ||
|
|
||
| from google.auth import exceptions | ||
| import google.auth.transport._mtls_helper | ||
|
|
||
| CERTIFICATE_CONFIGURATION_DEFAULT_PATH = "~/.config/gcloud/certificate_config.json" | ||
| _LOGGER = logging.getLogger(__name__) | ||
|
|
||
|
|
||
| @contextlib.contextmanager | ||
| def _create_temp_file(content: bytes): | ||
| """Creates a temporary file with the given content. | ||
|
|
||
| Args: | ||
| content (bytes): The content to write to the file. | ||
|
|
||
| Yields: | ||
| str: The path to the temporary file. | ||
| """ | ||
| # Create a temporary file that is readable only by the owner. | ||
| fd, file_path = tempfile.mkstemp() | ||
| try: | ||
| with os.fdopen(fd, "wb") as f: | ||
| f.write(content) | ||
| yield file_path | ||
| finally: | ||
| # Securely delete the file after use. | ||
| if os.path.exists(file_path): | ||
| os.remove(file_path) | ||
|
|
||
|
|
||
| def make_client_cert_ssl_context( | ||
| cert_bytes: bytes, key_bytes: bytes, passphrase: Optional[bytes] = None | ||
| ) -> ssl.SSLContext: | ||
| """Creates an SSLContext with the given client certificate and key. | ||
| This function writes the certificate and key to temporary files so that | ||
| ssl.create_default_context can load them, as the ssl module requires | ||
| file paths for client certificates. | ||
| Args: | ||
| cert_bytes (bytes): The client certificate content in PEM format. | ||
| key_bytes (bytes): The client private key content in PEM format. | ||
| passphrase (Optional[bytes]): The passphrase for the private key, if any. | ||
| Returns: | ||
| ssl.SSLContext: The configured SSL context with client certificate. | ||
|
|
||
| Raises: | ||
| google.auth.exceptions.TransportError: If there is an error loading the certificate. | ||
| """ | ||
| try: | ||
| context = ssl.create_default_context(ssl.Purpose.SERVER_AUTH) | ||
|
|
||
| # Write cert and key to temp files because ssl.load_cert_chain requires paths | ||
| with _create_temp_file(cert_bytes) as cert_path: | ||
| with _create_temp_file(key_bytes) as key_path: | ||
| context.load_cert_chain( | ||
| certfile=cert_path, keyfile=key_path, password=passphrase | ||
| ) | ||
| return context | ||
| except (ssl.SSLError, OSError) as exc: | ||
| raise exceptions.TransportError( | ||
| "Failed to load client certificate and key for mTLS." | ||
| ) from exc | ||
|
|
||
|
|
||
| def _check_config_path(config_path): | ||
| """Checks for config file path. If it exists, returns the absolute path with user expansion; | ||
| otherwise returns None. | ||
|
|
||
| Args: | ||
| config_path (str): The config file path for certificate_config.json for example | ||
|
|
||
| Returns: | ||
| str: absolute path if exists and None otherwise. | ||
| """ | ||
| config_path = path.expanduser(config_path) | ||
| if not path.exists(config_path): | ||
| _LOGGER.debug("%s is not found.", config_path) | ||
| return None | ||
| return config_path | ||
|
|
||
|
|
||
| async def _run_in_executor(func, *args): | ||
| """Run a blocking function in an executor to avoid blocking the event loop. | ||
|
|
||
| This implements the non-blocking execution strategy for disk I/O operations. | ||
| """ | ||
| try: | ||
| # For python versions 3.9 and newer versions | ||
| return await asyncio.to_thread(func, *args) | ||
| except AttributeError: | ||
| # Fallback for older Python versions | ||
| loop = asyncio.get_running_loop() | ||
| return await loop.run_in_executor(None, func, *args) | ||
|
|
||
|
|
||
| def has_default_client_cert_source(): | ||
| """Check if default client SSL credentials exists on the device. | ||
|
|
||
| Returns: | ||
| bool: indicating if the default client cert source exists. | ||
| """ | ||
| if _check_config_path(CERTIFICATE_CONFIGURATION_DEFAULT_PATH) is not None: | ||
| return True | ||
| cert_config_path = getenv("GOOGLE_API_CERTIFICATE_CONFIG") | ||
| if cert_config_path and _check_config_path(cert_config_path) is not None: | ||
| return True | ||
| return False | ||
|
|
||
|
|
||
| def default_client_cert_source(): | ||
| """Get a callback which returns the default client SSL credentials. | ||
|
|
||
| Returns: | ||
| Awaitable[Callable[[], [bytes, bytes]]]: A callback which returns the default | ||
| client certificate bytes and private key bytes, both in PEM format. | ||
|
|
||
| Raises: | ||
| google.auth.exceptions.MutualTLSChannelError: If the default | ||
| client SSL credentials don't exist or are malformed. | ||
| """ | ||
| if not has_default_client_cert_source(): | ||
| raise exceptions.MutualTLSChannelError( | ||
| "Default client cert source doesn't exist" | ||
| ) | ||
|
|
||
| async def callback(): | ||
| try: | ||
| _, cert_bytes, key_bytes = await get_client_cert_and_key() | ||
| except (OSError, RuntimeError, ValueError) as caught_exc: | ||
| new_exc = exceptions.MutualTLSChannelError(caught_exc) | ||
| raise new_exc from caught_exc | ||
|
|
||
| return cert_bytes, key_bytes | ||
|
|
||
| return callback | ||
|
|
||
|
|
||
| async def get_client_ssl_credentials( | ||
| certificate_config_path=None, | ||
| ): | ||
| """Returns the client side certificate, private key and passphrase. | ||
|
|
||
| We look for certificates and keys with the following order of priority: | ||
| 1. Certificate and key specified by certificate_config.json. | ||
| Currently, only X.509 workload certificates are supported. | ||
|
|
||
| Args: | ||
| certificate_config_path (str): The certificate_config.json file path. | ||
|
|
||
| Returns: | ||
| Tuple[bool, bytes, bytes, bytes]: | ||
| A boolean indicating if cert, key and passphrase are obtained, the | ||
| cert bytes and key bytes both in PEM format, and passphrase bytes. | ||
|
|
||
| Raises: | ||
| google.auth.exceptions.ClientCertError: if problems occurs when getting | ||
| the cert, key and passphrase. | ||
| """ | ||
|
|
||
| # Attempt to retrieve X.509 Workload cert and key. | ||
| cert, key = await _run_in_executor( | ||
| google.auth.transport._mtls_helper._get_workload_cert_and_key, | ||
| certificate_config_path, | ||
| ) | ||
|
|
||
| if cert and key: | ||
| return True, cert, key, None | ||
|
|
||
| return False, None, None, None | ||
|
|
||
|
|
||
| async def get_client_cert_and_key(client_cert_callback=None): | ||
| """Returns the client side certificate and private key. The function first | ||
| tries to get certificate and key from client_cert_callback; if the callback | ||
| is None or doesn't provide certificate and key, the function tries application | ||
| default SSL credentials. | ||
|
|
||
| Args: | ||
| client_cert_callback (Optional[Callable[[], (bytes, bytes)]]): An | ||
| optional callback which returns client certificate bytes and private | ||
| key bytes both in PEM format. | ||
|
|
||
| Returns: | ||
| Tuple[bool, bytes, bytes]: | ||
| A boolean indicating if cert and key are obtained, the cert bytes | ||
| and key bytes both in PEM format. | ||
|
|
||
| Raises: | ||
| google.auth.exceptions.ClientCertError: if problems occurs when getting | ||
| the cert and key. | ||
| """ | ||
| if client_cert_callback: | ||
| result = client_cert_callback() | ||
| if asyncio.iscoroutine(result): | ||
| cert, key = await result | ||
| else: | ||
| cert, key = result | ||
| return True, cert, key | ||
|
|
||
| has_cert, cert, key, _ = await get_client_ssl_credentials() | ||
| return has_cert, cert, key |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.