custom-domain-sdk 0.1.0__tar.gz

custom_domain_sdk-0.1.0/.gitignore

@@ -0,0 +1,16 @@
+/local/
+/venv/
+/.venv/
+.idea/
+.env
+.env.*
+!.env_example
+__pycache__/
+.pytest_cache/
+.ruff_cache/
+/data/
+*.db
+*.db-journal
+*.db-wal
+*.db-shm
+deploy/.env

custom_domain_sdk-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 [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.

custom_domain_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,189 @@
+Metadata-Version: 2.5
+Name: custom-domain-sdk
+Version: 0.1.0
+Summary: Client, assertion verification and middleware for the Custom Domain API.
+Project-URL: Homepage, https://github.com/sireto/custom-domain
+Project-URL: Documentation, https://github.com/sireto/custom-domain/blob/main/sdk/README.md
+Project-URL: Source, https://github.com/sireto/custom-domain/tree/main/sdk
+Project-URL: Issues, https://github.com/sireto/custom-domain/issues
+Author-email: Sireto <info@sireto.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: asgi,caddy,custom-domain,multi-tenant,saas
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27
+Description-Content-Type: text/markdown
+
+# custom-domain-sdk
+
+Python client and origin helpers for the Custom Domain API. Pure Python 3.10+
+with `httpx`; no dependency on the service itself.
+
+```
+pip install custom-domain-sdk        # from PyPI; from a checkout: pip install ./sdk
+```
+
+## Quick start: register a workspace domain
+
+```python
+from custom_domain import Client
+
+client = Client("https://domains.example.net", credential="cd_...")  # credential from the operator
+
+domain = client.create_domain(
+    "forms.customer.example",  # the customer's exact subdomain
+    reference="ws_8f3a1c",  # your workspace id, returned to you on every request
+    idempotency_key="signup-ws_8f3a1c",  # makes the call safe to retry
+)
+print(domain.status)  # pending_dns
+print(domain.render_dns_instructions())
+```
+
+prints something like
+
+```
+Create these DNS records for forms.customer.example:
+
+TXT   _custom-domain-challenge.forms.customer.example  ->  custom-domain-verify=...
+      purpose: ownership. Create a TXT record with exactly this name and value. ...
+CNAME forms.customer.example  ->  acme.edge.example.net
+      purpose: routing. Point the hostname at the target with a CNAME record. ...
+```
+
+Show both records to the customer as returned; each carries `help` text for
+the usual DNS console mistakes. Nothing here requires knowing anything about
+the edge or Caddy.
+
+Later:
+
+```python
+domain = client.get_domain(domain.id)
+for check in domain.checks:
+    print(check.type, check.status, check.error_code)
+if not domain.is_ready:
+    client.request_recheck(domain.id)  # after the customer fixed DNS; rate limited
+for d in client.iter_domains(reference="ws_8f3a1c"):
+    ...
+client.delete_domain(domain.id)
+```
+
+## Errors
+
+Every API error raises a subclass of `custom_domain.ApiError` with `status`,
+the stable `code` from the API, `message` and `details`:
+`AuthenticationError` (401), `NotFoundError` (404), `ConflictError` (409, for
+example `hostname_already_claimed`), `ValidationError` (422, for example
+`apex_not_supported`), `RateLimitedError` (429, with `retry_after`),
+`ServerError` (5xx). `TransportError` means no HTTP response was received.
+
+## Timeouts and retries
+
+Each request has a 10 second timeout (`Client(timeout=...)`). Requests that
+are safe to repeat, that is `GET`, `DELETE`, and `create_domain` **when an
+idempotency key is given**, are retried up to `max_retries` (default 2) on
+connection errors, timeouts, 429 (waiting `Retry-After`) and 5xx, with
+exponential backoff. A create without an idempotency key and a recheck are
+never retried by the client: retrying a create could register twice and a
+recheck is rate limited, so the caller decides.
+
+## Verifying requests at your origin
+
+The edge adds `X-Custom-Domain-Assertion` to every proxied request. Select
+the workspace from it and from nothing else.
+
+ASGI (FastAPI, Starlette, and others):
+
+```python
+from custom_domain import CustomDomainMiddleware
+
+app.add_middleware(
+    CustomDomainMiddleware,
+    keys={
+        "1": "<EDGE_ASSERTION_KEYS secret from the operator>"
+    },  # current and previous key during rotation
+    application_id="<your application id>",
+    workspace_lookup=load_workspace,  # returns the workspace for a reference, or None
+    on_missing="reject",  # "passthrough" if this app also serves its own domain
+)
+
+
+@app.get("/")
+def home(request: Request):
+    assertion = request.state.custom_domain  # None only with on_missing="passthrough"
+    workspace = load_workspace(assertion.reference)
+```
+
+The middleware also answers `GET /.well-known/custom-domain-workspace`: it
+verifies the assertion, calls your `workspace_lookup` with the reference, and
+returns the reference only when the lookup confirms the workspace exists
+(404 otherwise). The service's lifecycle worker uses that answer to prove
+that routing and tenant selection really work before it marks a domain
+ready, so `workspace_lookup` must consult the same source your request
+handlers use.
+
+Any framework:
+
+```python
+from custom_domain import WorkspaceResolver, AssertionInvalid
+
+resolver = WorkspaceResolver(keys={"1": "..."}, application_id="...")
+try:
+    assertion = resolver.resolve(request.headers, request.host)
+except AssertionInvalid as exc:
+    return forbidden(exc.code)  # missing, expired, bad_signature, wrong_application, ...
+```
+
+Origins should only be reachable from the edge (network rules), or treat any
+request without a valid assertion as a direct call and refuse it.
+
+## Webhooks
+
+```python
+from custom_domain import verify_webhook, parse_event, SignatureInvalid
+
+hook = client.create_webhook(
+    "https://app.acme.example/hooks/custom-domain", ["domain.ready", "domain.deleted"]
+)
+store(hook.secret)  # shown once
+
+# in your handler
+try:
+    verify_webhook(
+        request.headers.get("X-Custom-Domain-Signature"), body, secrets=[current, previous]
+    )
+except SignatureInvalid:
+    return 400
+event = parse_event(body)  # event.id, event.type, event.created_at, event.domain
+```
+
+Deliveries are at least once and may arrive out of order: deduplicate by
+`event.id` and compare `event.created_at` before moving state. A complete
+consumer is in `examples/webhook_consumer.py`.
+
+## Local development versus production
+
+Against the local Compose environment (`DISABLE_HTTPS=true`,
+`ORIGIN_ALLOW_PRIVATE=true`), the edge serves plain HTTP, the certificate
+check is marked not applicable, and origins on private addresses are
+accepted. In production the edge obtains real certificates on demand at the
+first handshake after DNS points to it, verifies origin TLS, refuses private
+origin and webhook addresses, and a domain becomes `ready` only after the
+HTTPS probe through the edge returns the right workspace. Customer DNS
+changes take up to the record TTL to be observed; the API's `checks` show the
+last observation and the next attempt.
+
+## Compatibility
+
+The SDK follows the API's `v1` contract. Minor SDK releases add fields and
+methods; a field the API stops sending is never removed within a major
+version. Unknown fields in API responses are ignored, so newer servers work
+with older SDKs. Python 3.10 and newer are supported.

custom_domain_sdk-0.1.0/README.md

@@ -0,0 +1,164 @@
+# custom-domain-sdk
+
+Python client and origin helpers for the Custom Domain API. Pure Python 3.10+
+with `httpx`; no dependency on the service itself.
+
+```
+pip install custom-domain-sdk        # from PyPI; from a checkout: pip install ./sdk
+```
+
+## Quick start: register a workspace domain
+
+```python
+from custom_domain import Client
+
+client = Client("https://domains.example.net", credential="cd_...")  # credential from the operator
+
+domain = client.create_domain(
+    "forms.customer.example",  # the customer's exact subdomain
+    reference="ws_8f3a1c",  # your workspace id, returned to you on every request
+    idempotency_key="signup-ws_8f3a1c",  # makes the call safe to retry
+)
+print(domain.status)  # pending_dns
+print(domain.render_dns_instructions())
+```
+
+prints something like
+
+```
+Create these DNS records for forms.customer.example:
+
+TXT   _custom-domain-challenge.forms.customer.example  ->  custom-domain-verify=...
+      purpose: ownership. Create a TXT record with exactly this name and value. ...
+CNAME forms.customer.example  ->  acme.edge.example.net
+      purpose: routing. Point the hostname at the target with a CNAME record. ...
+```
+
+Show both records to the customer as returned; each carries `help` text for
+the usual DNS console mistakes. Nothing here requires knowing anything about
+the edge or Caddy.
+
+Later:
+
+```python
+domain = client.get_domain(domain.id)
+for check in domain.checks:
+    print(check.type, check.status, check.error_code)
+if not domain.is_ready:
+    client.request_recheck(domain.id)  # after the customer fixed DNS; rate limited
+for d in client.iter_domains(reference="ws_8f3a1c"):
+    ...
+client.delete_domain(domain.id)
+```
+
+## Errors
+
+Every API error raises a subclass of `custom_domain.ApiError` with `status`,
+the stable `code` from the API, `message` and `details`:
+`AuthenticationError` (401), `NotFoundError` (404), `ConflictError` (409, for
+example `hostname_already_claimed`), `ValidationError` (422, for example
+`apex_not_supported`), `RateLimitedError` (429, with `retry_after`),
+`ServerError` (5xx). `TransportError` means no HTTP response was received.
+
+## Timeouts and retries
+
+Each request has a 10 second timeout (`Client(timeout=...)`). Requests that
+are safe to repeat, that is `GET`, `DELETE`, and `create_domain` **when an
+idempotency key is given**, are retried up to `max_retries` (default 2) on
+connection errors, timeouts, 429 (waiting `Retry-After`) and 5xx, with
+exponential backoff. A create without an idempotency key and a recheck are
+never retried by the client: retrying a create could register twice and a
+recheck is rate limited, so the caller decides.
+
+## Verifying requests at your origin
+
+The edge adds `X-Custom-Domain-Assertion` to every proxied request. Select
+the workspace from it and from nothing else.
+
+ASGI (FastAPI, Starlette, and others):
+
+```python
+from custom_domain import CustomDomainMiddleware
+
+app.add_middleware(
+    CustomDomainMiddleware,
+    keys={
+        "1": "<EDGE_ASSERTION_KEYS secret from the operator>"
+    },  # current and previous key during rotation
+    application_id="<your application id>",
+    workspace_lookup=load_workspace,  # returns the workspace for a reference, or None
+    on_missing="reject",  # "passthrough" if this app also serves its own domain
+)
+
+
+@app.get("/")
+def home(request: Request):
+    assertion = request.state.custom_domain  # None only with on_missing="passthrough"
+    workspace = load_workspace(assertion.reference)
+```
+
+The middleware also answers `GET /.well-known/custom-domain-workspace`: it
+verifies the assertion, calls your `workspace_lookup` with the reference, and
+returns the reference only when the lookup confirms the workspace exists
+(404 otherwise). The service's lifecycle worker uses that answer to prove
+that routing and tenant selection really work before it marks a domain
+ready, so `workspace_lookup` must consult the same source your request
+handlers use.
+
+Any framework:
+
+```python
+from custom_domain import WorkspaceResolver, AssertionInvalid
+
+resolver = WorkspaceResolver(keys={"1": "..."}, application_id="...")
+try:
+    assertion = resolver.resolve(request.headers, request.host)
+except AssertionInvalid as exc:
+    return forbidden(exc.code)  # missing, expired, bad_signature, wrong_application, ...
+```
+
+Origins should only be reachable from the edge (network rules), or treat any
+request without a valid assertion as a direct call and refuse it.
+
+## Webhooks
+
+```python
+from custom_domain import verify_webhook, parse_event, SignatureInvalid
+
+hook = client.create_webhook(
+    "https://app.acme.example/hooks/custom-domain", ["domain.ready", "domain.deleted"]
+)
+store(hook.secret)  # shown once
+
+# in your handler
+try:
+    verify_webhook(
+        request.headers.get("X-Custom-Domain-Signature"), body, secrets=[current, previous]
+    )
+except SignatureInvalid:
+    return 400
+event = parse_event(body)  # event.id, event.type, event.created_at, event.domain
+```
+
+Deliveries are at least once and may arrive out of order: deduplicate by
+`event.id` and compare `event.created_at` before moving state. A complete
+consumer is in `examples/webhook_consumer.py`.
+
+## Local development versus production
+
+Against the local Compose environment (`DISABLE_HTTPS=true`,
+`ORIGIN_ALLOW_PRIVATE=true`), the edge serves plain HTTP, the certificate
+check is marked not applicable, and origins on private addresses are
+accepted. In production the edge obtains real certificates on demand at the
+first handshake after DNS points to it, verifies origin TLS, refuses private
+origin and webhook addresses, and a domain becomes `ready` only after the
+HTTPS probe through the edge returns the right workspace. Customer DNS
+changes take up to the record TTL to be observed; the API's `checks` show the
+last observation and the next attempt.
+
+## Compatibility
+
+The SDK follows the API's `v1` contract. Minor SDK releases add fields and
+methods; a field the API stops sending is never removed within a major
+version. Unknown fields in API responses are ignored, so newer servers work
+with older SDKs. Python 3.10 and newer are supported.

custom_domain_sdk-0.1.0/custom_domain/__init__.py

@@ -0,0 +1,62 @@
+"""Custom Domain SDK.
+
+* :class:`Client` talks to the v1 API.
+* :func:`verify_assertion` and :class:`WorkspaceResolver` verify the signed
+  workspace assertion the edge adds to every proxied request.
+* :func:`verify_webhook` and :func:`parse_event` handle webhook deliveries.
+* :class:`CustomDomainMiddleware` does both for ASGI applications and serves
+  the workspace probe.
+"""
+
+from custom_domain.assertion import Assertion, AssertionInvalid, verify_assertion
+from custom_domain.client import Client
+from custom_domain.errors import (
+    ApiError,
+    AuthenticationError,
+    ConflictError,
+    NotFoundError,
+    RateLimitedError,
+    ServerError,
+    TransportError,
+    ValidationError,
+)
+from custom_domain.middleware import CustomDomainMiddleware, WorkspaceResolver
+from custom_domain.models import (
+    Check,
+    Delivery,
+    DnsRecord,
+    Domain,
+    Page,
+    Webhook,
+    WebhookEvent,
+)
+from custom_domain.webhooks import SignatureInvalid, parse_event, verify_webhook
+
+__all__ = [
+    "ApiError",
+    "Assertion",
+    "AssertionInvalid",
+    "AuthenticationError",
+    "Check",
+    "Client",
+    "ConflictError",
+    "CustomDomainMiddleware",
+    "Delivery",
+    "DnsRecord",
+    "Domain",
+    "NotFoundError",
+    "Page",
+    "RateLimitedError",
+    "ServerError",
+    "SignatureInvalid",
+    "TransportError",
+    "ValidationError",
+    "Webhook",
+    "WebhookEvent",
+    "WorkspaceResolver",
+    "parse_event",
+    "verify_assertion",
+    "verify_webhook",
+]
+
+__version__ = "0.1.0"