multicloud-py-sts 0.1.6__tar.gz

multicloud_py_sts-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_sts-0.1.6/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.4
+Name: multicloud-py-sts
+Version: 0.1.6
+Summary: Cloud-agnostic Security Token Service client for the python-multicloud SDK. Pair with a provider package (multicloud-sts-aws / -gcp / -alibaba) for actual cloud calls.
+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
+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_sts-0.1.6/multicloud/sts/sts_client/__init__.py

@@ -0,0 +1,57 @@
+"""Cloud-agnostic STS client package.
+
+Public entry point — :class:`StsClient`::
+
+    from multicloud.sts.sts_client import StsClient
+
+    with StsClient(provider="aws", region="us-west-2") as sts:
+        identity = sts.get_caller_identity()
+        creds = sts.assume_role(
+            "arn:aws:iam::123:role/MyRole",
+            session_name="dev",
+        )
+
+Provider classes (``AwsSts``, ``GcpSts``, ...) live in sibling
+distributions (``multicloud-sts-aws``, ``-gcp``, ``-alibaba``) and are
+discovered at runtime via setuptools entry points. They are hidden
+behind the registry; users never reference them directly.
+"""
+
+from multicloud.sts.sts_client.client import StsClient, StsUtilities
+from multicloud.sts.sts_client.driver import (
+    STS_REGISTRY,
+    AvailabilityCondition,
+    BaseSts,
+    CallerIdentity,
+    CredentialScope,
+    CredentialsOverrider,
+    CredentialsType,
+    ScopeRule,
+    StsCredentials,
+    StsValidator,
+)
+from multicloud.sts.sts_client.utilities import (
+    STS_UTILITIES_REGISTRY,
+    BaseStsUtilities,
+    SignedAuthRequest,
+)
+
+__all__ = [
+    "StsClient",
+    "StsUtilities",
+    "AvailabilityCondition",
+    "CallerIdentity",
+    "CredentialScope",
+    "CredentialsOverrider",
+    "CredentialsType",
+    "ScopeRule",
+    "SignedAuthRequest",
+    "StsCredentials",
+    # Internal: driver layer (re-exported for advanced/testing use; not
+    # part of the user-facing surface)
+    "BaseSts",
+    "BaseStsUtilities",
+    "STS_REGISTRY",
+    "STS_UTILITIES_REGISTRY",
+    "StsValidator",
+]

multicloud_py_sts-0.1.6/multicloud/sts/sts_client/client.py

