diff --git a/docs/manifest/cai-addon.css b/docs/manifest/json-ref/cai-addon.css similarity index 100% rename from docs/manifest/cai-addon.css rename to docs/manifest/json-ref/cai-addon.css diff --git a/docs/manifest/json-ref/index.md b/docs/manifest/json-ref/index.md new file mode 100644 index 00000000..17f3fe91 --- /dev/null +++ b/docs/manifest/json-ref/index.md @@ -0,0 +1,16 @@ +--- +id: index +title: Manifest JSON reference +hide_table_of_contents: true +pagination_next: null +pagination_prev: null +--- + +The [C2PA specification](https://c2pa.org/specifications/specifications/2.1/specs/C2PA_Specification.html#_manifests) describes a manifest with a binary structure in JPEG universal metadata box format ([JUMBF](https://www.iso.org/standard/84635.html)) that includes JSON as well as binary data for things like encryption keys and thumbnail images. Because the binary structure is hard to understand and program to, the SDK defines a JSON manifest structure that's a declarative language for representing and creating a binary manifest. + +The JSON manifest is an abstract translation layer that's easier to understand than the binary format. It can describe everything in the underlying binary format except for binary data such as thumbnails that are included by a structure called a _resource reference_. To generate a binary manifest, the SDK assembles all the JSON objects, resource references, and ingredients defined, and then converts them into different assertions and other objects as required. + +These JSON references are generated from the JSON schemas for [ManifestDefinition](https://docs.rs/c2pa/latest/c2pa/struct.ManifestDefinition.html) and [Reader](https://docs.rs/c2pa/latest/c2pa/struct.Reader.html) objects (_structs_ in Rust terminology): + +- [ManifestDefinition](manifest-def.mdx): Defines a manifest and builds a manifest store. +- [Reader](reader.mdx): Reads and validates a manifest. \ No newline at end of file diff --git a/docs/manifest/json-ref/manifest-def.html b/docs/manifest/json-ref/manifest-def.html new file mode 100644 index 00000000..e5b3c05d --- /dev/null +++ b/docs/manifest/json-ref/manifest-def.html @@ -0,0 +1,4514 @@ +

ManifestDefinition

+ +
+

+ Use a ManifestDefinition to define a manifest and to build a + ManifestStore. A + manifest is a collection of ingredients and assertions used to define a + claim that can be signed and embedded into a file. +

+
+ +

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
assertions + + + + + + An array of + AssertionDefinition +

A list of assertions

 + + + NO + + + Empty array +
claim_generator_info + + + + + + An array of + ClaimGeneratorInfo + +

Claim Generator Info is always required with at least one entry

+ 		+ + + NO + + + + Object with properties: +
    +
  • name - c2pa-rs
    • + +
  • version - 0.49.5
    • +
+
claim_version + + + + + Integer + + (uint8)
Minimum: 0.0 + + + + + 		+

The version of the claim. Defaults to 1.

+ 		+ + + NO + + + + N/A +
format + + + + + String + +

The format of the source file as a MIME type.

+ 		+ + + NO + + + + application/octet-stream +
ingredients + + + + + + An array of + Ingredient +

A List of ingredients

 + + + NO + + + Empty array +
instance_id + + + + + String + +

+ Instance ID from + xmpMM:InstanceID + in XMP metadata. +

+ 		+ + + NO + + + + xmp:iid:dde3986c-d7b2-4256-b5dd-acc8ed9aada3 +
label + + + + + String + + + + + + +

+ Allows you to pre-define the manifest label, which must be unique. Not + intended for general use. If not set, it will be assigned + automatically. +

+ 		+ + + NO + + + + N/A +
metadata + + + + + Array of + + Metadata + + + + + +

+ Optional manifest metadata. This will be deprecated in the future; not + recommended to use. +

+ 		+ + + NO + + + + N/A +
redactions + + + + + Array of string + + + + + +

A list of redactions - URIs to redacted assertions.

+ 		+ + + NO + + + + N/A +
thumbnail + + + ResourceRef + + + +

+ An optional ResourceRef to a thumbnail image that represents the asset + that was signed. Must be available when the manifest is signed. +

+ 		+ + + NO + + + + N/A +
title + + + + + String + + + + + + +

A human-readable title, generally source filename.

+ 		+ + + NO + + + + N/A +
vendor + + + + + String + + + + + + +

+ Optional prefix added to the generated Manifest Label This is + typically a reverse domain name. +

+ 		+ + + NO + + + + N/A +
+ + + +

Definitions

+ + + + + + + + + + + +
+ Actor
+ + AssertionData
+ + AssertionDefinition
+ + AssetType
+ + ClaimGeneratorInfo
+ + Coordinate
+ + DataSource
+ + Frame
+ 		+ HashedUri
+ + Ingredient
+ + IngredientDeltaValidationResult +
+ + Item
+ + Metadata
+ + Range
+ + RangeType
+ + RegionOfInterest
+ 		+ Relationship
+ + ResourceRef
+ + ReviewRating
+ + Role
+ + Shape
+ + ShapeType
+ + StatusCodes
+ + Text
+ 		+ TextSelector
+ + TextSelectorRange
+ + Time
+ + TimeType
+ + UnitType
+ + UriOrResource
+ + ValidationResults
+ + ValidationStatus
+
+ + + +

+ Definitions +

+ +

Actor

+ +

+ +

Identifies a person responsible for an action.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
credentials + + + + + Array of + + HashedUri + + + + + +
+

List of references to W3C Verifiable Credentials.

+
+ 		NON/A
identifier + + + + + String + + + + + + +
+

+ An identifier for a human actor, used when the “type” is + humanEntry.identified. +

+
+ 		NON/A
+ + + +

+ Definitions +

+ +

AssertionData

+ +

+ +
+

+ This allows the assertion to be expressed as CBOR or JSON. The default is + CBOR unless you specify that an assertion should be JSON. +

+
+

Any of the following:

+ + + +

+ Definitions +

+ +

AssertionDefinition

+ +

+ +

+ Defines an assertion that consists of a label that can be either a + C2PA-defined assertion label or a custom label in reverse domain format. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
data + + + + + AssertionData + +

Description TBD.

+ 		+ YES + N/A
label + + + + + String + +

Description TBD.

+ 		+ YES + N/A
+ + + +

+ Definitions +

+ +

AssetType

+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
type + + + + + String + +

Description TBD.

+ 		+ YES + N/A
version + + + + + String + + + + + + +

Description TBD.

+ 		+ NO + N/A
+ + + +

+ Definitions +

+ +

ClaimGeneratorInfo

+ +

+ +

+ Description of the claim generator, or the software used in generating the + claim. This structure is also used for actions softwareAgent +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
icon + + + UriOrResource + + + +
+

hashed URI to the icon (either embedded or remote)

+
+ 		+ NO + N/A
name + + + + + String + +
+

A human readable string naming the claim_generator

+
+ 		+ YES + N/A
operating_system + + + + + String + + + + + + +
+

+ A human readable string of the OS the claim generator is running on +

+
+ 		+ NO + N/A
version + + + + + String + + + + + + +
+

A human readable string of the product’s version

+
+ 		+ NO + N/A
+ +

+ NOTE: This object can have any number of additional user-defined properties. +

+ + + +

+ Definitions +

+ +

Coordinate

+ +

+ +

+ An x, y coordinate used for specifying vertices in polygons. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
x + + + + + Number / double + +

The coordinate along the x-axis.

+ 		+ YES + N/A
y + + + + + Number / double + +

The coordinate along the y-axis.

+ 		+ YES + N/A
+ + + +

+ Definitions +

+ +

DataSource

+ +

+ +

A description of the source for assertion data

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
actors + + + + + Array of + + Actor + + + + + +
+

+ A list of [Actor]s associated with this source. +

+
+ 		+ NO + N/A
details + + + + + String + + + + + + +
+

+ A human-readable string giving details about the source of the + assertion data. +

+
+ 		+ NO + N/A
type + + + + + String + +
+

+ A value from among the enumerated list indicating the source of the + assertion. +

+
+ 		+ YES + N/A
+ + + +

+ Definitions +

+ +

Frame

+ +

+ +

+ A frame range representing starting and ending frames or pages. If both + start and + end are missing, the + frame will span the entire asset. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
end + + + + + Integer + + (int32) + + + + + +
+

+ The end of the frame inclusive or the end of the asset if not + present. +

+
+ 		NON/A
start + + + + + Integer + + (int32) + + + + + +
+

The start of the frame or the end of the asset if not present.

+ +

The first frame/page starts at 0.

+
+ 		NON/A
+ + + +

+ Definitions +

+ +

HashedUri

+ +

+ +

+ A HashedUri provides + a reference to content available within the same manifest store. This is + described in [§8.3, URI References], of the C2PA Technical Specification. + [§8.3, URI References]: + https://c2pa.org/specifications/specifications/2.1/specs/C2PA_Specification.html#_uri_references +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
alg + + + + + String + + + + + + +
+

+ A string identifying the cryptographic hash algorithm used to + compute the hash +

+
+ 		+ NO + N/A
hash + + + + + + An array of + integer + +
+

Byte string containing the hash value

+
+ 		+ YES + N/A
url + + + + + String + +

JUMBF URI reference

+ 		+ YES + N/A
+ + + +

+ Definitions +

+ +

Ingredient

+ +

+ +

+ An Ingredient is any + external asset that has been used in the creation of an asset. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
active_manifest + + + + + String + + + + + + +
+

The active manifest label (if one exists).

+ +

+ If this ingredient has a [ManifestStore], this will hold the label of the active + Manifest. +

+
+ 		NON/A
data + + + ResourceRef + + + +
+

A reference to the actual data of the ingredient.

+
+ 		NON/A
data_types + + + + + Array of + + AssetType + + + + + +
+

+ Additional information about the data’s type to the ingredient V2 + structure. +

+
+ 		NON/A
description + + + + + String + + + + + + +
+

Additional description of the ingredient.

+
+ 		NON/A
document_id + + + + + String + + + + + + +
+

+ Document ID from + xmpMM:DocumentID + in XMP metadata. +

+
+ 		NON/A
format + + + + + String + + + + + + +
+

The format of the source file as a MIME type.

+
+ 		NON/A
hash + + + + + String + + + + + + +
+

An optional hash of the asset to prevent duplicates.

+
+ 		NON/A
informational_URI + + + + + String + + + + + + +
+

URI to an informational page about the ingredient or its data.

+
+ 		NON/A
instance_id + + + + + String + + + + + + +
+

+ Instance ID from + xmpMM:InstanceID + in XMP metadata. +

+
+ 		NON/A
label + + + + + String + + + + + + +
+

The ingredient’s label as assigned in the manifest.

+
+ 		NON/A
manifest_data + + + ResourceRef + + + +
+

+ A + ManifestStore + from the source asset extracted as a binary C2PA blob. +

+
+ 		NON/A
metadata + + + Metadata + + + +
+

+ Any additional + Metadata + as defined in the C2PA spec. +

+
+ 		NON/A
provenance + + + + + String + + + + + + +
+

+ URI from + dcterms:provenance + in XMP metadata. +

+
+ 		NON/A
relationship + + + Relationship + + + +
+

+ Set to + ParentOf + if this is the parent ingredient. +

+ +

There can only be one parent ingredient in the ingredients.

+
+ 		NOcomponentOf
thumbnail + + + ResourceRef + + + +
+

+ A thumbnail image capturing the visual state at the time of import. +

+ +

+ A tuple of thumbnail MIME format (for example + image/jpeg) and binary bits of the image. +

+
+ 		NON/A
title + + + + + String + + + + + + +
+

A human-readable title, generally source filename.

+
+ 		NON/A
validation_results + + + ValidationResults + + + +

Validation results (Ingredient.V3)

+ 		NON/A
validation_status + + + + + Array of + + ValidationStatus + + + + + +
+

Validation status (Ingredient v1 & v2)

+
+ 		NON/A
+ + + +

+ Definitions +

+ +

+ IngredientDeltaValidationResult +

+ +

+ +

+ Represents any changes or deltas between the current and previous validation + results for an ingredient’s manifest. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
ingredientAssertionURI + + + + + String + +
+

JUMBF URI reference to the ingredient assertion

+
+ 		+ YES + N/A
validationDeltas + + + StatusCodes + + + +
+

Validation results for the ingredient’s active manifest

+
+ 		+ YES + N/A
+ + + +

+ Definitions +

+ +

Item

+ +

+ +

Description of the boundaries of an identified range.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
identifier + + + + + String + +
+

+ The container-specific term used to identify items, such as + “track_id” for MP4 or “item_ID” for HEIF. +

+
+ 		+ YES + N/A
value + + + + + String + +
+

+ The value of the identifier, e.g. a value of “2” for an identifier + of “track_id” would imply track 2 of the asset. +

+
+ 		+ YES + N/A
+ + + +

+ Definitions +

+ +

Metadata

+ +

+ +

+ The Metadata structure can be used as part of other assertions or on its own + to reference others +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
dataSource + + + DataSource + + + +

Description TBD.

+ 		NON/A
dateTime + + + + +

Description TBD.

+ 		NON/A
reference + + + HashedUri + + + +

Description TBD.

+ 		NON/A
regionOfInterest + + + RegionOfInterest + + + +

Description TBD.

+ 		NON/A
reviewRatings + + + + + Array of + + ReviewRating + + + + + +

Description TBD.

+ 		NON/A
+ +

+ NOTE: This object can have any number of additional user-defined properties. +

+ + + +

+ Definitions +

+ +

Range

+ +

+ +

+ A spatial, temporal, frame, or textual range describing the region of + interest. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
frame + + + Frame + + + +

A frame range.

+ 		+ NO + N/A
item + + + Item + + + +

A item identifier.

+ 		+ NO + N/A
shape + + + Shape + + + +

A spatial range.

+ 		+ NO + N/A
text + + + Text + + + +

A textual range.

+ 		+ NO + N/A
time + + + Time + + + +

A temporal range.

+ 		+ NO + N/A
type + + + RangeType + + + +

The type of range of interest.

+ 		+ YES + N/A
+ + + +

+ Definitions +

+ +

RangeType

+ +

The type of range for the region of interest.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
RangeTypeTypeDescription
spatialstring +
+

+ A spatial range, see [Shape] for more details. +

+
+
temporalstring +
+

+ A temporal range, see [Time] for more details. +

+
+
framestring +
+

+ A spatial range, see [Frame] for more details. +

+
+
textualstring +
+

+ A textual range, see [Text] for more details. +

+
+
identifiedstring +
+

+ A range identified by a specific identifier and value, see [Item] for more details. +

+
+
+ +

+ +

+ Definitions +

+ +

RegionOfInterest

+ +

+ +

+ A region of interest within an asset describing the change. This struct can be + used from [Action::changes][crate::assertions::Action::changes] or [Metadata::region_of_interest][crate::assertions::Metadata::region_of_interest]. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
description + + + + + String + + + + + + +

A free-text string.

+ 		+ NO + N/A
identifier + + + + + String + + + + + + +
+

+ A free-text string representing a machine-readable, unique to this + assertion, identifier for the region. +

+
+ 		+ NO + N/A
metadata + + + Metadata + + + +
+

Additional information about the asset.

+
+ 		+ NO + N/A
name + + + + + String + + + + + + +
+

+ A free-text string representing a human-readable name for the region + which might be used in a user interface. +

+
+ 		+ NO + N/A
region + + + + + + An array of + Range + +
+

+ A range describing the region of interest for the specific asset. +

+
+ 		+ YES + N/A
role + + + Role + + + +
+

+ A value from our controlled vocabulary or an entity-specific value + (e.g., com.litware.coolArea) that represents the role of a region + among other regions. +

+
+ 		+ NO + N/A
type + + + + + String + + + + + + +
+

+ A value from a controlled vocabulary such as + https://cv.iptc.org/newscodes/imageregiontype/ + or an entity-specific value (e.g., com.litware.newType) that + represents the type of thing(s) depicted by a region. +

+ +

+ Note this field serializes/deserializes into the name + type. +

+
+ 		+ NO + N/A
+ + + +

+ Definitions +

+ +

Relationship

+ +

+ +

A string that is one of the following:

+ + + +

+ Definitions +

+ +

ResourceRef

+ +

+ +

+ A reference to a resource to be used in JSON serialization. The underlying + data can be read as a stream via [Reader::resource_to_stream][crate::Reader::resource_to_stream]. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
alg + + + + + String + + + + + + +
+

The algorithm used to hash the resource (if applicable).

+
+ 		+ NO + N/A
data_types + + + + + Array of + + AssetType + + + + + +
+

More detailed data types as defined in the C2PA spec.

+
+ 		+ NO + N/A
format + + + + + String + +
+

The mime type of the referenced resource.

+
+ 		+ YES + N/A
hash + + + + + String + + + + + + +
+

The hash of the resource (if applicable).

+
+ 		+ NO + N/A
identifier + + + + + String + +
+

+ A URI that identifies the resource as referenced from the manifest. +

+ +

+ This may be a JUMBF URI, a file path, a URL or any other string. + Relative JUMBF URIs will be resolved with the manifest label. + Relative file paths will be resolved with the base path if provided. +

+
+ 		+ YES + N/A
+ + + +

+ Definitions +

+ +

ReviewRating

+ +

+ +

+ A rating on an Assertion. See + https://c2pa.org/specifications/specifications/1.0/specs/C2PA_Specification.html#_claim_review. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
code + + + + + String + + + + + + +

Description TBD.

+ 		+ NO + N/A
explanation + + + + + String + +

Description TBD.

+ 		+ YES + N/A
value + + + + + Integer (uint8) +
Minimum: 0.0 + 		+

Description TBD.

+ 		+ YES + N/A
+ + + +

+ Definitions +

+ +

Role

+ +

A role describing the region.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
RoleTypeDescription
c2pa.areaOfIntereststring +

Arbitrary area worth identifying.

+
c2pa.croppedstring +
+

This area is all that is left after a crop action.

+
+
c2pa.editedstring +
+

This area has had edits applied to it.

+
+
c2pa.placedstring +
+

The area where an ingredient was placed/added.

+
+
c2pa.redactedstring +

Something in this area was redacted.

+
c2pa.subjectAreastring +
+

Area specific to a subject (human or not).

+
+
c2pa.deletedstring +
+

A range of information was removed/deleted.

+
+
c2pa.styledstring +

Styling was applied to this area.

+
c2pa.watermarkedstring +
+

+ Invisible watermarking was applied to this area for the purpose of + soft binding. +

+
+
+ +

+ +

+ Definitions +

+ +

Shape

+ +

+ +

+ A spatial range representing rectangle, circle, or a polygon. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
height + + + + + Number + + (double) + + + + + +
+

The height of a rectnagle.

+ +

This field can be ignored for circles and polygons.

+
+ 		+ NO + N/A
inside + + + + + Boolean + + + + + + +
+

If the range is inside the shape.

+ +

The default value is true.

+
+ 		+ NO + N/A
origin + + + Coordinate + + + +
+

THe origin of the coordinate in the shape.

+
+ 		+ YES + N/A
type + + + ShapeType + + + +

The type of shape.

+ 		+ YES + N/A
unit + + + UnitType + + + +
+

The type of unit for the shape range.

+
+ 		+ YES + N/A
vertices + + + + + Array of + + Coordinate + + + + + +
+

The vertices of the polygon.

+ +

This field can be ignored for rectangles and circles.

+
+ 		+ NO + N/A
width + + + + + Number + + (double) + + + + + +
+

The width for rectangles or diameter for circles.

+ +

This field can be ignored for polygons.

+
+ 		+ NO + N/A
+ + + +

+ Definitions +

+ +

ShapeType

+ +

The type of shape for the range.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
ShapeTypeTypeDescription
rectanglestring +

A rectangle.

+
circlestring +

A circle.

+
polygonstring +

A polygon.

+
+ +

+ +

+ Definitions +

+ +

StatusCodes

+ +

+ +

+ Contains a set of success, informational, and failure validation status codes. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
failure + + + + + + An array of + ValidationStatus + +

Description TBD.

+ 		+ YES + N/A
informational + + + + + + An array of + ValidationStatus + +

Description TBD.

+ 		+ YES + N/A
success + + + + + + An array of + ValidationStatus + +

Description TBD.

+ 		+ YES + N/A
+ + + +

+ Definitions +

+ +

Text

+ +

+ +

+ A textual range representing multiple (possibly discontinuous) ranges of text. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
selectors + + + + + + An array of + TextSelectorRange + +

The ranges of text to select.

+ 		+ YES + N/A
+ + + +

+ Definitions +

+ +

TextSelector

+ +

+ +

+ Selects a range of text via a fragment identifier. This is modeled after the + W3C Web Annotation selector model. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
end + + + + + Integer + + (int32) + + + + + +
+

+ The end character offset or the end of the fragment if not present. +

+
+ 		+ NO + N/A
fragment + + + + + String + +
+

+ Fragment identifier as per RFC3023 (XML) or ISO 32000-2 (PDF), Annex + O. +

+
+ 		+ YES + N/A
start + + + + + Integer + + (int32) + + + + + +
+

+ The start character offset or the start of the fragment if not + present. +

+
+ 		+ NO + N/A
+ + + +

+ Definitions +

+ +

TextSelectorRange

+ +

+ +

+ One or two [TextSelector][TextSelector] identifiying the range to select. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
end + + + TextSelector + + + +

The end of the text range.

+ 		+ NO + N/A
selector + + + TextSelector + + + +

The start (or entire) text range.

+ 		+ YES + N/A
+ + + +

+ Definitions +

+ +

Time

+ +

+ +

+ A temporal range representing a starting time to an ending time. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
end + + + + + String + + + + + + +
+

The end time or the end of the asset if not present.

+
+ 		NON/A
start + + + + + String + + + + + + +
+

The start time or the start of the asset if not present.

+
+ 		NON/A
type + + + TimeType + + + +

The type of time.

+ 		NOnpt
+ + + +

+ Definitions +

+ +

TimeType

+ +

The type of time.

+ + + + + + + + + + + + + + + + + +
TimeTypeTypeDescription
nptstring +
+

+ Times are described using Normal Play Time (npt) as described in RFC + 2326. +

+
+
+ +

+ +

+ Definitions +

+ +

UnitType

+ +

The type of unit for the range.

+ + + + + + + + + + + + + + + + + + + + + + +
UnitTypeTypeDescription
pixelstring +

Use pixels.

+
percentstring +

Use percentage.

+
+ +

+ +

+ Definitions +

+ +

UriOrResource

+ +

+ +

Description TBD.

+

Any of the following:

+ + + +

+ Definitions +

+ +

ValidationResults

+ +

+ +

+ A map of validation results for a manifest store. The map contains the + validation results for the active manifest and any ingredient deltas. It is + normal for there to be many +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
activeManifest + + + StatusCodes + + + +

Description TBD.

+ 		NON/A
ingredientDeltas + + + + + Array of + + IngredientDeltaValidationResult + + + + + +

Description TBD.

+ 		NON/A
+ + + +

+ Definitions +

+ +

ValidationStatus

+ +

+ +

+ A + ValidationStatus + struct describes the validation status of a specific part of a manifest. See + https://c2pa.org/specifications/specifications/1.0/specs/C2PA_Specification.html#_existing_manifests. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
code + + + + + String + +

Description TBD.

+ 		+ YES + N/A
explanation + + + + + String + + + + + + +

Description TBD.

+ 		+ NO + N/A
success + + + + + Boolean + + + + + + +

Description TBD.

+ 		+ NO + N/A
url + + + + + String + + + + + + +

Description TBD.

+ 		+ NO + N/A
+ + + +

+ +

diff --git a/docs/manifest/json-ref/manifest-def.mdx b/docs/manifest/json-ref/manifest-def.mdx new file mode 100644 index 00000000..77c5ddaf --- /dev/null +++ b/docs/manifest/json-ref/manifest-def.mdx @@ -0,0 +1,15 @@ +--- +id: manifest-def +title: ManifestDefinition JSON reference +hide_table_of_contents: true +--- + +import ManifestReference from './manifest-ref.js'; + +:::danger Warning +This is a beta release of this reference. It is a work in progress and may not be accurate or complete. +::: + +This page is generated from the unmodified JSON schema generated from c2pa-rs on 05/09/2025. + + diff --git a/docs/manifest/manifest-json-schema.md b/docs/manifest/json-ref/manifest-json-schema.md similarity index 100% rename from docs/manifest/manifest-json-schema.md rename to docs/manifest/json-ref/manifest-json-schema.md diff --git a/docs/manifest/json-ref/manifest-ref.js b/docs/manifest/json-ref/manifest-ref.js new file mode 100644 index 00000000..f0d3a4b3 --- /dev/null +++ b/docs/manifest/json-ref/manifest-ref.js @@ -0,0 +1,54 @@ +import BrowserOnly from '@docusaurus/BrowserOnly'; +import React, { useEffect, useRef, useState } from 'react'; +import './cai-addon.css'; + +// Import all possible HTML files statically +const htmlFiles = { + './manifest-def.html': require('!!raw-loader!./manifest-def.html')?.default, + './reader.html': require('!!raw-loader!./reader.html')?.default, + // Add other HTML files here as needed +}; + +const ManifestReference = ({ htmlPath }) => { + const myRef = useRef(null); + const [refAquired, setRefAquired] = useState(false); + const [htmlContent, setHtmlContent] = useState(''); + + useEffect(() => { + setRefAquired(true); + }, []); + + useEffect(() => { + // Get the HTML content from our static imports + const content = htmlFiles[htmlPath]; + if (content) { + setHtmlContent(content); + } else { + console.error(`HTML file not found: ${htmlPath}`); + setHtmlContent('
Error: HTML file not found
'); + } + }, [htmlPath]); + + useEffect(() => { + if (myRef.current) { + for (const link of myRef.current.querySelectorAll('a')) { + if (link.hasAttribute('href')) { + let linkStr = link.getAttribute('href'); + if (linkStr.startsWith('crate::')) { + link.setAttribute('href', '#' + linkStr.substring(7).toLowerCase()); + } + } + } + } + }, [refAquired, htmlContent]); + + return ( + + {() => ( +
+ )} + + ); +}; + +export default ManifestReference; diff --git a/docs/manifest/json-ref/reader.html b/docs/manifest/json-ref/reader.html new file mode 100644 index 00000000..363b4c8c --- /dev/null +++ b/docs/manifest/json-ref/reader.html @@ -0,0 +1,5329 @@ +

