Skip to main content

Crate hide_format

Crate hide_format 

Source

Structs§

Extension
An ignorable map entry: key 64..=65535, value an opaque byte string. A reader that does not know the key skips it; it is still authenticated and signed.
Metadata
Preamble
ProtectedHeader
RecipientStanza
SignatureStanza
A public signature over the container, readable by anyone holding the file. Confidential signatures live inside the encrypted metadata instead.
UnknownStanza
A recipient stanza of a type this implementation does not know. It is kept so the header re-encodes canonically and a signature can cover it, and it is skipped when looking for a key: a future recipient type must not make the file unreadable to the recipients it already had.

Enums§

FormatError
Stanza

Constants§

CHUNK_LEN
CURRENT_MINOR
The minor a HIDE/1.0 writer emits. A minor is a non-breaking revision, so readers accept every minor except 0 and the legacy 2.
FIRST_IGNORABLE_KEY
Keys below this are core (1..=5) or critical (6..=63); at or above it, up to u16::MAX, a reader that does not know the key skips it.
FLAG_SIGNED
The one flag HIDE/1.0 defines. Every flag bit is critical: a reader that does not know a set bit must refuse the container, never ignore the bit.
LEGACY_SIGNED_MINOR
HIDE/0.5 through 0.8 marked a signed container by minor 2. Still read, never written, and only valid with no flags set.
MAGIC
MAX_EXTENSIONS
Ignorable extensions: at most this many per map, each value at most this long.
MAX_EXTENSION_LEN
MAX_HEADER_LEN
MAX_METADATA_LEN
MAX_RECIPIENTS
MAX_SIGNATURES
Exactly one signer is verified, so exactly one stanza is admitted. Allowing more would let a recipient append stanzas nobody checks.
MAX_STANZA_ITEMS
A recipient stanza is a tag followed by at most seven byte strings.
PREAMBLE_LEN
SIGNATURE_LEN
SUITE
TAG_LEN
VERIFYING_KEY_LEN

Functions§

decode_header
encode_header