@@ -0,0 +1,304 @@
+"""User-facing :class:`StsClient` — the public entry point for STS ops.
+
+Three-layer architecture:
+
+1. **Client** (this file) — what users import; provider-agnostic API.
+2. **Driver** (:class:`BaseSts` in ``driver.py``) — internal abstract
+   contract; defines public methods + provider hooks.
+3. **Provider** — concrete impls callers never reference directly.
+
+User code stays cloud-agnostic; only the ``provider`` kwarg selects the
+registered implementation::
+
+    from multicloud.sts.sts_client import StsClient
+
+    with StsClient(provider="<provider-id>", region="<region>") as sts:
+        identity = sts.get_caller_identity()
+        creds = sts.assume_role(
+            "<role-resource-identifier>",
+            session_name="dev",
+        )
+"""
+
+from __future__ import annotations
+
+from typing import Any, Mapping, Optional
+
+from multicloud.sts.sts_client.driver import (
+    STS_REGISTRY,
+    BaseSts,
+    CallerIdentity,
+    CredentialScope,
+    CredentialsOverrider,
+    StsCredentials,
+)
+from multicloud.sts.sts_client.utilities import (
+    STS_UTILITIES_REGISTRY,
+    BaseStsUtilities,
+    SignedAuthRequest,
+)
+
+
+class StsClient:
+    """Cloud-agnostic Security Token Service client.
+
+    Args:
+        provider: Registered provider id used to select the implementation.
+        region: Region (interpreted per provider). Optional; falls back
+            to provider defaults.
+        endpoint: Endpoint override URL. Optional.
+        credentials_overrider: Override default credential resolution.
+            Optional.
+        properties: Provider-specific extras passed through to the
+            driver constructor as keyword arguments.
+    """
+
+    def __init__(
+        self,
+        *,
+        provider: str,
+        region: Optional[str] = None,
+        endpoint: Optional[str] = None,
+        credentials_overrider: Optional[CredentialsOverrider] = None,
+        properties: Optional[Mapping[str, Any]] = None,
+    ) -> None:
+        sts_cls = STS_REGISTRY.get(provider)
+        kwargs: dict = {}
+        if region is not None:
+            kwargs["region"] = region
+        if endpoint is not None:
+            kwargs["endpoint_url"] = endpoint
+        if credentials_overrider is not None:
+            kwargs["credentials_overrider"] = credentials_overrider
+        if properties:
+            kwargs.update(properties)
+        self._sts: BaseSts = sts_cls(**kwargs)
+
+    # properties
+
+    @property
+    def provider(self) -> str:
+        return self._sts.get_provider_id()
+
+    @property
+    def region(self) -> Optional[str]:
+        return self._sts.region
+
+    # operations (forwarding to the driver)
+
+    def get_caller_identity(self, *, aud: Optional[str] = None) -> CallerIdentity:
+        """Return identity info for the current credentials.
+
+        Args:
+            aud: Target audience for the identity token. Some providers
+                use this for audience-scoped token generation; others
+                ignore it.
+        """
+        try:
+            return self._sts.get_caller_identity(aud=aud)
+        except Exception as exc:
+            raise self._sts.translate_error(exc) from exc
+
+    def assume_role(
+        self,
+        role: str,
+        *,
+        session_name: str = "",
+        expiration: int = 3600,
+        external_id: Optional[str] = None,
+        policy: Optional[str] = None,
+        tags: Optional[Mapping[str, str]] = None,
+        credential_scope: Optional[CredentialScope] = None,
+    ) -> StsCredentials:
+        """Assume a role and return temporary credentials.
+
+        Args:
+            role: Cloud resource name to assume.
+            session_name: Session identifier.
+            expiration: Duration in seconds (default 3600).
+            external_id: External ID for cross-account access (optional).
+            policy: Inline policy to scope down permissions (optional).
+            tags: Session tags (optional).
+            credential_scope: Optional scope to downscope credentials.
+        """
+        try:
+            return self._sts.assume_role(
+                role,
+                session_name=session_name,
+                expiration=expiration,
+                external_id=external_id,
+                policy=policy,
+                tags=tags,
+                credential_scope=credential_scope,
+            )
+        except Exception as exc:
+            raise self._sts.translate_error(exc) from exc
+
+    def get_access_token(
+        self,
+        *,
+        audience: Optional[str] = None,
+        scopes: Optional[list[str]] = None,
+        duration_seconds: Optional[int] = None,
+    ) -> StsCredentials:
+        """Retrieve a fresh access token from the provider.
+
+        Args:
+            audience: Target audience for an audience-scoped token.
+                Interpreted per provider; see the provider implementation
+                for details. Mutually exclusive with ``scopes``.
+            scopes: OAuth scopes for a scoped token. Interpreted per
+                provider; see the provider implementation for details.
+                Mutually exclusive with ``audience``.
+            duration_seconds: Requested token duration. Interpreted per
+                provider; some providers may ignore or cap this value
+                (optional).
+        """
+        try:
+            return self._sts.get_access_token(
+                audience=audience, scopes=scopes, duration_seconds=duration_seconds
+            )
+        except Exception as exc:
+            raise self._sts.translate_error(exc) from exc
+
+    def generate_service_account_token(
+        self,
+        target_principal: str,
+        *,
+        scopes: list[str],
+        lifetime: int = 3600,
+    ) -> StsCredentials:
+        """Generate a token for a target service account via impersonation.
+
+        Args:
+            target_principal: Service account to impersonate. Format is
+                interpreted per provider; see the provider implementation
+                for details.
+            scopes: OAuth scopes to request on the generated token.
+            lifetime: Token lifetime in seconds (default 3600). Supported
+                range and behaviour are provider-specific; see the provider
+                implementation for details.
+        """
+        try:
+            return self._sts.generate_service_account_token(
+                target_principal, scopes=scopes, lifetime=lifetime
+            )
+        except Exception as exc:
+            raise self._sts.translate_error(exc) from exc
+
+    def assume_role_with_web_identity(
+        self,
+        role: str,
+        web_identity_token: str,
+        *,
+        session_name: str = "",
+        expiration: int = 3600,
+    ) -> StsCredentials:
+        """Exchange a web identity (OIDC) token for temporary credentials.
+
+        Args:
+            role: Cloud resource identifier to assume (interpretation is
+                provider-specific).
+            web_identity_token: The OIDC/JWT token proving external identity.
+            session_name: Session identifier (optional; provider support
+                varies).
+            expiration: Requested duration in seconds (default 3600).
+                Provider support varies; some providers may ignore this
+                parameter.
+        """
+        try:
+            return self._sts.assume_role_with_web_identity(
+                role,
+                web_identity_token,
+                session_name=session_name,
+                expiration=expiration,
+            )
+        except Exception as exc:
+            raise self._sts.translate_error(exc) from exc
+
+    # lifecycle
+
+    def close(self) -> None:
+        """Release underlying resources."""
+        self._sts.close()
+
+    def __enter__(self) -> "StsClient":
+        return self
+
+    def __exit__(self, exc_type, exc, tb) -> None:
+        self.close()
+
+
+class StsUtilities:
+    """Cloud-agnostic STS utility functions (offline request signing).
+
+    Companion to :class:`StsClient` for utilities that sign a request
+    locally instead of calling the provider. The signed request is handed
+    to another system that replays it to verify the caller's identity.
+
+    Args:
+        provider: Registered provider id used to select the implementation.
+        region: Region (interpreted per provider). Optional for some
+            providers; required by others for request signing.
+        credentials_overrider: Override default credential resolution.
+            Optional.
+        properties: Provider-specific extras passed through to the driver
+            constructor as keyword arguments.
+    """
+
+    def __init__(
+        self,
+        *,
+        provider: str,
+        region: Optional[str] = None,
+        credentials_overrider: Optional[CredentialsOverrider] = None,
+        properties: Optional[Mapping[str, Any]] = None,
+    ) -> None:
+        utils_cls = STS_UTILITIES_REGISTRY.get(provider)
+        kwargs: dict = {}
+        if region is not None:
+            kwargs["region"] = region
+        if credentials_overrider is not None:
+            kwargs["credentials_overrider"] = credentials_overrider
+        if properties:
+            kwargs.update(properties)
+        self._utils: BaseStsUtilities = utils_cls(**kwargs)
+
+    # properties
+
+    @property
+    def provider(self) -> str:
+        return self._utils.get_provider_id()
+
+    @property
+    def region(self) -> Optional[str]:
+        return self._utils.region
+
+    # operations (forwarding to the driver)
+
+    def create_signed_auth_request(
+        self,
+        *,
+        custom_headers: Optional[Mapping[str, str]] = None,
+    ) -> SignedAuthRequest:
+        """Produce a signed identity request for cloud-native auth.
+
+        Args:
+            custom_headers: Extra headers to fold into the signature so the
+                system replaying the request can bind them to the identity.
+        """
+        try:
+            return self._utils.create_signed_auth_request(custom_headers=custom_headers)
+        except Exception as exc:
+            raise self._utils.translate_error(exc) from exc
+
+    # lifecycle
+
+    def close(self) -> None:
+        self._utils.close()
+
+    def __enter__(self) -> "StsUtilities":
+        return self
+
+    def __exit__(self, exc_type, exc, tb) -> None:
+        self.close()

