ab-token-validator 0.1.1__tar.gz

ab_token_validator-0.1.1/.gitignore

@@ -0,0 +1,195 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore

ab_token_validator-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Matthew Coulter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ab_token_validator-0.1.1/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: ab-token-validator
+Version: 0.1.1
+Author-email: Matthew Coulter <53892067+mattcoulter7@users.noreply.github.com>
+License-File: LICENSE
+Requires-Python: <4,>=3.12
+Requires-Dist: ab-dependency
+Requires-Dist: aiocache<0.13,>=0.12.3
+Requires-Dist: fastapi<0.116,>=0.115.14
+Requires-Dist: httpx<0.29,>=0.28.1
+Requires-Dist: pydantic<3,>=2.11.7
+Requires-Dist: python-jose[cryptography]<4,>=3.5.0
+Requires-Dist: uuid7<0.2,>=0.1.0
+Requires-Dist: yarl<2,>=1.20.1
+Description-Content-Type: text/markdown
+
+# Open Banking, Opened | FastAPI Token Validator
+
+FastAPI Token Validator Package for Open Banking, Opened API packages.

ab_token_validator-0.1.1/README.md

@@ -0,0 +1,3 @@
+# Open Banking, Opened | FastAPI Token Validator
+
+FastAPI Token Validator Package for Open Banking, Opened API packages.

ab_token_validator-0.1.1/pyproject.toml

@@ -0,0 +1,78 @@
+[build-system]
+build-backend = "hatchling.build"
+requires = ["hatchling"]
+
+[dependency-groups]
+dev = [
+  "debugpy>=1.8.14,<2",
+  "isort>=6.0.1,<7",
+  "ab-test-fixtures",
+  "pre-commit>=4.2.0,<5",
+  "pytest-asyncio>=1.0.0,<2",
+  "pytest-cov>=6.2.1,<7",
+  "pytest>=8.4.1,<9",
+  "ruff>=0.12.3,<0.13",
+  "tox>=4.27.0,<5"
+]
+
+[project]
+authors = [{email = "53892067+mattcoulter7@users.noreply.github.com", name = "Matthew Coulter"}]
+dependencies = [
+  "aiocache>=0.12.3,<0.13",
+  "fastapi>=0.115.14,<0.116",
+  "httpx>=0.28.1,<0.29",
+  "ab-dependency",
+  "pydantic>=2.11.7,<3",
+  "python-jose[cryptography]>=3.5.0,<4",
+  "uuid7>=0.1.0,<0.2",
+  "yarl>=1.20.1,<2"
+]
+description = ""
+name = "ab-token-validator"
+readme = "README.md"
+requires-python = ">=3.12, <4"
+version = "0.1.1"
+
+[tool.uv.sources]
+ab-dependency  = { git = "https://@github.com/auth-broker/package-dependency", tag= "0.1.2" }
+ab-test-fixtures  = { git = "https://@github.com/auth-broker/package-test-fixtures", tag= "0.1.1" }
+
+[tool.hatch.build.targets.sdist]
+include = ["src/ab_core"]
+
+[tool.hatch.build.targets.wheel]
+include = ["src/ab_core"]
+
+[tool.hatch.build.targets.wheel.sources]
+"src/ab_core" = "ab_core"
+
+[tool.pytest.ini_options]
+asyncio_default_fixture_loop_scope = "session"
+asyncio_mode = "auto"
+markers = [
+  "integration: Assigns the test to the integration test suite.",
+  "regression: Assigns the test to the regression test suite"
+]
+
+[tool.ruff]
+line-length = 120
+src = ["src"]
+target-version = "py312"
+
+[tool.ruff.lint]
+exclude = [".git", ".venv", "__pycache__", "proto"]
+fixable = ["ALL"]
+ignore = [
+  "D104" # missing docstring in public package
+]
+select = [
+  "ARG001", # unused arguments
+  "B", # flake8-bugbear
+  "C4", # flake8-comprehensions
+  "D", # pydocstyle (docstring checks)
+  "E", # pycodestyle errors
+  "F", # pyflakes
+  "I", # isort
+  "UP", # pyupgrade
+  "W" # pycodestyle warnings
+]

ab_token_validator-0.1.1/src/ab_core/token_validator/schema/token_validator_type.py

@@ -0,0 +1,6 @@
+from enum import StrEnum
+
+
+class TokenValidatorType(StrEnum):
+    OIDC = "OIDC"
+    TEMPLATE = "TEMPLATE"

ab_token_validator-0.1.1/src/ab_core/token_validator/schema/validated_token.py

