eager-auth 2.0.0__tar.gz

eager_auth-2.0.0/.gitignore

@@ -0,0 +1,22 @@
+# Python
+.venv/
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+dist/
+*.egg-info/
+
+# Node
+node_modules/
+coverage/
+
+# Editors / OS
+.DS_Store
+.idea/
+.vscode/
+
+# Produced by the live conformance job; the token in it is real, if short-lived.
+conformance/live/live-result.json

eager_auth-2.0.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 2026 What's Next
+
+   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.

eager_auth-2.0.0/PKG-INFO

@@ -0,0 +1,64 @@
+Metadata-Version: 2.5
+Name: eager-auth
+Version: 2.0.0
+Summary: Standard OIDC relying party for Eager FastAPI services — verification core
+Project-URL: Homepage, https://github.com/Whats-Next-CC/eager-auth
+Project-URL: Source, https://github.com/Whats-Next-CC/eager-auth
+Project-URL: Issues, https://github.com/Whats-Next-CC/eager-auth/issues
+Author-email: What's Next <engineering@whatsnext.cc>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: authentication,fastapi,keycloak,oidc,openid-connect
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP :: Session
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: httpx>=0.27
+Requires-Dist: joserfc>=1.0
+Requires-Dist: pyjwt[crypto]>=2.9
+Provides-Extra: dev
+Requires-Dist: black>=24.0; extra == 'dev'
+Requires-Dist: fastapi>=0.110; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Provides-Extra: fastapi
+Requires-Dist: fastapi>=0.110; extra == 'fastapi'
+Description-Content-Type: text/markdown
+
+# eager-auth (Python)
+
+Standard OIDC relying party for Eager FastAPI services. Verification core.
+
+```python
+from eager_auth import AuthConfig, HttpJwksSource, KeyResolver, verify_id_token
+
+config = AuthConfig(
+    issuer=os.environ["AUTH_ISSUER"],            # e.g. https://id.whatsnext.cc
+    client_id=os.environ["AUTH_CLIENT_ID"],
+    client_secret=os.environ["AUTH_CLIENT_SECRET"],
+)
+keys = KeyResolver(HttpJwksSource(config), max_age_seconds=config.jwks_max_age_seconds)
+
+principal = verify_id_token(id_token, config=config, keys=keys, nonce=flow_nonce)
+principal.sub, principal.email, principal.org, principal.roles
+```
+
+No vendor SDK, no database, no knowledge of orgs: everything about the provider comes from
+`{issuer}/.well-known/openid-configuration`, which is what makes the broker swappable.
+
+The behaviour is specified in `CONTRACT.md` at the repository root and enforced by
+`conformance/vectors.json`, which the TypeScript adapter runs against the same matrix.
+
+## Development
+
+```bash
+uv venv && uv pip install -e ".[dev]"
+.venv/bin/python -m pytest
+.venv/bin/ruff check src tests && .venv/bin/black --check src tests
+```

eager_auth-2.0.0/README.md

@@ -0,0 +1,31 @@
+# eager-auth (Python)
+
+Standard OIDC relying party for Eager FastAPI services. Verification core.
+
+```python
+from eager_auth import AuthConfig, HttpJwksSource, KeyResolver, verify_id_token
+
+config = AuthConfig(
+    issuer=os.environ["AUTH_ISSUER"],            # e.g. https://id.whatsnext.cc
+    client_id=os.environ["AUTH_CLIENT_ID"],
+    client_secret=os.environ["AUTH_CLIENT_SECRET"],
+)
+keys = KeyResolver(HttpJwksSource(config), max_age_seconds=config.jwks_max_age_seconds)
+
+principal = verify_id_token(id_token, config=config, keys=keys, nonce=flow_nonce)
+principal.sub, principal.email, principal.org, principal.roles
+```
+
+No vendor SDK, no database, no knowledge of orgs: everything about the provider comes from
+`{issuer}/.well-known/openid-configuration`, which is what makes the broker swappable.
+
+The behaviour is specified in `CONTRACT.md` at the repository root and enforced by
+`conformance/vectors.json`, which the TypeScript adapter runs against the same matrix.
+
+## Development
+
+```bash
+uv venv && uv pip install -e ".[dev]"
+.venv/bin/python -m pytest
+.venv/bin/ruff check src tests && .venv/bin/black --check src tests
+```

