pkcs11-check 0.1.0__tar.gz

pkcs11_check-0.1.0/.dockerignore

@@ -0,0 +1,33 @@
+# Third-party test vector data (bind-mounted at runtime, not copied)
+data/
+
+# Local builds (large, not needed in Docker)
+local-builds/
+
+# Artifacts from previous Docker runs
+artifacts/
+artifacts*/
+
+# All dotfiles/dirs (caches, editor state, git)
+.*
+
+# Python caches
+**/__pycache__/
+*.pyc
+
+# Documentation — not needed at runtime
+docs/
+
+# Host-side scripts (fetch-data, analysis, etc.)
+scripts/
+
+# Meta-tests (pkcs11-check's own tests, not product testcases)
+tests/
+
+# Dockerfiles and compose (not needed inside containers; run-*.sh ARE needed)
+docker/*/Dockerfile*
+docker/docker-compose*.yml
+
+# Root analysis/investigation/dev files
+CLAUDE.md
+AGENTS.md

pkcs11_check-0.1.0/.gitignore

@@ -0,0 +1,20 @@
+__pycache__/
+*.pyc
+*.egg-info/
+dist/
+build/
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+*.so
+.venv/
+.hypothesis/
+.claude/*.local.md
+results/
+artifacts/
+artifacts*/
+.pkcs11-check-isolation-state.json
+.pkcs11-check-isolation-policy.json
+local-builds/bouncyhsm/
+local-builds/data/
+.worktrees/

pkcs11_check-0.1.0/.python-version

@@ -0,0 +1 @@
+3.13

pkcs11_check-0.1.0/CHANGELOG.md