Reader

+ +

A reader for the manifest store.

+ +

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
active_manifest + + + + + String + + + + + + +

A label for the active (most recent) manifest in the store

+ 		+ + NO + + + + N/A +
manifestsObject +

A HashMap of Manifests

+ +
See + Manifest + 		+ + YES + + + + N/A +
validation_results + + + ValidationResults + + + +

+ ValidationStatus generated when loading the ManifestStore from an + asset +

+ 		+ + NO + + + + N/A +
validation_state + + + ValidationState + + + +

The validation state of the manifest store

+ 		+ + NO + + + + N/A +
validation_status + + + + + Array of + + ValidationStatus + + + + + +

+ ValidationStatus generated when loading the ManifestStore from an + asset +

+ 		+ + NO + + + + N/A +
+ + + +

Definitions

+ + + + + + + + + + + + +
+ Actor
+ + AssetType
+ + ClaimGeneratorInfo
+ + Coordinate
+ + DataSource
+ + DateT
+ + Frame
+ + HashedUri
+ 		+ Ingredient
+ + IngredientDeltaValidationResult +
+ + Item
+ + Manifest
+ + ManifestAssertion
+ + ManifestAssertionKind
+ + ManifestData
+ + Metadata
+ 		+ Range
+ + RangeType
+ + RegionOfInterest
+ + Relationship
+ + ResourceRef
+ + ResourceStore
+ + ReviewRating
+ + Role
+ 		+ Shape
+ + ShapeType
+ + SignatureInfo
+ + SigningAlg
+ + StatusCodes
+ + Text
+ + TextSelector
+ + TextSelectorRange
+ 		+ Time
+ + TimeType
+ + UnitType
+ + UriOrResource
+ + ValidationResults
+ + ValidationState
+ + ValidationStatus
+
+ + + +