eager_auth-2.0.0/pyproject.toml

@@ -0,0 +1,68 @@
+[project]
+name = "eager-auth"
+version = "2.0.0"
+description = "Standard OIDC relying party for Eager FastAPI services — verification core"
+readme = "README.md"
+requires-python = ">=3.12"
+authors = [{ name = "What's Next", email = "engineering@whatsnext.cc" }]
+keywords = ["oidc", "openid-connect", "authentication", "fastapi", "keycloak"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Framework :: FastAPI",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Internet :: WWW/HTTP :: Session",
+    "Typing :: Typed",
+]
+
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+dependencies = [
+    "pyjwt[crypto]>=2.9",
+    "httpx>=0.27",
+    "joserfc>=1.0",
+]
+
+[project.optional-dependencies]
+fastapi = [
+    "fastapi>=0.110",
+]
+dev = [
+    "fastapi>=0.110",
+    "pytest>=8.0",
+    "pytest-cov>=5.0",
+    "ruff>=0.6",
+    "black>=24.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/Whats-Next-CC/eager-auth"
+Source = "https://github.com/Whats-Next-CC/eager-auth"
+Issues = "https://github.com/Whats-Next-CC/eager-auth/issues"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/eager_auth"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-q"
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "ANN", "D"]
+ignore = ["D203", "D213"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["ANN", "D"]
+
+[tool.black]
+line-length = 100

eager_auth-2.0.0/src/eager_auth/__init__.py

@@ -0,0 +1,115 @@
+"""eager-auth — standard OIDC relying party for Eager FastAPI services.
+
+The public surface of the verification core. The authorization-code flow, the session
+cookie and the FastAPI glue build on top of this and do not change it.
+
+See CONTRACT.md at the repository root.
+"""
+
+from eager_auth.claims import claim_at, extract_org, extract_roles
+from eager_auth.config import (
+    ALLOWED_ALGORITHMS,
+    DEFAULT_ORG_CLAIM,
+    DEFAULT_ROLES_CLAIM,
+    DEFAULT_SESSION_TTL_SECONDS,
+    AuthConfig,
+)
+from eager_auth.context import AuthContext
+from eager_auth.discovery import Discovery, fetch_discovery
+from eager_auth.errors import (
+    AuthError,
+    BadSignatureError,
+    ConfigError,
+    DiscoveryError,
+    ExpiredTokenError,
+    InvalidSessionError,
+    InvalidTokenError,
+    MalformedTokenError,
+    NonceMismatchError,
+    RefreshRejectedError,
+    StateMismatchError,
+    TokenExchangeError,
+    UnknownKeyError,
+    UnsupportedAlgorithmError,
+    WrongAudienceError,
+    WrongIssuerError,
+)
+from eager_auth.flow import (
+    CompletedLogin,
+    PendingLogin,
+    code_challenge_for,
+    complete_login,
+    logout_url,
+    refresh_session,
+    start_login,
+)
+from eager_auth.keys import HttpJwksSource, JwksSource, KeyResolver
+from eager_auth.pending import PendingState, safe_next, seal_pending, unseal_pending
+from eager_auth.presets import KEYCLOAK_REALM_ROLES, ZITADEL, keycloak_client_roles
+from eager_auth.principal import Principal
+from eager_auth.session import (
+    CookieAttributes,
+    SessionPayload,
+    decode_session,
+    encode_session,
+    needs_refresh,
+    pending_cookie,
+    session_cookie,
+)
+from eager_auth.tokens import verify_id_token
+
+__all__ = [
+    "ALLOWED_ALGORITHMS",
+    "AuthConfig",
+    "AuthContext",
+    "AuthError",
+    "BadSignatureError",
+    "CompletedLogin",
+    "ConfigError",
+    "CookieAttributes",
+    "DEFAULT_ORG_CLAIM",
+    "DEFAULT_ROLES_CLAIM",
+    "DEFAULT_SESSION_TTL_SECONDS",
+    "Discovery",
+    "DiscoveryError",
+    "ExpiredTokenError",
+    "HttpJwksSource",
+    "InvalidSessionError",
+    "InvalidTokenError",
+    "JwksSource",
+    "KEYCLOAK_REALM_ROLES",
+    "KeyResolver",
+    "MalformedTokenError",
+    "NonceMismatchError",
+    "PendingLogin",
+    "PendingState",
+    "Principal",
+    "RefreshRejectedError",
+    "SessionPayload",
+    "StateMismatchError",
+    "TokenExchangeError",
+    "UnknownKeyError",
+    "UnsupportedAlgorithmError",
+    "WrongAudienceError",
+    "WrongIssuerError",
+    "ZITADEL",
+    "claim_at",
+    "code_challenge_for",
+    "complete_login",
+    "decode_session",
+    "encode_session",
+    "extract_org",
+    "extract_roles",
+    "fetch_discovery",
+    "keycloak_client_roles",
+    "logout_url",
+    "needs_refresh",
+    "pending_cookie",
+    "refresh_session",
+    "safe_next",
+    "seal_pending",
+    "session_cookie",
+    "start_login",
+    "unseal_pending",
+    "verify_id_token",
+]

eager_auth-2.0.0/src/eager_auth/claims.py

@@ -0,0 +1,78 @@
+"""Reading claims out of a token — see CONTRACT.md section 3.
+
+Brokers disagree about where authorization data lives, and the disagreement is structural,
+not cosmetic:
+
+* **Zitadel** puts a flat claim holding an object map keyed by role name.
+* **Keycloak** nests roles at `realm_access.roles` (realm roles) or
+  `resource_access.<client>.roles` (client roles), and its Organizations feature emits an
+  `organization` claim keyed by org alias.
+
+So claim paths are **dotted** and the extractors accept every shape we have actually seen.
+This is the one place the module bends to a provider — by configuration, never by branching
+on which broker is in use.
+"""
+
+from __future__ import annotations
+
+from typing import Any
+
+
+def claim_at(claims: dict[str, Any], path: str) -> Any:  # noqa: ANN401
+    """Read a claim by dotted path.
+
+    A flat name like `email` works as before. `realm_access.roles` walks into the nested
+    object. Any missing hop, or a hop that is not an object, yields None rather than an
+    error: a token that does not carry the claim is a legitimate token.
+
+    The full path is tried as a literal key first, because Zitadel's claim names contain
+    dots (`urn:zitadel:iam:org:project:roles` does not, but others do) and a literal match
+    must win over a walk.
+    """
+    if path in claims:
+        return claims[path]
+
+    current: Any = claims
+    for hop in path.split("."):
+        if not isinstance(current, dict) or hop not in current:
+            return None
+        current = current[hop]
+    return current
+
+
+def extract_roles(claim_value: Any) -> tuple[str, ...]:  # noqa: ANN401
+    """Normalise a roles claim into a sorted, de-duplicated tuple.
+
+    Accepted shapes: a list of strings (Keycloak), and an object map keyed by role name
+    (Zitadel). Anything else yields an empty tuple rather than an error — a user with no
+    roles is a legitimate state, and it is the service's job to decide what to do about it.
+    """
+    if isinstance(claim_value, dict):
+        names = [str(name) for name in claim_value]
+    elif isinstance(claim_value, (list, tuple, set)):
+        names = [str(name) for name in claim_value if isinstance(name, str)]
+    else:
+        return ()
+    return tuple(sorted({name for name in names if name}))
+
+
+def extract_org(claim_value: Any) -> str | None:  # noqa: ANN401
+    """Normalise an org claim into a single identifier.
+
+    Accepted shapes: a string (Zitadel's primary domain), a one-element list, and an object
+    map keyed by org alias (Keycloak Organizations). When a map or list carries more than
+    one entry the first sorted key wins, deterministically — a principal belonging to
+    several orgs is out of scope for this contract, and picking at random would be worse
+    than picking predictably.
+    """
+    if isinstance(claim_value, str):
+        return claim_value or None
+    if isinstance(claim_value, dict):
+        names = sorted(str(name) for name in claim_value if str(name))
+        return names[0] if names else None
+    if isinstance(claim_value, (list, tuple)):
+        names = sorted(str(name) for name in claim_value if isinstance(name, str) and name)
+        return names[0] if names else None
+    if isinstance(claim_value, int) and not isinstance(claim_value, bool):
+        return str(claim_value)
+    return None