Skip to main content

Module report

Module report 

Source
Expand description

Structured results.

strypt-core returns data; front-ends render it (ADR-0003). Nothing in this module is a sentence meant for a human — the strings that do appear are format-domain identifiers such as APP1 (Exif) or /Info /Author, which are stable, machine-usable, and identical in the CLI’s text output, its JSON output, and the Phase 5 GUI. If a type here ever grows a field holding a translated or prose string, that is the boundary being violated.

§Values are opt-in, and off by default

A report names the metadata it found. It carries the value only when the caller sets InspectOptions::include_values. The default is off because a report is easy to redirect into a file, paste into an issue, or scroll back to — each of which recreates the secret the user just asked to have destroyed (docs/THREAT_MODEL.md §5.5). Front-ends that show values, such as the Phase 5 before/after diff, opt in deliberately.

Structs§

Finding
One piece of metadata found in a file.
InspectOptions
What a caller wants from an inspection.
MetadataReport
The result of inspecting a file. Produced without modifying anything.
Retained
Something the handler found and chose not to remove.
StripReport
The result of stripping a file.

Enums§

MetadataKind
What kind of identifying information an item represents.
MetadataValue
A metadata value, when the caller asked for values.
Note
A caveat about what strypt did or could not do.
RetentionReason
Why a handler kept something it could see.
Sensitivity
How directly an item exposes its subject.