qkdsec 0.2.0__tar.gz

qkdsec-0.2.0/.github/workflows/ci.yml

@@ -0,0 +1,63 @@
+name: CI
+
+on:
+  push:
+    branches: [main, dev]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    name: Tests on Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Install package with all extras
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[all,test]"
+
+      - name: Run tests
+        run: pytest -v
+
+  build:
+    name: Build distributions
+    runs-on: ubuntu-latest
+    needs: test
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build sdist and wheel
+        run: python -m build
+
+      - name: Check distributions
+        run: twine check dist/*
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/

qkdsec-0.2.0/.github/workflows/publish.yml

@@ -0,0 +1,70 @@
+name: Publish to PyPI
+
+# Publishes on tag push (e.g., v0.1.0). Uses PyPI Trusted Publishing (OIDC) —
+# no API tokens stored. Before first use, configure the trusted publisher at:
+#   https://pypi.org/manage/account/publishing/
+# with: project=qkdsec, owner=John-Jepsen, repo=qkdsec, workflow=publish.yml.
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    name: Build distributions
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build sdist and wheel
+        run: python -m build
+
+      - name: Verify distributions
+        run: twine check dist/*
+
+      - name: Verify tag matches package version
+        run: |
+          TAG="${GITHUB_REF#refs/tags/v}"
+          PKG_VERSION=$(python -c "import tomllib; print(tomllib.load(open('pyproject.toml','rb'))['project']['version'])")
+          if [ "$TAG" != "$PKG_VERSION" ]; then
+            echo "Tag $TAG does not match package version $PKG_VERSION"
+            exit 1
+          fi
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs: build
+    environment:
+      name: pypi
+      url: https://pypi.org/p/qkdsec
+    permissions:
+      id-token: write   # Required for PyPI trusted publishing (OIDC)
+
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

qkdsec-0.2.0/.gitignore

@@ -0,0 +1,38 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+.Python
+build/
+dist/
+*.egg-info/
+*.egg
+wheels/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+
+# Editors
+.idea/
+.vscode/
+*.swp
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Sphinx
+docs/_build/
+docs/_static/
+docs/_templates/

qkdsec-0.2.0/.readthedocs.yaml

@@ -0,0 +1,24 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: false
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+        - async
+        - proofs
+        - sim
+
+formats:
+  - htmlzip
+  - pdf

qkdsec-0.2.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 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 or hard drive failure, 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 Support. 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 support.
+
+   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 John Jepsen
+
+   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.

qkdsec-0.2.0/PKG-INFO

@@ -0,0 +1,215 @@
+Metadata-Version: 2.4
+Name: qkdsec
+Version: 0.2.0
+Summary: A developer toolkit for Quantum Key Distribution: numerical security proofs, BB84 simulation, and a full ETSI GS QKD 014 client with built-in conformance probe
+Author-email: John Jepsen <jjepsen15@protonmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/John-Jepsen/qkdsec
+Project-URL: Repository, https://github.com/John-Jepsen/qkdsec
+Project-URL: Issues, https://github.com/John-Jepsen/qkdsec/issues
+Keywords: qkd,quantum,cryptography,bb84,etsi,security
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Security :: Cryptography
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.28
+Provides-Extra: proofs
+Requires-Dist: cvxpy>=1.5; extra == "proofs"
+Requires-Dist: numpy>=1.24; extra == "proofs"
+Requires-Dist: scipy>=1.10; extra == "proofs"
+Provides-Extra: proofs-mosek
+Requires-Dist: mosek>=10; extra == "proofs-mosek"
+Provides-Extra: proofs-diff
+Requires-Dist: cvxpylayers>=0.1.6; extra == "proofs-diff"
+Requires-Dist: torch>=2; extra == "proofs-diff"
+Provides-Extra: sim
+Requires-Dist: qiskit>=2.0; extra == "sim"
+Requires-Dist: qiskit-aer>=0.17; extra == "sim"
+Provides-Extra: async
+Requires-Dist: httpx>=0.27; extra == "async"
+Provides-Extra: cli
+Requires-Dist: typer>=0.12; extra == "cli"
+Requires-Dist: rich>=13; extra == "cli"
+Provides-Extra: doctor
+Requires-Dist: httpx>=0.27; extra == "doctor"
+Requires-Dist: typer>=0.12; extra == "doctor"
+Requires-Dist: rich>=13; extra == "doctor"
+Provides-Extra: docs
+Requires-Dist: sphinx>=7; extra == "docs"
+Requires-Dist: furo>=2024.5; extra == "docs"
+Requires-Dist: myst-parser>=3; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints>=2; extra == "docs"
+Requires-Dist: sphinx-copybutton>=0.5; extra == "docs"
+Provides-Extra: all
+Requires-Dist: cvxpy>=1.5; extra == "all"
+Requires-Dist: numpy>=1.24; extra == "all"
+Requires-Dist: scipy>=1.10; extra == "all"
+Requires-Dist: qiskit>=2.0; extra == "all"
+Requires-Dist: qiskit-aer>=0.17; extra == "all"
+Requires-Dist: httpx>=0.27; extra == "all"
+Requires-Dist: typer>=0.12; extra == "all"
+Requires-Dist: rich>=13; extra == "all"
+Provides-Extra: test
+Requires-Dist: pytest>=7; extra == "test"
+Requires-Dist: pytest-asyncio>=0.23; extra == "test"
+Requires-Dist: responses>=0.24; extra == "test"
+Requires-Dist: respx>=0.21; extra == "test"
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
+Requires-Dist: responses>=0.24; extra == "dev"
+Requires-Dist: respx>=0.21; extra == "dev"
+Requires-Dist: build>=1.0; extra == "dev"
+Requires-Dist: twine>=5.0; extra == "dev"
+Dynamic: license-file
+
+# qkdsec
+
+[![PyPI](https://img.shields.io/pypi/v/qkdsec.svg)](https://pypi.org/project/qkdsec/)
+[![Python](https://img.shields.io/pypi/pyversions/qkdsec.svg)](https://pypi.org/project/qkdsec/)
+[![CI](https://github.com/John-Jepsen/qkdsec/actions/workflows/ci.yml/badge.svg)](https://github.com/John-Jepsen/qkdsec/actions/workflows/ci.yml)
+[![Docs](https://readthedocs.org/projects/qkdsec/badge/?version=latest)](https://qkdsec.readthedocs.io/)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+
+A developer toolkit for Quantum Key Distribution: numerical security proofs, BB84 simulation, and an ETSI GS QKD 014 client with a built-in KME conformance probe.
+
+`qkdsec` is one library with three subpackages, each addressing a different need:
+
+- **`qkdsec.proofs`** — Provable secret-key-rate lower bounds for QKD protocols under given channel models.
+- **`qkdsec.sim`** — Working BB84 simulator (Qiskit and classical backends).
+- **`qkdsec.client`** — Full ETSI GS QKD 014 v1.1.1 client (sync **and** async), plus a `qkdsec doctor` conformance probe that audits any KME.
+
+## What sets it apart
+
+- **`qkdsec doctor`** — point it at any KME and get a colored conformance report against ETSI GS QKD 014 v1.1.1. Catches spec violations before they bite production. JSON output for CI; HTML output for sharing.
+- **Full spec coverage** — multicast key delivery (`additional_slave_SAE_IDs`), mandatory/optional vendor extensions, and container-level metadata. Most KME clients only implement the happy path.
+- **Sync and async** — `ETSI014Client` for scripts and `AsyncETSI014Client` for FastAPI / asyncio services. Same surface, share parsers.
+- **Lightweight default** — `pip install qkdsec` brings only `requests`. Heavy deps (CVXPY, Qiskit, httpx, typer) are behind extras.
+
+## Install
+
+```bash
+# ETSI 014 client only (sync, lightweight)
+pip install qkdsec
+
+# + async client
+pip install "qkdsec[async]"
+
+# + qkdsec CLI and doctor (recommended for ops)
+pip install "qkdsec[doctor]"
+
+# + numerical security proofs
+pip install "qkdsec[proofs]"
+
+# + BB84 simulator (Qiskit backend)
+pip install "qkdsec[sim]"
+
+# Everything
+pip install "qkdsec[all]"
+```
+
+## Quick start
+
+### Audit a KME in 30 seconds
+
+```bash
+qkdsec doctor https://kme.example.com \
+    --slave-sae-id sae-bob \
+    --cert alice.crt --key alice.key
+```
+
+```
+qkdsec doctor — https://kme.example.com
+slave SAE: sae-bob
+
+  PASS  reachability         [§5.2]      45 ms
+  PASS  status_fields        [§5.2.2]    12 ms
+  PASS  enc_keys_get         [§5.3]     108 ms
+  PASS  enc_keys_post        [§5.3]      94 ms
+  PASS  enc_keys_caps        [§5.3]      31 ms
+  WARN  extensions_accepted  [§5.3.2]    28 ms
+        KME returned HTTP 400 with extension_optional present.
+  PASS  dec_keys_roundtrip   [§5.4]     142 ms
+  PASS  error_contract_404   [§5.4]      19 ms
+  PASS  error_contract_400   [§5.3]      18 ms
+  PASS  latency                          14 ms
+
+  Summary: 9 pass, 1 warn, 0 fail, 0 skip
+  Verdict: CONFORMANT  (511 ms total)
+```
+
+Exit code 0 if conformant, 1 if not — drop in CI directly.
+
+### Fetch a key (sync)
+
+```python
+from qkdsec.client import ETSI014Client
+
+with ETSI014Client(
+    "https://kme.example.com",
+    client_cert=("alice.crt", "alice.key"),
+) as kme:
+    keys = kme.get_enc_keys("sae-bob", number=1, size=256)
+    print(keys[0].key.hex())
+```
+
+### Fetch a key (async)
+
+```python
+from qkdsec.client.aio import AsyncETSI014Client
+
+async with AsyncETSI014Client(
+    "https://kme.example.com",
+    client_cert=("alice.crt", "alice.key"),
+) as kme:
+    keys = await kme.get_enc_keys("sae-bob", number=1, size=256)
+```
+
+### Compute a provable key rate
+
+```python
+from qkdsec.proofs import key_rate, BB84, DepolarizingChannel
+
+result = key_rate(BB84(), DepolarizingChannel(qber=0.03))
+print(f"Lower bound: {result.r_lower:.4f} bits/pulse")
+```
+
+### Simulate a BB84 exchange
+
+```python
+from qkdsec.sim import BB84Protocol
+
+result = BB84Protocol(error_rate=0.01).run(n_bits=4096)
+if result.secure:
+    print(result.final_key.hex())
+```
+
+## Standards
+
+- **ETSI GS QKD 014 v1.1.1** — REST API for key delivery (full coverage)
+- **BB84** (Bennett & Brassard, 1984)
+- **Shor–Preskill** asymptotic key rate
+- **Tomamichel et al.** finite-key correction
+- **Two-decoy state** estimation
+
+## Documentation
+
+Full docs at [qkdsec.readthedocs.io](https://qkdsec.readthedocs.io/) — quickstart, doctor guide, async guide, spec coverage walk-through, and API reference.
+
+## Scope and non-goals
+
+- **What this is:** a developer-facing library for the three roles above.
+- **What this is not:** a complete QKD network, a hybrid QKD+PQC system, or a vendor-specific SDK. QKD itself requires quantum hardware (single-photon sources and detectors over an optical channel). This library helps you build *around* that hardware.
+
+## License
+
+Apache-2.0