c2pa 0.82.1

Rust SDK for C2PA (Coalition for Content Provenance and Authenticity) implementors
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170

# c2pa-rs Configuration File

# Version information.
version = 1

# # Trust settings for certificate validation.
# [trust]
# # String to user-provided trust anchors (PEM format).
# user_anchors = ""
# # String to system trust anchors (PEM format).
# trust_anchors = ""
# # String to trust configuration.
# trust_config = ""
# # Path to allowed certificate list (PEM format).
# allowed_list = ""

# Verification settings.
[verify]
# Verify manifests after reading.
verify_after_reading = true
# Verify manifests after signing.
verify_after_sign = true
# Fetch remote manifests.
remote_manifest_fetch = true

# Configuration for a signer.
#
# The signer can be retrieved via the `Context::signer` function.
[signer]

# A signer can be loaded in the API with the function `Context::signer`.
[signer.local]
# Algorithm to use for signing.
alg = "ps256"
# Certificate used for signing (PEM format).
sign_cert = ""
# Private key used for signing (PEM format).
private_key = ""
# Time stamp authority URL for signing.
tsa_url = ""

# # Alternatively, you can specify a remote signer, which is also loaded
# # via `Context::signer`.
# #
# # Note that you may not specify both a local and remote signer at the same time.
# [signer.remote]
# # URL to the signer used for signing.
# #
# # A POST request with a byte stream will be sent to this URL.
# url = "https://www.google.com"
# # Algorithm to use for signing.
# alg = "ps256"
# # Certificate used for signing (PEM format).
# sign_cert = ""
# # Time stamp authority URL for signing.
# tsa_url = ""

# Configuration for the `Builder`.
[builder]

# Claim generator info list.
[builder.claim_generator_info]
# A human readable name.
name = "My Service"
# A human readable string of the product's version.
version = "1.0.0"
# The operating system the claim generator is running on.
# Or specify "auto" to infer the operating system automatically.
operating_system = "macOS"
# Arbitrary fields can also be defined.
#
# By default, the SDK adds a field "org.cai.c2pa_rs" with the value
# being the current version of the SDK.
some_other_field = ""

# Actions assertion configuration.
[builder.actions]
# Signifies if all the actions that ever happened on a particular asset are specified
# or if some are missing.
# all_actions_included = true

# A template to use as the base values for a particular action.
[[builder.actions.templates]]
# The label of the action.
action = "c2pa.edited"
# TODO: do we want to document these fields here or just include links to the docs
#       rust docs or c2pa docs?
# The source type field is required for the c2pa.created action.
#
# For more information, see `c2pa::assertions::actions::source_type`.
source_type = "empty"
# Description for the action
description = "Some edit action."
# Arbitrary key/value pairs to store in the action.
template_parameters = { "arbitrary_key" = true }
# A software agent has the same fields as a claim generator info.
software_agent = { name = "My Service" }

# Multiple templates can be specified.
[[builder.actions.templates]]
action = "c2pa.cropped"

# TODO: document rest of fields for actions
# Actions to be added to every "Actions" assertion.
[[builder.actions.actions]]
# The label of the action.
action = "c2pa.drawing"

# Similarly, multiple actions can be defined.
[[builder.actions.actions]]
action = "c2pa.color_adjustments"

# Settings for configuring how c2pa.created actions are auto created.
#
# This is a convenience setting and it can be disabled if the information
# is provided manually.
[builder.actions.auto_created_action]
# Whether to auto create the c2pa.created action.
enabled = true
# The source type field is required for the c2pa.created action.
#
# For more information, see `c2pa::assertions::actions::source_type`.
source_type = "empty"

# Settings for configuring how c2pa.opened actions are auto created.
#
# This is a convenience setting and it can be disabled if the information
# is provided manually.
[builder.actions.auto_opened_action]
# Whether to auto create the c2pa.opened action.
enabled = true
# For more information, see `c2pa::assertions::actions::source_type`.
#
# Note this field is optional for the c2pa.opened action.
source_type = "empty"

# Settings for configuring how c2pa.placed actions are auto created.
#
# This is a convenience setting and it can be disabled if the information
# is provided manually.
[builder.actions.auto_placed_action]
# Whether to auto create the c2pa.placed action.
enabled = true
# For more information, see `c2pa::assertions::actions::source_type`.
#
# Note this field is optional for the c2pa.placed action.
source_type = "empty"

# Settings for automatic thumbnail generation.
[builder.thumbnail]
# Whether to enable automatic thumbnail generation.
enabled = true
# Whether to ignore errors when generating a thumbnail and continue signing.
ignore_errors = true
# The size of the longest edge of the thumbnail.
long_edge = 1024
# The output format of the thumbnail.
#
# If this field isn't specified, the thumbnail format will correspond to the
# input format.
format = "png"
# Whether or not to prefer a smaller sized media format for the thumbnail.
#
# The "format" option takes precedence over this field.
#
# For instance, if the source input type is a PNG, but it doesn't have an alpha channel,
# the image will be converted to a JPEG of smaller size.
prefer_smallest_format = true
# The output quality of the thumbnail (low, medium, high).
quality = "medium"