@@ -0,0 +1,97 @@
+# Changelog
+
+## [0.1.0] - 2026-05-04
+
+First public release.
+
+This release packages the internal beta work into a public CLI-first PKCS#11 test
+suite. It includes the command line app, pytest plugin, pure-ctypes raw binding,
+provider isolation, security regression coverage, Docker/local provider tooling,
+and release-readiness hardening needed for use across multiple projects.
+
+### Features
+
+- **PKCS#11 interface negotiation** - automatic v2.40/v3.0/v3.1/v3.2 detection
+  with `--interface` forcing.
+- **Crash survival** - per-file subprocess isolation keeps the runner alive when
+  loaded modules segfault or abort.
+- **Pure ctypes binding** (`pkcs11_check.raw`) - v2.40, v3.0 message-based, and
+  v3.2 KEM surfaces without C compilation.
+- **Large product test suite** - mechanism, compliance, security, CVE, Wycheproof,
+  ACVP, CCTV, X.509, and PQC coverage.
+- **pytest plugin** - run project-specific tests with `pytest --p11-module=...`.
+- **CLI** - `pkcs11-check test`, `info`, `state`, `compliance-report`,
+  `fetch-data`, and related helper commands.
+- **Provider tooling** - local and Docker flows for SoftHSM2, Kryoptic, NSS,
+  OpenCryptoki, TPM2, BouncyHSM, pkcs11-mock, qryptotoken, and related targets.
+
+### Security and Compliance Coverage
+
+- Added regression coverage for known PKCS#11 vulnerability classes, including
+  Tookan-style attribute escalation, sensitive/extractable downgrade checks,
+  Bleichenbacher/Manger RSA oracle families, CBC padding-oracle patterns, KWP
+  error-path behavior, arithmetic/boundary validation, and API state misuse.
+- Added hard-fail gates for access-control and attribute-enforcement issues such
+  as `CKA_TRUSTED`, `CKA_COPYABLE`, `CKA_DESTROYABLE`,
+  `CKA_WRAP_WITH_TRUSTED`, and non-extractable key handling.
+- Added authenticated wrap, ECDH AES key wrap, v3.0 message API, multipart state,
+  and cross-process isolation checks.
+- Added module quirk registry support so provider-specific behavior is explicit,
+  documented, and does not silently hide real failures.
+- Expanded `docs/module-issues.md` and `docs/cve-regression.md` with findings and
+  coverage notes discovered during internal provider validation.
+
+### Release Hardening
+
+- Hardened `fetch-data` by requiring HTTPS downloads and rejecting unsafe archive
+  members that could escape the extraction directory.
+- Removed shell invocation from OpenSSL interop tests.
+- Replaced silent broad `except Exception: pass` patterns with specific handling
+  or direct failure paths.
+- Annotated intentional legacy PKCS#11 crypto references, including SHA-1 and
+  AES-ECB compatibility checks, so scanner output separates deliberate mechanism
+  coverage from unsafe application crypto.
+- Added release hygiene tests for broad exception swallowing, `shell=True`,
+  non-security SHA-1 context, legacy crypto annotations, public-doc path leaks,
+  and packaging hygiene.
+- Verified the package with linting, formatting, strict mypy, meta-tests,
+  product-test collection, SoftHSM2 smoke, dependency audit, Bandit medium/high
+  scan, credential-focused secret scan, wheel/sdist build, artifact scrub, and
+  isolated wheel install smoke.
+
+### Supported modules
+
+- SoftHSM2 2.7.0
+- Kryoptic 1.5.0+PQC (v3.2)
+- NSS 3.120.1 / 3.121.0 PQC
+- OpenCryptoki 3.26
+- tpm2-pkcs11 1.9.0
+- BouncyHSM 2.0.1
+- pkcs11-mock 2.0.0
+- qryptotoken 0.4.1
+
+### Test Results (2026-04-09)
+
+Internal baseline results before the public release candidate. These numbers are
+kept as release evidence from the deliberate provider validation run and should
+only be refreshed after another full provider validation pass.
+
+Tested 6 modules, ~510K total test executions across 237 test files:
+
+| Module | Passed | Failed | Skipped | Xfailed | Total |
+|--------|-------:|-------:|--------:|--------:|------:|
+| OpenCryptoki (master) | 75,265 | 2,405 | 8,512 | 54 | 86,242 |
+| BouncyHSM (v2.0.1) | 66,307 | 22,282 | 8,694 | 59 | 97,345 |
+| Kryoptic (main) | 65,674 | 2,831 | 32,218 | 68 | 100,791 |
+| SoftHSM2 (main) | 60,820 | 2,697 | 16,943 | 41 | 80,501 |
+| NSS (main) | 46,185 | 2,018 | 34,454 | 105 | 82,763 |
+| tpm2-pkcs11 (1.9.1) | 8,202 | 5,028 | 47,977 | 2 | 62,242 |
+
+Key findings: 2 CRITICAL (NSS sensitive key exposure, Tookan CKA_EXTRACTABLE escalation),
+9 HIGH-severity issues across 4 modules, real SIGSEGV crashes in all 6 modules.
+See [docs/release-v0.1.0.md](docs/release-v0.1.0.md) for full breakdown.
+
+### Requirements
+
+- Python 3.13+
+- Linux (primary), macOS and Windows where ctypes works

pkcs11_check-0.1.0/LICENSE-APACHE

@@ -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 2026 Denis Mingulov
+
+   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.

pkcs11_check-0.1.0/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Denis Mingulov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pkcs11_check-0.1.0/PKG-INFO

