Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 1.48 KB

GLOSSARY.md

File metadata and controls

37 lines (26 loc) · 1.48 KB

Vitamin C

Vitamin C is a suite of crates for cryptography and handling sensitive data. This glossary names the concepts specific to it.

Language

Serialized plaintext

Profile: A set of rules for turning a value into nodes and back. There are two: the transport profile, for values in flight between a host and a guest that ship together, and the storage profile, for values that are kept. Avoid: Format, codec, mode

Frame: A value's plaintext as the transport profile writes it. It carries no version and makes no compatibility promise. Avoid: Payload, message

Blob: A value's plaintext as the storage profile writes it: a versioned header, then one node. Its bytes are a compatibility promise. Avoid: Record, stored frame

Node: One tagged value inside a frame or blob: a scalar, an array, an object or map, or a presence marker. Avoid: Element, item, token

Refusal: A value that a profile declines to read or write, together with where in the value it happened. It never contains the value itself or any of its keys. Avoid: Diagnostic, rejection, failure

Context encoding

Canonical encoding: An encoding that gives each value exactly one sequence of bytes. Two programs that encode the same context get the same bytes. Avoid: Unique encoding, normalized form

Unambiguous encoding: An encoding in which two different values never produce the same bytes. For example, the contexts ("ab", "c") and ("a", "bc") encode differently. Avoid: Unique encoding