diff --git a/docs/manifest/reference-cai.html b/docs/manifest/reference-cai.html index af810788..56443a33 100644 --- a/docs/manifest/reference-cai.html +++ b/docs/manifest/reference-cai.html @@ -151,15 +151,7 @@
+ +
- A Container for a set of Manifests and a ValidationStatus list.. + A Container for a set of Manifests and a ValidationStatus list.
+ A label for the active (most recent) manifest in the store +
+ A HashMap of Manifests +
+ ValidationStatus generated when loading the ManifestStore from an asset +
+ +
Identifies a person responsible for an action.
@@ -539,7 +609,9 @@+ List of references to W3C Verifiable Credentials. +
+ An identifier for a human actor, used when the “type” is
+
+ humanEntry.identified
+
+ .
+
+ +
- hashed URI to the icon (either embedded or remote)
+
+ hashed URI to the icon (either embedded or remote) + |
@@ -745,7 +831,9 @@
- A human readable string naming the claim_generator
+
+ A human readable string naming the claim_generator + |
+ A human readable string of the product’s version +
+ +
++ An x, y coordinate used for specifying vertices in polygons. +
++ Property + | ++ Type + | ++ Description + | ++ Required? + | ++ Default Value + | +
---|---|---|---|---|
+ x + | + ++ + + Number + + FORMAT = double + | + +
+
+
+ + The coordinate along the x-axis. + + |
+ + + YES + | ++ + N/A + | +
+ y + | + ++ + + Number + + FORMAT = double + | + +
+
+
+ + The coordinate along the y-axis. + + |
+ + + YES + | ++ + N/A + | +
+ +
A description of the source for assertion data
@@ -842,7 +1031,15 @@
+ A list of
+
+
+ Actor
+
+
+ s associated with this source.
+
+ A human-readable string giving details about the source of the assertion data. +
+ A value from among the enumerated list indicating the source of the assertion. +
+ +
+
+ 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
+
+ + Format: int32 + + Minimum: + + + |
+
+
+
+
+ + The end of the frame inclusive or the end of the asset if not present. + + |
+ + + NO + | ++ + N/A + | +
+ start + | + +
+
+
+ Integer
+
+ + Format: int32 + + Minimum: + + + |
+
+
+
+
+ + The start of the frame or the end of the asset if not present. + ++ The first frame/page starts at 0. + + |
+ + + NO + | ++ + N/A + | +
+ +
- Hashed Uri structure as defined by C2PA spec. It is annotated to produce the correctly tagged cbor serialization. + Hashed Uri structure as defined by C2PA spec It is annotated to produce the correctly tagged cbor serialization
-
- hash algorithm used (“sha256”, “sha384”, “sha512”)
-
+ + Description TBD. + |
@@ -988,9 +1311,9 @@ |
-
- “alg” hash of stored as cbor byte string
-
+ + Description TBD. + |
@@ -1013,9 +1336,9 @@ |
-
- URI stored as tagged cbor
-
+ + Description TBD. + |
@@ -1037,12 +1360,15 @@
|
- The active manifest label (if one exists).
-
-If this ingredient has a ManifestStore, this will hold the label of the active Manifest.
+
+ The active manifest label (if one exists). + +
+ If this ingredient has a
+
+ |
@@ -1111,7 +1452,9 @@
- A reference to the actual data of the ingredient.
+
+ A reference to the actual data of the ingredient. + |
+ Additional information about the data’s type to the ingredient V2 structure. +
++ Additional description of the ingredient. +
+ Document ID from
+
+ xmpMM:DocumentID
+
+ in XMP metadata.
+
+ The format of the source file as a MIME type. +
+ An optional hash of the asset to prevent duplicates. +
+ URI to an informational page about the ingredient or its data. +
+ Instance ID from
+
+ xmpMM:InstanceID
+
+ in XMP metadata.
+
+ A
+
+
+ ManifestStore
+
+
+ from the source asset extracted as a binary C2PA blob.
+
+ Any additional
+
+
+ Metadata
+
+
+ as defined in the C2PA spec.
+
+ URI from
+
+ dcterms:provenance
+
+ in XMP metadata.
+
+ Set to
+
+ ParentOf
+
+ if this is the parent ingredient.
+
+ There can only be one parent ingredient in the ingredients. +
+ 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.
+
+ A human-readable title, generally source filename. +
+ Validation results. +
+ +
- Represents all the information in a c2pa manifest. + A Manifest represents all the information in a c2pa manifest
- A list of assertions
+
+ A list of assertions + |
@@ -1566,7 +2006,9 @@
- 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
+
+ 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 +
redactions
@@ -1768,7 +2256,9 @@ |
- A list of redactions - URIs to a redacted assertions
+
+ A list of redactions - URIs to a redacted assertions + |
- Description TBD. -
++ A list of claim generator info data identifying the software/hardware/system produced this claim +
++ A List of verified credentials +
+ The format of the source file as a MIME type. +
+ A List of ingredients +
+ Instance ID from
+
+ xmpMM:InstanceID
+
+ in XMP metadata.
+
+ A list of user metadata for this claim +
++ Signature data (only used for reporting) +
+ A human-readable title, generally source filename. +
+ Optional prefix added to the generated Manifest Label This is typically Internet domain name for the vendor (i.e.
+
+ adobe
+
+ )
+
+ +
A labeled container for an Assertion value in a Manifest
@@ -1942,7 +2445,9 @@+ The data of the assertion as Value +
+ There can be more than one assertion for any label +
+ The + + ManifestAssertionKind + + for this assertion (as stored in c2pa content) +
+ An assertion label in reverse domain format +
+ +
A string that is one of the following:
@@ -2075,6 +2593,9 @@+ +
Description TBD.
@@ -2101,6 +2622,9 @@+ +
The Metadata structure can be used as part of other assertions or on its own to reference others
@@ -2127,7 +2651,7 @@+ A date time in ISO 8601 format. +
+ Description TBD. +
+- A string that is one of the following: -
-- A reference to a resource to be used in JSON serialization + A spatial, temporal, frame, or textual range describing the region of interest.
- data_types + frame | - - Array of - - AssetType + + Frame - |
- - Description TBD. - +
+
+ A frame range. + + |
@@ -2327,120 +2859,52 @@ | |
- format + shape | - - String - | - -
- - Description TBD. - - |
- - - YES - | -- - N/A - | -
- identifier - | - -+ + Shape + - - String |
- - Description TBD. - +
+
+ A spatial range. + + |
- YES + NO | N/A |
- 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 + text |
-
- String
-
- - + + Text + |
- - Description TBD. - +
+
+ A textual range. + + |
@@ -2453,23 +2917,27 @@ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- explanation + time | - - String + + Time + + |
- - Description TBD. - +
+
+ A temporal range. + + |
- YES + NO |
@@ -2478,23 +2946,23 @@ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- value + type |
-
- Integer
- - Format: uint8 - - Minimum: 0.0 + + RangeType + + |
- - Description TBD. - +
+
+ The type of range of interest. + + |
@@ -2513,11 +2981,1816 @@
Scroll To Top
- + RangeType+ |
+ RangeType + | ++ Type + | ++ Description + | +
---|---|---|
+ spatial + | ++ string + | +
+
+
+
+ A spatial range, see
+
+ |
+
+ temporal + | ++ string + | +
+
+
+
+ A temporal range, see
+
+ |
+
+ frame + | ++ string + | +
+
+
+
+ A spatial range, see
+
+ |
+
+ textual + | ++ string + | +
+
+
+
+ A textual range, see
+
+ |
+
+ +
+ ++ +
+
+ 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
+ |
+ + + NO + | ++ + N/A + | +
+ +
++ A string that is one of the following: +
++ +
+
+ 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 + | +
+ +
+
+ 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
+ + Format: uint8 + + Minimum: 0.0 + |
+
+
+ + Description TBD. + + |
+ + + YES + | ++ + N/A + | +
+ 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. + + |
+
+ +
+ ++ +
++ A spatial range representing rectangle, circle, or a polygon. +
++ Property + | ++ Type + | ++ Description + | ++ Required? + | ++ Default Value + | +
---|---|---|---|---|
+ height + | + +
+
+
+ Number
+
+ + Format: double + + Minimum: + + + |
+
+
+
+
+ + 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
+
+ + Format: double + + Minimum: + + + |
+
+
+
+
+ + The width for rectangles or diameter for circles. + ++ This field can be ignored for polygons. + + |
+ + + NO + | ++ + N/A + | +
+ The type of shape for the range. +
++ ShapeType + | ++ Type + | ++ Description + | +
---|---|---|
+ rectangle + | ++ string + | +
+
+
+ + A rectangle. + + |
+
+ circle + | ++ string + | +
+
+
+ + A circle. + + |
+
+ polygon + | ++ string + | +
+
+
+ + A polygon. + + |
+
+ +
+ ++ +
++ 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 + | +
+ 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) + + |
+
+ +
+ ++ +
++ 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 + | +
+ +
++ 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
+
+ + Format: int32 + + Minimum: + + + |
+
+
+
+
+ + 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
+
+ + Format: int32 + + Minimum: + + + |
+
+
+
+
+ + The start character offset or the start of the fragment if not present. + + |
+ + + NO + | ++ + N/A + | +
+ +
- Holds information about a signature
+ One or two
+
+
+ TextSelector
+
+
+ identifying the range to select.
- cert_serial_number + end |
-
- String
-
- - + + TextSelector + |
- The serial number of the certificate
+
+ The end of the text range. + |
@@ -2571,7 +4844,74 @@ | |
- issuer + selector + | + ++ + + TextSelector + + + | + +
+
+
+ + The start (or entire) text range. + + |
+ + + YES + | ++ + N/A + | +
+ +
++ A temporal range representing a starting time to an ending time. +
++ Property + | ++ Type + | ++ Description + | ++ Required? + | ++ Default Value + | +
---|---|---|---|---|
+ end |
@@ -2586,7 +4926,9 @@
- human readable issuing authority for this signature
+
+ The end time or the end of the asset if not present. + | |||
- time + start |
@@ -2615,7 +4957,9 @@
- the time the signature was created
+
+ The start time or the start of the asset if not present. + | |||
+ type + | + ++ + + TimeType + + + | + +
+
+
+ + The type of time. + + |
+ + + NO + | ++ + npt + | +
+ The type of time. +
++ TimeType + | ++ Type + | ++ Description + | +
---|---|---|
+ npt + | ++ string + | +
+
+
+ + Times are described using Normal Play Time (npt) as described in RFC 2326. + + |
+
+ +
+ ++ The type of unit for the range. +
++ UnitType + | ++ Type + | ++ Description + | +
---|---|---|
+ pixel + | ++ string + | +
+
+
+ + Use pixels. + + |
+
+ percent + | ++ string + | +
+
+
+ + Use percentage. + + |
+
+ +
++ +
Description TBD.
@@ -2666,6 +5149,9 @@+ +
A
@@ -2674,8 +5160,8 @@
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
+
+ https://c2pa.org/specifications/specifications/1.4/specs/C2PA_Specification.html#_existing_manifests
.
+ Description TBD. +
+ Description TBD. +
+ Description TBD. +