+ Definitions +

+ +

Actor

+ +

+ +

Identifies a person responsible for an action.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
credentials + + + + + Array of + + HashedUri + + + + + +
+

List of references to W3C Verifiable Credentials.

+
+ 		NON/A
identifier + + + + + String + + + + + + +
+

+ An identifier for a human actor, used when the “type” is + humanEntry.identified. +

+
+ 		NON/A
+ + + +

+ Definitions +

+ +

AssetType

+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
type + + + + + String + +

Description TBD.

+ 		+ YES + N/A
version + + + + + String + + + + + + +

Description TBD.

+ 		+ NO + N/A
+ + + +

+ Definitions +

+ +

ClaimGeneratorInfo

+ +

+ +

+ Description of the claim generator, or the software used in generating the + claim. This structure is also used for actions softwareAgent +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
icon + + + UriOrResource + + + +
+

hashed URI to the icon (either embedded or remote)

+
+ 		+ NO + N/A
name + + + + + String + +
+

A human readable string naming the claim_generator

+
+ 		+ YES + N/A
operating_system + + + + + String + + + + + + +
+

+ A human readable string of the OS the claim generator is running on +

+
+ 		+ NO + N/A
version + + + + + String + + + + + + +
+

A human readable string of the product’s version

+
+ 		+ NO + N/A
+ +

+ NOTE: This object can have any number of additional user-defined properties. +

+ + + +

+ Definitions +

+ +

Coordinate

+ +

+ +

+ An x, y coordinate used for specifying vertices in polygons. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
x + + + + + Number / double + +

The coordinate along the x-axis.

+ 		+ YES + N/A
y + + + + + Number / double + +

The coordinate along the y-axis.

+ 		+ YES + N/A
+ + + +

+ Definitions +

+ +

DataSource

+ +

+ +

A description of the source for assertion data

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
actors + + + + + Array of + + Actor + + + + + +
+

+ A list of [Actor]s associated with this source. +

+
+ 		+ NO + N/A
details + + + + + String + + + + + + +
+

+ A human-readable string giving details about the source of the + assertion data. +

+
+ 		+ NO + N/A
type + + + + + String + +
+

+ A value from among the enumerated list indicating the source of the + assertion. +

+
+ 		+ YES + N/A
+ + + +

+ Definitions +

+ +

DateT