@@ -0,0 +1,22 @@
+from typing import List, Optional
+
+from pydantic import BaseModel
+
+
+class ValidatedOIDCClaims(BaseModel):
+    iss: str
+    sub: str
+    aud: str | List[str]
+    exp: int
+    iat: int
+    auth_time: int
+    acr: str
+
+    # New fields
+    email: Optional[str] = None
+    email_verified: Optional[bool] = None
+    name: Optional[str] = None
+    given_name: Optional[str] = None
+    preferred_username: Optional[str] = None
+    nickname: Optional[str] = None
+    groups: Optional[List[str]] = None

ab_token_validator-0.1.1/src/ab_core/token_validator/token_validators/__init__.py

@@ -0,0 +1,14 @@
+from typing import Annotated, Union
+
+from pydantic import Discriminator
+
+from .oidc import OIDCTokenValidator
+from .template import TemplateTokenValidator
+
+TokenValidator = Annotated[
+    Union[
+        OIDCTokenValidator,
+        TemplateTokenValidator,
+    ],
+    Discriminator("type"),
+]

ab_token_validator-0.1.1/src/ab_core/token_validator/token_validators/base.py

@@ -0,0 +1,25 @@
+from abc import ABC, abstractmethod
+from typing import Generic, TypeVar
+
+from pydantic import BaseModel
+
+ValidatedType = TypeVar("ValidatedType")
+
+
+class TokenValidatorBase(BaseModel, Generic[ValidatedType], ABC):
+    """
+    Abstract base for any token validator.
+
+    Generic on the validated return type.
+    Also a Pydantic model, so you get:
+      - field validation on init
+      - .model_dump(), .model_json(), etc
+    """
+
+    @abstractmethod
+    async def validate(self, token: str) -> ValidatedType:
+        """
+        Validate a raw token string and return a structured result.
+        Should raise on failure.
+        """
+        ...

ab_token_validator-0.1.1/src/ab_core/token_validator/token_validators/oidc.py

@@ -0,0 +1,52 @@
+from typing import List, Literal, Sequence, Union
+
+import httpx
+from aiocache import SimpleMemoryCache, cached
+from jose import JWTError, jwt
+from pydantic import AnyHttpUrl, Field, HttpUrl
+
+from ..schema.token_validator_type import TokenValidatorType
+from ..schema.validated_token import ValidatedOIDCClaims
+from .base import TokenValidatorBase
+
+
+class OIDCTokenValidator(TokenValidatorBase[ValidatedOIDCClaims]):
+    """
+    Validates a JWT from an OIDC provider
+    and returns a ValidatedOIDCClaims model.
+    """
+
+    type: Literal[TokenValidatorType.OIDC] = TokenValidatorType.OIDC
+
+    issuer: HttpUrl
+    jwks_uri: AnyHttpUrl
+    audience: Union[str, Sequence[str]]
+    algorithms: List[str] = Field(default_factory=lambda: ["RS256"])
+
+    # @field_validator("audience", mode="before")
+    # def normalize_audience(cls, v: Union[str, Sequence[str]]) -> List[str]:
+    #     return list(v) if isinstance(v, (list, tuple, set)) else [str(v)]
+
+    @cached(ttl=300, cache=SimpleMemoryCache)
+    async def _get_jwks(self) -> dict:
+        async with httpx.AsyncClient() as client:
+            resp = await client.get(self.jwks_uri.encoded_string(), timeout=5)
+            resp.raise_for_status()
+            return resp.json()
+
+    async def validate(self, token: str) -> ValidatedOIDCClaims:
+        jwks = await self._get_jwks()
+        header = jwt.get_unverified_header(token)
+        key = next((k for k in jwks["keys"] if k.get("kid") == header.get("kid")), None)
+        if key is None:
+            raise JWTError("No matching 'kid' found in JWKS")
+
+        claims_dict = jwt.decode(
+            token,
+            key=key,
+            algorithms=self.algorithms,
+            audience=self.audience,
+            issuer=str(self.issuer),
+        )
+
+        return ValidatedOIDCClaims.model_validate(claims_dict)

ab_token_validator-0.1.1/src/ab_core/token_validator/token_validators/template.py

@@ -0,0 +1,17 @@
+from typing import Literal
+
+from ..schema.token_validator_type import TokenValidatorType
+from ..schema.validated_token import ValidatedOIDCClaims
+from .base import TokenValidatorBase
+
+
+class TemplateTokenValidator(TokenValidatorBase[ValidatedOIDCClaims]):
+    """
+    Validates a JWT from an OIDC provider
+    and returns a ValidatedOIDCClaims model.
+    """
+
+    type: Literal[TokenValidatorType.TEMPLATE] = TokenValidatorType.TEMPLATE
+
+    async def validate(self, token: str) -> ValidatedOIDCClaims:
+        raise NotImplementedError()