multicloud_py_sts-0.1.6/multicloud/sts/sts_client/driver.py

@@ -0,0 +1,398 @@
+"""Driver-level abstractions for the Security Token Service (STS).
+
+Same ABC + template-method shape as
+``multicloud.blob.blob_client.driver.BaseBlobStore``: providers
+implement ``do_*`` hooks; the public ``get_caller_identity`` /
+``assume_role`` / ``get_access_token`` methods on :class:`BaseSts`
+validate input then delegate.
+
+Users never reach this layer directly — they construct a
+:class:`StsClient` (in ``client.py``), which holds a ``BaseSts``
+instance internally.
+"""
+
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from dataclasses import dataclass
+from typing import Mapping, Optional
+
+from multicloud.common.credentials import (
+    CredentialsOverrider,
+    CredentialsType,
+    StsCredentials,
+)
+from multicloud.common.exceptions import InvalidArgumentException
+from multicloud.common.provider import Provider, ProviderRegistry
+
+# Service-scoped registry. Provider distributions advertise themselves
+# under the ``multicloud.sts.providers`` entry-point group; the registry
+# imports those modules lazily on first use, at which point each provider's
+# ``@STS_REGISTRY.register("aws")`` decorator stamps the class.
+STS_REGISTRY = ProviderRegistry(
+    service_name="sts",
+    entry_point_group="multicloud.sts.providers",
+)
+
+# Default session identifiers applied in the driver layer so every provider
+# receives a non-empty, uniform session name regardless of provider support.
+_DEFAULT_SESSION_NAME = "multicloud-session"
+_DEFAULT_WEB_IDENTITY_SESSION_NAME = "multicloud-web-identity"
+
+
+@dataclass(frozen=True)
+class AvailabilityCondition:
+    """Condition that must be met for a ScopeRule to apply.
+
+    Currently supports prefix-based resource restriction.
+    """
+
+    resource_prefix: Optional[str] = None
+    title: Optional[str] = None
+    description: Optional[str] = None
+
+
+@dataclass(frozen=True)
+class ScopeRule:
+    """A single resource + permissions entry within a CredentialScope.
+
+    Attributes:
+        available_resource: URI of the resource.
+        available_permissions: Tuple of permission strings granted on the resource.
+        availability_condition: Optional condition to further narrow access.
+    """
+
+    available_resource: str
+    available_permissions: tuple[str, ...]
+    availability_condition: Optional[AvailabilityCondition] = None
+
+    def __post_init__(self) -> None:
+        object.__setattr__(
+            self, "available_permissions", tuple(self.available_permissions)
+        )
+
+
+@dataclass(frozen=True)
+class CredentialScope:
+    """Used with assume_role to downscope credentials.
+
+    Empty rules means no restrictions applied.
+    """
+
+    rules: tuple[ScopeRule, ...] = ()
+
+    def __post_init__(self) -> None:
+        object.__setattr__(self, "rules", tuple(self.rules))
+
+
+# StsCredentials is defined in multicloud.common.credentials and re-exported
+# here for backward compatibility.
+
+
+@dataclass(frozen=True)
+class CallerIdentity:
+    """Cloud-agnostic caller identity.
+
+    - ``user_id``: unique identifier of the calling entity
+    - ``cloud_resource_name``: cloud resource identifier or identity proof
+    - ``account_id``: cloud account/project that owns the identity
+    """
+
+    user_id: str = ""
+    cloud_resource_name: str = ""
+    account_id: str = ""
+
+
+# CredentialsOverrider and CredentialsType are defined in
+# multicloud.common.credentials and re-exported here for backward
+# compatibility.
+
+
+class StsValidator:
+    """Input validator; raises :class:`InvalidArgumentException`."""
+
+    def validate_assume_role(
+        self,
+        role: str,
+        expiration: int,
+        credential_scope: Optional[CredentialScope] = None,
+    ) -> None:
+        if not role:
+            raise InvalidArgumentException("assume_role: role is required")
+        if expiration <= 0:
+            raise InvalidArgumentException("assume_role: expiration must be positive")
+        if credential_scope is not None:
+            for rule in credential_scope.rules:
+                if not rule.available_permissions:
+                    raise InvalidArgumentException(
+                        "ScopeRule.available_permissions must not be empty"
+                    )
+
+    def validate_get_access_token(
+        self,
+        audience: Optional[str],
+        scopes: Optional[list[str]],
+    ) -> None:
+        if audience is not None and scopes is not None:
+            raise InvalidArgumentException(
+                "get_access_token: audience and scopes are mutually exclusive"
+            )
+
+    def validate_generate_service_account_token(
+        self, target_principal: str, scopes: list[str]
+    ) -> None:
+        if not target_principal:
+            raise InvalidArgumentException(
+                "generate_service_account_token: target_principal is required"
+            )
+        if not scopes:
+            raise InvalidArgumentException(
+                "generate_service_account_token: scopes must be non-empty"
+            )
+
+    def validate_assume_role_with_web_identity(
+        self, role: str, web_identity_token: str
+    ) -> None:
+        # Note: expiration is intentionally not validated here. Providers
+        # either ignore it or enforce their own bounds, surfacing an
+        # out-of-range value as a provider error mapped to
+        # InvalidArgumentException. A blanket ``> 0`` check would be arbitrary.
+        if not role:
+            raise InvalidArgumentException(
+                "assume_role_with_web_identity: role is required"
+            )
+        if not web_identity_token:
+            raise InvalidArgumentException(
+                "assume_role_with_web_identity: web_identity_token is required"
+            )
+
+
+class BaseSts(Provider, ABC):
+    """Base class for substrate-specific STS implementations.
+
+    Providers extend this class and implement :meth:`do_get_caller_identity`,
+    :meth:`do_assume_role`, :meth:`do_get_access_token`, and
+    :meth:`do_generate_service_account_token`.
+    All cross-cutting concerns (validation, default arg handling) happen in
+    the public methods so providers don't have to repeat them.
+    """
+
+    def __init__(
+        self,
+        region: Optional[str] = None,
+        *,
+        endpoint_url: Optional[str] = None,
+        credentials_overrider: Optional[CredentialsOverrider] = None,
+        validator: Optional[StsValidator] = None,
+    ) -> None:
+        self._region = region
+        self._endpoint_url = endpoint_url
+        self._credentials_overrider = credentials_overrider
+        self._validator = validator or StsValidator()
+
+    # properties
+    @property
+    def region(self) -> Optional[str]:
+        return self._region
+
+    # public API
+    def get_caller_identity(self, *, aud: Optional[str] = None) -> CallerIdentity:
+        """Return identity info for the current credentials.
+
+        Args:
+            aud: Target audience for the identity token. Some providers
+                use this for audience-scoped token generation; others
+                ignore it.
+        """
+        return self.do_get_caller_identity(aud=aud)
+
+    def assume_role(
+        self,
+        role: str,
+        *,
+        session_name: str = "",
+        expiration: int = 3600,
+        external_id: Optional[str] = None,
+        policy: Optional[str] = None,
+        tags: Optional[Mapping[str, str]] = None,
+        credential_scope: Optional[CredentialScope] = None,
+    ) -> StsCredentials:
+        """Assume a role and return temporary credentials.
+
+        Args:
+            role: Cloud resource name to assume.
+            session_name: Session identifier.
+            expiration: Duration in seconds (default 3600).
+            external_id: External ID for cross-account access (optional).
+            policy: Inline policy to scope down permissions (optional).
+            tags: Session tags (optional).
+            credential_scope: Optional scope to downscope credentials.
+
+        Returns:
+            StsCredentials with temporary access tokens.
+        """
+        self._validator.validate_assume_role(role, expiration, credential_scope)
+        return self.do_assume_role(
+            role=role,
+            session_name=session_name or _DEFAULT_SESSION_NAME,
+            expiration=expiration,
+            external_id=external_id,
+            policy=policy,
+            tags=tags or {},
+            credential_scope=credential_scope,
+        )
+
+    def get_access_token(
+        self,
+        *,
+        audience: Optional[str] = None,
+        scopes: Optional[list[str]] = None,
+        duration_seconds: Optional[int] = None,
+    ) -> StsCredentials:
+        """Retrieve a fresh access token from the provider.
+
+        Args:
+            audience: Target audience for an audience-scoped token.
+                Interpreted per provider; see the provider implementation
+                for details. Mutually exclusive with ``scopes``.
+            scopes: OAuth scopes for a scoped token. Interpreted per
+                provider; see the provider implementation for details.
+                Mutually exclusive with ``audience``.
+            duration_seconds: Requested token duration. Interpreted per
+                provider; some providers may ignore or cap this value
+                (optional).
+
+        Returns:
+            StsCredentials with the token in ``security_token``.
+        """
+        self._validator.validate_get_access_token(audience, scopes)
+        return self.do_get_access_token(
+            audience=audience, scopes=scopes, duration_seconds=duration_seconds
+        )
+
+    def generate_service_account_token(
+        self,
+        target_principal: str,
+        *,
+        scopes: list[str],
+        lifetime: int = 3600,
+    ) -> StsCredentials:
+        """Generate a token for a target service account via impersonation.
+
+        Behaviour, required permissions, and supported lifetime range are
+        provider-specific; see the provider ``do_generate_service_account_token``
+        implementation for details.
+
+        Args:
+            target_principal: Service account to impersonate. Format is
+                interpreted per provider; see the provider implementation
+                for details.
+            scopes: OAuth scopes to request on the generated token.
+            lifetime: Token lifetime in seconds (default 3600). Supported
+                range and behaviour are provider-specific; see the provider
+                implementation for details.
+
+        Returns:
+            StsCredentials with the impersonated token in ``security_token``.
+        """
+        self._validator.validate_generate_service_account_token(
+            target_principal, scopes
+        )
+        return self.do_generate_service_account_token(
+            target_principal, scopes=scopes, lifetime=lifetime
+        )
+
+    def assume_role_with_web_identity(
+        self,
+        role: str,
+        web_identity_token: str,
+        *,
+        session_name: str = "",
+        expiration: int = 3600,
+    ) -> StsCredentials:
+        """Exchange a web identity (OIDC) token for temporary credentials.
+
+        Federated sign-in: the caller presents an OIDC/JWT token minted by
+        an external identity provider and receives short-lived cloud
+        credentials in return — no long-lived cloud keys required.
+
+        Args:
+            role: Cloud resource name to assume, interpreted by each
+                provider as its federated-identity resource identifier.
+            web_identity_token: The OIDC/JWT token proving the caller's
+                external identity.
+            session_name: Session identifier (optional; provider may ignore).
+            expiration: Requested duration in seconds (default 3600).
+                Interpreted per provider; some providers may honor, cap,
+                or ignore it.
+
+        Returns:
+            StsCredentials with temporary access tokens.
+        """
+        self._validator.validate_assume_role_with_web_identity(role, web_identity_token)
+        return self.do_assume_role_with_web_identity(
+            role=role,
+            web_identity_token=web_identity_token,
+            session_name=session_name or _DEFAULT_WEB_IDENTITY_SESSION_NAME,
+            expiration=expiration,
+        )
+
+    # extension points (substrate-specific)
+    @abstractmethod
+    def do_get_caller_identity(self, *, aud: Optional[str] = None) -> CallerIdentity:
+        """Provider-specific implementation of ``get_caller_identity``."""
+
+    @abstractmethod
+    def do_assume_role(
+        self,
+        role: str,
+        *,
+        session_name: str,
+        expiration: int,
+        external_id: Optional[str],
+        policy: Optional[str],
+        tags: Mapping[str, str],
+        credential_scope: Optional[CredentialScope],
+    ) -> StsCredentials:
+        """Provider-specific implementation of ``assume_role``."""
+
+    @abstractmethod
+    def do_get_access_token(
+        self,
+        *,
+        audience: Optional[str] = None,
+        scopes: Optional[list[str]] = None,
+        duration_seconds: Optional[int] = None,
+    ) -> StsCredentials:
+        """Provider-specific implementation of ``get_access_token``."""
+
+    @abstractmethod
+    def do_generate_service_account_token(
+        self,
+        target_principal: str,
+        *,
+        scopes: list[str],
+        lifetime: int,
+    ) -> StsCredentials:
+        """Provider-specific implementation of ``generate_service_account_token``."""
+
+    @abstractmethod
+    def do_assume_role_with_web_identity(
+        self,
+        role: str,
+        web_identity_token: str,
+        *,
+        session_name: str,
+        expiration: int,
+    ) -> StsCredentials:
+        """Provider-specific implementation of ``assume_role_with_web_identity``."""
+
+    # lifecycle
+    def close(self) -> None:
+        """Release underlying resources. Default is a no-op."""
+
+    def __enter__(self) -> "BaseSts":
+        return self
+
+    def __exit__(self, exc_type, exc, tb) -> None:  # noqa: D401
+        self.close()