+ +

+ +

A string.

+ + + +

+ Definitions +

+ +

Frame

+ +

+ +

+ A frame range representing starting and ending frames or pages. If both + start and + end are missing, the + frame will span the entire asset. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
end + + + + + Integer + + (int32) + + + + + +
+

+ The end of the frame inclusive or the end of the asset if not + present. +

+
+ 		NON/A
start + + + + + Integer + + (int32) + + + + + +
+

The start of the frame or the end of the asset if not present.

+ +

The first frame/page starts at 0.

+
+ 		NON/A
+ + + +

+ Definitions +

+ +

HashedUri

+ +

+ +

+ A HashedUri provides + a reference to content available within the same manifest store. This is + described in [§8.3, URI References], of the C2PA Technical Specification. + [§8.3, URI References]: + https://c2pa.org/specifications/specifications/2.1/specs/C2PA_Specification.html#_uri_references +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
alg + + + + + String + + + + + + +
+

+ A string identifying the cryptographic hash algorithm used to + compute the hash +

+
+ 		+ NO + N/A
hash + + + + + + An array of + integer + +
+

Byte string containing the hash value

+
+ 		+ YES + N/A
url + + + + + String + +

JUMBF URI reference

+ 		+ YES + N/A
+ + + +

+ Definitions +

+ +

Ingredient

+ +

+ +

+ An Ingredient is any + external asset that has been used in the creation of an asset. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
active_manifest + + + + + String + + + + + + +
+

The active manifest label (if one exists).

+ +

+ If this ingredient has a [ManifestStore], this will hold the label of the active + Manifest. +

+
+ 		NON/A
data + + + ResourceRef + + + +
+

A reference to the actual data of the ingredient.

+
+ 		NON/A
data_types + + + + + Array of + + AssetType + + + + + +
+

+ Additional information about the data’s type to the ingredient V2 + structure. +

+
+ 		NON/A
description + + + + + String + + + + + + +
+

Additional description of the ingredient.

+
+ 		NON/A
document_id + + + + + String + + + + + + +
+

+ Document ID from + xmpMM:DocumentID + in XMP metadata. +

+
+ 		NON/A
format + + + + + String + + + + + + +
+

The format of the source file as a MIME type.

+
+ 		NON/A
hash + + + + + String + + + + + + +
+

An optional hash of the asset to prevent duplicates.

+
+ 		NON/A
informational_URI + + + + + String + + + + + + +
+

URI to an informational page about the ingredient or its data.

+
+ 		NON/A
instance_id + + + + + String + + + + + + +
+

+ Instance ID from + xmpMM:InstanceID + in XMP metadata. +

+
+ 		NON/A
label + + + + + String + + + + + + +
+

The ingredient’s label as assigned in the manifest.

+
+ 		NON/A
manifest_data + + + ResourceRef + + + +
+

+ A + ManifestStore + from the source asset extracted as a binary C2PA blob. +

+
+ 		NON/A
metadata + + + Metadata + + + +
+

+ Any additional + Metadata + as defined in the C2PA spec. +

+
+ 		NON/A
provenance + + + + + String + + + + + + +
+

+ URI from + dcterms:provenance + in XMP metadata. +

+
+ 		NON/A
relationship + + + Relationship + + + +
+

+ Set to + ParentOf + if this is the parent ingredient. +

+ +

There can only be one parent ingredient in the ingredients.

+
+ 		NOcomponentOf
resources + + + ResourceStore + + + +

Description TBD.

+ 		NON/A
thumbnail + + + ResourceRef + + + +
+

+ A thumbnail image capturing the visual state at the time of import. +

+ +

+ A tuple of thumbnail MIME format (for example + image/jpeg) and binary bits of the image. +

+
+ 		NON/A
title + + + + + String + + + + + + +
+

A human-readable title, generally source filename.

+
+ 		NON/A
validation_results + + + ValidationResults + + + +

Validation results (Ingredient.V3)

+ 		NON/A
validation_status + + + + + Array of + + ValidationStatus + + + + + +
+

Validation status (Ingredient v1 & v2)

+
+ 		NON/A
+ + + +

+ Definitions +

+ +

+ IngredientDeltaValidationResult +

+ +

+ +

+ Represents any changes or deltas between the current and previous validation + results for an ingredient’s manifest. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
ingredientAssertionURI + + + + + String + +
+

JUMBF URI reference to the ingredient assertion

+
+ 		+ YES + N/A
validationDeltas + + + StatusCodes + + + +
+

Validation results for the ingredient’s active manifest

+
+ 		+ YES + N/A
+ + + +

+ Definitions +

+ +

Item

+ +

+ +

Description of the boundaries of an identified range.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
identifier + + + + + String + +
+

+ The container-specific term used to identify items, such as + “track_id” for MP4 or “item_ID” for HEIF. +

+
+ 		+ YES + N/A
value + + + + + String + +
+

+ The value of the identifier, e.g. a value of “2” for an identifier + of “track_id” would imply track 2 of the asset. +

+
+ 		+ YES + N/A
+ + + +

+ Definitions +

+ +

Manifest

+ +

+ +

+ A Manifest represents all the information in a c2pa manifest +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
assertions + + + + + + An array of + ManifestAssertion + +

A list of assertions

+ 		NOEmpty array
claim_generator + + + + + String + + + + + + +
+

+ A User Agent formatted string identifying the + software/hardware/system produced this claim Spaces are not allowed + in names, versions can be specified with product/1.0 syntax +

+
+ 		NON/A
claim_generator_info + + + + + Array of + + ClaimGeneratorInfo + + + + + +
+

+ A list of claim generator info data identifying the + software/hardware/system produced this claim +

+
+ 		NON/A
credentials + + + + + Array of true + + + + + +

A List of verified credentials

+ 		NON/A
format + + + + + String + + + + + + +
+

The format of the source file as a MIME type.

+
+ 		NON/A
ingredients + + + + + + An array of + Ingredient + +

A List of ingredients

+ 		NOEmpty array
instance_id + + + + + String + +
+

+ Instance ID from + xmpMM:InstanceID + in XMP metadata. +

+
+ 		NO + xmp:iid:424afed8-279d-4793-a279-b80a00b8c32b +
label + + + + + String + + + + + + +

Description TBD.

+ 		NON/A
metadata + + + + + Array of + + Metadata + + + + + +
+

A list of user metadata for this claim

+
+ 		NON/A
redactions + + + + + Array of string + + + + + +
+

A list of redactions - URIs to a redacted assertions

+
+ 		NON/A
resources + + + ResourceStore + + + +
+

container for binary assets (like thumbnails)

+
+ 		NON/A
signature_info + + + SignatureInfo + + + +
+

Signature data (only used for reporting)

+
+ 		NON/A
thumbnail + + + ResourceRef + + + +

Description TBD.

+ 		NON/A
title + + + + + String + + + + + + +
+

A human-readable title, generally source filename.

+
+ 		NON/A
vendor + + + + + String + + + + + + +
+

+ Optional prefix added to the generated Manifest Label This is + typically Internet domain name for the vendor (i.e. + adobe) +

+
+ 		NON/A
+ + + +

+ Definitions +

+ +

ManifestAssertion

+ +

+ +

+ A labeled container for an Assertion value in a Manifest +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
data + + + ManifestData + + + +

The data of the assertion as Value

+ 		+ YES + N/A
instance + + + + + Integer + + (uint)
Minimum: 0.0 + + + + + 		+
+

There can be more than one assertion for any label

+
+ 		+ NO + N/A
kind + + + ManifestAssertionKind + + + +
+

+ The [ManifestAssertionKind] for this assertion (as stored in c2pa + content) +

+
+ 		+ NO + N/A
label + + + + + String + +
+

An assertion label in reverse domain format

+
+ 		+ YES + N/A
+ + + +

+ Definitions +

+ +

ManifestAssertionKind

+ +

+ +

A string that is one of the following:

+ +
    +
  • “Cbor”
    • +
  • “Json”
    • +
  • “Binary”
    • +
  • “Uri”
    • +
+ +

+ Definitions +

+ +

ManifestData

+ +

+ +

Description TBD.

+

Any of the following:

+ +
    + +
  • true
    • + + +
  • type: integer, format: uint8, minimum: 0.0
    • +
+ +

+ Definitions +

+ +

Metadata

+ +

+ +

+ The Metadata structure can be used as part of other assertions or on its own + to reference others +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
dataSource + + + DataSource + + + +

Description TBD.

+ 		NON/A
dateTime + + + DateT + + + +

Description TBD.

+ 		NON/A
reference + + + HashedUri + + + +

Description TBD.

+ 		NON/A
regionOfInterest + + + RegionOfInterest + + + +

Description TBD.

+ 		NON/A
reviewRatings + + + + + Array of + + ReviewRating + + + + + +

Description TBD.

+ 		NON/A
+ +

+ NOTE: This object can have any number of additional user-defined properties. +

+ + + +

+ Definitions +

+ +

Range

+ +

+ +

+ A spatial, temporal, frame, or textual range describing the region of + interest. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
frame + + + Frame + + + +

A frame range.

+ 		+ NO + N/A
item + + + Item + + + +

A item identifier.

+ 		+ NO + N/A
shape + + + Shape + + + +

A spatial range.

+ 		+ NO + N/A
text + + + Text + + + +

A textual range.

+ 		+ NO + N/A
time + + + Time + + + +

A temporal range.

+ 		+ NO + N/A
type + + + RangeType + + + +

The type of range of interest.

+ 		+ YES + N/A
+ + + +

+ Definitions +

+ +

RangeType

+ +

The type of range for the region of interest.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
RangeTypeTypeDescription
spatialstring +
+

+ A spatial range, see [Shape] for more details. +

+
+
temporalstring +
+

+ A temporal range, see [Time] for more details. +

+
+
framestring +
+

+ A spatial range, see [Frame] for more details. +

+
+
textualstring +
+

+ A textual range, see [Text] for more details. +

+
+
identifiedstring +
+

+ A range identified by a specific identifier and value, see [Item] for more details. +

+
+
+ +

+ +

+ Definitions +

+ +

RegionOfInterest

+ +

+ +

+ A region of interest within an asset describing the change. This struct can be + used from [Action::changes][crate::assertions::Action::changes] or [Metadata::region_of_interest][crate::assertions::Metadata::region_of_interest]. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
description + + + + + String + + + + + + +

