apron-auth 0.1.0__tar.gz

apron_auth-0.1.0/.github/workflows/ci.yaml

@@ -0,0 +1,32 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v7
+        with:
+          python-version: "3.13"
+      - run: uv sync --group lint
+      - run: uv run pre-commit run --all-files --verbose
+
+  test:
+    needs: lint
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: uv sync --group tests
+      - run: uv run pytest tests/ -v

apron_auth-0.1.0/.github/workflows/release.yaml

@@ -0,0 +1,39 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  release:
+    environment: pypi
+    permissions:
+      contents: read
+      id-token: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out the repository
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: Upgrade pip
+        run: |
+          pip install --upgrade pip
+          pip --version
+
+      - name: Install build tools
+        run: python -m pip install build setuptools setuptools_scm
+
+      - name: Build package
+        run: python -m build
+
+      - name: Upload package
+        if: github.event_name == 'release'
+        uses: pypa/gh-action-pypi-publish@release/v1

apron_auth-0.1.0/.gitignore

@@ -0,0 +1,17 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+*.egg
+dist/
+build/
+.eggs/
+.venv/
+*.so
+.ruff_cache/
+.mypy_cache/
+.pytest_cache/
+.idea/
+.vscode/
+*.swp
+*.swo

apron_auth-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,34 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-merge-conflict
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.12
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/Yelp/detect-secrets
+    rev: v1.5.0
+    hooks:
+      - id: detect-secrets
+
+  - repo: local
+    hooks:
+      - id: ty-check
+        name: ty
+        entry: uvx ty check src/apron_auth --python .venv
+        language: system
+        pass_filenames: false
+        types: [python]
+        files: ^src/
+
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.11.7
+    hooks:
+      - id: uv-lock

apron_auth-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 Mozilla.ai
+
+   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.

apron_auth-0.1.0/Makefile

