multicloud-py-gcp-common 0.1.6__tar.gz

multicloud_py_gcp_common-0.1.6/LICENSE.txt

@@ -0,0 +1,206 @@
+Apache License Version 2.0
+
+Copyright (c) 2026 Salesforce, Inc.
+All rights reserved.
+
+                                 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.

multicloud_py_gcp_common-0.1.6/PKG-INFO

@@ -0,0 +1,22 @@
+Metadata-Version: 2.4
+Name: multicloud-py-gcp-common
+Version: 0.1.6
+Summary: Shared GCP credential resolution utilities for multicloud-* providers.
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/salesforce/multicloud-py
+Project-URL: Repository, https://github.com/salesforce/multicloud-py
+Project-URL: Issues, https://github.com/salesforce/multicloud-py/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: multicloud-py-common>=0.1.6
+Requires-Dist: google-auth>=2.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Dynamic: license-file
+
+MultiCloud Python SDK package.

multicloud_py_gcp_common-0.1.6/multicloud/gcp_common/__init__.py

@@ -0,0 +1,10 @@
+"""GCP-specific cross-service utilities.
+
+Shared helpers used by GCP provider modules across services
+(STS, Blob, PubSub, DocStore). This package depends on google-auth
+and must not be imported by cloud-agnostic code (multicloud.common.*).
+"""
+
+from multicloud.gcp_common.gcp_credentials import DEFAULT_SCOPES, get_credentials
+
+__all__ = ["DEFAULT_SCOPES", "get_credentials"]

multicloud_py_gcp_common-0.1.6/multicloud/gcp_common/gcp_credentials.py