A free-text string.

+ 		+ NO + N/A
identifier + + + + + String + + + + + + +
+

+ A free-text string representing a machine-readable, unique to this + assertion, identifier for the region. +

+
+ 		+ NO + N/A
metadata + + + Metadata + + + +
+

Additional information about the asset.

+
+ 		+ NO + N/A
name + + + + + String + + + + + + +
+

+ A free-text string representing a human-readable name for the region + which might be used in a user interface. +

+
+ 		+ NO + N/A
region + + + + + + An array of + Range + +
+

+ A range describing the region of interest for the specific asset. +

+
+ 		+ YES + N/A
role + + + Role + + + +
+

+ A value from our controlled vocabulary or an entity-specific value + (e.g., com.litware.coolArea) that represents the role of a region + among other regions. +

+
+ 		+ NO + N/A
type + + + + + String + + + + + + +
+

+ A value from a controlled vocabulary such as + https://cv.iptc.org/newscodes/imageregiontype/ + or an entity-specific value (e.g., com.litware.newType) that + represents the type of thing(s) depicted by a region. +

+ +

+ Note this field serializes/deserializes into the name + type. +

+
+ 		+ NO + N/A
+ + + +

+ Definitions +

+ +

Relationship

+ +

+ +

A string that is one of the following:

+ +
    +
  • “parentOf”
    • +
  • “componentOf”
    • +
  • “inputTo”
    • +
+ +

+ Definitions +

+ +

ResourceRef

+ +

+ +

+ A reference to a resource to be used in JSON serialization. The underlying + data can be read as a stream via [Reader::resource_to_stream][crate::Reader::resource_to_stream]. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
alg + + + + + String + + + + + + +
+

The algorithm used to hash the resource (if applicable).

+
+ 		+ NO + N/A
data_types + + + + + Array of + + AssetType + + + + + +
+

More detailed data types as defined in the C2PA spec.

+
+ 		+ NO + N/A
format + + + + + String + +
+

The mime type of the referenced resource.

+
+ 		+ YES + N/A
hash + + + + + String + + + + + + +
+

The hash of the resource (if applicable).

+
+ 		+ NO + N/A
identifier + + + + + String + +
+

+ A URI that identifies the resource as referenced from the manifest. +

+ +

+ This may be a JUMBF URI, a file path, a URL or any other string. + Relative JUMBF URIs will be resolved with the manifest label. + Relative file paths will be resolved with the base path if provided. +

+
+ 		+ YES + N/A
+ + + +

+ Definitions +

+ +

ResourceStore

+ +

+ +

+ Resource store to contain binary objects referenced from JSON serializable + structures +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
base_path + + + + + String + + + + + + +

Description TBD.

+ 		+ NO + N/A
label + + + + + String + + + + + + +

Description TBD.

+ 		+ NO + N/A
resources + + + + + (Object) + +

Description TBD.

+ 		+ YES + N/A
+ + + +

+ Definitions +

+ +

ReviewRating

+ +

+ +

+ A rating on an Assertion. See + https://c2pa.org/specifications/specifications/1.0/specs/C2PA_Specification.html#_claim_review. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
code + + + + + String + + + + + + +

Description TBD.

+ 		+ NO + N/A
explanation + + + + + String + +

Description TBD.

+ 		+ YES + N/A
value + + + + + Integer (uint8) +
Minimum: 0.0 + 		+

Description TBD.

+ 		+ YES + N/A
+ + + +

+ Definitions +

+ +

Role

+ +

A role describing the region.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
RoleTypeDescription
c2pa.areaOfIntereststring +

Arbitrary area worth identifying.

+
c2pa.croppedstring +
+

This area is all that is left after a crop action.

+
+
c2pa.editedstring +
+

This area has had edits applied to it.

+
+
c2pa.placedstring +
+

The area where an ingredient was placed/added.

+
+
c2pa.redactedstring +

Something in this area was redacted.

+
c2pa.subjectAreastring +
+

Area specific to a subject (human or not).

+
+
c2pa.deletedstring +
+

A range of information was removed/deleted.

+
+
c2pa.styledstring +

Styling was applied to this area.

+
c2pa.watermarkedstring +
+

+ Invisible watermarking was applied to this area for the purpose of + soft binding. +

+
+
+ +

+ +

+ Definitions +

+ +

Shape

+ +

+ +

+ A spatial range representing rectangle, circle, or a polygon. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
height + + + + + Number + + (double) + + + + + +
+

The height of a rectnagle.

+ +

This field can be ignored for circles and polygons.

+
+ 		+ NO + N/A
inside + + + + + Boolean + + + + + + +
+

If the range is inside the shape.

+ +

The default value is true.

+
+ 		+ NO + N/A
origin + + + Coordinate + + + +
+

THe origin of the coordinate in the shape.

+
+ 		+ YES + N/A
type + + + ShapeType + + + +

The type of shape.

+ 		+ YES + N/A
unit + + + UnitType + + + +
+

The type of unit for the shape range.

+
+ 		+ YES + N/A
vertices + + + + + Array of + + Coordinate + + + + + +
+

The vertices of the polygon.

+ +

This field can be ignored for rectangles and circles.

+
+ 		+ NO + N/A
width + + + + + Number + + (double) + + + + + +
+

The width for rectangles or diameter for circles.

+ +

This field can be ignored for polygons.

+
+ 		+ NO + N/A
+ + + +

+ Definitions +

+ +

ShapeType

+ +

The type of shape for the range.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
ShapeTypeTypeDescription
rectanglestring +

A rectangle.

+
circlestring +

A circle.

+
polygonstring +

A polygon.

+
+ +

+ +

+ Definitions +

+ +

SignatureInfo

+ +

+ +

Holds information about a signature

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
alg + + + SigningAlg + + + +
+

Human-readable issuing authority for this signature.

+
+ 		NON/A
cert_serial_number + + + + + String + + + + + + +
+

The serial number of the certificate.

+
+ 		NON/A
issuer + + + + + String + + + + + + +
+

Human-readable issuing authority for this signature.

+
+ 		NON/A
revocation_status + + + + + Boolean + + + + + + +
+

Revocation status of the certificate.

+
+ 		NON/A
time + + + + + String + + + + + + +

The time the signature was created.

+ 		NON/A
+ + + +

+ Definitions +

+ +

SigningAlg

+ +

Describes the digital signature algorithms allowed by the C2PA spec.

+ +

+ Per + §13.2, “Digital Signatures”: +

+ +
+

+ All digital signatures applied as per the technical requirements of this + > specification shall be generated using one of the digital signature + > algorithms and key types listed as described in this section. +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SigningAlgTypeDescription
Es256string +

ECDSA with SHA-256

+
Es384string +

ECDSA with SHA-384

+
Es512string +

ECDSA with SHA-512

+
Ps256string +
+

RSASSA-PSS using SHA-256 and MGF1 with SHA-256

+
+
Ps384string +
+

RSASSA-PSS using SHA-384 and MGF1 with SHA-384

+
+
Ps512string +
+

RSASSA-PSS using SHA-512 and MGF1 with SHA-512

+
+
Ed25519string +
+

Edwards-Curve DSA (Ed25519 instance only)

+
+
+ +

+ +

+ Definitions +

+ +

StatusCodes

+ +

+ +

+ Contains a set of success, informational, and failure validation status codes. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
failure + + + + + + An array of + ValidationStatus + +

Description TBD.

+ 		+ YES + N/A
informational + + + + + + An array of + ValidationStatus + +

Description TBD.

+ 		+ YES + N/A
success + + + + + + An array of + ValidationStatus + +

Description TBD.

+ 		+ YES + N/A
+ + + +

+ Definitions +

+ +

Text

+ +

+ +

+ A textual range representing multiple (possibly discontinuous) ranges of text. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
selectors + + + + + + An array of + TextSelectorRange + +

The ranges of text to select.

+ 		+ YES + N/A
+ + + +

+ Definitions +

+ +

TextSelector

+ +

+ +

+ Selects a range of text via a fragment identifier. This is modeled after the + W3C Web Annotation selector model. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
end + + + + + Integer + + (int32) + + + + + +
+

+ The end character offset or the end of the fragment if not present. +

+
+ 		+ NO + N/A
fragment + + + + + String + +
+

+ Fragment identifier as per RFC3023 (XML) or ISO 32000-2 (PDF), Annex + O. +

+
+ 		+ YES + N/A
start + + + + + Integer + + (int32) + + + + + +
+

+ The start character offset or the start of the fragment if not + present. +

+
+ 		+ NO + N/A
+ + + +

+ Definitions +

+ +

TextSelectorRange

+ +

+ +

+ One or two [TextSelector][TextSelector] identifiying the range to select. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
end + + + TextSelector + + + +

The end of the text range.

+ 		+ NO + N/A
selector + + + TextSelector + + + +

The start (or entire) text range.

+ 		+ YES + N/A
+ + + +

+ Definitions +

+ +

Time

+ +

+ +

+ A temporal range representing a starting time to an ending time. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
end + + + + + String + + + + + + +
+

The end time or the end of the asset if not present.

+
+ 		NON/A
start + + + + + String + + + + + + +
+

The start time or the start of the asset if not present.

+
+ 		NON/A
type + + + TimeType + + + +

The type of time.

+ 		NOnpt
+ + + +

+ Definitions +

+ +

TimeType

+ +

The type of time.

+ + + + + + + + + + + + + + + + + +
TimeTypeTypeDescription
nptstring +
+

+ Times are described using Normal Play Time (npt) as described in RFC + 2326. +

+
+
+ +

+ +

+ Definitions +

+ +

UnitType

+ +

The type of unit for the range.

+ + + + + + + + + + + + + + + + + + + + + + +
UnitTypeTypeDescription
pixelstring +

Use pixels.

+
percentstring +

Use percentage.

+
+ +

+ +

+ Definitions +

+ +

UriOrResource

+ +

+ +

Description TBD.

+

Any of the following:

+ + + +

+ Definitions +

+ +

ValidationResults

+ +

+ +

+ A map of validation results for a manifest store. The map contains the + validation results for the active manifest and any ingredient deltas. It is + normal for there to be many +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
activeManifest + + + StatusCodes + + + +

Description TBD.