multicloud_py_sts-0.1.6/multicloud/sts/sts_client/utilities.py

@@ -0,0 +1,137 @@
+"""Driver-level abstractions for STS utility functions.
+
+Offline signing helpers built on the Security Token Service. Unlike the
+:class:`~multicloud.sts.sts_client.driver.BaseSts` operations, these do
+not issue the identity request themselves — they produce a
+signed-but-unsent identity request that the caller hands to another
+system (e.g. an identity broker), which replays it to the provider to
+verify the caller's identity. Resolving the signing credentials may
+itself require a network call.
+
+Same ABC + template-method shape as ``BaseSts``: providers implement the
+``do_*`` hook; the public ``create_signed_auth_request`` method on
+:class:`BaseStsUtilities` normalizes input then delegates.
+
+Users never reach this layer directly — they construct an
+:class:`~multicloud.sts.sts_client.client.StsUtilities` (in
+``client.py``), which holds a ``BaseStsUtilities`` instance internally.
+"""
+
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from dataclasses import dataclass
+from typing import Mapping, Optional
+
+from multicloud.common.credentials import CredentialsOverrider, StsCredentials
+from multicloud.common.provider import Provider, ProviderRegistry
+
+# Utility-scoped registry. It shares the ``multicloud.sts.providers``
+# entry-point group with ``STS_REGISTRY`` so a single provider-package
+# import registers both the STS driver and its utility counterpart.
+STS_UTILITIES_REGISTRY = ProviderRegistry(
+    service_name="sts-utilities",
+    entry_point_group="multicloud.sts.providers",
+)
+
+
+@dataclass(frozen=True)
+class SignedAuthRequest:
+    """A signed-but-unsent identity request.
+
+    Produced by :meth:`BaseStsUtilities.create_signed_auth_request`. The
+    caller forwards the request itself — ``method``, ``url``, ``headers``,
+    and ``body`` — to an identity broker, which replays it to the provider
+    to prove the caller's identity.
+
+    Security: this is a **replayable identity proof** — the signed ``headers``
+    (and any session token on ``credentials``) let anyone holding them
+    impersonate the signer until the signature expires. Treat it as a secret:
+    ``__repr__`` redacts the sensitive parts, but ``dataclasses.asdict`` and
+    direct field access do not.
+
+    - ``method``: HTTP method of the signed request
+    - ``url``: fully-qualified request URL
+    - ``headers``: signed request headers; redacted in ``repr``
+    - ``body``: request body bytes
+    - ``credentials``: non-secret signer identity (key id + session token);
+      the long-term signing secret is omitted
+    """
+
+    method: str
+    url: str
+    headers: Mapping[str, str]
+    body: bytes
+    credentials: StsCredentials
+
+    def __repr__(self) -> str:
+        # Redact the signed headers (a replayable identity proof) so accidental
+        # logging can't leak them; ``credentials`` masks its own secrets.
+        return (
+            f"SignedAuthRequest(method={self.method!r}, url={self.url!r}, "
+            f"headers=<{len(self.headers)} signed headers; redacted>, "
+            f"body=<{len(self.body)} bytes>, credentials={self.credentials!r})"
+        )
+
+
+class BaseStsUtilities(Provider, ABC):
+    """Base class for substrate-specific STS utility implementations.
+
+    Providers extend this class and implement
+    :meth:`do_create_signed_auth_request`. Cross-cutting concerns
+    (argument normalization) happen in the public method so providers
+    don't have to repeat them.
+    """
+
+    def __init__(
+        self,
+        region: Optional[str] = None,
+        *,
+        credentials_overrider: Optional[CredentialsOverrider] = None,
+    ) -> None:
+        self._region = region
+        self._credentials_overrider = credentials_overrider
+
+    # properties
+    @property
+    def region(self) -> Optional[str]:
+        return self._region
+
+    # public API
+    def create_signed_auth_request(
+        self,
+        *,
+        custom_headers: Optional[Mapping[str, str]] = None,
+    ) -> SignedAuthRequest:
+        """Produce a signed identity request for cloud-native auth.
+
+        Args:
+            custom_headers: Extra headers to fold into the signature so the
+                broker replaying the request can bind them to the identity.
+
+        Returns:
+            SignedAuthRequest with the signed method, url, headers, body,
+            and the credentials used to sign it.
+        """
+        return self.do_create_signed_auth_request(
+            custom_headers=dict(custom_headers or {})
+        )
+
+    # extension point (substrate-specific)
+    @abstractmethod
+    def do_create_signed_auth_request(
+        self,
+        *,
+        custom_headers: Mapping[str, str],
+    ) -> SignedAuthRequest:
+        """Provider-specific implementation of ``create_signed_auth_request``."""
+
+    # lifecycle
+    def close(self) -> None:
+        """Release underlying resources. Default is a no-op."""
+
+    def __enter__(self) -> "BaseStsUtilities":
+        return self
+
+    def __exit__(self, exc_type, exc, tb) -> None:
+        self.close()

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