@@ -0,0 +1,169 @@
+Metadata-Version: 2.4
+Name: pkcs11-check
+Version: 0.1.0
+Summary: CLI-first PKCS#11 test suite with segfault survival, interface forcing, and pytest plugin
+Project-URL: Homepage, https://github.com/mingulov/pkcs11-check
+Project-URL: Repository, https://github.com/mingulov/pkcs11-check
+Project-URL: Documentation, https://github.com/mingulov/pkcs11-check/tree/main/docs
+Project-URL: Issues, https://github.com/mingulov/pkcs11-check/issues
+Author-email: Denis Mingulov <denis@mingulov.com>
+License-Expression: MIT OR Apache-2.0
+License-File: LICENSE-APACHE
+License-File: LICENSE-MIT
+License-File: THIRD_PARTY_LICENSES.md
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Security :: Cryptography
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.13
+Requires-Dist: asn1crypto>=1.5
+Requires-Dist: cryptography>=46.0.5
+Requires-Dist: hypothesis>=6.100
+Requires-Dist: psutil>=5.9
+Requires-Dist: pydantic-settings[toml]>=2.0
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pytest-reportlog>=1.0.0
+Requires-Dist: pytest-timeout>=2.3
+Requires-Dist: pytest-xdist>=3.5
+Requires-Dist: pytest>=8.0
+Requires-Dist: rich>=13.0
+Requires-Dist: typer>=0.15
+Provides-Extra: dev
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# pkcs11-check
+
+CLI-first PKCS#11 test suite with segfault survival, interface forcing, and pytest plugin.
+
+## What it does
+
+pkcs11-check runs comprehensive tests against PKCS#11 modules (hardware HSMs, software tokens, smart cards). It catches:
+
+- **Crashes and segfaults** — per-file subprocess isolation recovers from SIGSEGV
+- **CKR return code violations** — different spec conditions checked against OASIS PKCS#11 standard
+- **CVE regressions** — tests for known CVEs across NSS, SoftHSM2, TPM2, OpenCryptoki
+- **Security policy violations** — Tookan paper vectors, attribute fuzzing, padding oracle detection
+- **Interface negotiation bugs** — v2.40/v3.0/v3.1/v3.2 with automatic fallback
+
+## Quick start
+
+```bash
+# Install
+git clone https://github.com/mingulov/pkcs11-check
+cd pkcs11-check
+uv sync
+
+# Run against SoftHSM2
+bash local-builds/build.sh softhsm2
+bash local-builds/test.sh softhsm2
+
+# Run against Kryoptic (v3.2 with PQC)
+bash local-builds/build.sh kryoptic
+bash local-builds/test.sh kryoptic
+
+# Run against system NSS
+bash local-builds/test.sh nss-softokn
+```
+
+### From PyPI (installed)
+
+```bash
+pip install pkcs11-check
+pkcs11-check fetch-data all # download test vectors (~800 MB)
+pkcs11-check test --module /path/to/module.so --pin 1234
+```
+
+## Test suite
+
+Test categories:
+
+| Category | Description |
+|----------|-------------|
+| Core crypto | AES, RSA, ECDSA, EdDSA, HMAC, digest |
+| Wycheproof | Edge-case vectors from C2SP |
+| PQC (v3.2) | ML-KEM, ML-DSA, SLH-DSA |
+| CKR compliance | Return code verification per OASIS spec |
+| CVE regression | Known vulnerability tests |
+| Security | Attribute fuzz, Tookan, handle reuse |
+| Stress | Threading, resource exhaustion |
+
+## Supported modules
+
+| Module | Version | Status |
+|--------|---------|--------|
+| SoftHSM2 | 2.7.0 | Full support |
+| Kryoptic | 1.5.0+PQC | Full support (v3.2) |
+| NSS softokn | system | Crypto services (slot 0) |
+| OpenCryptoki | 3.26 | Docker only |
+| pkcs11-mock | 2.0.0 | Stub testing |
+| tpm2-pkcs11 | 1.9.0 | Hardware TPM |
+| BouncyHSM | 2.0.1 | Docker only |
+| qryptotoken | 0.4.1 | Docker only |
+
+## Known limitations in v0.1.0
+
+- SO login is not implemented yet, so trusted-certificate import with
+  `CKA_TRUSTED=True` is not fully covered through `CKU_SO` workflows.
+- CloudHSM/Thales in-band IV profiles, proxy/loader mutable-parameter
+  preservation checks, and broader mutable-output simulator targets are tracked
+  as post-v0.1.0 interop work.
+
+## Architecture
+
+```
+src/pkcs11_check/
+  raw/          — pure ctypes PKCS#11 binding (v2.40-v3.2, PQC)
+  cli/          — typer CLI (test, info, version commands)
+  core/         — module loader, isolation runner, preflight
+  testcases/    — test files (the product)
+    ckr/        — CKR return code compliance tests
+  plugin.py     — pytest plugin (markers, fixtures, collection)
+  fixtures.py   — p11_session, p11_module, p11_config
+  config.py     — four-layer config (CLI > env > TOML > defaults)
+
+local-builds/   — build scripts for soft token providers
+docker/         — Docker test targets
+```
+
+## Key features
+
+- **`pkcs11_check.raw`** — pure Python ctypes binding with v2.40/v3.0/v3.1/v3.2 interface negotiation, 50+ PQC mechanisms, all 68 standard functions
+- **`--isolation file`** mode runs each test file in its own subprocess — crashes don't kill the suite
+- **`--ckr-strict`** mode enforces exact OASIS spec CKR codes (not just "any error")
+- **Wycheproof + ACVP vectors** — cross-verification against C2SP and NIST test vectors
+
+## Documentation
+
+- `docs/architecture.md` — codebase structure and test writing guide
+- `docs/commands.md` — build, test, and Docker commands
+- `docs/module-issues.md` — per-module bugs and quirks
+- `docs/mechanism-output-parameters.md` — generated IV/nonce/tag output-parameter coverage
+- `docs/docker-provider-results.md` — release Docker provider source and result snapshot
+- `docs/todo.md` — public roadmap and known limitations
+- `docs/cve-regression.md` — CVE coverage tracker
+- `docs/file-isolation.md` — isolation runner design
+- `docs/docker-artifacts.md` — Docker test runner contract
+
+## License
+
+Licensed under either of
+
+- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
+- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+
+at your option.
+
+### Third-party attributions
+
+pkcs11-check bundles the public-domain PKCS#11 v3.2 header from
+`latchset/pkcs11-headers`, and its `fetch-data` command downloads test
+vectors from C2SP and NIST. See
+[`THIRD_PARTY_LICENSES.md`](THIRD_PARTY_LICENSES.md) for the full list and
+per-source license terms.