+ 		NON/A
ingredientDeltas + + + + + Array of + + IngredientDeltaValidationResult + + + + + +

Description TBD.

+ 		NON/A
+ + + +

+ Definitions +

+ +

ValidationState

+ +

Indicates if the manifest store is valid and trusted.

+ +

+ The Trusted state implies the manifest store is valid and the active signature + is trusted. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValidationStateTypeDescription
Invalidstring +
+

Errors were found in the manifest store.

+
+
Validstring +
+

+ No errors were found in validation, but the active signature is not + trusted. +

+
+
Trustedstring +
+

+ The manifest store is valid and the active signature is trusted. +

+
+
+ +

+ +

+ Definitions +

+ +

ValidationStatus

+ +

+ +

+ A + ValidationStatus + struct describes the validation status of a specific part of a manifest. See + https://c2pa.org/specifications/specifications/1.0/specs/C2PA_Specification.html#_existing_manifests. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRequired?Default Value
code + + + + + String + +

Description TBD.

+ 		+ YES + N/A
explanation + + + + + String + + + + + + +

Description TBD.

+ 		+ NO + N/A
success + + + + + Boolean + + + + + + +

Description TBD.

+ 		+ NO + N/A
url + + + + + String + + + + + + +

Description TBD.

+ 		+ NO + N/A
+ + + +

+ +

diff --git a/docs/manifest/manifest-ref.mdx b/docs/manifest/json-ref/reader.mdx similarity index 54% rename from docs/manifest/manifest-ref.mdx rename to docs/manifest/json-ref/reader.mdx index c9c68f1f..b4a11412 100644 --- a/docs/manifest/manifest-ref.mdx +++ b/docs/manifest/json-ref/reader.mdx @@ -1,6 +1,6 @@ --- -id: manifest-ref -title: Manifest store reference +id: reader +title: Reader JSON reference hide_table_of_contents: true --- @@ -10,4 +10,6 @@ import ManifestReference from './manifest-ref.js'; This is a beta release of this reference. It is a work in progress and may not be accurate or complete. ::: - +This page is generated from the unmodified JSON schema generated from c2pa-rs on 05/09/2025. + + diff --git a/docs/manifest/manifest-ref.js b/docs/manifest/manifest-ref.js deleted file mode 100644 index b7a82cdd..00000000 --- a/docs/manifest/manifest-ref.js +++ /dev/null @@ -1,35 +0,0 @@ -import BrowserOnly from '@docusaurus/BrowserOnly'; -import React, { useEffect, useRef, useState } from 'react'; -import './cai-addon.css'; -const referenceCAI = require('!!raw-loader!./reference-cai.html')?.default; - -const ManifestReference = () => { - const myRef = useRef(null); - const [refAquired, setRefAquired] = useState(false); - useEffect(() => { - setRefAquired(true); - }, []); - - useEffect(() => { - if (myRef.current) { - for (const link of myRef.current.querySelectorAll('a')) { - if (link.hasAttribute('href')) { - let linkStr = link.getAttribute('href'); - if (linkStr.startsWith('crate::')) { - link.setAttribute('href', '#' + linkStr.substring(7).toLowerCase()); - } - } - } - } - }, [refAquired]); - - return ( - - {() => ( -
- )} - - ); -}; - -export default ManifestReference; diff --git a/docs/manifest/reference-cai.html b/docs/manifest/reference-cai.html deleted file mode 100644 index 764f43b1..00000000 --- a/docs/manifest/reference-cai.html +++ /dev/null @@ -1,5220 +0,0 @@ - -
- - ManifestStore - -
-
-
- - active_manifest - - : - - - UUID - - -
-
- - manifests - -
-
-
- - UUID - - : -
-
- - Manifest - -
-
-
-
- - UUID - - : -
-
- - Manifest - -
-
-
- - ... - -
-
-
- - validation_status - - : Array of -
-
- - ValidationStatus - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- - Manifest - -
-
-
- -
- title -
-
- : - - A human-readable title, generally source filename. - -
-
-
- -
- label -
-
- : - - : - - Description TBD - - . - -
-
-
- -
- format -
-
- : - - The format of the source file as a MIME type. - -
-
-
- -
- credentials -
-
- : - - A List of verified credentials - -
-
-
- -
- instance_id -
-
- : - - Instance ID from - - xmpMM:InstanceID - - in XMP metadata. - -
-
-
- -
- redactions -
-
- : - - A list of redactions - URIs to a redacted assertions - -
-
-
- -
- claim_generator -
-
- : - - A User Agent formatted string identifying the software/hardware/system produced this claim Spaces are not allowed in names, versions can be specified with product/1.0 syntax - -
-
-
-
- claim_generator_info -
-
- - ClaimGeneratorInfo - -
-
-
-
- thumbnail -
-
- - ResourceRef - -
-
-
-
- - ingredients - - : Array of -
-
- - Ingredient - -
-
-
-
- - assertions - - : Array of -
-
- - ManifestAssertion - -
-
-
-
- signature_info -
-
- - SignatureInfo - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

- -

-

- ManifestStore -

-

- A Container for a set of Manifests and a ValidationStatus list.. -

-

- Properties -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Property - - Type - - Description - - Required? -
- active_manifest - - - - String - - - - -

- A label for the active (most recent) manifest in the store. -

- 		- - NO -
- manifests - - Object - -

- A HashMap of Manifests. -

-
- See - - Manifest - - 		- - YES -
- validation_status - - - - Array of - - ValidationStatus - - - - -

- ValidationStatus generated when loading the ManifestStore from an asset. -

- 		- - NO -
- -

- Definitions -

- - - - - - - - - - - -
- - Actor - -
- - AssetType - -
- - ClaimGeneratorInfo - -
- - Coordinate - -
- - DataSource - -
- - Frame - -
- - HashedUri - -
- 		- - Ingredient - -
- - Manifest - -
- - ManifestAssertion - -
- - ManifestAssertionKind - -
- - ManifestData - -
- - Metadata - -
- - Range - -
- 		- - RangeType - -
- - RegionOfInterest - -
- - Relationship - -
- - ResourceRef - -
- - ReviewRating - -
- - Role - -
- - Shape - -
- 		- - ShapeType - -
- - SignatureInfo - -
- - SigningAlg - -
- - Text - -
- - TextSelector - -
- - TextSelectorRange - -
- - Time - -
- 		- - TimeType - -
- - UnitType - -
- - UriOrResource - -
- - ValidationStatus - -
-
- -

- - Scroll To Top - -

-

- Actor -

-

- -

-

- Identifies a person responsible for an action. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Property - - Type - - Description - - Required? - - Default Value -
- credentials - - - - Array of - - HashedUri - - - - -
-

- List of references to W3C Verifiable Credentials. -

-
- 		- - NO - - - N/A -
- identifier - - - - String - - - - -
-

- An identifier for a human actor, used when the “type” is - - humanEntry.identified - - . -

-
- 		- - NO - - - N/A -
- -

- - Scroll To Top - -

-

- AssetType -

-

- -

-

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Property - - Type - - Description - - Required? - - Default Value -
- type - - - - String - -

- Description TBD. -

- 		- - YES - - - N/A -
- version - - - - String - - - - -

- Description TBD. -

- 		- - NO - - - N/A -
- -

- - Scroll To Top - -

-

- ClaimGeneratorInfo -

-

- -

-

- Description of the claim generator, or the software used in generating the claim. - -This structure is also used for actions softwareAgent -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Property - - Type - - Description - - Required? - - Default Value -
- icon - - - - UriOrResource - - - -
-

- hashed URI to the icon (either embedded or remote) -

-
- 		- - NO - - - N/A -
- name - - - - String - -
-

- A human readable string naming the claim_generator -

-
- 		- - YES - - - N/A -
- version - - - - String - - - - -
-

- A human readable string of the product’s version -

-
- 		- - NO - - - N/A -
-

- NOTE: This object can have any number of additional user-defined properties. -

- -

- - Scroll To Top - -

-

- Coordinate -

-

- -

-

- An x, y coordinate used for specifying vertices in polygons. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Property - - Type - - Description - - Required? - - Default Value -
- x - - - - Number - - / double - -
-

- The coordinate along the x-axis. -

-
- 		- - YES - - - N/A -
- y - - - - Number - - / double - -
-

- The coordinate along the y-axis. -

-
- 		- - YES - - - N/A -
- -

- - Scroll To Top - -

-

- DataSource -

-

- -

-

- A description of the source for assertion data -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Property - - Type - - Description - - Required? - - Default Value -
- actors - - - - Array of - - Actor - - - - -
-

- A list of [ - - Actor - - ]s associated with this source. -

-
- 		- - NO - - - N/A -
- details - - - - String - - - - -
-

- A human-readable string giving details about the source of the assertion data. -

-
- 		- - NO - - - N/A -
- type - - - - String - -
-

- A value from among the enumerated list indicating the source of the assertion. -

-
- 		- - YES - - - N/A -
- -

- - Scroll To Top - -

-

- Frame -

-

- -

-

- A frame range representing starting and ending frames or pages. - -If both - - start - - and - - end - - are missing, the frame will span the entire asset. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Property - - Type - - Description - - Required? - - Default Value -
- end - - - - Integer - - (int32) - - - -
-

- The end of the frame inclusive or the end of the asset if not present. -

-
- 		- - NO - - - N/A -
- start - - - - Integer - - (int32) - - - -
-

- The start of the frame or the end of the asset if not present. -

-

- The first frame/page starts at 0. -

-
- 		- - NO - - - N/A -
- -

- - Scroll To Top - -

-

- HashedUri -

-

- -

-

- Hashed Uri structure as defined by C2PA spec It is annotated to produce the correctly tagged cbor serialization -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Property - - Type - - Description - - Required? - - Default Value -
- alg - - - - String - - - - -

- Description TBD. -

- 		- - NO - - - N/A -
- hash - - - - - An array of - - integer - - -

- Description TBD. -

- 		- - YES - - - N/A -
- url - - - - String - -

- Description TBD. -

- 		- - YES - - - N/A -
- -

- - Scroll To Top - -

-

- Ingredient -

-

- -

-

- An - - Ingredient - - is any external asset that has been used in the creation of an asset. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Property - - Type - - Description - - Required? - - Default Value -
- active_manifest - - - - String - - - - -
-