@@ -0,0 +1,19 @@
+.PHONY: ensure-scripts-exec
+ensure-scripts-exec:
+	@chmod +x scripts/* || true
+
+.PHONY: setup
+setup: ensure-scripts-exec
+	@scripts/setup_uv.sh
+
+.PHONY: test
+test:
+	@uv run -m pytest tests
+
+.PHONY: test-integration
+test-integration:
+	@APRON_AUTH_INTEGRATION_TESTS=1 uv run -m pytest tests -m integration -v
+
+.PHONY: lint
+lint:
+	@uv run pre-commit run --all-files

apron_auth-0.1.0/PKG-INFO

@@ -0,0 +1,274 @@
+Metadata-Version: 2.4
+Name: apron-auth
+Version: 0.1.0
+Summary: Stateless OAuth 2.0 protocol library with PKCE, token refresh, and provider-specific revocation.
+License: Apache-2.0
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: authlib>=1.6.11
+Requires-Dist: httpx>=0.27
+Requires-Dist: pydantic>=2.0
+Dynamic: license-file
+
+# apron-auth
+
+Stateless OAuth 2.0 protocol library with PKCE, token refresh, and provider-specific revocation.
+
+## What is apron-auth?
+
+Provider-specific OAuth knowledge — endpoints, auth methods, PKCE quirks, error classification, and revocation — encoded as a library so your application doesn't have to maintain it.
+
+| What                 | Why                                                                                                                                       |
+|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
+| Provider presets     | Endpoints, auth methods, PKCE toggles, scope separators, and revocation for multiple providers out of the box.                            |
+| Error classification | Distinguishes permanent failures (revoked token, invalid client) from transient ones so callers know whether to retry or re-authenticate. |
+| Revocation support   | Providers all revoke differently (POST, DELETE, GET, Basic auth, query params) — presets include the right handler when available.          |
+| Auth method handling | `client_secret_post` vs `client_secret_basic` — picked from your config and handled by authlib under the hood.                            |
+| PKCE (S256)          | Generated automatically when the provider supports it, no setup needed.                                                                   |
+
+apron-auth is stateless. It doesn't store tokens, manage sessions, or hold database connections — you bring your own storage, apron-auth handles the protocol.
+
+## Installation
+
+```bash
+# via uv
+uv add apron-auth
+
+# via pip
+pip install apron-auth
+```
+
+Requires Python 3.11+.
+
+## Usage
+
+### With a provider preset
+
+Presets bundle the endpoints, auth method, PKCE config, and revocation handler for a given provider into a single call.
+
+```python
+from apron_auth.providers import google
+
+config, revocation_handler = google.preset(
+    client_id="your-client-id",
+    client_secret="your-client-secret",  # pragma: allowlist secret
+    scopes=["openid", "email", "profile"],
+)
+```
+
+If you use [apron-tools](https://github.com/mozilla-ai/apron-tools), scopes come from capability groups instead of being hardcoded:
+
+```python
+from apron_tools.providers.google.gmail.scopes import CAPABILITY_GROUP as GMAIL
+
+config, revocation_handler = google.preset(
+    client_id="your-client-id",
+    client_secret="your-client-secret",  # pragma: allowlist secret
+    scopes=GMAIL.scopes,
+)
+```
+
+### Manual configuration
+
+If your provider doesn't have a preset, configure it directly.
+
+```python
+from pydantic import SecretStr
+from apron_auth import ProviderConfig
+
+config = ProviderConfig(
+    client_id="your-client-id",
+    client_secret=SecretStr("your-client-secret"),  # pragma: allowlist secret
+    authorize_url="https://provider.com/oauth/authorize",
+    token_url="https://provider.com/oauth/token",
+    scopes=["read", "write"],
+)
+```
+
+### Authorization URL
+
+Build the URL to redirect the user to. State and PKCE are included automatically.
+
+```python
+from apron_auth import OAuthClient
+
+client = OAuthClient(config)
+url, pending_state = await client.get_authorization_url(
+    redirect_uri="https://yourapp.com/callback",
+)
+# Redirect the user to `url`.
+# Hold onto `pending_state` — you'll need it for the callback.
+```
+
+### Code exchange
+
+When the user comes back with an authorization code, exchange it for tokens.
+
+```python
+tokens = await client.exchange_code(
+    code="authorization-code-from-callback",
+    redirect_uri="https://yourapp.com/callback",
+    code_verifier=pending_state.code_verifier,
+)
+print(tokens.access_token)
+print(tokens.refresh_token)
+```
+
+### Token refresh
+
+Refreshing can fail permanently (the user revoked access, the client was deregistered) or transiently (network blip, rate limit). apron-auth tells you which.
+
+```python
+from apron_auth import PermanentOAuthError
+
+try:
+    tokens = await client.refresh_token(tokens.refresh_token)
+except PermanentOAuthError:
+    # The token can't be recovered — delete it and re-authenticate the user.
+    pass
+```
+
+By default, `invalid_grant`, `unauthorized_client`, and `invalid_client` are treated as permanent. If your provider uses non-standard error codes for the same thing, you can extend the set:
+
+```python
+client = OAuthClient(
+    config,
+    permanent_error_codes={"token_revoked", "account_suspended"},
+)
+```
+
+These merge with the defaults — you can inspect them via `OAuthClient.DEFAULT_PERMANENT_ERROR_CODES`.
+
+### Token revocation
+
+```python
+client = OAuthClient(config, revocation_handler=revocation_handler)
+await client.revoke_token(tokens.access_token)
+```
+
+### State management
+
+If you need to persist OAuth state across requests (e.g. between the redirect and the callback), implement the `StateStore` protocol.
+
+```python
+from apron_auth import StateStore, OAuthPendingState
+
+class MyStateStore:
+    async def save(self, state: OAuthPendingState) -> None:
+        # Persist state, keyed by state.state.
+        ...
+
+    async def consume(self, state_key: str) -> OAuthPendingState | None:
+        # Look up and invalidate in one step. Return None if it's missing or expired.
+        ...
+
+client = OAuthClient(config, state_store=MyStateStore())
+url, pending_state = await client.get_authorization_url(
+    redirect_uri="https://yourapp.com/callback",
+)
+
+# When the callback arrives, pass the state parameter and the code.
+# The store is consumed automatically.
+tokens = await client.exchange_code(code="...", state="state-from-callback")
+```
+
+#### Carrying context through the flow
+
+If your application needs to carry context through the OAuth flow (e.g. which user or tenant initiated it), pass `metadata` when building the authorization URL. apron-auth carries it opaquely through the `StateStore` and surfaces it on `TokenSet.context` after auto-consume.
+
+```python
+url, pending_state = await client.get_authorization_url(
+    redirect_uri="https://yourapp.com/callback",
+    metadata={"user_id": "U123", "tenant_id": "T456"},
+)
+
+# On callback, context comes back on the TokenSet.
+tokens = await client.exchange_code(code="...", state="state-from-callback")
+print(tokens.context["user_id"])    # "U123"
+print(tokens.context["tenant_id"])  # "T456"
+
+# Provider response extras (e.g. Slack's team_id) are separate.
+print(tokens.metadata)  # {"team_id": "T123", ...}
+```
+
+## Provider presets
+
+| Provider   | Preset                   | Revocation             | `disconnect_fully_revokes` |
+|------------|--------------------------|------------------------|----------------------------|
+| Google     | `google.preset(...)`     | POST with query param  | `True`                     |
+| GitHub     | `github.preset(...)`     | DELETE with Basic auth | `True`                     |
+| Slack      | `slack.preset(...)`      | GET with query param   | `False`                    |
+| Notion     | `notion.preset(...)`     | POST with Basic auth   | `False`                    |
+| Microsoft  | `microsoft.preset(...)`  | —                      | `False`                    |
+| Atlassian  | `atlassian.preset(...)`  | RFC 7009 POST          | `False`                    |
+| Linear     | `linear.preset(...)`     | RFC 7009 POST          | `False`                    |
+| Salesforce | `salesforce.preset(...)` | RFC 7009 POST          | `False`                    |
+| Typeform   | `typeform.preset(...)`   | —                      | `False`                    |
+| HubSpot    | `hubspot.preset(...)`    | DELETE refresh-token   | `False`                    |
+
+## Scope reduction tiers
+
+Some providers' revocation endpoints fully remove the user's portal-level OAuth grant; others only invalidate the current token while the grant lingers. apron-auth surfaces this difference as `ProviderConfig.disconnect_fully_revokes` so consumers can offer the right scope-reduction UX without rebuilding the per-provider truth table inline.
+
+| Tier | Meaning                                                                                                             | When                                |
+|------|---------------------------------------------------------------------------------------------------------------------|-------------------------------------|
+| 1    | Automatic scope reduction: revoke + re-auth presents a fresh consent screen, narrower scopes take effect.           | `disconnect_fully_revokes is True`  |
+| 3    | Manual via provider settings: deep-link the user to the provider's app management page; revoke alone is not enough. | `disconnect_fully_revokes is False` |
+
+```python
+from apron_auth.providers import google, hubspot
+
+google_config, _ = google.preset(...)
+hubspot_config, _ = hubspot.preset(...)
+
+if google_config.disconnect_fully_revokes:
+    ...  # tier 1: trigger revoke + re-auth in-app
+else:
+    ...  # tier 3: open the provider's app-management page
+```
+
+The default for unconfigured `ProviderConfig` is `False` — under-claiming the capability harmlessly falls back to the manual deep-link path.
+
+### Trello
+
+Trello's API uses OAuth 1.0 exclusively — there is no OAuth 2.0 support yet. Atlassian has [announced plans](https://community.developer.atlassian.com/t/rfc-89-introducing-oauth2-to-trello/90359) to introduce OAuth 2.0 (3LO) for Trello, but no launch date has been committed.
+
+Because apron-auth is an OAuth 2.0 library, Trello is not supported. If your application needs Trello, handle its OAuth 1.0 flow separately (e.g. with [authlib](https://docs.authlib.org/en/latest/client/oauth1.html)). [apron-tools](https://github.com/mozilla-ai/apron-tools) provides Trello tool definitions — you just need to bring your own token.
+
+When Trello ships OAuth 2.0, a preset will be added here.
+
+## Error hierarchy
+
+All exceptions inherit from `OAuthError`.
+
+| Exception             | When it's raised                                                                                                |
+|-----------------------|-----------------------------------------------------------------------------------------------------------------|
+| `TokenExchangeError`  | Code exchange failed at the token endpoint.                                                                     |
+| `TokenRefreshError`   | Refresh failed, but it might work if you try again (transient).                                                 |
+| `PermanentOAuthError` | The token is gone — `invalid_grant`, `unauthorized_client`, or `invalid_client`. Delete it and re-authenticate. |
+| `RevocationError`     | The provider rejected the revocation request.                                                                   |
+| `StateError`          | OAuth state was invalid, expired, or already used.                                                              |
+| `ConfigurationError`  | Something's wrong with the provider config (e.g. missing `redirect_uri`).                                       |
+
+## Development
+
+Requires [uv](https://docs.astral.sh/uv/).
+
+```bash
+make setup    # Install uv, create venv, sync deps, install pre-commit hooks
+make test     # Run unit tests
+make lint     # Run pre-commit hooks (ruff, ty, detect-secrets)
+```
+
+Or using uv directly:
+
+```bash
+uv sync --group dev
+uv run pytest tests
+uv run pre-commit run --all-files
+```
+
+## License
+
+[Apache-2.0](LICENSE)