pkcs11_check-0.1.0/README.md

@@ -0,0 +1,129 @@
+# pkcs11-check
+
+CLI-first PKCS#11 test suite with segfault survival, interface forcing, and pytest plugin.
+
+## What it does
+
+pkcs11-check runs comprehensive tests against PKCS#11 modules (hardware HSMs, software tokens, smart cards). It catches:
+
+- **Crashes and segfaults** — per-file subprocess isolation recovers from SIGSEGV
+- **CKR return code violations** — different spec conditions checked against OASIS PKCS#11 standard
+- **CVE regressions** — tests for known CVEs across NSS, SoftHSM2, TPM2, OpenCryptoki
+- **Security policy violations** — Tookan paper vectors, attribute fuzzing, padding oracle detection
+- **Interface negotiation bugs** — v2.40/v3.0/v3.1/v3.2 with automatic fallback
+
+## Quick start
+
+```bash
+# Install
+git clone https://github.com/mingulov/pkcs11-check
+cd pkcs11-check
+uv sync
+
+# Run against SoftHSM2
+bash local-builds/build.sh softhsm2
+bash local-builds/test.sh softhsm2
+
+# Run against Kryoptic (v3.2 with PQC)
+bash local-builds/build.sh kryoptic
+bash local-builds/test.sh kryoptic
+
+# Run against system NSS
+bash local-builds/test.sh nss-softokn
+```
+
+### From PyPI (installed)
+
+```bash
+pip install pkcs11-check
+pkcs11-check fetch-data all # download test vectors (~800 MB)
+pkcs11-check test --module /path/to/module.so --pin 1234
+```
+
+## Test suite
+
+Test categories:
+
+| Category | Description |
+|----------|-------------|
+| Core crypto | AES, RSA, ECDSA, EdDSA, HMAC, digest |
+| Wycheproof | Edge-case vectors from C2SP |
+| PQC (v3.2) | ML-KEM, ML-DSA, SLH-DSA |
+| CKR compliance | Return code verification per OASIS spec |
+| CVE regression | Known vulnerability tests |
+| Security | Attribute fuzz, Tookan, handle reuse |
+| Stress | Threading, resource exhaustion |
+
+## Supported modules
+
+| Module | Version | Status |
+|--------|---------|--------|
+| SoftHSM2 | 2.7.0 | Full support |
+| Kryoptic | 1.5.0+PQC | Full support (v3.2) |
+| NSS softokn | system | Crypto services (slot 0) |
+| OpenCryptoki | 3.26 | Docker only |
+| pkcs11-mock | 2.0.0 | Stub testing |
+| tpm2-pkcs11 | 1.9.0 | Hardware TPM |
+| BouncyHSM | 2.0.1 | Docker only |
+| qryptotoken | 0.4.1 | Docker only |
+
+## Known limitations in v0.1.0
+
+- SO login is not implemented yet, so trusted-certificate import with
+  `CKA_TRUSTED=True` is not fully covered through `CKU_SO` workflows.
+- CloudHSM/Thales in-band IV profiles, proxy/loader mutable-parameter
+  preservation checks, and broader mutable-output simulator targets are tracked
+  as post-v0.1.0 interop work.
+
+## Architecture
+
+```
+src/pkcs11_check/
+  raw/          — pure ctypes PKCS#11 binding (v2.40-v3.2, PQC)
+  cli/          — typer CLI (test, info, version commands)
+  core/         — module loader, isolation runner, preflight
+  testcases/    — test files (the product)
+    ckr/        — CKR return code compliance tests
+  plugin.py     — pytest plugin (markers, fixtures, collection)
+  fixtures.py   — p11_session, p11_module, p11_config
+  config.py     — four-layer config (CLI > env > TOML > defaults)
+
+local-builds/   — build scripts for soft token providers
+docker/         — Docker test targets
+```
+
+## Key features
+
+- **`pkcs11_check.raw`** — pure Python ctypes binding with v2.40/v3.0/v3.1/v3.2 interface negotiation, 50+ PQC mechanisms, all 68 standard functions
+- **`--isolation file`** mode runs each test file in its own subprocess — crashes don't kill the suite
+- **`--ckr-strict`** mode enforces exact OASIS spec CKR codes (not just "any error")
+- **Wycheproof + ACVP vectors** — cross-verification against C2SP and NIST test vectors
+
+## Documentation
+
+- `docs/architecture.md` — codebase structure and test writing guide
+- `docs/commands.md` — build, test, and Docker commands
+- `docs/module-issues.md` — per-module bugs and quirks
+- `docs/mechanism-output-parameters.md` — generated IV/nonce/tag output-parameter coverage
+- `docs/docker-provider-results.md` — release Docker provider source and result snapshot
+- `docs/todo.md` — public roadmap and known limitations
+- `docs/cve-regression.md` — CVE coverage tracker
+- `docs/file-isolation.md` — isolation runner design
+- `docs/docker-artifacts.md` — Docker test runner contract
+
+## License
+
+Licensed under either of
+
+- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
+- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+
+at your option.
+
+### Third-party attributions
+
+pkcs11-check bundles the public-domain PKCS#11 v3.2 header from
+`latchset/pkcs11-headers`, and its `fetch-data` command downloads test
+vectors from C2SP and NIST. See
+[`THIRD_PARTY_LICENSES.md`](THIRD_PARTY_LICENSES.md) for the full list and
+per-source license terms.