@@ -0,0 +1,21 @@
+Metadata-Version: 2.4
+Name: multicloud-py-sts
+Version: 0.1.6
+Summary: Cloud-agnostic Security Token Service client for the python-multicloud SDK. Pair with a provider package (multicloud-sts-aws / -gcp / -alibaba) for actual cloud calls.
+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
+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_sts-0.1.6/multicloud_py_sts.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE.txt
+pyproject.toml
+multicloud/sts/sts_client/__init__.py
+multicloud/sts/sts_client/client.py
+multicloud/sts/sts_client/driver.py
+multicloud/sts/sts_client/utilities.py
+multicloud_py_sts.egg-info/PKG-INFO
+multicloud_py_sts.egg-info/SOURCES.txt
+multicloud_py_sts.egg-info/dependency_links.txt
+multicloud_py_sts.egg-info/requires.txt
+multicloud_py_sts.egg-info/top_level.txt

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

@@ -0,0 +1 @@
+

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

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

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

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

multicloud_py_sts-0.1.6/pyproject.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires = ["setuptools>=77", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "multicloud-py-sts"
+version = "0.1.6"
+license = "Apache-2.0"
+description = "Cloud-agnostic Security Token Service client for the python-multicloud SDK. Pair with a provider package (multicloud-sts-aws / -gcp / -alibaba) for actual cloud calls."
+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",
+]
+
+[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_sts-0.1.6/setup.cfg

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