Identifies a person responsible for an action.
-
-
-
- This allows the assertion to be expressed as CBOR or JSON. The default is
- CBOR unless you specify that an assertion should be JSON.
-
+
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.
-
Any of the following:
-
-
-
-
- Definitions
-
-
-
-
-
-
-
- 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.
-
-
-
-
-
- Property
- Type
- Description
- Required?
- Default Value
-
-
-
-
-
- data
-
-
-
-
-
-
-
- AssertionData
-
-
-
-
-
-
-
-
-
- YES
-
-
-
- N/A
-
-
-
- label
-
-
-
-
-
-
-
- String
-
-
-
-
-
-
-
-
-
- YES
-
-
-
- N/A
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-
-
-
-
-
-
-
- Property
- Type
- Description
- Required?
- Default Value
-
-
-
-
-
- type
-
-
-
-
-
-
-
- String
-
-
-
-
-
-
-
-
-
- YES
-
-
-
- N/A
-
-
-
- version
-
-
-
-
-
-
-
- String
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- NO
-
-
-
- N/A
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-
-
-
- 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
-
-
-
- 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
-
-
-
-
-
-
-
- An x, y coordinate used for specifying vertices in polygons.
-
-
-
-
-
- Property
- Type
- Description
- Required?
- Default Value
-
-
-
-
- x
+Properties
-
-
-
-
-
-
- Number / double
-
-
-
-
- The coordinate along the x-axis.
-
-
-
- YES
-
-
-
- N/A
-
-
-
- y
-
-
-
-
-
-
-
- Number / double
-
-
-
-
- The coordinate along the y-axis.
-
-
-
- YES
-
-
-
- N/A
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-
-
-
A description of the source for assertion data
-
-
-
-
- Property
- Type
- Description
- Required?
- Default Value
-
-
-
-
-
- actors
-
-
-
-
-
-
-
- Array of
-
- Actor
-
-
-
-
-
-
-
-
-
-
A list of actors 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
-
-
-
-
-
-
-
- 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
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-
-
-
- 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.
-
-
-
-
-
- Property
- Type
- Description
- Required?
- 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
-
-
-
-
-
-
-
-
-
- YES
-
-
-
- N/A
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-
-
-
- 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 manifest store, this is 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
+
+
+Property
+Type
+Description
+Required?
+Default Value
+
-
+
-
- String
-
+
+claim_version
+
+
-
+
-
-
-
-
-
-
- Document ID from
- xmpMM:DocumentID
- in XMP metadata.
-
-
-
- NO
+
+
+
+
+
+ Integer
+ (uint8) N/A
-
+
+
+
+
+
-
- format
+
+
+
-
-
-
-
- String
-
-
+
-
-
+
+The version of the claim. Defaults to 2.
-
-
-
-
The format of the source file as a MIME type.
-
-
- NO
+
-
- N/A
-
+
-
- hash
+NO
-
-
-
-
+
- String
-
+
-
+
+ N/A
-
-
+
-
-
-
-
An optional hash of the asset to prevent duplicates.
-
+
-
- NO
-
- N/A
-
+
+vendor
+
+
-
- informational_URI
+
-
-
-
-
- String
-
+
+
+
+
+
+ String
+
+
-
+
+
+
+
+
-
-
+
+
+
-
-
-
-
URI to an informational page about the ingredient or its data.
-
-
- NO
-
- N/A
-
-
- instance_id
+
-
-
-
+
+ Optional prefix added to the generated Manifest Label
+This is typically a reverse domain name.
-
- String
-
+
-
-
+NO
-
-
-
-
- Instance ID from
- xmpMM:InstanceID
- in XMP metadata.
-
-
-
- NO
+
-
- N/A
-
+
-
- label
+
+ N/A
-
-
-
+
-
+
- String
-
-
+
+claim_generator_info
+
+
-
-
+
-
-
-
-
The ingredient’s label as assigned in the manifest.
-
-
- NO
-
- N/A
-
+
-
- manifest_data
+
+
+
+
+ An array of
+#/$defs/ClaimGeneratorInfo
-
-
-
- ResourceRef
-
-
-
-
-
-
- A manifest store from the source asset extracted as a binary C2PA
- blob.
-
-
-
-
- NO
-
- N/A
-
-
-
- metadata
-
-
-
-
- Metadata
-
-
-
-
-
-
-
- Any additional
- Metadata
-
-
-
- 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.
-
+
+
Claim Generator Info is always required with an entry
- There can only be one parent ingredient in the ingredients.
-
-
-
-
NO
+
-
- componentOf
-
+
-
- thumbnail
+NO
-
-
-
- ResourceRef
+
-
-
+
-
-
-
-
- A thumbnail image capturing the visual state at the time of import.
-
+ Object with properties:
+
+ name - c2pa-rs
+
+ version - 0.68.0
+
+
-
- A tuple of thumbnail MIME format (for example
- image/jpeg) and binary bits of the image.
-
-
+
-
- NO
+
-
- N/A
-
-
- title
+
+metadata
+
+
-
-
-
+
-
- String
-
-
+
+
+
+
+ Array of
+
-
-
+
+
+#/$defs/AssertionMetadata
-
-
-
-
A human-readable title, generally source filename.
-
+
-
- NO
+
+
+
+
+
-
- N/A
-
+
+
+
-
- validation_results
-
-
-
- ValidationResults
-
-
+
-
-
- Validation results (Ingredient.V3)
+
+Optional manifest metadata. This will be deprecated in the future; not recommended to use.
-
- NO
-
- N/A
-
+
-
- validation_status
+
-
-
-
+NO
-
- Array of
+
- ValidationStatus
+
-
+
+ N/A
-
-
+
-
-
-
-
Validation status (Ingredient v1 & v2)
-
+
-
- NO
-
- N/A
-
-
-
+
+title
+
+
-
+
-
- Definitions
-
-
-
+
+
+
+
+
+ String
+
+
-
- Represents any changes or deltas between the current and previous validation
- results for an ingredient’s manifest.
-
+
+
+
+
+
-
-
-
- Property
- Type
- Description
- Required?
- 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
-
-
-
-
-
-
-Description of the boundaries of an identified range.
-
-
-
-
- Property
- Type
- Description
- Required?
- 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
-
+
-
+
+A human-readable title, generally source filename.
-
-
- 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
+
-
-
-
+NO
- DataSource
-
-
+
-
-
-
-
+
-
- NO
+
+ N/A
-
- N/A
-
+
-
- dateTime
+
-
-
-
-
-
+
+format
+
+
-
-
-
-
+
-
- NO
-
- N/A
-
-
- reference
+
-
-
-
+
+
+ String
- HashedUri
-
-
-
-
-
-
-
- NO
-
- N/A
-
-
- regionOfInterest
+
-
-
-
- RegionOfInterest
-
-
-
-
-
-
+
-
- NO
+
+The format of the source file as a MIME type.
-
- N/A
-
-
- reviewRatings
+
-
-
-
+
-
+NO
- Array of
- ReviewRating
+
-
+
-
-
+
+ application/octet-stream
-
-
-
-
+
-
- NO
+
-
- N/A
-
-
-
-
- NOTE: This object can have any number of additional user-defined properties.
-
+
+instance_id
+
+
-
+
-
- Definitions
-
-
-
+
-
- A spatial, temporal, frame, or textual range describing the region of
- interest.
-
+
+
+ String
-
-
-
- Property
- Type
- Description
- Required?
- Default Value
-
-
-
-
- frame
-
-
-
- Frame
-
-
-
-
-
-
+
-
-
- NO
-
-
- N/A
-
-
- item
-
-
-
+
- Item
+
+Instance ID from xmpMM:InstanceID in XMP metadata.
-
-
-
-
+
-
-
- NO
-
+
-
- N/A
-
+NO
-
- shape
-
-
-
+
- Shape
+
-
-
+
+ xmp:iid:6cb65db1-57b3-48fd-89a9-75fb694311cd
-
-
-
-
+
-
-
- NO
-
+
-
- N/A
-
-
- text
+
+thumbnail
+
+
-
-
-
-
- Text
-
-
-
-
-
-
-
-
-
-
-
- NO
-
-
-
- N/A
-
-
-
- time
-
-
-
-
-
- Time
-
-
-
-
-
-
-
-
-
-
-
- NO
-
-
-
- N/A
-
-
-
- type
-
-
-
-
-
- RangeType
-
-
-
-
-
-
- The type of range of interest.
-
-
-
- YES
-
-
-
- N/A
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-The type of range for the region of interest.
-
-
-
-
- RangeType
- Type
- Description
-
-
-
-
-
- spatial
- string
-
-
-
- A spatial range. See
- Shape
-
-
-
- temporal
- string
-
-
-
- A temporal range. See
- Time
-
-
-
- frame
- string
-
-
-
- A spatial range. See
- Frame
-
-
-
- textual
- string
-
-
-
- A textual range. See
- Text
-
-
-
- identified
- string
-
-
-
- A range identified by a specific identifier and value. See
- Item
-
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-
-
-
- A region of interest within an asset describing the change. This struct can be
- used from
- Action::changesMetadata::region_of_interest
-
-
-
-
- Property
- Type
- Description
- Required?
- Default Value
-
-
-
-
-
- description
-
-
-
-
-
-
-
- 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
-
-
+
+
+
+
+#/$defs/ResourceRef
+
+
-
-
+
-
-
-
-
- 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
-
-
-
-
-
-
-A string that is one of the following:
-
-
- “parentOf”
- “componentOf”
- “inputTo”
-
-
-
- Definitions
-
-
-
-
-
-
-
- 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
-
+
+An optional ResourceRef to a thumbnail image that represents the asset that was signed.
+Must be available when the manifest is signed.
-
- data_types
-
-
-
+
-
+
- Array of
+NO
- AssetType
-
+
-
-
+
-
-
-
-
More detailed data types as defined in the C2PA spec.
-
+
+ N/A
-
-
- NO
-
-
-
- N/A
-
-
-
- format
-
-
-
-
+
-
+
- String
-
-
-
-
-
The mime type of the referenced resource.
-
+
+ingredients
+
+
-
-
- YES
-
-
-
- N/A
-
-
-
- hash
+
-
-
-
-
-
- String
-
-
+
-
-
+
+
+
+
+ An array of
+#/$defs/Ingredient
-
-
-
-
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
-
-
-
-
-
-
- A rating on an Assertion. See
- https://c2pa.org/specifications/specifications/1.0/specs/C2PA_Specification.html#_claim_review .
-
-
-
-
- Property
- Type
- Description
- Required?
- Default Value
-
-
-
-
- code
-
-
-
-
-
-
-
- String
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- NO
-
-
-
- N/A
-
-
-
- explanation
-
-
-
-
-
-
-
- String
-
-
-
-
-
-
-
-
-
- YES
-
-
-
- N/A
-
-
-
- value
-
-
-
-
-
-
-
- Integer (uint8)
-
-
-
-
-
-
-
-
-
- YES
-
-
-
- N/A
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-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.
-
-
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-
-
-
- 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
-
+
+A List of ingredients
-
- N/A
-
-
- origin
+
-
-
-
+
- Coordinate
+NO
-
-
-
-
-
-
THe origin of the coordinate in the shape.
-
+
-
-
- YES
-
+
+ Empty array
+
+
-
- N/A
-
+
-
- type
+
-
-
-
- ShapeType
+
+assertions
+
+
-
-
+
-
-
-
-
-
-
- YES
-
-
- N/A
-
+
-
- unit
+
+
+
+
+ An array of
+#/$defs/AssertionDefinition
-
-
-
- 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
-
-
-
-
-The type of shape for the range.
-
-
-
-
- ShapeType
- Type
- Description
-
-
-
-
-
- rectangle
- string
-
-
-
-
-
- circle
- string
-
-
-
-
-
- polygon
- string
-
-
-
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-
-
-
- Contains a set of success, informational, and failure validation status codes.
-
-
-
-
-
- Property
- Type
- Description
- Required?
- Default Value
-
-
-
-
-
- failure
-
-
-
-
-
-
-
-
- An array of
- ValidationStatus
-
-
-
-
-
-
-
-
-
- YES
-
-
-
- N/A
-
-
-
- informational
-
-
-
-
-
-
-
-
- An array of
- ValidationStatus
-
-
-
-
-
-
-
-
-
- YES
-
-
-
- N/A
-
-
-
- success
-
-
-
-
-
-
-
-
- An array of
- ValidationStatus
-
-
-
-
-
-
-
-
-
- YES
-
-
-
- N/A
-
-
-
-
-
-
-
- Definitions
-
-
-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
-
-
-
-
-
-
-
- Definitions
-
-
-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
-
-
-
-
-
-
-
- Definitions
-
-
-TextSelectorRange
-
-
-
-
- One or two TextSelectors identifiying the range to
- select.
-
-
-
-
-
- Property
- Type
- Description
- Required?
- Default Value
-
-
-
-
-
- end
-
-
-
-
-
- TextSelector
-
-
-
-
-
-
- The end of the text range.
-
-
-
- NO
-
-
- N/A
-
-
- selector
+
-
-
-
+
+ A list of assertions
- TextSelector
-
-
- The start (or entire) text range.
-
-
-
- YES
-
-
-
- N/A
-
-
-
+
-
+NO
-
- Definitions
-
-
+
-
+
+ Empty array
+
+
-
- A temporal range representing a starting time to an ending time.
-
+
-
-
-
- Property
- Type
- Description
- Required?
- Default Value
-
-
+
-
-
- end
-
-
-
+
+redactions
+
+
-
+
- String
-
-
-
-
+
+
+
+
+ Array of
+
-
-
-
-
The end time or the end of the asset if not present.
-
-
-
- NO
+
+
+ string
+
+
+
-
- N/A
-
-
-
- start
-
-
-
-
+
+
+
+
+
-
+
+
+
- String
-
-
-
-
-
-
-
-
-
-
-
The start time or the start of the asset if not present.
-
-
-
- NO
-
-
- N/A
-
-
-
- type
-
-
-
-
-
- TimeType
-
-
-
-
-
-
-
-
-
-
- NO
-
-
- npt
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-The type of time.
-
-
-
-
- TimeType
- Type
- Description
-
-
-
-
-
- npt
- string
-
-
-
- Times are described using Normal Play Time (npt) as described in RFC
- 2326.
-
-
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-The type of unit for the range.
-
-
-
-
- UnitType
- Type
- Description
-
-
-
-
-
- pixel
- string
-
-
-
-
-
- percent
- string
-
-
-
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-
-
-
-Any of the following:
-
-
-
-
- Definitions
-
-
-
-
-
-
-
- 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
-
-
-
-
-
- Property
- Type
- Description
- Required?
- Default Value
-
-
-
-
-
- activeManifest
-
-
-
-
-
- StatusCodes
-
-
-
-
-
-
-
-
-
-
- NO
-
-
- N/A
-
-
-
- ingredientDeltas
-
-
-
-
-
-
-
- Array of
-
- IngredientDeltaValidationResult
-
-
-
-
-
-
-
-
-
- NO
+
-
- N/A
-
-
-
+
+A list of redactions - URIs to redacted assertions.
-
-
- Definitions
-
+
-
+NO
-
- 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 .
-
-
-
-
- Property
- Type
- Description
- Required?
- Default Value
-
-
+
-
-
- code
+
-
-
-
+
+ N/A
-
+
- String
-
+
-
-
-
-
-
-
- YES
-
+
+label
+
+
-
- N/A
-
+
-
- explanation
-
-
-
-
+
+
+
+
+
+ String
+
+
- String
-
+
+
+
+
+
-
+
+
+
-
-
-
-
-
-
-
-
- NO
-
-
- N/A
-
+
-
- success
+
+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.
-
-
-
-
+
- Boolean
-
+
-
+NO
-
-
-
-
-
-
+
-
-
- NO
-
+
-
- N/A
-
+
+ N/A
-
- url
+
-
-
-
+
-
- String
-
+
-
+
-
-
+Definitions
-
-
-
-
+
+
-
-
- NO
-
+
+
-
- N/A
-
-
-
-
-
-
-
diff --git a/docs/manifest/json-ref/reader.html b/docs/manifest/json-ref/reader.html
index 363b4c8..a95abc4 100644
--- a/docs/manifest/json-ref/reader.html
+++ b/docs/manifest/json-ref/reader.html
@@ -1,5329 +1,282 @@
-
-
A reader for the manifest store.
+
Reader
-
+
Use a Reader to read and validate a manifest store.
+
-
-
-
- Property
- Type
- Description
- Required?
- Default Value
-
-
-
-
-
- active_manifest
-
-
-
-
-
-
- String
-
-
-
-
-
-
-
-
-
- A label for the active (most recent) manifest in the store
-
-
-
-
- NO
-
-
-
-
-
- N/A
-
-
-
-
- manifests
-
- Object
-
-
-
- A HashMap of Manifests
-
- 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
-
-
-
-
-
-
-
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
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-
-
-
-
-
-
-
- Property
- Type
- Description
- Required?
- Default Value
-
-
-
-
-
- type
-
-
-
-
-
-
-
- String
-
-
-
-
-
-
-
-
-
- YES
-
-
-
- N/A
-
-
-
- version
-
-
-
-
-
-
-
- String
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- NO
-
-
-
- N/A
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-
-
-
- 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
-
-
-
- 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
-
-
-
-
-
-
-
- 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
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-
-
-
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
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-
-
-
A string.
-
-
-
-
- Definitions
-
-
-
-
-
-
-
- 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
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-
-
-
- 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
-
-
-
-
-
- Property
- Type
- Description
- Required?
- 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
-
-
-
-
-
-
-
-
-
- YES
-
-
-
- N/A
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-
-
-
- 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
-
-
- N/A
-
-
-
- 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
-
-
-
- label
-
-
-
-
-
-
-
- String
-
-
-
-
-
-
-
-
-
-
-
The ingredient’s label as assigned in the manifest.
-
-
-
- NO
-
-
- N/A
-
-
-
- manifest_data
-
-
-
-
-
- ResourceRef
-
-
-
-
-
-
-
-
- A
- ManifestStore
-
-
-
- NO
-
-
- N/A
-
-
-
- metadata
-
-
-
-
-
- Metadata
-
-
-
-
-
-
-
-
- Any additional
- Metadata
-
-
-
- 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
-
-
-
- resources
-
-
-
-
-
- ResourceStore
-
-
-
-
-
-
-
-
-
-
- NO
-
-
- N/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.
-
-
-
-
- NO
-
-
- N/A
-
-
-
- title
-
-
-
-
-
-
-
- String
-
-
-
-
-
-
-
-
-
-
-
A human-readable title, generally source filename.
-
-
-
- NO
-
-
- N/A
-
-
-
- validation_results
-
-
-
-
-
- ValidationResults
-
-
-
-
-
-
- Validation results (Ingredient.V3)
-
-
- NO
-
-
- N/A
-
-
-
- validation_status
-
-
-
-
-
-
-
- Array of
-
- ValidationStatus
-
-
-
-
-
-
-
-
-
-
Validation status (Ingredient v1 & v2)
-
-
-
- NO
-
-
- N/A
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-
-
-
- Represents any changes or deltas between the current and previous validation
- results for an ingredient’s manifest.
-
-
-
-
-
- Property
- Type
- Description
- Required?
- 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
-
-
-
-
-
-
-
Description of the boundaries of an identified range.
-
-
-
-
- Property
- Type
- Description
- Required?
- 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
-
-
-
-
-
-
-
- A Manifest represents all the information in a c2pa manifest
-
-
-
-
-
- Property
- Type
- Description
- Required?
- Default Value
-
-
-
-
-
- assertions
-
-
-
-
-
-
-
-
- An array of
- ManifestAssertion
-
-
-
-
-
-
-
-
- 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
-
-
- N/A
-
-
-
- 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
-
-
- N/A
-
-
-
- ingredients
-
-
-
-
-
-
-
-
- An array of
- Ingredient
-
-
-
-
-
-
-
-
- NO
-
-
- Empty array
-
-
-
- instance_id
-
-
-
-
-
-
-
- String
-
-
-
-
-
-
- Instance ID from
- xmpMM:InstanceID
- in XMP metadata.
-
-
-
-
- NO
-
-
-
- xmp:iid:424afed8-279d-4793-a279-b80a00b8c32b
-
-
-
-
- label
-
-
-
-
-
-
-
- String
-
-
-
-
-
-
-
-
-
-
-
-
-
- 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
-
-
-
- resources
-
-
-
-
-
- ResourceStore
-
-
-
-
-
-
-
-
container for binary assets (like thumbnails)
-
-
-
- NO
-
-
- N/A
-
-
-
- signature_info
-
-
-
-
-
- SignatureInfo
-
-
-
-
-
-
-
-
Signature data (only used for reporting)
-
-
-
- NO
-
-
- N/A
-
-
-
- thumbnail
-
-
-
-
-
- ResourceRef
-
-
-
-
-
-
-
-
-
-
- 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
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-
-
-
- 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)
-
-
-
-
-
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
-
-
-
-
-
-
-
A string that is one of the following:
-
-
- “Cbor”
- “Json”
- “Binary”
- “Uri”
-
-
-
- Definitions
-
-
-
-
-
-
-
-
Any of the following:
-
-
-
- true
-
-
- type: integer, format: uint8, minimum: 0.0
-
-
-
- Definitions
-
-
-
-
-
-
-
- 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
-
-
-
-
-
-
-
-
-
-
- NO
-
-
- N/A
-
-
-
- dateTime
-
-
-
-
-
- DateT
-
-
-
-
-
-
-
-
-
-
- NO
-
-
- N/A
-
-
-
- reference
-
-
-
-
-
- HashedUri
-
-
-
-
-
-
-
-
-
-
- NO
-
-
- N/A
-
-
-
- regionOfInterest
-
-
-
-
-
- RegionOfInterest
-
-
-
-
-
-
-
-
-
-
- NO
-
-
- N/A
-
-
-
- reviewRatings
-
-
-
-
-
-
-
- Array of
-
- ReviewRating
-
-
-
-
-
-
-
-
-
-
-
-
- NO
-
-
- N/A
-
-
-
-
-
- NOTE: This object can have any number of additional user-defined properties.
-
-
-
-
-
- Definitions
-
-
-
-
-
-
-
- A spatial, temporal, frame, or textual range describing the region of
- interest.
-
-
-
-
-
- Property
- Type
- Description
- Required?
- Default Value
-
-
-
-
-
- frame
-
-
-
-
-
- Frame
-
-
-
-
-
-
-
-
-
-
-
- NO
-
-
-
- N/A
-
-
-
- item
-
-
-
-
-
- Item
-
-
-
-
-
-
-
-
-
-
-
- NO
-
-
-
- N/A
-
-
-
- shape
-
-
-
-
-
- Shape
-
-
-
-
-
-
-
-
-
-
-
- NO
-
-
-
- N/A
-
-
-
- text
-
-
-
-
-
- Text
-
-
-
-
-
-
-
-
-
-
-
- NO
-
-
-
- N/A
-
-
-
- time
-
-
-
-
-
- Time
-
-
-
-
-
-
-
-
-
-
-
- NO
-
-
-
- N/A
-
-
-
- type
-
-
-
-
-
- RangeType
-
-
-
-
-
-
- The type of range of interest.
-
-
-
- YES
-
-
-
- N/A
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-
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.
-
-
-
-
- identified
- string
-
-
-
- A range identified by a specific identifier and value, see [Item] for more details.
-
-
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-
-
-
- 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].
-
-
-
-
-
- Property
- Type
- Description
- Required?
- Default Value
-
-
-
-
-
- description
-
-
-
-
-
-
-
- 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
-
-
-
-
-
-
-
A string that is one of the following:
-
-
- “parentOf”
- “componentOf”
- “inputTo”
-
-
-
- Definitions
-
-
-
-
-
-
-
- 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].
-
-
-
-
-
- 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
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-
-
-
- Resource store to contain binary objects referenced from JSON serializable
- structures
-
-
-
-
-
- Property
- Type
- Description
- Required?
- Default Value
-
-
-
-
-
- base_path
-
-
-
-
-
-
-
- String
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- NO
-
-
-
- N/A
-
-
-
- label
-
-
-
-
-
-
-
- String
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- NO
-
-
-
- N/A
-
-
-
- resources
-
-
-
-
-
-
-
- (Object)
-
-
-
-
-
-
-
-
-
- YES
-
-
-
- N/A
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-
-
-
- A rating on an Assertion. See
- https://c2pa.org/specifications/specifications/1.0/specs/C2PA_Specification.html#_claim_review .
-
-
-
-
-
- Property
- Type
- Description
- Required?
- Default Value
-
-
-
-
-
- code
-
-
-
-
-
-
-
- String
-
-
-
-
-
-
-
-
-
-
-
+Properties
-
-
- NO
-
-
-
- N/A
-
-
-
- explanation
-
-
-
-
-
-
-
- String
-
-
-
-
-
-
-
-
-
- YES
-
-
-
- N/A
-
-
-
- value
-
-
-
-
-
-
-
- Integer (uint8)
-
-
-
-
-
-
-
-
-
- YES
-
-
-
- N/A
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-
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.
-
-
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-
-
-
- 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
-
-
-
-
-
-
-
-
-
-
-
- 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
-
-
-
-
-
The type of shape for the range.
-
-
-
-
- ShapeType
- Type
- Description
-
-
-
-
-
- rectangle
- string
-
-
-
-
-
- circle
- string
-
-
-
-
-
- polygon
- string
-
-
-
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-
-
-
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
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-
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.
-
-
-
-
-
-
- SigningAlg
- Type
- Description
-
-
-
-
-
- Es256
- string
-
-
-
-
-
- Es384
- string
-
-
-
-
-
- Es512
- string
-
-
-
-
-
- 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)
-
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-
-
-
- Contains a set of success, informational, and failure validation status codes.
-
-
-
-
-
- Property
- Type
- Description
- Required?
- Default Value
-
-
-
-
-
- failure
-
-
-
-
-
-
-
-
- An array of
- ValidationStatus
-
-
-
-
-
-
-
-
-
- YES
-
-
-
- N/A
-
-
-
- informational
-
-
-
-
-
-
-
-
- An array of
- ValidationStatus
-
-
-
-
-
-
-
-
-
- YES
-
-
-
- N/A
-
-
-
- success
-
-
-
-
-
-
-
-
- An array of
- ValidationStatus
-
-
-
-
-
-
-
-
-
- YES
-
-
-
- N/A
-
-
-
-
-
-
-
- Definitions
-
-
-
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
-
-
-
-
-
-
-
- Definitions
-
-
-
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
-
-
-
-
-
-
-
- Definitions
-
-
-
TextSelectorRange
-
-
-
-
- One or two [TextSelector][TextSelector] identifiying 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
-
-
-
-
-
-
-
- Definitions
-
-
-
-
-
-
-
- A temporal range representing a starting time to an ending time.
-
-
-
-
-
- Property
- Type
- Description
- Required?
- Default Value
-
-
-
-
-
- end
-
-
-
-
-
-
+
+
+Property
+Type
+Description
+Required?
+Default Value
+
-
-
-
+
+active_manifest
+
+
-
-
-
-
The end time or the end of the asset if not present.
-
+
-
- NO
-
- N/A
-
-
- start
+
+
+
+
+
+ String
+
+
-
-
-
+
+
+
+
+
-
+
+
+
- String
-
-
-
-
-
-
-
-
The start time or the start of the asset if not present.
-
+
-
- NO
+
+A label for the active (most recent) manifest in the store
-
- N/A
-
-
- type
+
-
-
-
+
+NO
- TimeType
+
-
-
+
-
-
-
-
+
+ N/A
-
- NO
+
-
- npt
-
-
-
+
-
-
- Definitions
-
+
+manifests
+
+
+
+ Object
-
+
-The type of time.
+
+A HashMap of Manifests
-
-
-
- TimeType
- Type
- Description
-
-
-
-
- npt
- string
-
-
-
- Times are described using Normal Play Time (npt) as described in RFC
- 2326.
-
-
-
-
-
+
+ #/$defs/Manifest
-
-
- Definitions
-
+
+YES
-The type of unit for the range.
+
-
-
-
- UnitType
- Type
- Description
-
-
+
-
-
- pixel
- string
-
-
-
-
-
- percent
- string
-
-
-
-
-
-
+
+ N/A
-
+
-
- Definitions
-
+
-
-
+
+validation_status
+
+
-
-Any of the following:
+
-
-
- Definitions
-
+
+
+
+
+ Array of
+
-
+
+
+#/$defs/ValidationStatus
-
+
-
- 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
-
+
+
+
+
+
-
-
-
- Property
- Type
- Description
- Required?
- Default Value
-
-
+
+
+
-
-
- activeManifest
-
-
-
- StatusCodes
-
-
+
-
-
-
-
+
+ValidationStatus generated when loading the ManifestStore from an asset
-
- NO
-
- N/A
-
+
-
- ingredientDeltas
+
+NO
-
-
-
+
-
+
- Array of
+
+ N/A
- IngredientDeltaValidationResult
+
-
+
-
-
-
-
-
-
+
+validation_results
+
+
-
- NO
+
-
- N/A
-
-
-
-
-
- Definitions
-
-
+
+
+
+
+#/$defs/ValidationResults
+
+
-Indicates if the manifest store is valid and trusted.
+
-
- The Trusted state implies the manifest store is valid and the active signature
- is trusted.
-
+
-
-
-
- ValidationState
- Type
- Description
-
-
-
-
- Invalid
- string
-
-
-
Errors were found in the manifest store.
-
-
-
- Valid
- string
-
-
-
- No errors were found in validation, but the active signature is not
- trusted.
-
-
-
-
- Trusted
- string
-
-
-
- The manifest store is valid and the active signature is trusted.
-
-
-
-
-
-
-
- Definitions
-
+
-
+
+ValidationStatus generated when loading the ManifestStore from an asset
-
-
- 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 .
-
+
-
-
- Property
- Type
- Description
- Required?
- Default Value
-
-
+
+NO
-
-
- code
+
-
-
-
+
-
+
+ N/A
- String
-
+
-
-
-
-
+
-
-
- YES
-
-
- N/A
-
+
+validation_state
+
+
-
- explanation
+
-
-
-
-
- String
-
-
+
+
+
+
+#/$defs/ValidationState
+
+
-
-
+
-
-
-
-
+
-
-
- NO
-
-
- N/A
-
-
- success
-
-
-
+
-
+
+The validation state of the manifest store
- Boolean
-
-
+
+NO
-
-
-
-
+
-
-
- NO
-
+
-
- N/A
-
+
+ N/A
-
- url
+
-
-
-
+
-
- String
-
+
-
+
-
-
+Definitions
-
-
-
-
+
+
-
-
- NO
-
+
+
-
- N/A
-
-
-
-
-
-
-
diff --git a/docs/manifest/json-ref/settings.html b/docs/manifest/json-ref/settings.html
new file mode 100644
index 0000000..9003b00
--- /dev/null
+++ b/docs/manifest/json-ref/settings.html
@@ -0,0 +1,597 @@
+
+
+
+
+
+
Settings JSON reference - Manifest Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Settings JSON reference
+
+
+
+
+
+ Scroll To Top
+
+Settings
+
+Settings for configuring all aspects of c2pa-rs.
+
+
[Settings::default] will be set thread-locally by default. Any settings set via
+[Settings::from_toml] or [Settings::from_file] will also be thread-local.
+
Properties
+
+
+
+Property
+Type
+Description
+Required?
+Default Value
+
+
+
+
+version
+
+
+
+
+
+
+
+
+
+
+
+ Integer
+ (uint32)
+
+
+
+Version of the configuration.
+
+
+
+YES
+
+
+
+
+
+
+ N/A
+
+
+
+
+
+
+
+trust
+
+
+
+
+
+
+
+
+
+
+
+
+
+Settings for configuring the C2PA trust lists.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Settings for configuring the C2PA trust lists.
+
+
+
+YES
+
+
+
+
+
+
+ N/A
+
+
+
+
+
+
+
+cawg_trust
+
+
+
+
+
+
+
+
+
+
+
+
+
+Settings for configuring the CAWG trust lists.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Settings for configuring the CAWG trust lists.
+
+
+
+YES
+
+
+
+
+
+
+ N/A
+
+
+
+
+
+
+
+core
+
+
+
+
+
+
+
+
+
+
+
+
+
+Settings for configuring core features.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Settings for configuring core features.
+
+
+
+YES
+
+
+
+
+
+
+ N/A
+
+
+
+
+
+
+
+verify
+
+
+
+
+
+
+
+
+
+
+
+
+
+Settings for configuring verification.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Settings for configuring verification.
+
+
+
+YES
+
+
+
+
+
+
+ N/A
+
+
+
+
+
+
+
+builder
+
+
+
+
+
+
+
+
+
+
+
+
+
+Settings for configuring the [`Builder`].
+
+[`Builder`]: crate::Builder
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Settings for configuring the Builder
+
+
+
+
+YES
+
+
+
+
+
+
+ N/A
+
+
+
+
+
+
+
+signer
+
+
+
+
+
+
+
+
+
+
+
+
+#/$defs/SignerSettings
+
+
+
+
+
+
+
+
+
+
+
+
+
+Settings for configuring the base C2PA signer, accessible via [Settings::signer].
+
+
+
+NO
+
+
+
+
+
+
+ N/A
+
+
+
+
+
+
+
+cawg_x509_signer
+
+
+
+
+
+
+
+
+
+
+
+
+#/$defs/SignerSettings
+
+
+
+
+
+
+
+
+
+
+
+
+
+Settings for configuring the CAWG x509 signer, accessible via [Settings::signer].
+
+
+
+NO
+
+
+
+
+
+
+ N/A
+
+
+
+
+
+
+
+
+
+
+Definitions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
