Expand description
Local-first, verification-only C2PA SDK.
The public facade reads caller-provided bytes and reports integrity separately from trust. Network access occurs only after saved failure telemetry consent or an explicit per-call override.
Structs§
- Detached
Manifest Evidence - Raw, read-only evidence needed to validate an embedded manifest remotely without uploading the host asset.
- Freshness
Report - Network
Report - What a verification did, or could have done, on the network.
- Network
Request - One attempted fetch.
- Revocation
Report - Segment
Report - One per-segment stream position, verified as a standalone asset.
- Stream
Verification Report - Result of
verify_stream. - Telemetry
Options - Per-verification override for persisted failure telemetry consent.
- Trust
Report - Validation
Failure Telemetry - Privacy-bounded validation failure report. It contains no asset bytes, manifest data, filenames, URLs, keys, trust material, or stable identifiers.
- Validation
Results - Verification
Report - Verification
Status - Verify
Options
Enums§
- Error
- Online
Preference - The saved answer to “may this machine fetch what a file references?”.
- Online
Preference Error - Stream
Encapsulation - How a fragmented stream is packaged.
- Stream
Method - The C2PA protection method applied to a fragmented stream.
- Telemetry
Preference Error
Constants§
- C2PA_
PROFILE - DEFAULT_
TELEMETRY_ ENDPOINT - DEFAULT_
TRUST_ SNAPSHOT_ DATE - REPORT_
SCHEMA_ VERSION - SUPPORTED_
EXTENSIONS - Every filename extension the SDK maps to a MIME type, with its mapping.
Functions§
- allow_
interactive_ online_ consent - Let this process ask the operator before it fetches anything.
- config_
directory - The directory holding this SDK’s saved preferences for the current
operating-system account, or
Nonewhen none can be resolved (containers, service accounts, HOME-less shells). - detached_
manifest_ evidence - Extract the signed manifest store and its contiguous carrier for detached server validation.
- mime_
from_ path - Infer a MIME type from a filename extension, case-insensitively.
- online_
preference - The effective saved choice.
ENCYPHER_C2PA_ONLINEis an operator override and wins over the file; it accepts onlyonandoff, because an operator setting an environment variable on a service has nobody to ask. - prompt_
for_ telemetry_ consent - Ask for consent on the first interactive verification and persist the
answer. Non-interactive processes return
Noneand remain disabled. - set_
online_ preference - Persist the online choice for later runs of every terminal surface used by this operating-system account.
- set_
telemetry_ enabled - Persist the telemetry preference for subsequent verifications by every native Encypher C2PA binding used by this operating-system account.
- supported_
mime_ types - Canonical MIME types covered by the C2PA 2.4 profile and readable by this build.
- telemetry_
preference - Return the effective saved preference. An environment override takes precedence over the per-user configuration file.
- validation_
failure_ telemetry - verify
- Verify asset bytes with default options. Parsing and validation stay offline;
saved failure-telemetry consent may emit one bounded request. For guaranteed
no egress, disable the
telemetryfeature or callverify_with_optionswithtelemetry.enabledset toSome(false). - verify_
file - Read and verify one local asset.
- verify_
fragmented - Verify a fragmented ISO BMFF stream with default options.
- verify_
fragmented_ with_ options - Verify a fragmented ISO BMFF stream with explicit trust, validation-time, CAWG, and telemetry options.
- verify_
stream - Verify a fragmented ISO BMFF stream under a declared encapsulation and protection method, with default options.
- verify_
stream_ with_ options - Verify a fragmented ISO BMFF stream with explicit trust, validation-time, and CAWG options.
- verify_
with_ manifest_ store - Verify one asset against a manifest store the caller supplies separately.
- verify_
with_ options - Verify asset bytes against the bundled trust snapshots plus any static trust material supplied by the caller. Failure telemetry follows the explicit override or saved per-user preference.