- The active manifest label (if one exists). -

-

- If this ingredient has a - - - ManifestStore - - - , this will hold the label of the active - - - Manifest - - - . -

-
- 		- - NO - - - N/A -
- data - - - - ResourceRef - - - -
-

- A reference to the actual data of the ingredient. -

-
- 		- - NO - - - N/A -
- data_types - - - - Array of - - AssetType - - - - -
-

- Additional information about the data’s type to the ingredient V2 structure. -

-
- 		- - NO - - - N/A -
- description - - - - String - - - - -
-

- Additional description of the ingredient. -

-
- 		- - NO - - - N/A -
- document_id - - - - String - - - - -
-

- Document ID from - - xmpMM:DocumentID - - in XMP metadata. -

-
- 		- - NO - - - N/A -
- format - - - - String - -
-

- The format of the source file as a MIME type. -

-
- 		- - NO - - - application/octet-stream -
- hash - - - - String - - - - -
-

- An optional hash of the asset to prevent duplicates. -

-
- 		- - NO - - - N/A -
- informational_URI - - - - String - - - - -
-

- URI to an informational page about the ingredient or its data. -

-
- 		- - NO - - - N/A -
- instance_id - - - - String - - - - -
-

- Instance ID from - - xmpMM:InstanceID - - in XMP metadata. -

-
- 		- - NO - - - N/A -
- manifest_data - - - - ResourceRef - - - -
-

- A - - - ManifestStore - - - from the source asset extracted as a binary C2PA blob. -

-
- 		- - NO - - - N/A -
- metadata - - - - Metadata - - - -
-

- Any additional - - - Metadata - - - as defined in the C2PA spec. -

-
- 		- - NO - - - N/A -
- provenance - - - - String - - - - -
-

- URI from - - dcterms:provenance - - in XMP metadata. -

-
- 		- - NO - - - N/A -
- relationship - - - - Relationship - - - -
-

- Set to - - ParentOf - - if this is the parent ingredient. -

-

- There can only be one parent ingredient in the ingredients. -

-
- 		- - NO - - - componentOf -
- thumbnail - - - - ResourceRef - - - -
-

- A thumbnail image capturing the visual state at the time of import. -

-

- A tuple of thumbnail MIME format (for example - - image/jpeg - - ) and binary bits of the image. -

-
- 		- - NO - - - N/A -
- title - - - - String - -
-

- A human-readable title, generally source filename. -

-
- 		- - YES - - - N/A -
- validation_status - - - - Array of - - ValidationStatus - - - - -
-

- Validation results. -

-
- 		- - NO - - - N/A -
- -

- - Scroll To Top - -

-

- Manifest -

-

- -

-

- A Manifest represents all the information in a c2pa manifest -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Property - - Type - - Description - - Required? - - Default Value -
- assertions - - - - - An array of - - ManifestAssertion - - -
-

- A list of assertions -

-
- 		- - NO - - - Empty array -
- claim_generator - - - - String - -
-

- A User Agent formatted string identifying the software/hardware/system produced this claim Spaces are not allowed in names, versions can be specified with product/1.0 syntax -

-
- 		- - NO - - - c2pa/0.36.3 -
- claim_generator_info - - - - Array of - - ClaimGeneratorInfo - - - - -
-

- A list of claim generator info data identifying the software/hardware/system produced this claim -

-
- 		- - NO - - - N/A -
- credentials - - - - Array of - - - - - true - - - -
-

- A List of verified credentials -

-
- 		- - NO - - - N/A -
- format - - - - String - -
-

- The format of the source file as a MIME type. -

-
- 		- - NO - - - application/octet-stream -
- ingredients - - - - - An array of - - Ingredient - - -
-

- A List of ingredients -

-
- 		- - NO - - - Empty array -
- instance_id - - - - String - -
-

- Instance ID from - - xmpMM:InstanceID - - in XMP metadata. -

-
- 		- - NO - - - xmp:iid:eafef862-379d-44a1-99f7-2ead485e279d -
- label - - - - String - - - - -

- Description TBD. -

- 		- - NO - - - N/A -
- metadata - - - - Array of - - Metadata - - - - -
-

- A list of user metadata for this claim -

-
- 		- - NO - - - N/A -
- redactions - - - - Array of - - - - - string - - - -
-

- A list of redactions - URIs to a redacted assertions -

-
- 		- - NO - - - N/A -
- signature_info - - - - SignatureInfo - - - -
-

- Signature data (only used for reporting) -

-
- 		- - NO - - - N/A -
- thumbnail - - - - ResourceRef - - - -

- Description TBD. -

- 		- - NO - - - N/A -
- title - - - - String - - - - -
-

- A human-readable title, generally source filename. -

-
- 		- - NO - - - N/A -
- vendor - - - - String - - - - -
-

- Optional prefix added to the generated Manifest Label This is typically Internet domain name for the vendor (i.e. - - adobe - - ) -

-
- 		- - NO - - - N/A -
- -

- - Scroll To Top - -

-

- ManifestAssertion -

-

- -

-

- A labeled container for an Assertion value in a Manifest -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Property - - Type - - Description - - Required? - - Default Value -
- data - - - - ManifestData - - - -
-

- The data of the assertion as Value -

-
- 		- - YES - - - N/A -
- instance - - - - Integer - - (uint) -
- Minimum: 0.0 - - - 		-
-

- There can be more than one assertion for any label -

-
- 		- - NO - - - N/A -
- kind - - - - ManifestAssertionKind - - - -
-

- The - - ManifestAssertionKind - - for this assertion (as stored in c2pa content) -

-
- 		- - NO - - - N/A -
- label - - - - String - -
-

- An assertion label in reverse domain format -

-
- 		- - YES - - - N/A -
- -

- - Scroll To Top - -

-

- ManifestAssertionKind -

-

- -

-

- A string that is one of the following: -

-
    -
  • - “Cbor” -
    • -
  • - “Json” -
    • -
  • - “Binary” -
    • -
  • - “Uri” - -
    • -
-

- - Scroll To Top - -

-

- ManifestData -

-

- -

-

- Description TBD. -

-

- Any of the following: -

-
    - -
  • - true -
    • - -
  • - type: integer, - format: uint8, - minimum: 0.0 -
    • -
-

- - Scroll To Top - -

-

- Metadata -

-

- -

-

- The Metadata structure can be used as part of other assertions or on its own to reference others -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Property - - Type - - Description - - Required? - - Default Value -
- dataSource - - - - DataSource - - - -

- Description TBD. -

- 		- - NO - - - N/A -
- dateTime - - - - String - -
-

- A date time in ISO 8601 format. -

-
- 		- - NO - - - N/A -
- reference - - - - HashedUri - - - -

- Description TBD. -

- 		- - NO - - - N/A -
- regionOfInterest - - - - RegionOfInterest - - - -

- Description TBD. -

- 		- - NO - - - N/A -
- reviewRatings - - - - Array of - - ReviewRating - - - - -

- Description TBD. -

- 		- - NO - - - N/A -
-

- NOTE: This object can have any number of additional user-defined properties. -

- -

- - Scroll To Top - -

-

- Range -

-

- -

-

- A spatial, temporal, frame, or textual range describing the region of interest. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Property - - Type - - Description - - Required? - - Default Value -
- frame - - - - Frame - - - -
-

- A frame range. -

-
- 		- - NO - - - N/A -
- shape - - - - Shape - - - -
-

- A spatial range. -

-
- 		- - NO - - - N/A -
- text - - - - Text - - - -
-

- A textual range. -

-
- 		- - NO - - - N/A -
- time - - - - Time - - - -
-

- A temporal range. -

-
- 		- - NO - - - N/A -
- type - - - - RangeType - - - -
-

- The type of range of interest. -

-
- 		- - YES - - - N/A -
- -

- - Scroll To Top - -

-

- RangeType -

-

- The type of range for the region of interest. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- RangeType - - Type - - Description -
- spatial - - string - -
-

- A spatial range, see - - - Shape - - - for more details. -

-
-
- temporal - - string - -
-

- A temporal range, see - - - Time - - - for more details. -

-
-
- frame - - string - -
-

- A spatial range, see - - - Frame - - - for more details. -

-
-
- textual - - string - -
-

- A textual range, see - - - Text - - - for more details. -

-
-
-

- -

-

- - Scroll To Top - -

-

- RegionOfInterest -

-

- -

-

- A region of interest within an asset describing the change. - -This struct can be used from - - - Action::changes - - - or - - - Metadata::region_of_interest - - - . -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Property - - Type - - Description - - Required? - - Default Value -
- description - - - - String - - - - -
-

- A free-text string. -

-
- 		- - NO - - - N/A -
- identifier - - - - String - - - - -
-

- A free-text string representing a machine-readable, unique to this assertion, identifier for the region. -

-
- 		- - NO - - - N/A -
- metadata - - - - Metadata - - - -
-

- Additional information about the asset. -

-
- 		- - NO - - - N/A -
- name - - - - String - - - - -
-

- A free-text string representing a human-readable name for the region which might be used in a user interface. -

-
- 		- - NO - - - N/A -
- region - - - - - An array of - - Range - - -
-

- A range describing the region of interest for the specific asset. -

-
- 		- - YES - - - N/A -
- role - - - - Role - - - -
-

- A value from our controlled vocabulary or an entity-specific value (e.g., com.litware.coolArea) that represents the role of a region among other regions. -

-
- 		- - NO - - - N/A -
- type - - - - String - - - - -
-

- A value from a controlled vocabulary such as - - https://cv.iptc.org/newscodes/imageregiontype/ - - or an entity-specific value (e.g., com.litware.newType) that represents the type of thing(s) depicted by a region. -

-

- Note this field serializes/deserializes into the name - - type - - . -

-
- 		- - NO - - - N/A -
- -

- - Scroll To Top - -

-

- Relationship -

-

- -

-

- A string that is one of the following: -

-
    -
  • - “parentOf” -
    • -
  • - “componentOf” -
    • -
  • - “inputTo” - -
    • -
-

- - Scroll To Top - -

-

- ResourceRef -

-

- -

-

- A reference to a resource to be used in JSON serialization. - -The underlying data can be read as a stream via - - - Reader::resource_to_stream - - - . -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Property - - Type - - Description - - Required? - - Default Value -
- alg - - - - String - - - - -
-