@@ -0,0 +1,192 @@
+"""GCP credential resolution from CredentialsOverrider.
+
+Shared utility for all GCP provider modules (STS, Blob, PubSub, DocStore).
+"""
+
+from __future__ import annotations
+
+import logging
+from typing import Any, Optional
+
+try:
+    import google.auth  # type: ignore[import-not-found]
+    import google.auth.exceptions  # type: ignore[import-not-found]
+    import google.auth.impersonated_credentials  # type: ignore[import-not-found]
+except ImportError as _exc:
+    raise ImportError(
+        "GCP dependencies not found. Install with: "
+        "pip install 'python-multicloud-sdk[gcp]'"
+    ) from _exc
+
+from multicloud.common.credentials import (
+    CredentialsOverrider,
+    CredentialsType,
+)
+from multicloud.common.exceptions import InvalidArgumentException, UnAuthorizedException
+
+DEFAULT_SCOPES = ["https://www.googleapis.com/auth/cloud-platform"]
+
+_logger = logging.getLogger(__name__)
+
+
+def get_credentials(
+    overrider: CredentialsOverrider,
+    scopes: Optional[list[str]] = None,
+) -> Any:
+    """Resolve GCP credentials from a CredentialsOverrider.
+
+    Args:
+        overrider: Credential override configuration.
+        scopes: OAuth scopes for the credentials. Defaults to
+            cloud-platform scope.
+
+    Returns:
+        A ``google.auth.credentials.Credentials`` instance, or None if
+        the override type is not supported (caller should fall through
+        to default credentials).
+    """
+
+    effective_scopes = scopes or DEFAULT_SCOPES
+
+    if overrider.credentials_type == CredentialsType.SESSION:
+        creds = overrider.session_credentials
+        if creds is None:
+            raise InvalidArgumentException(
+                "session_credentials required for SESSION override"
+            )
+        if not creds.security_token:
+            # Unlike AWS (where security_token is an optional session token
+            # layered over an access key), the GCP bearer token IS the
+            # credential. An empty one builds a credential that fails opaquely
+            # at request time, so reject it up front.
+            raise InvalidArgumentException(
+                "security_token required for SESSION override on GCP"
+            )
+        from google.oauth2.credentials import Credentials as OAuth2Credentials
+
+        # SESSION wraps a static bearer token; the returned credential is
+        # intentionally non-refreshable. Caller owns re-issuing before expiry.
+        return OAuth2Credentials(token=creds.security_token)
+
+    if overrider.credentials_type == CredentialsType.ASSUME_ROLE:
+        try:
+            source_credentials, _ = google.auth.default(scopes=effective_scopes)
+        except google.auth.exceptions.DefaultCredentialsError as exc:
+            raise UnAuthorizedException("Could not find default credentials") from exc
+        kwargs: dict[str, Any] = {
+            "source_credentials": source_credentials,
+            "target_principal": overrider.role,
+            "target_scopes": effective_scopes,
+        }
+        if overrider.duration_seconds is not None:
+            kwargs["lifetime"] = overrider.duration_seconds
+        return google.auth.impersonated_credentials.Credentials(**kwargs)
+
+    # ASSUME_ROLE_WEB_IDENTITY (WIF) falls through to ADC. Warn loudly: the
+    # caller explicitly requested federation but will instead authenticate as
+    # whatever ambient ADC identity is present.
+    _logger.warning(
+        "credentials_overrider requested ASSUME_ROLE_WEB_IDENTITY, but "
+        "Workload Identity Federation is not supported here; falling back to "
+        "Application Default Credentials. The caller will authenticate as the "
+        "ambient ADC identity, not the requested federated principal."
+    )
+    return None
+
+
+class _StaticToken:
+    """A minimal gcloud-aio-compatible token wrapping a static bearer string.
+
+    ``gcloud.aio.auth.Token`` has no constructor for a pre-issued bearer
+    token, so the SESSION override path uses this duck-typed stand-in. It
+    exposes the async ``get()``/``close()`` surface ``Storage`` relies on.
+    The token is intentionally non-refreshable — the caller owns re-issuing
+    it before expiry.
+    """
+
+    def __init__(self, token: str) -> None:
+        self._token = token
+
+    async def get(self) -> str:
+        return self._token
+
+    async def close(self) -> None:
+        return None
+
+
+def get_token(
+    overrider: Optional[CredentialsOverrider],
+    scopes: Optional[list[str]] = None,
+) -> Any:
+    """Resolve an async GCP auth token from a CredentialsOverrider.
+
+    Async counterpart of :func:`get_credentials`. gcloud-aio is imported
+    lazily so this module stays importable without the ``async`` extra.
+
+    Args:
+        overrider: Credential override configuration. If None, returns None
+            so the caller falls through to Application Default Credentials.
+        scopes: OAuth scopes for the token. Defaults to cloud-platform scope.
+
+    Returns:
+        A token object exposing async ``get()``/``close()`` (a static-bearer
+        stand-in for SESSION, a ``gcloud.aio.auth.Token`` for ASSUME_ROLE),
+        or None for ASSUME_ROLE_WEB_IDENTITY — gcloud-aio has no WIF token
+        type — so the caller falls back to ADC.
+    """
+    if overrider is None:
+        return None
+
+    effective_scopes = scopes or DEFAULT_SCOPES
+
+    if overrider.credentials_type == CredentialsType.SESSION:
+        creds = overrider.session_credentials
+        if creds is None:
+            raise InvalidArgumentException(
+                "session_credentials required for SESSION override"
+            )
+        if not creds.security_token:
+            # The GCP bearer token IS the credential (unlike AWS, where it is
+            # an optional session token). An empty one yields a token that
+            # fails opaquely at request time, so reject it up front.
+            raise InvalidArgumentException(
+                "security_token required for SESSION override on GCP"
+            )
+        return _StaticToken(creds.security_token)
+
+    if overrider.credentials_type == CredentialsType.ASSUME_ROLE:
+        try:
+            from gcloud.aio.auth import Token  # type: ignore[import-not-found]
+        except ImportError as exc:
+            raise ImportError(
+                "gcloud-aio-storage is required for async GCP credential "
+                "resolution. Install it with: "
+                "pip install 'multicloud-py-blob-gcp[async]'"
+            ) from exc
+        token = Token(
+            target_principal=overrider.role,
+            scopes=effective_scopes,
+        )
+        # gcloud-aio's Token takes no lifetime kwarg and defaults to a 3600s
+        # impersonation TTL; set it per-instance so duration_seconds is honored,
+        # matching the sync get_credentials() lifetime behavior.
+        if overrider.duration_seconds is not None:
+            token.default_token_ttl = overrider.duration_seconds
+        return token
+
+    # ASSUME_ROLE_WEB_IDENTITY (WIF) is not supported on the async path:
+    # gcloud-aio's Token has no Workload Identity Federation / IdentityPool
+    # token type, so there is nothing to build here. Fall through to ADC,
+    # matching the sync get_credentials() behavior for this override type.
+    #
+    # Warn loudly: the caller explicitly requested federation but will instead
+    # authenticate as whatever ambient ADC identity is present. Without this
+    # signal the identity swap is silent and undebuggable in production.
+    _logger.warning(
+        "credentials_overrider requested ASSUME_ROLE_WEB_IDENTITY, but "
+        "Workload Identity Federation is not supported on the async GCP path; "
+        "falling back to Application Default Credentials. The caller will "
+        "authenticate as the ambient ADC identity, not the requested "
+        "federated principal."
+    )
+    return None

