capwx 0.1.0__tar.gz

capwx-0.1.0/.gitattributes

@@ -0,0 +1,4 @@
+* text=auto
+src/capwx/contrib/django/static/capwx/* -text
+src/capwx/_vendor/hashwx/* -text
+*.wasm binary

capwx-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,91 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    name: ruff and pyright
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+      - name: Sync dependencies
+        run: uv sync --group dev --extra django --extra ninja
+      - name: ruff check
+        run: uv run ruff check .
+      - name: ruff format check
+        run: uv run ruff format --check .
+      - name: pyright (strict, src/capwx)
+        run: uv run pyright
+
+  unit:
+    name: unit (py${{ matrix.python }}, ${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+      - name: Install Python ${{ matrix.python }}
+        run: uv python install ${{ matrix.python }}
+      - name: Sync dependencies
+        run: uv sync --group dev --extra django --extra ninja --python ${{ matrix.python }}
+      - name: "Unit tests with coverage (fails under 90% on src/capwx)"
+        run: |
+          uv run --python ${{ matrix.python }} coverage run -m pytest
+          uv run coverage report
+
+  redis:
+    name: unit with Redis (ubuntu)
+    runs-on: ubuntu-latest
+    services:
+      redis:
+        image: redis:7
+        ports: ["6379:6379"]
+        options: >-
+          --health-cmd "redis-cli ping" --health-interval 5s --health-timeout 3s --health-retries 10
+    env:
+      REDIS_URL: redis://localhost:6379/0
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+      - name: Sync dependencies
+        run: uv sync --group dev --extra django --extra ninja --extra redis
+      - name: Redis store tests (not skipped here)
+        run: uv run pytest tests/test_stores.py -v
+
+  e2e:
+    name: browser e2e (chromium)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+      - name: Sync dependencies
+        run: uv sync --group dev --group e2e --extra django --extra ninja
+      - name: Install Chromium
+        run: uv run playwright install --with-deps chromium
+      - name: Browser e2e tests (real cap-widget)
+        run: uv run pytest -m e2e tests/e2e -v
+
+  node:
+    name: node interop (node 22)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+      - name: Sync dependencies
+        run: uv sync --group dev --extra django --extra ninja
+      - name: Node interop tests (capjs-core installed in a temp dir by the test)
+        run: uv run pytest -m node tests/test_interop_node.py -v

capwx-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,48 @@
+name: Release
+
+# Tag vX.Y.Z -> build the sdist and wheel, check them, publish to PyPI with Trusted Publishing
+# (OpenID Connect; no API token is stored in the repository).
+
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: build and check distributions
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+      - name: Build sdist and wheel
+        run: uv build
+      - name: The tag must match the package version
+        run: |
+          version="$(ls dist/capwx-*.whl | sed -E 's#.*/capwx-([^-]+)-py3.*#\1#')"
+          test "v${version}" = "${GITHUB_REF_NAME}"
+      - name: Check the artifacts contain everything a release ships
+        run: uv run --no-project python scripts/check_dist.py dist
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/capwx
+    permissions:
+      id-token: write  # Trusted Publishing: the job exchanges an OIDC token for a PyPI upload token
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

capwx-0.1.0/.gitignore

@@ -0,0 +1,44 @@
+# Build and distribution
+dist/
+build/
+*.egg-info/
+*.whl
+*.tar.gz
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Python caches and tooling
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.ruff_cache/
+.pyright/
+.mypy_cache/
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+
+# Environment and local secrets
+.env
+.env.*
+!.env.example
+*.local
+
+# Editors and OS
+.idea/
+.vscode/
+*.swp
+.DS_Store
+Thumbs.db
+
+# Node (scripts/gen_vectors.mjs, interop tests)
+node_modules/
+package-lock.json
+
+# Playwright
+test-results/
+playwright-report/