- The algorithm used to hash the resource (if applicable). -

-
- 		- - NO - - - N/A -
- data_types - - - - Array of - - AssetType - - - - -
-

- More detailed data types as defined in the C2PA spec. -

-
- 		- - NO - - - N/A -
- format - - - - String - -
-

- The mime type of the referenced resource. -

-
- 		- - YES - - - N/A -
- hash - - - - String - - - - -
-

- The hash of the resource (if applicable). -

-
- 		- - NO - - - N/A -
- identifier - - - - String - -
-

- A URI that identifies the resource as referenced from the manifest. -

-

- This may be a JUMBF URI, a file path, a URL or any other string. Relative JUMBF URIs will be resolved with the manifest label. Relative file paths will be resolved with the base path if provided. -

-
- 		- - YES - - - N/A -
- -

- - Scroll To Top - -

-

- ReviewRating -

-

- -

-

- A rating on an - - - Assertion - - - . - - See - - Review Ratings in C2PA spec - -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Property - - Type - - Description - - Required? - - Default Value -
- code - - - - String - - - - -

- Description TBD. -

- 		- - NO - - - N/A -
- explanation - - - - String - -

- Description TBD. -

- 		- - YES - - - N/A -
- value - - - - Integer - (uint8) -
- Minimum: 0.0 - 		-

- Description TBD. -

- 		- - YES - - - N/A -
- -

- - Scroll To Top - -

-

- Role -

-

- A role describing the region. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Role - - Type - - Description -
- c2pa.areaOfInterest - - string - -
-

- Arbitrary area worth identifying. -

-
-
- c2pa.cropped - - string - -
-

- This area is all that is left after a crop action. -

-
-
- c2pa.edited - - string - -
-

- This area has had edits applied to it. -

-
-
- c2pa.placed - - string - -
-

- The area where an ingredient was placed/added. -

-
-
- c2pa.redacted - - string - -
-

- Something in this area was redacted. -

-
-
- c2pa.subjectArea - - string - -
-

- Area specific to a subject (human or not). -

-
-
- c2pa.deleted - - string - -
-

- A range of information was removed/deleted. -

-
-
- c2pa.styled - - string - -
-

- Styling was applied to this area. -

-
-
- c2pa.watermarked - - string - -
-

- Invisible watermarking was applied to this area for the purpose of soft binding. -

-
-
-

- -

-

- - Scroll To Top - -

-

- Shape -

-

- -

-

- A spatial range representing rectangle, circle, or a polygon. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Property - - Type - - Description - - Required? - - Default Value -
- height - - - - Number - - (double) - - - -
-

- The height of a rectnagle. -

-

- This field can be ignored for circles and polygons. -

-
- 		- - NO - - - N/A -
- inside - - - - Boolean - - - - -
-

- If the range is inside the shape. -

-

- The default value is true. -

-
- 		- - NO - - - N/A -
- origin - - - - Coordinate - - - -
-

- THe origin of the coordinate in the shape. -

-
- 		- - YES - - - N/A -
- type - - - - ShapeType - - - -
-

- The type of shape. -

-
- 		- - YES - - - N/A -
- unit - - - - UnitType - - - -
-

- The type of unit for the shape range. -

-
- 		- - YES - - - N/A -
- vertices - - - - Array of - - Coordinate - - - - -
-

- The vertices of the polygon. -

-

- This field can be ignored for rectangles and circles. -

-
- 		- - NO - - - N/A -
- width - - - - Number - - (double) - - - -
-

- The width for rectangles or diameter for circles. -

-

- This field can be ignored for polygons. -

-
- 		- - NO - - - N/A -
- -

- - Scroll To Top - -

-

- ShapeType -

-

- The type of shape for the range. -

- - - - - - - - - - - - - - - - - - - - - - - - - -
- ShapeType - - Type - - Description -
- rectangle - - string - -
-

- A rectangle. -

-
-
- circle - - string - -
-

- A circle. -

-
-
- polygon - - string - -
-

- A polygon. -

-
-
-

- -

-

- - Scroll To Top - -

-

- SignatureInfo -

-

- -

-

- Holds information about a signature -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Property - - Type - - Description - - Required? - - Default Value -
- alg - - - - SigningAlg - - - -
-

- human readable issuing authority for this signature -

-
- 		- - NO - - - N/A -
- cert_serial_number - - - - String - - - - -
-

- The serial number of the certificate -

-
- 		- - NO - - - N/A -
- issuer - - - - String - - - - -
-

- human readable issuing authority for this signature -

-
- 		- - NO - - - N/A -
- revocation_status - - - - Boolean - - - - -
-

- revocation status of the certificate -

-
- 		- - NO - - - N/A -
- time - - - - String - - - - -
-

- the time the signature was created -

-
- 		- - NO - - - N/A -
- -

- - Scroll To Top - -

-

- SigningAlg -

-

- Describes the digital signature algorithms allowed by the - - C2PA spec - - : -

-
-

- All digital signatures that are stored in a C2PA Manifest shall be generated using one of the digital signature algorithms and key types listed as described in this section. -

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- SigningAlg - - Type - - Description -
- Es256 - - string - -
-

- ECDSA with SHA-256 -

-
-
- Es384 - - string - -
-

- ECDSA with SHA-384 -

-
-
- Es512 - - string - -
-

- ECDSA with SHA-512 -

-
-
- Ps256 - - string - -
-

- RSASSA-PSS using SHA-256 and MGF1 with SHA-256 -

-
-
- Ps384 - - string - -
-

- RSASSA-PSS using SHA-384 and MGF1 with SHA-384 -

-
-
- Ps512 - - string - -
-

- RSASSA-PSS using SHA-512 and MGF1 with SHA-512 -

-
-
- Ed25519 - - string - -
-

- Edwards-Curve DSA (Ed25519 instance only) -

-
-
-

- -

-

- - Scroll To Top - -

-

- Text -

-

- -

-

- A textual range representing multiple (possibly discontinuous) ranges of text. -

- - - - - - - - - - - - - - - - - - - - - -
- Property - - Type - - Description - - Required? - - Default Value -
- selectors - - - - - An array of - - TextSelectorRange - - -
-

- The ranges of text to select. -

-
- 		- - YES - - - N/A -
- -

- - Scroll To Top - -

-

- TextSelector -

-

- -

-

- Selects a range of text via a fragment identifier. - -This is modeled after the W3C Web Annotation selector model. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Property - - Type - - Description - - Required? - - Default Value -
- end - - - - Integer - - (int32) - - - -
-

- The end character offset or the end of the fragment if not present. -

-
- 		- - NO - - - N/A -
- fragment - - - - String - -
-

- Fragment identifier as per RFC3023 (XML) or ISO 32000-2 (PDF), Annex O. -

-
- 		- - YES - - - N/A -
- start - - - - Integer - - (int32) - - - -
-

- The start character offset or the start of the fragment if not present. -

-
- 		- - NO - - - N/A -
- -

- - Scroll To Top - -

-

- TextSelectorRange -

-

- -

-

- One or two - - - TextSelector - - - objects identifying the range to select. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Property - - Type - - Description - - Required? - - Default Value -
- end - - - - TextSelector - - - -
-

- The end of the text range. -

-
- 		- - NO - - - N/A -
- selector - - - - TextSelector - - - -
-

- The start (or entire) text range. -

-
- 		- - YES - - - N/A -
- -

- - Scroll To Top - -

-

- Time -

-

- -

-

- A temporal range representing a starting time to an ending time. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Property - - Type - - Description - - Required? - - Default Value -
- end - - - - String - - - - -
-

- The end time or the end of the asset if not present. -

-
- 		- - NO - - - N/A -
- start - - - - String - - - - -
-

- The start time or the start of the asset if not present. -

-
- 		- - NO - - - N/A -
- type - - - - TimeType - - - -
-

- The type of time. -

-
- 		- - NO - - - npt -
- -

- - Scroll To Top - -

-

- TimeType -

-

- The type of time. -

- - - - - - - - - - - - - - - -
- TimeType - - Type - - Description -
- npt - - string - -
-

- Times are described using Normal Play Time (npt) as described in RFC 2326. -

-
-
-

- -

-

- - Scroll To Top - -

-

- UnitType -

-

- The type of unit for the range. -

- - - - - - - - - - - - - - - - - - - - -
- UnitType - - Type - - Description -
- pixel - - string - -
-

- Use pixels. -

-
-
- percent - - string - -
-

- Use percentage. -

-
-
-

- -

-

- - Scroll To Top - -

-

- UriOrResource -

-

- -

-

- Description TBD. -

-

- Any of the following: -

- -

- - Scroll To Top - -

-

- ValidationStatus -

-

- -

-

- A - - ValidationStatus - - struct describes the validation status of a specific part of a manifest. - -See - - https://c2pa.org/specifications/specifications/1.4/specs/C2PA_Specification.html#_existing_manifests - - . -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Property - - Type - - Description - - Required? - - Default Value -
- code - - - - String - -

- Description TBD. -

- 		- - YES - - - N/A -
- explanation - - - - String - - - - -

- Description TBD. -

- 		- - NO - - - N/A -
- url - - - - String - - - - -

- Description TBD. -

- 		- - NO - - - N/A -
- -

- -

- diff --git a/sidebars.js b/sidebars.js index 0be68513..2adec6da 100644 --- a/sidebars.js +++ b/sidebars.js @@ -51,13 +51,20 @@ const sidebars = { label: 'Examples', }, { - type: 'doc', - id: 'manifest/manifest-ref', - }, - { - type: 'doc', - id: 'manifest/manifest-json-schema', - label: 'JSON schema', + type: 'category', + label: 'JSON reference', + link: { type: 'doc', id: 'manifest/json-ref/index' }, + collapsed: true, + items: [ + { + type: 'doc', + id: 'manifest/json-ref/manifest-def', + }, + { + type: 'doc', + id: 'manifest/json-ref/reader', + }, + ], }, ], }, diff --git a/src/css/custom.css b/src/css/custom.css index 7c39fbc1..2701d835 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -424,3 +424,10 @@ body:not(.is-scrolling) .navbar { .github-only { display: none; } + +/* For JSON reference headers +*/ + +.scroll-target { + scroll-margin-top: 130px; /* Slightly more than title bar */ +}