multicloud_py_gcp_common-0.1.6/multicloud_py_gcp_common.egg-info/PKG-INFO

@@ -0,0 +1,22 @@
+Metadata-Version: 2.4
+Name: multicloud-py-gcp-common
+Version: 0.1.6
+Summary: Shared GCP credential resolution utilities for multicloud-* providers.
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/salesforce/multicloud-py
+Project-URL: Repository, https://github.com/salesforce/multicloud-py
+Project-URL: Issues, https://github.com/salesforce/multicloud-py/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: multicloud-py-common>=0.1.6
+Requires-Dist: google-auth>=2.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Dynamic: license-file
+
+MultiCloud Python SDK package.

multicloud_py_gcp_common-0.1.6/multicloud_py_gcp_common.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+LICENSE.txt
+pyproject.toml
+multicloud/gcp_common/__init__.py
+multicloud/gcp_common/gcp_credentials.py
+multicloud_py_gcp_common.egg-info/PKG-INFO
+multicloud_py_gcp_common.egg-info/SOURCES.txt
+multicloud_py_gcp_common.egg-info/dependency_links.txt
+multicloud_py_gcp_common.egg-info/requires.txt
+multicloud_py_gcp_common.egg-info/top_level.txt

multicloud_py_gcp_common-0.1.6/multicloud_py_gcp_common.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

multicloud_py_gcp_common-0.1.6/multicloud_py_gcp_common.egg-info/requires.txt

@@ -0,0 +1,7 @@
+multicloud-py-common>=0.1.6
+google-auth>=2.0.0
+
+[dev]
+pytest>=7.0.0
+pytest-cov>=4.0.0
+mypy>=1.0.0

multicloud_py_gcp_common-0.1.6/multicloud_py_gcp_common.egg-info/top_level.txt

@@ -0,0 +1 @@
+multicloud

multicloud_py_gcp_common-0.1.6/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["setuptools>=77", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "multicloud-py-gcp-common"
+version = "0.1.6"
+license = "Apache-2.0"
+description = "Shared GCP credential resolution utilities for multicloud-* providers."
+readme = {text = "MultiCloud Python SDK package.", content-type = "text/markdown"}
+requires-python = ">=3.10"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "multicloud-py-common>=0.1.6",
+    "google-auth>=2.0.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/salesforce/multicloud-py"
+Repository = "https://github.com/salesforce/multicloud-py"
+Issues = "https://github.com/salesforce/multicloud-py/issues"
+
+[project.optional-dependencies]
+dev = ["pytest>=7.0.0", "pytest-cov>=4.0.0", "mypy>=1.0.0"]
+
+[tool.setuptools]
+license-files = ["LICENSE.txt"]
+
+[tool.setuptools.packages.find]
+include = ["multicloud*"]

multicloud_py_gcp_common-0.1.6/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+