capwx-0.1.0/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Changelog
+
+All notable changes to this project are documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+
+## [0.1.0] - Unreleased
+
+First release. Pre-release until a `v0.1.0` tag is published to PyPI.
+
+### Added
+
+- Format-2 Cap protocol server: `create_challenge`, `redeem` and their async twins, for the
+  `hashwx`, `sha256-pow` and `instrumentation` protocols. Compatible with `capjs-core` 0.1.5 (verified
+  in both directions by the `node` test suite).
+- Verification tokens: `validate_token`, `siteverify` and async twins. Stored tokens (single use with a
+  store) and stateless tokens (valid until expiry).
+- Stores: `MemoryStore` (development), `DjangoCacheStore`, `RedisStore` and `AsyncRedisStore`.
+- Instrumentation: a generated probe script and a verifier, with automation detection and risk flags.
+- Django integration (`capwx.contrib.django`): settings with per-site overrides, endpoints under a
+  URL prefix of your choice, `{% capwx_scripts %}` and `{% capwx_widget %}` template tags,
+  `CapField`, `@require_cap`, CSRF modes, `BEFORE_CHALLENGE_HOOK` and `DIFFICULTY_HOOK`, and the
+  `capwx_check` management command.
+- Django Ninja integration (`capwx.contrib.ninja`): `build_router`, `install` and `CapRequired`.
+- Vendored assets: the server `hashwx.wasm` (LGPL-3.0, separate file) and the browser assets, each
+  with a pinned SHA-256 and `VERSIONS.json`. See [UPSTREAM.md](UPSTREAM.md).
+- Documentation: README, [SECURITY.md](SECURITY.md), [UPSTREAM.md](UPSTREAM.md) and
+  [docs/security-checklist.md](docs/security-checklist.md).
+
+### Security
+
+- `repr()` of `CapConfig` and of the Django site configuration no longer shows the secrets.
+- `DjangoCacheStore.take` is atomic where `cache.add` is atomic (Redis, Memcached, locmem), so a
+  verification token cannot be consumed twice by two concurrent requests. Previously it was a
+  get-then-delete.
+- `hashwx` and `sha256-pow` verification bound the difficulty they accept, as minting does. An empty
+  `sha256-pow` target matched every nonce.
+- `CapRequired(field="")` accepts only the header, as documented. An empty JSON key was accepted before.
+- A `DIFFICULTY_HOOK` or `BEFORE_CHALLENGE_HOOK` dotted path that cannot be imported is reported as
+  `ImproperlyConfigured`, not as a bare `ImportError`.

capwx-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.

capwx-0.1.0/NOTICE

@@ -0,0 +1,31 @@
+capwx
+Copyright 2026 capwx contributors
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).
+
+capwx is an unofficial Python implementation and is not affiliated with Cap.
+
+This product includes and/or is derived from the following third-party works:
+
+1. Cap (https://github.com/tiagozip/cap)
+   Copyright (c) tiagozip and Cap contributors.
+   Licensed under the Apache License, Version 2.0.
+   Pinned commit: 29bbe6fbe284786cdb0d4489e5040aee6042b2a4
+   Ported parts: core/src (capjs-core 0.1.5) protocol logic, instrumentation
+   generation and detection.
+   Vendored browser assets (src/capwx/contrib/django/static/capwx/):
+   cap-widget 0.1.58 (cap.min.js), @cap.js/wasm 0.0.8 (cap_wasm_bg.wasm),
+   pako 2.1.0 (pako_inflate.min.js, MIT).
+
+2. HashWX (https://github.com/tevador/hashwx)
+   Copyright (c) tevador.
+   Licensed under the GNU Lesser General Public License, Version 3.
+   Pinned commit: 74b567a31276a4c5d7cb232a5b7639467f49f961
+   Vendored binary: src/capwx/_vendor/hashwx/hashwx.wasm (also shipped as
+   static/capwx/hashwx.wasm). The licence text is in
+   src/capwx/_vendor/hashwx/LICENSE and static/capwx/hashwx-LICENSE.txt.
+   The HashWX source code is not included in capwx; the wasm binary is a
+   separate file that can be replaced with a user-supplied build
+   (config option hashwx_wasm_path).
+
+Full details, pins and the re-sync procedure are in UPSTREAM.md.