ferrocrypt 0.3.0-beta.1

Recipient-oriented file and directory encryption: passphrase (Argon2id) and X25519 public-key recipients, XChaCha20-Poly1305 STREAM payloads, HKDF-SHA3-256 / HMAC-SHA3-256 key derivation and authentication.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

//! FerroCrypt v1 recipient layer.
//!
//! Per `FORMAT.md` §3.3, a recipient entry is an independently framed
//! method for recovering the per-file `file_key`. Two native v1
//! recipient types are defined:
//!
//! - [`native::argon2id`] — passphrase-based, exclusive (must be the
//!   only entry in a file per `FORMAT.md` §4.1 mixing rule).
//! - [`native::x25519`] — X25519 public-key, public-key-mixable.
//!
//! ## Module layout
//!
//! - [`entry`] — generic recipient framing (`type_name_len:u16 ||
//!   recipient_flags:u16 || body_len:u32 || type_name || body`),
//!   `RecipientEntry`, framing parser.
//! - [`name`] — `validate_type_name_grammar`,
//!   `validate_external_type_name`, and `TYPE_NAME_MAX_LEN` per
//!   `FORMAT.md` §3.3 grammar and §3.3.1 namespace policy.
//! - [`policy`] — `NativeRecipientType` registry, internal
//!   `NativeMixingRule` enforcement type, public `MixingPolicy` diagnostic
//!   projection, `enforce_recipient_mixing_policy`,
//!   `classify_recipient_mode`.
//! - [`native`] — per-algorithm scheme implementations:
//!   [`native::argon2id`] and [`native::x25519`].
//!
//! ## Type-name namespace
//!
//! Per `FORMAT.md` §3.3.1, native recipient type names are short names
//! without `/`. Plugin and third-party types MUST use a fully qualified
//! name containing `/` (e.g. `example.com/enigma`). Native-name
//! prefixes `mlkem`, `pq`, `hpke`, `tag`, `xwing`, `kem` and any name
//! ending in `tag` are reserved for future FerroCrypt-defined recipient
//! types. The stable public API does not expose a third-party recipient plugin
//! registration surface.

pub(crate) mod entry;
pub(crate) mod name;
pub(crate) mod native;
pub(crate) mod policy;

pub(crate) use entry::{RecipientEntry, parse_recipient_entries};
pub(crate) use name::{TYPE_NAME_MAX_LEN, validate_type_name_grammar};
pub(crate) use native::{argon2id, x25519};
pub(crate) use policy::classify_recipient_mode;