seamless-auth 0.1.0__tar.gz

seamless_auth-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+.venv/
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+dist/
+build/
+*.egg-info/
+*.log

seamless_auth-0.1.0/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## 0.1.0 (2026-10-08)
+
+
+### Added
+
+* Seamless Auth server adapter for FastAPI and Django ([1f3fab7](https://github.com/fells-code/seamless-auth-python/commit/1f3fab7ff35fa44b5587a6a095c24c4b05888166))
+
+## Changelog
+
+All notable changes to this project are documented in this file. The release
+automation (release-please) writes each entry from the Conventional Commits it
+releases.

seamless_auth-0.1.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 [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.

seamless_auth-0.1.0/PKG-INFO

@@ -0,0 +1,238 @@
+Metadata-Version: 2.5
+Name: seamless-auth
+Version: 0.1.0
+Summary: Seamless Auth server adapter for FastAPI and Django: cookie and bearer sessions in front of the Seamless Auth API
+Project-URL: Homepage, https://github.com/fells-code/seamless-auth-python
+Project-URL: Repository, https://github.com/fells-code/seamless-auth-python
+Project-URL: Issues, https://github.com/fells-code/seamless-auth-python/issues
+Project-URL: Changelog, https://github.com/fells-code/seamless-auth-python/blob/main/CHANGELOG.md
+Author: Fells Code LLC
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: auth,django,fastapi,passkeys,session,webauthn
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.2
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP :: Session
+Classifier: Topic :: Security
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: httpx2<3,>=2.13
+Requires-Dist: pyjwt[crypto]<3,>=2.10
+Provides-Extra: django
+Requires-Dist: django>=5.2; extra == 'django'
+Provides-Extra: fastapi
+Requires-Dist: fastapi>=0.115; extra == 'fastapi'
+Description-Content-Type: text/markdown
+
+# seamless-auth-python
+
+A [Seamless Auth](https://github.com/fells-code/seamless-auth-api) server adapter for Python, with
+bindings for [FastAPI](https://fastapi.tiangolo.com) and [Django](https://www.djangoproject.com).
+
+The adapter sits in your backend between your users and the Seamless Auth API:
+
+- **Browsers** talk to it over `HttpOnly` cookies on your own domain. The API's tokens never
+  reach page scripts.
+- **Native clients** (mobile, CLIs) talk to it over bearer tokens, sending
+  `x-seamless-auth-transport: bearer`.
+- **The auth API** sees bearer tokens plus a service token that lets it trust the client
+  address and user agent the adapter forwards.
+
+Which routes the adapter serves, and what each does to the session, comes from the adapter
+manifest the auth API publishes, so a new API route works without a new release of this package.
+
+It is held to the same [conformance suite](https://github.com/fells-code/seamless-cli/blob/main/verify/CONFORMANCE.md)
+as the Express, Fastify, Go and Rust adapters, with a FastAPI and a Django reference app, in CI on
+every change.
+
+## Install
+
+```bash
+pip install "seamless-auth[fastapi]"   # or "seamless-auth[django]"
+```
+
+Python 3.11 or later. Django 5.2 or later.
+
+## FastAPI
+
+```python
+import os
+
+from fastapi import Depends, FastAPI
+from seamless_auth import Adapter, User
+from seamless_auth.fastapi import RequireUser, auth_router
+
+auth = Adapter(
+    auth_server_url=os.environ["AUTH_SERVER_URL"],
+    cookie_secret=os.environ["COOKIE_SECRET"],  # at least 32 bytes
+    service_secret=os.environ["SERVICE_SECRET"],  # the API's API_SERVICE_TOKEN
+    jwks_kid=os.environ["JWKS_KID"],
+)
+current_user = RequireUser(auth)
+
+app = FastAPI()
+# The auth routes, at /auth, which is where the client SDKs call.
+app.include_router(auth_router(auth))
+
+
+# Your own routes, behind the adapter's guard.
+@app.get("/api/me")
+def me(user: User = Depends(current_user)):
+    return {"id": user.id}
+```
+
+`RequireUser` answers 401 unless the request carries a session, and returns the `User`.
+
+## Django
+
+```python
+# settings.py
+SEAMLESS_AUTH = {
+    "auth_server_url": os.environ["AUTH_SERVER_URL"],
+    "cookie_secret": os.environ["COOKIE_SECRET"],
+    "service_secret": os.environ["SERVICE_SECRET"],
+    "jwks_kid": os.environ["JWKS_KID"],
+}
+
+# urls.py
+urlpatterns = [
+    path("auth/", include("seamless_auth.django")),
+    path("api/me", views.me),
+]
+
+# views.py
+from django.http import JsonResponse
+from seamless_auth.django import require_auth, user_of
+
+
+@require_auth
+def me(request):
+    return JsonResponse({"id": user_of(request).id})
+```
+
+`SEAMLESS_AUTH` takes the keyword arguments of `Adapter` (below). `deliver` and
+`resolve_client_ip` may be dotted paths to callables. `require_auth` works on sync and async
+views. The auth routes are exempt from Django's CSRF middleware: the adapter does its own
+cross-site checks (below), and the client SDKs send no CSRF token.
+
+## The guard
+
+The guard (`RequireUser`, `require_auth`) accepts the adapter's session cookie, or an auth API
+access token in `Authorization: Bearer` for clients with no cookie jar. The cookie wins when both
+are present. It does not refresh: the auth routes refresh a browser session silently, and a bearer
+client calls `POST /auth/refresh` itself. `Adapter.authenticate(headers)` does the same check
+anywhere else.
+
+A request the guard admits on the session cookie also gets the auth routes' cross-site check:
+while cookies are `SameSite=None`, a state-changing request from another site (`Sec-Fetch-Site:
+cross-site`, or an `Origin` outside `allowed_origins`) answers 403. A bearer token is never
+attached by a browser, so it is not checked.
+
+### Request bodies
+
+The auth routes forward a request body to the auth API as JSON, so a body must be sent as
+`application/json` (or a `+json` type). Anything else answers 415 `unsupported_media_type`: a
+cross-site form can post a `text/plain` body shaped like JSON with no CORS preflight, and read as
+JSON it would be a sign-in the user never made. The client SDKs already send JSON.
+
+## Options
+
+| Argument | Default | Purpose |
+| --- | --- | --- |
+| `auth_server_url` | required | Where the adapter reaches the auth API |
+| `auth_server_issuer` | the URL | Expected `iss` of the API's tokens, when it differs from the URL you reach it at |
+| `audience` | the issuer | Expected `aud` of the API's tokens |
+| `cookie_secret` | required | Signs the session cookies (32 bytes or more) |
+| `service_secret` | required | The API's `API_SERVICE_TOKEN` (32 bytes or more) |
+| `jwks_kid` | `dev-main` | `kid` header on service tokens |
+| `cookie_domain` | none | Cookie `Domain` |
+| `insecure_cookies` | `False` | Drops `Secure`, for local development over HTTP |
+| `same_site` | `None`, or `Lax` with `insecure_cookies` | Cookie `SameSite` |
+| `allowed_origins` | none | The only cross-origin callers allowed to change state while cookies are `SameSite=None` |
+| `access_cookie_name`, `refresh_cookie_name` | `seamless-access`, `seamless-refresh` | Session cookie names |
+| `registration_cookie_name`, `pre_auth_cookie_name` | `seamless-ephemeral` | Sign-in flow cookie names |
+| `deliver` | none | Sends OTP codes and magic links through your own transports |
+| `resolve_client_ip` | the connecting peer | The end user's address. See below |
+| `disable_manifest_fetch` | `False` | Use only the manifest bundled with this version |
+| `http_client` | 15 second timeout, no redirects | Outbound `httpx2.Client` |
+
+### Client IP
+
+The adapter forwards the end user's address and user agent so the auth API rate limits and
+audits against the user, not your server. Behind a proxy, name it:
+
+```python
+from seamless_auth import TrustedProxies
+
+auth = Adapter(..., resolve_client_ip=TrustedProxies(["10.0.0.0/8"]))
+```
+
+`TrustedProxies` walks `X-Forwarded-For` from the right, skipping trusted proxies. There is
+deliberately no hop-count option: a hop count cannot tell a proxy from a client that sent its
+own header.
+
+### Delivery
+
+Without `deliver`, the auth API sends OTP codes and magic links itself. With it, the adapter
+asks the API for the message and hands it to you:
+
+```python
+from seamless_auth import Delivery
+
+
+def deliver(d: Delivery) -> None:
+    mailer.send(d.to, d.kind, d.token, d.magic_link_url)
+
+
+auth = Adapter(..., deliver=deliver)
+```
+
+An `async def` callback works too; under FastAPI it runs on the application's event loop. A
+delivery error answers the request with 502 `delivery_failed`.
+
+## How it runs
+
+The adapter is synchronous and thread-safe: one `Adapter` serves the whole process. Under FastAPI
+the bindings run it on Starlette's threadpool, so it never blocks the event loop. Under Django it
+runs in the request thread, on WSGI or ASGI. Refresh sharing (one rotation per refresh token,
+handed to every parallel request for 5 seconds) works across threads.
+
+## The manifest
+
+On its first request the adapter fetches `/.well-known/seamless-adapter.json` from the auth API
+(5 second timeout) and keeps it for the life of the process. If the API serves none, it uses the
+copy bundled in this package and tries again a minute later. A manifest with anything this
+version does not understand is refused whole, rather than following a route with the wrong token.
+Refresh the bundled copy with `scripts/sync-manifest.sh`.
+
+## Conformance
+
+`conformance/` holds the FastAPI and Django reference apps the conformance suite drives. To run
+one locally you need Docker, a checkout of `seamless-auth-api` and the `seamless` CLI:
+
+```bash
+PORT=8080 AUTH_SERVER_URL=http://localhost:5312 AUTH_SERVER_ISSUER=http://auth-api:5312 \
+  API_SERVICE_TOKEN=verify-dev-service-token-not-a-real-secret \
+  COOKIE_SIGNING_KEY=verify-dev-service-token-not-a-real-secret JWKS_KID=dev-main \
+  uv run python conformance/fastapi_app.py &   # or conformance/django_app.py
+
+SEAMLESS_API_DIR=../seamless-auth-api seamless verify --adapter-url=http://localhost:8080
+```
+
+## Status
+
+Pre-1.0. The public API may change between minor versions until 1.0.
+
+## License
+
+Apache-2.0

seamless_auth-0.1.0/README.md

@@ -0,0 +1,202 @@
+# seamless-auth-python
+
+A [Seamless Auth](https://github.com/fells-code/seamless-auth-api) server adapter for Python, with
+bindings for [FastAPI](https://fastapi.tiangolo.com) and [Django](https://www.djangoproject.com).
+
+The adapter sits in your backend between your users and the Seamless Auth API:
+
+- **Browsers** talk to it over `HttpOnly` cookies on your own domain. The API's tokens never
+  reach page scripts.
+- **Native clients** (mobile, CLIs) talk to it over bearer tokens, sending
+  `x-seamless-auth-transport: bearer`.
+- **The auth API** sees bearer tokens plus a service token that lets it trust the client
+  address and user agent the adapter forwards.
+
+Which routes the adapter serves, and what each does to the session, comes from the adapter
+manifest the auth API publishes, so a new API route works without a new release of this package.
+
+It is held to the same [conformance suite](https://github.com/fells-code/seamless-cli/blob/main/verify/CONFORMANCE.md)
+as the Express, Fastify, Go and Rust adapters, with a FastAPI and a Django reference app, in CI on
+every change.
+
+## Install
+
+```bash
+pip install "seamless-auth[fastapi]"   # or "seamless-auth[django]"
+```
+
+Python 3.11 or later. Django 5.2 or later.
+
+## FastAPI
+
+```python
+import os
+
+from fastapi import Depends, FastAPI
+from seamless_auth import Adapter, User
+from seamless_auth.fastapi import RequireUser, auth_router
+
+auth = Adapter(
+    auth_server_url=os.environ["AUTH_SERVER_URL"],
+    cookie_secret=os.environ["COOKIE_SECRET"],  # at least 32 bytes
+    service_secret=os.environ["SERVICE_SECRET"],  # the API's API_SERVICE_TOKEN
+    jwks_kid=os.environ["JWKS_KID"],
+)
+current_user = RequireUser(auth)
+
+app = FastAPI()
+# The auth routes, at /auth, which is where the client SDKs call.
+app.include_router(auth_router(auth))
+
+
+# Your own routes, behind the adapter's guard.
+@app.get("/api/me")
+def me(user: User = Depends(current_user)):
+    return {"id": user.id}
+```
+
+`RequireUser` answers 401 unless the request carries a session, and returns the `User`.
+
+## Django
+
+```python
+# settings.py
+SEAMLESS_AUTH = {
+    "auth_server_url": os.environ["AUTH_SERVER_URL"],
+    "cookie_secret": os.environ["COOKIE_SECRET"],
+    "service_secret": os.environ["SERVICE_SECRET"],
+    "jwks_kid": os.environ["JWKS_KID"],
+}
+
+# urls.py
+urlpatterns = [
+    path("auth/", include("seamless_auth.django")),
+    path("api/me", views.me),
+]
+
+# views.py
+from django.http import JsonResponse
+from seamless_auth.django import require_auth, user_of
+
+
+@require_auth
+def me(request):
+    return JsonResponse({"id": user_of(request).id})
+```
+
+`SEAMLESS_AUTH` takes the keyword arguments of `Adapter` (below). `deliver` and
+`resolve_client_ip` may be dotted paths to callables. `require_auth` works on sync and async
+views. The auth routes are exempt from Django's CSRF middleware: the adapter does its own
+cross-site checks (below), and the client SDKs send no CSRF token.
+
+## The guard
+
+The guard (`RequireUser`, `require_auth`) accepts the adapter's session cookie, or an auth API
+access token in `Authorization: Bearer` for clients with no cookie jar. The cookie wins when both
+are present. It does not refresh: the auth routes refresh a browser session silently, and a bearer
+client calls `POST /auth/refresh` itself. `Adapter.authenticate(headers)` does the same check
+anywhere else.
+
+A request the guard admits on the session cookie also gets the auth routes' cross-site check:
+while cookies are `SameSite=None`, a state-changing request from another site (`Sec-Fetch-Site:
+cross-site`, or an `Origin` outside `allowed_origins`) answers 403. A bearer token is never
+attached by a browser, so it is not checked.
+
+### Request bodies
+
+The auth routes forward a request body to the auth API as JSON, so a body must be sent as
+`application/json` (or a `+json` type). Anything else answers 415 `unsupported_media_type`: a
+cross-site form can post a `text/plain` body shaped like JSON with no CORS preflight, and read as
+JSON it would be a sign-in the user never made. The client SDKs already send JSON.
+
+## Options
+
+| Argument | Default | Purpose |
+| --- | --- | --- |
+| `auth_server_url` | required | Where the adapter reaches the auth API |
+| `auth_server_issuer` | the URL | Expected `iss` of the API's tokens, when it differs from the URL you reach it at |
+| `audience` | the issuer | Expected `aud` of the API's tokens |
+| `cookie_secret` | required | Signs the session cookies (32 bytes or more) |
+| `service_secret` | required | The API's `API_SERVICE_TOKEN` (32 bytes or more) |
+| `jwks_kid` | `dev-main` | `kid` header on service tokens |
+| `cookie_domain` | none | Cookie `Domain` |
+| `insecure_cookies` | `False` | Drops `Secure`, for local development over HTTP |
+| `same_site` | `None`, or `Lax` with `insecure_cookies` | Cookie `SameSite` |
+| `allowed_origins` | none | The only cross-origin callers allowed to change state while cookies are `SameSite=None` |
+| `access_cookie_name`, `refresh_cookie_name` | `seamless-access`, `seamless-refresh` | Session cookie names |
+| `registration_cookie_name`, `pre_auth_cookie_name` | `seamless-ephemeral` | Sign-in flow cookie names |
+| `deliver` | none | Sends OTP codes and magic links through your own transports |
+| `resolve_client_ip` | the connecting peer | The end user's address. See below |
+| `disable_manifest_fetch` | `False` | Use only the manifest bundled with this version |
+| `http_client` | 15 second timeout, no redirects | Outbound `httpx2.Client` |
+
+### Client IP
+
+The adapter forwards the end user's address and user agent so the auth API rate limits and
+audits against the user, not your server. Behind a proxy, name it:
+
+```python
+from seamless_auth import TrustedProxies
+
+auth = Adapter(..., resolve_client_ip=TrustedProxies(["10.0.0.0/8"]))
+```
+
+`TrustedProxies` walks `X-Forwarded-For` from the right, skipping trusted proxies. There is
+deliberately no hop-count option: a hop count cannot tell a proxy from a client that sent its
+own header.
+
+### Delivery
+
+Without `deliver`, the auth API sends OTP codes and magic links itself. With it, the adapter
+asks the API for the message and hands it to you:
+
+```python
+from seamless_auth import Delivery
+
+
+def deliver(d: Delivery) -> None:
+    mailer.send(d.to, d.kind, d.token, d.magic_link_url)
+
+
+auth = Adapter(..., deliver=deliver)
+```
+
+An `async def` callback works too; under FastAPI it runs on the application's event loop. A
+delivery error answers the request with 502 `delivery_failed`.
+
+## How it runs
+
+The adapter is synchronous and thread-safe: one `Adapter` serves the whole process. Under FastAPI
+the bindings run it on Starlette's threadpool, so it never blocks the event loop. Under Django it
+runs in the request thread, on WSGI or ASGI. Refresh sharing (one rotation per refresh token,
+handed to every parallel request for 5 seconds) works across threads.
+
+## The manifest
+
+On its first request the adapter fetches `/.well-known/seamless-adapter.json` from the auth API
+(5 second timeout) and keeps it for the life of the process. If the API serves none, it uses the
+copy bundled in this package and tries again a minute later. A manifest with anything this
+version does not understand is refused whole, rather than following a route with the wrong token.
+Refresh the bundled copy with `scripts/sync-manifest.sh`.
+
+## Conformance
+
+`conformance/` holds the FastAPI and Django reference apps the conformance suite drives. To run
+one locally you need Docker, a checkout of `seamless-auth-api` and the `seamless` CLI:
+
+```bash
+PORT=8080 AUTH_SERVER_URL=http://localhost:5312 AUTH_SERVER_ISSUER=http://auth-api:5312 \
+  API_SERVICE_TOKEN=verify-dev-service-token-not-a-real-secret \
+  COOKIE_SIGNING_KEY=verify-dev-service-token-not-a-real-secret JWKS_KID=dev-main \
+  uv run python conformance/fastapi_app.py &   # or conformance/django_app.py
+
+SEAMLESS_API_DIR=../seamless-auth-api seamless verify --adapter-url=http://localhost:8080
+```
+
+## Status
+
+Pre-1.0. The public API may change between minor versions until 1.0.
+
+## License
+
+Apache-2.0