cryptovault-py 0.2.0__tar.gz

cryptovault_py-0.2.0/LICENSE-APACHE

@@ -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 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 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 name 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 Julian Bolivar
+
+   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.

cryptovault_py-0.2.0/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Julian Bolivar
+
+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.

cryptovault_py-0.2.0/PKG-INFO

@@ -0,0 +1,259 @@
+Metadata-Version: 2.4
+Name: cryptovault-py
+Version: 0.2.0
+Summary: Authenticated encryption byte-compatible with the cryptovault Rust crate: AES-256-GCM-SIV over Argon2id/HKDF.
+Keywords: cryptography,aead,encryption,aes-gcm-siv,argon2
+Author: Julian Bolivar
+Author-email: Julian Bolivar <jbolivarg@gmail.com>
+License-Expression: MIT OR Apache-2.0
+License-File: LICENSE-APACHE
+License-File: LICENSE-MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Security :: Cryptography
+Classifier: Typing :: Typed
+Requires-Dist: cryptography>=45.0.1
+Requires-Python: >=3.11
+Project-URL: Repository, https://github.com/BolivarTech/CryptoVault-Python
+Description-Content-Type: text/markdown
+
+# CryptoVault-Python
+
+**A Python implementation of the [`cryptovault`](https://github.com/BolivarTech/cryptovault)
+blob format, byte-compatible with the Rust crate.** AES-256-GCM-SIV under an HKDF-SHA256 key,
+Argon2id key derivation and DEK/KEK key wrapping, followed by the crate's forward-error
+correction: Reed-Solomon, an interleaver and a Viterbi code, or no FEC at all.
+
+> **Status: 0.2.0, alpha.** Every FEC strategy of `cryptovault` 0.3.0 is implemented and
+> checked in both directions against the crate.
+
+---
+
+## What it does
+
+Two services that share a 32-byte key can encrypt and authenticate messages for each other.
+A blob made on either side opens on the other, Rust → Python and Python → Rust. The package
+opens no connections and knows nothing about transports: it turns text or key material into
+a blob and back, and the caller moves the blob.
+
+The Rust crate stacks two independent layers: an AEAD that provides all of the security,
+then an FEC that adds channel resilience and no security. Both are implemented here, with
+the same four FEC strategies as the crate.
+
+## Installation
+
+```sh
+pip install cryptovault-py
+```
+
+The import name is `cryptovault`. [Requirements](#requirements) lists the supported Python versions and the `cryptography` and
+OpenSSL floor.
+
+## Quick start
+
+```python
+>>> from cryptovault import CryptoVault, generate_dek, generate_salt
+>>> vault = CryptoVault.default()             # Argon2id + AES-256-GCM-SIV + concatenated FEC
+
+>>> key = generate_dek()                      # or vault.derive_key(password, salt)
+>>> blob = vault.encrypt_with_key(key, "sk-secret")
+>>> vault.decrypt_with_key(key, blob)
+'sk-secret'
+
+>>> salt = generate_salt()                    # one per context, kept by the caller
+>>> kek = generate_dek()
+>>> dek = generate_dek()
+>>> wrapped = vault.wrap_key(kek, salt, dek)  # the salt is bound as AAD
+>>> vault.unwrap_key(kek, salt, wrapped) == dek
+True
+
+```
+
+`CryptoVault.default()` matches `CryptoVault::default()` in Rust. To pick another FEC
+strategy, compose the vault yourself; the constructor has no defaults:
+
+```python
+>>> from cryptovault import Aes256GcmSivCipher, Argon2Kdf, NoFec
+>>> aead_only = CryptoVault(Argon2Kdf(), Aes256GcmSivCipher(), NoFec())
+>>> aead_only.decrypt_with_key(key, aead_only.encrypt_with_key(key, "hi"))
+'hi'
+
+```
+
+`derive_key(password, salt)` runs Argon2id with the crate's OWASP-2025 profile (64 MiB, three
+passes, four lanes). Call it once per session and keep the key.
+
+### Blob layout
+
+```text
+blob    = base64( fec.encode( header ‖ nonce(12 B) ‖ ciphertext ‖ tag(16 B) ) )   standard, padded
+header  = version (0x01) ‖ plaintext_len (u32, little-endian)
+key     = HKDF-SHA256( salt = none, ikm = 32-byte master key, info = "cryptovault:v1:aead", L = 32 )
+AAD     = purpose ‖ header ‖ aad_extra
+purpose = 0x01 data · 0x02 wrapped key
+extra   = empty for data · the salt for a wrapped key (authenticated, never stored)
+cipher  = AES-256-GCM-SIV, fresh random 12-byte nonce per message
+```
+
+The header is bound as associated data, so changing any bit of it fails authentication. The purpose byte keeps a data blob from opening as a wrapped key, and
+the other way round. As for the version byte, it leaves room for the format to evolve; today
+only `0x01` is accepted.
+
+## FEC strategies
+
+The FEC layer sits after the AEAD and only helps a blob survive a noisy channel. Correction
+is all or nothing. Within capacity the blob comes back exact; past it, decryption fails with
+a typed error and never returns wrong plaintext, because the AEAD tag checks the result.
+
+| Strategy | Pipeline | Corrects | Size of a 1 KiB message |
+|---|---|---|---|
+| `ConcatenatedFec.default()` | RS(255, 223) → depth-5 block interleaver → Viterbi K=7 R=1/2 | scattered bit errors and bursts | 3404 B |
+| `ConcatenatedFec.with_csprng_from_master(master, depth)` | the same, plus a keyed shuffle per window | as above, weaker burst spreading | 3404 B |
+| `ViterbiOnlyFec()` | Viterbi K=7 R=1/2 | scattered bit errors | 2824 B |
+| `ReedSolomonCodec()` | RS(255, 223) | up to 16 bad bytes per 255-byte codeword | 1700 B |
+| `NoFec()` | none | nothing; any change fails authentication | 1412 B |
+
+The CSPRNG variant derives its seed from the master key with HKDF (`info =
+"cryptovault:v1:interleaver"`), and both ends must build it from the same master and depth.
+It is obfuscation, not security.
+
+The codecs are pure Python, so they are much slower than the Rust crate. Measured with
+CPython 3.11 on Windows:
+
+| Strategy | Encrypt 128 KiB | Decrypt 128 KiB | Decrypt 128 KiB, one flipped bit | Decrypt 1 KiB, one flipped bit |
+|---|---|---|---|---|
+| `ConcatenatedFec` | 1.4 s | 1.7 s | 15.6 s | 0.16 s |
+| `ViterbiOnlyFec` | 0.25 s | 0.66 s | 14.3 s | 0.12 s |
+| `ReedSolomonCodec` | 1.1 s | 1.0 s | 0.82 s | 0.01 s |
+| `NoFec` | < 0.01 s | < 0.01 s | fails, < 0.01 s | fails, < 0.01 s |
+
+A clean Viterbi sub-block decodes directly. One with channel errors runs the full trellis,
+which in Python costs about 12 µs per coded bit pair, or about 12 s for a full 124 950-byte
+sub-block. Noisy channels carrying large messages pay that price.
+
+## Security model
+
+| Property | Mechanism | Level |
+|---|---|---|
+| Confidentiality | AES-256-GCM-SIV (RFC 8452) | 256-bit key |
+| Integrity / authenticity | 128-bit GCM-SIV tag, header bound as AAD | forgery ≤ 2⁻¹²⁸ per message |
+| Nonce-misuse resistance | SIV construction | a nonce collision reveals only plaintext equality |
+| Key separation | HKDF-SHA256 with a fixed `info` label | the AEAD key is never the raw master key |
+| Password hardening | Argon2id v1.3, m = 64 MiB, t = 3, p = 4 | OWASP 2025 profile |
+| Context binding | salt and purpose bound as AAD on wrapped keys | wrong salt or purpose fails authentication |
+| Typed failures | one exception class per failing stage, fixed messages | no input echoed in an error |
+| Secret hygiene | no key, secret, blob or plaintext in errors, logs or `repr` | — |
+
+All cryptographic primitives come from the [`cryptography`](https://cryptography.io/)
+package. Nothing here is home-rolled crypto.
+
+### Out of scope (what it does NOT defend against)
+
+- **Weak passwords.** Argon2id slows guessing down; it does not make a weak password strong.
+- **Replay.** A valid blob stays valid. Detecting repeats is the caller's protocol concern.
+- **Traffic analysis.** The header carries the plaintext length in the clear, and the blob
+  size follows from it.
+- **Channel errors past the FEC capacity.** The blob fails closed and never decrypts to
+  something wrong. With `NoFec`, a single flipped bit is enough.
+- **Memory disclosure.** The crate wipes secrets from memory; Python's immutable `str` and
+  `bytes` cannot promise that, and this package does not try.
+- **Host compromise.** A key in process memory is as safe as the process.
+
+### Operational contracts (the caller must honor)
+
+- **Use exactly 32 bytes of key.** A shorter or longer key is an error, not something the
+  package pads or truncates.
+- **Use a fresh salt per context**, from `generate_salt()`. The same password and salt give
+  the same key.
+- **Rate-limit `derive_key` for untrusted callers.** Each call costs 64 MiB and noticeable
+  CPU.
+- **Rekey before ~2⁴⁸ messages per key.** That is the birthday bound for random 96-bit
+  nonces.
+- **Decode with the same FEC strategy you encoded with.** A blob from a default Rust vault
+  opens with `CryptoVault.default()`; one from a `NoFec` vault needs a `NoFec` vault here.
+- **Bound decrypt input from untrusted sources.** `with_max_blob_len(cap)` returns a vault
+  that rejects larger blobs before any decryption work. With FEC this also bounds the decode
+  time, which grows with the number of corrupted Viterbi sub-blocks.
+- **One blob, one message.** Framing and delivery belong to the caller.
+
+## Errors
+
+Every failure is a `CryptoVaultError`. The subclass names the stage that failed, and `str()`
+matches the crate's `Display` for the same input, word for word:
+
+| Class | Raised for |
+|---|---|
+| `InvalidInputError` | wrong key, salt or seed length, empty password, interleave depth out of range, oversized input, malformed blob, unknown version |
+| `EncodingError` | non-canonical base64, text that is not valid UTF-8 |
+| `CipherError` | a tag that does not verify (wrong key, salt or purpose, any tampering) |
+| `KeyDerivationError` | Argon2id failure, or no OS entropy for a salt or DEK |
+| `ErrorCorrectionError` | corruption beyond the Reed-Solomon capacity, or no ChaCha20 in the backend for the CSPRNG layer |
+
+## Compatibility testing
+
+The test suite replays reference data that the crate itself produced. For `NoFec`: its
+constants, data blobs up to 128 KiB, wrapped keys, Argon2id outputs, and the exact error for
+358 adversarial inputs (every single-bit flip of a blob, truncations, bad versions and
+lengths, non-canonical base64, wrong keys and salts, invalid UTF-8). For the FEC layer: the
+Reed-Solomon codewords and the outcome of 146 corrupted decodes, the interleaver
+permutations (the CSPRNG layer included), Viterbi encodings and 26 corrupted decodes down to
+the wrong bytes a heavily damaged stream decodes to, and 335 adversarial blobs under three
+strategies (sampled bit flips, bursts, truncation, rewritten headers, wrong keys and salts).
+In the other direction, a second test hands the crate blobs made in Python under every
+strategy and checks that it opens each one. The generator lives in `interop/rust`:
+
+```sh
+uv run pytest                     # full suite, Rust fixtures included
+uv run pytest -m interop          # Python → Rust; needs the Rust toolchain
+cargo run --release --manifest-path interop/rust/Cargo.toml -- fixtures \
+    > tests/fixtures/rust_nofec.json   # regenerate the NoFec fixtures
+cargo run --release --manifest-path interop/rust/Cargo.toml -- fec-fixtures \
+    > tests/fixtures/rust_fec.json     # regenerate the FEC fixtures
+```
+
+## Requirements
+
+- **Python 3.11** or newer. Tested on Linux and Windows with 3.11 and 3.14.
+- **`cryptography` 45.0.1 or newer**, linked against **OpenSSL 3.2 or newer** (AES-GCM-SIV and
+  Argon2id need it; the CSPRNG layer also uses its ChaCha20). Releases before 45.0.1 reject an empty plaintext, which the crate allows.
+  The official wheels qualify.
+
+## Development
+
+```sh
+uv sync --locked
+uv run ruff check . && uv run ruff format --check . && uv run mypy . && uv run pytest
+uv run pip-audit
+uv build
+```
+
+## Roadmap
+
+1. **`NoFec` blob format, Argon2id and key wrapping.** Implemented and cross-checked against
+   the crate in both directions.
+2. **The FEC strategies.** Reed-Solomon, the interleaver and Viterbi, so any `cryptovault`
+   blob can be read from Python. Implemented and cross-checked in both directions.
+3. **A compiled FEC accelerator.** The codecs are pure Python, and a damaged sub-block runs
+   the full Viterbi trellis at about 12 µs per stage: a 128 KiB blob with one flipped bit takes
+   about 15 s to decrypt. The plan is an optional Rust extension (PyO3) that wraps the same
+   `reedsolomon` and `viterbi` crates the reference crate uses, with the pure-Python codecs
+   kept as the fallback where no wheel exists. The crate fixtures stay as its parity check.
+
+## License
+
+Licensed under either of
+
+- **MIT** license ([LICENSE-MIT](LICENSE-MIT)), or
+- **Apache License, Version 2.0** ([LICENSE-APACHE](LICENSE-APACHE))
+
+at your option.
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for
+inclusion in this package by you, as defined in the Apache-2.0 license, shall be
+dual-licensed as above, without any additional terms or conditions.
+
+Copyright © 2026 Julian Bolivar / BolivarTech.