You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Remove outdated ref to CreativeWork, other small edits (#1770)
* Remove outdated ref to CreativeWork, other small edits
* Put full CLI reference in separate file
* misc edits
* docs: Change header levels
* Remove command ref
* docs: Clarify -o option
* docs: Update trust support info
* docs: add URL for aca inspect
4. Copy the `c2patool` executable file to a location on your `PATH`.
36
-
5. Confirm that you can run the tool by entering a command such as:
44
+
45
+
46
+
After installing, confirm that you can run the tool by entering a command such as:
37
47
```
38
48
c2patool -h
39
49
```
40
50
41
-
You may need to set execution permission for the tool on your system.
42
-
For macOS, see [If you want to open an app that hasn’t been notarized or is from an unidentified developer](https://support.apple.com/en-us/102445#openanyway).
51
+
When running a prebuilt binary, you may need to set execution permission for the tool on your system. For macOS, see [If you want to open an app that hasn’t been notarized or is from an unidentified developer](https://support.apple.com/en-us/102445#openanyway).
43
52
44
53
NOTE: You also may want to get some of the example files provided in the repository `sample` directory. To do so, clone the repository with `git clone https://github.com/contentauth/c2pa-rs.git`.
45
54
46
55
### Installing from source
47
56
48
-
Instead of installing a prebuilt binary, you can [build the project from source](https://github.com/contentauth/c2pa-rs/blob/main/cli/docs/project-contributions.md#building-from-source).
57
+
Instead of installing a prebuilt binary, you can [build the project from source](docs/project-contributions.md#building-from-source).
49
58
50
59
### Upgrading
51
60
@@ -55,4 +64,6 @@ To display the version of C2PA Tool that you have, enter this command:
55
64
c2patool -V
56
65
```
57
66
58
-
The tool will display the version installed. Compare the version number displayed with the latest release version shown in the [repository releases page filtered for c2patool](https://github.com/contentauth/c2pa-rs/releases?q=c2patool). If you don't have the latest version, simply reinstall to get the latest version.
67
+
The tool will display the version installed. Compare the version number displayed with the latest release version shown in the [repository releases page filtered for c2patool](https://github.com/contentauth/c2pa-rs/releases?q=c2patool).
68
+
69
+
If you don't have the latest version, simply reinstall C2PA Tool to get the latest version.
Copy file name to clipboardExpand all lines: cli/docs/manifest.md
+31-30Lines changed: 31 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,18 +5,13 @@ In the manifest definition file, file paths are relative to the location of the
5
5
6
6
## JSON format
7
7
8
-
The C2PA specification describes a manifest that has a binary structure in JPEG universal metadata box format (JUMBF). However, C2PA Tool works with a JSON manifest structure that's easier to understand and work with. It's a declarative language for representing and creating a manifest in binary format. For more information on the JSON manifest, see [Working with manifests](https://opensource.contentauthenticity.org/docs/manifest/understanding-manifest).
8
+
The C2PA specification describes a manifest that has a binary structure in JPEG universal metadata box format (JUMBF). However, C2PA Tool works with a JSON manifest structure that's easier to understand and work with. It's a declarative language for representing and creating a manifest in binary format.
9
9
10
-
See also:
11
-
12
-
* <ahref="https://opensource.contentauthenticity.org/docs/manifest/manifest-ref"target="_self">Manifest store reference</a>
13
-
* <ahref="https://opensource.contentauthenticity.org/docs/manifest/manifest-json-schema"target="_self">Manifest store schema</a>
See also <ahref="https://opensource.contentauthenticity.org/docs/manifest/json-ref/"target="_self">JSON manifest reference</a>.
16
11
17
12
## Adding a claim generator icon
18
13
19
-
You can specify an icon to be displayed by tools such as [Verify](https://contentcredentials.org/verify) to indicate the signer of the manifest.
14
+
You can specify an icon to be displayed by tools such as [Inspect tool on Adobe Content Authenticity (Beta)](https://inspect.cr/) (also called ACA Inspect) to indicate the signer of the manifest.
20
15
21
16
To do this, add a `claim_generator_info` property to the manifest definition. The `claim_generator_info.icon` property contains information on the icon:
22
17
-`icon.format` specifies the MIME type of the icon file. SVG format is preferred, but you can also use PNG or JPEG formats.
@@ -43,43 +38,49 @@ To add the icon using C2PA Tool, make sure the icon file and the manifest defini
NOTE: The [Verify](https://contentcredentials.org/verify) tool will not display an icon for a signing certificate that is not on the temporary certificate list, such as the C2PA Tool test certificate.
47
-
48
-
## Example
49
-
50
-
The example below is a snippet of a manifest definition that inserts a `CreativeWork` author assertion. This example uses the default testing certificates in the [sample folder](https://github.com/contentauth/c2pa-rs/tree/main/cli/sample) that are also built into the `c2patool` binary.
41
+
NOTE: [ACA Inspect](https://inspect.cr/) will only display an icon for a signing certificate if the certificate can be traced back to a root certificate on the [C2PA trust list](https://opensource.contentauthenticity.org/docs/conformance/trust-lists#c2pa-trust-list).
51
42
52
-
**NOTE**: When you don't specify a key or certificate in the manifest `private_key` and `sign_cert` fields, the tool will use the built-in key and cert. You'll see a warning message, since they are meant for development purposes only. For actual use, provide a permanent key and certificate in the manifest definition or environment variables; see [Creating and using an X.509 certificate](x_509.md).
43
+
## Special properties used by C2PA Tool
53
44
54
-
The following manifest properties are specific to c2patool and used for signing manifests:
45
+
The following manifest properties are specific to C2PA Tool and used for signing manifests:
55
46
56
47
-`alg`: Signing algorithm to use. See [Creating and using an X.509 certificate](x_509.md) for possible values. Default: `es256`.
57
48
-`private_key`: Private key to use. Default: `es256_private.key`
58
49
-`sign_cert`: Signing certificate to use. Default: `es256_certs.pem`
59
-
-`ta_url`: Time Authority URL for getting a time-stamp (for example, `http://timestamp.digicert.com`). A time-stamp provides a way to confirm that the manifest was signed when the certificate was valid, even if the certificate has since expired. Howver, the Time Authority URL requires a live online connection for confirmation, which may not always be available.
50
+
-`ta_url`: Time Authority URL for getting a time-stamp (for example, `http://timestamp.digicert.com`). A time-stamp provides a way to confirm that the manifest was signed when the certificate was valid, even if the certificate has since expired. However, the Time Authority URL requires a live online connection for confirmation, which may not always be available.
51
+
52
+
## Example
53
+
54
+
The example below is a minimal manifest definition that uses a default testing certificate in the [sample folder](https://github.com/contentauth/c2pa-rs/tree/main/cli/sample) that are also built into the `c2patool` binary.
55
+
56
+
**NOTE**: When you don't specify a key or certificate in the manifest `private_key` and `sign_cert` fields, the tool will use the built-in key and cert. You'll see a warning message, since they are meant for development purposes only.
57
+
58
+
For actual use, provide a permanent key and certificate in the manifest definition or environment variables; see [Creating and using an X.509 certificate](x_509.md).
0 commit comments