shard-core 0.2.0__tar.gz

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

shard_core-0.2.0/LICENSE-MIT-0

@@ -0,0 +1,16 @@
+MIT No Attribution
+
+Copyright 2026 Protocol Wealth LLC
+
+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.
+
+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.

shard_core-0.2.0/PKG-INFO

@@ -0,0 +1,284 @@
+Metadata-Version: 2.4
+Name: shard-core
+Version: 0.2.0
+Summary: Authenticated local encryption and Shamir threshold recovery with offline workflows.
+Author: Protocol Wealth LLC
+License-Expression: Apache-2.0 OR MIT-0
+Project-URL: Homepage, https://protocolwealthllc.com/opensource/encryption
+Project-URL: Documentation, https://protocolwealthllc.com/opensource/encryption
+Project-URL: Repository, https://github.com/Protocol-Wealth/shard-core
+Project-URL: Issues, https://github.com/Protocol-Wealth/shard-core/issues
+Project-URL: Changelog, https://github.com/Protocol-Wealth/shard-core/blob/main/CHANGELOG.md
+Project-URL: Security, https://github.com/Protocol-Wealth/shard-core/security/policy
+Keywords: shamir,secret-sharing,encryption,aead,disaster-recovery,fordefi,slip39
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+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: Programming Language :: Python :: 3.14
+Classifier: Topic :: Security :: Cryptography
+Classifier: Environment :: Console
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: LICENSE-MIT-0
+Requires-Dist: pycryptodome>=3.20
+Provides-Extra: slip39
+Requires-Dist: shamir-mnemonic>=0.3.0; extra == "slip39"
+Requires-Dist: mnemonic>=0.20; extra == "slip39"
+Provides-Extra: test
+Requires-Dist: shamir-mnemonic>=0.3.0; extra == "test"
+Requires-Dist: mnemonic>=0.20; extra == "test"
+Requires-Dist: packaging>=26.2; extra == "test"
+Provides-Extra: dev
+Requires-Dist: shamir-mnemonic>=0.3.0; extra == "dev"
+Requires-Dist: mnemonic>=0.20; extra == "dev"
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Dynamic: license-file
+
+# shard-core
+
+[![CI](https://github.com/Protocol-Wealth/shard-core/actions/workflows/ci.yml/badge.svg)](https://github.com/Protocol-Wealth/shard-core/actions/workflows/ci.yml)
+[![Python 3.9+](https://img.shields.io/badge/python-3.9%2B-1f6feb)](https://www.python.org/)
+[![License: Apache--2.0 OR MIT--0](https://img.shields.io/badge/license-Apache--2.0%20OR%20MIT--0-2ea44f)](LICENSE)
+
+`shard-core` protects sensitive bytes and recovery phrases with authenticated
+encryption, threshold recovery, and fail-closed file handling.
+
+> **Security status:** `0.2.0` is the first stable release and has not received
+> an independent security audit. Tests and AI-assisted review are not a
+> security audit. Use synthetic material for evaluation and rehearse recovery
+> before protecting production secrets.
+
+## What it provides
+
+| Capability | Status |
+|---|---|
+| ChaCha20-Poly1305 authenticated encryption | Included |
+| Scrypt passphrase encryption | Included |
+| AEAD plus Shamir threshold protection | Included |
+| Corrupt-extra-share recovery and ambiguity detection | Included |
+| Fordefi Recovery Phrases workflow | Included |
+| Optional SLIP-39 support | `.[slip39]` extra |
+| Reproducible, hash-verified offline bundle pipeline | [Included](OFFLINE_BUILD.md) |
+| Implicit plaintext output or silent overwrite | Refused |
+
+## Architecture
+
+### Protect
+
+```text
+plaintext
+    |
+    | encrypt with random 32-byte data-encryption key (DEK)
+    v
+ChaCha20-Poly1305 --------------------> authenticated ciphertext C
+    ^                                               |
+    |                                               |
+random DEK -- Shamir split --> K1, K2, ... Kn       |
+                              |                      |
+                              +--> SHRD i = header + Ki + C
+```
+
+Each SHRD artifact contains a unique Shamir key share and the same ciphertext.
+That duplication is intentional: every valid threshold subset is self-contained.
+The trade-off is additional storage, not weaker confidentiality.
+
+The plaintext itself is never Shamir-split. A wrong key-share combination fails
+AEAD authentication instead of returning plausible but incorrect plaintext.
+
+### Recover
+
+```text
+supplied SHRD files
+    |
+    v
+parse and group candidate sets
+    |
+    v
+try bounded threshold combinations
+    |
+    v
+reconstruct DEK -> verify AEAD tag -> plaintext
+                       |
+                       +--> fail closed on corruption or ambiguity
+```
+
+See [THREAT_MODEL.md](THREAT_MODEL.md) for the security properties, assumptions,
+and non-goals.
+
+## Install
+
+Requires Python 3.9 or newer.
+
+### Quick install
+
+Use this path for evaluation and normal use on a connected host:
+
+```bash
+git clone --branch v0.2.0 --depth 1 \
+  https://github.com/Protocol-Wealth/shard-core.git
+cd shard-core
+python3 -m venv .venv
+. .venv/bin/activate
+python -m pip install .
+shard-core --version
+```
+
+This path may obtain dependencies from a package index. To add SLIP-39:
+
+```bash
+python -m pip install '.[slip39]'
+```
+
+For development:
+
+```bash
+python -m pip install -e '.[test]'
+```
+
+### Advanced verified build
+
+For a hash-locked, network-disabled, rootless Podman build and an installable
+offline bundle, follow [OFFLINE_BUILD.md](OFFLINE_BUILD.md). The top-level
+`install.sh` only dispatches to an already built offline bundle; it is not the
+quick installer.
+
+## Quickstart
+
+### Authenticated threshold shares
+
+```bash
+shard-core protect \
+  --threshold 2 \
+  --shares 3 \
+  --input secret.bin \
+  --out-dir shares
+
+shard-core verify-set --require-complete \
+  shares/share-01.txt \
+  shares/share-02.txt \
+  shares/share-03.txt
+
+shard-core recover \
+  --output recovered.bin \
+  shares/share-01.txt \
+  shares/share-03.txt
+```
+
+### Passphrase encryption
+
+```bash
+shard-core encrypt --input secret.bin --output secret.shen
+shard-core decrypt --input secret.shen --output recovered.bin
+```
+
+The commands prompt without echo. For controlled automation, use a private
+regular file with `--passphrase-file`; environment-variable passphrases emit a
+warning.
+
+### Fordefi backup choice
+
+Fordefi lets the operator choose among Public Key Upload, Recovery Phrases,
+and managed provider or hardware-backed methods.
+
+```text
+Fordefi backup method
+    |
+    +--> Public Key Upload / native CoinCover / Station70 / YubiKey
+    |        +--> public-key recovery path; shard-core is not required
+    |
+    +--> Recovery Phrases
+             +--> phrase -> SHEN plus separate credential
+             +--> phrase -> threshold SHRD shares
+```
+
+For the Recovery Phrases path, direct encryption is:
+
+```bash
+shard-core fordefi encrypt --output protocol-phrase.shen
+shard-core fordefi decrypt \
+  --input protocol-phrase.shen \
+  --output protocol-phrase.txt
+```
+
+Fordefi phrase entry is hidden and confirmed twice. Standard entry requires 12
+lowercase ASCII words; whitespace is canonicalized without changing spelling,
+order, or case. `shard-core` does not assume a Fordefi phrase is BIP-39.
+
+Follow [docs/FORDEFI-DISASTER-RECOVERY.md](docs/FORDEFI-DISASTER-RECOVERY.md)
+for method selection, `2-of-2` phrase custody, external-custodian role checks,
+and the final offline Fordefi recovery boundary.
+
+### SLIP-39
+
+Install `.[slip39]`, then use the explicit `slip39` command family for material
+independently confirmed to be compatible:
+
+```bash
+shard-core slip39 split \
+  --threshold 2 \
+  --shares 3 \
+  --bip39-file mnemonic.txt \
+  --out-dir slip39-shares
+
+shard-core slip39 combine \
+  --bip39 \
+  --output recovered-mnemonic.txt \
+  slip39-shares/share-01.txt \
+  slip39-shares/share-03.txt
+```
+
+## Safety defaults
+
+- Sensitive recovery and decryption require `--output FILE` or deliberate
+  `--stdout`.
+- Existing output files are refused unless `--force` is explicit.
+- Final-component symlinks are refused even with `--force`.
+- Multi-file output is fully preflighted before any share is written.
+- New secret files use mode `0600`; new private directories use mode `0700`.
+- Identical duplicate shares are reported; conflicting duplicates fail.
+- Independent complete sets in one recovery invocation fail as ambiguous.
+- Recovery combinations are bounded to prevent uncontrolled work.
+- Manifests contain artifact hashes and set metadata, never plaintext hashes.
+
+These controls assume a trusted host and controlled parent directories. See
+[THREAT_MODEL.md](THREAT_MODEL.md) and [CEREMONY.md](CEREMONY.md).
+
+## Formats and compatibility
+
+- SHEN v2 stores scrypt parameters, salt, nonce, tag, and ciphertext.
+- SHRD v2 stores the authenticated common header, one key share, and ciphertext.
+- SHEN v1/v2 and SHRD v1/v2 readers remain supported.
+- Display comments and holder labels are not cryptographically authenticated.
+
+Wire-format changes require a separate compatibility and cryptographic review.
+
+## Documentation
+
+- [CEREMONY.md](CEREMONY.md): generic safe operator workflow.
+- [docs/FORDEFI-DISASTER-RECOVERY.md](docs/FORDEFI-DISASTER-RECOVERY.md): Fordefi-specific workflow.
+- [OFFLINE_BUILD.md](OFFLINE_BUILD.md): reproducible verified bundle build.
+- [THREAT_MODEL.md](THREAT_MODEL.md): assets, adversaries, assumptions, and scope.
+- [SECURITY.md](SECURITY.md): vulnerability disclosure and support policy.
+- [AGENTS.md](AGENTS.md): rules for AI agents assisting a human.
+- [CHANGELOG.md](CHANGELOG.md): release history and compatibility notes.
+- [CONTRIBUTING.md](CONTRIBUTING.md): development and review workflow.
+- [SUPPORT.md](SUPPORT.md): support boundaries and safe issue reporting.
+- [RELEASING.md](RELEASING.md): maintainer release procedure.
+
+## Test
+
+```bash
+PYTHONPATH=src python -m unittest discover -s tests -v
+PYTHONPATH=src python -O -m unittest discover -s tests -v
+```
+
+## License
+
+Dual-licensed under Apache-2.0 or MIT-0. See [LICENSE](LICENSE) and [LICENSE-MIT-0](LICENSE-MIT-0).