C2PA Rust SDK

The Coalition for Content Provenance and Authenticity (C2PA) addresses the prevalence of misleading information online through the development of technical standards for certifying the source and history (or provenance) of media content. Adobe and other contributors created the C2PA Rust SDK as part of the Content Authenticity Initiative and released it to open source in June, 2022.

Key features

The C2PA Rust SDK implements a subset of the C2PA technical specification.

The SDK enables a desktop, mobile, or embedded application to:

• Create and sign C2PA claims and manifests.
• Embed manifests in certain file formats.
• Parse and validate manifests found in certain file formats.

The SDK supports several common C2PA assertions and hard bindings.

State of the project

This is a beta release (version 0.x.x) of the project. The minor version number (0.x.0) is incremented when there are breaking API changes, which may happen frequently.

Contributions and feedback

We welcome contributions to this project. For information on contributing, providing feedback, and about ongoing work, see Contributing.

Requirements

The SDK requires Rust version 1.70.0 or newer.

Supported platforms

The SDK has been tested on the following operating systems:

• Windows (Intel only)
• MacOS (Intel and Apple silicon)
• Ubuntu Linux (64-bit Intel and ARM v8)
• WebAssembly (Wasm)

Supported file formats

Usage

Add this to your Cargo.toml:

[dependencies]
c2pa = "0.28.3"

If you want to read or write a manifest file, add the file_io dependency to your Cargo.toml. The add_thumbnails feature will generate thumbnails for JPEG and PNG files. For example:

c2pa = { version = "0.25.0", features = ["file_io", "add_thumbnails"] }

NOTE: If you are building for WASM, omit the file_io dependency.

Crate features

The Rust SDK crate provides:

• file_io enables manifest generation, signing via OpenSSL, and embedding manifests in various file formats.
• add_thumbnails will generate thumbnails automatically for JPEG and PNG files. (no longer included with file_io)
• serialize_thumbnails includes binary thumbnail data in the Serde serialization output.
• xmp_write enables updating XMP on embed with the dcterms:provenance field. (Requires xmp_toolkit.)
• no_interleaved_io forces fully-synchronous I/O; otherwise, the SDK uses threaded I/O for some operations to improve performance.
• fetch_remote_manifests enables the verification step to retrieve externally referenced manifest stores. External manifests are only fetched if there is no embedded manifest store and no locally adjacent .c2pa manifest store file of the same name.
• json_schema is used by make schema to produce a JSON schema document that represents the ManifestStore data structures.

License

The c2pa crate is distributed under the terms of both the MIT license and the Apache License (Version 2.0).

Note that some components and dependent crates are licensed under different terms; please check the license terms for each crate and component for details.

Nightly builds

In most cases, you should depend on this crate as published via crates.io.

The Adobe team produces nightly snapshots of this crate via a nightly branch, which we use for testing the impact of pending changes to upstream dependencies.

You may wish to use these builds for your own testing ahead of our releases, you may include the SDK via the following Cargo.toml entry:

c2pa = { git = "https://github.com/contentauth/c2pa-rs.git", branch = "nightly", features = [...]}

Commits in this branch have a modified sdk/Cargo.toml entry which includes a version number similar to the following:

version = "0.25.3-nightly+2023-08-28-2f33ab3"

Please note that there is no formal support for code from a nightly release, but if you become aware of any issues, we would appreciate a bug report including this version number.

Release notes

This section gives a highlight of noteworthy changes.

Refer to the CHANGELOG for detailed changes derived from git commit history.

0.29.0

17 November 2023

• PDF read support
• MP3 support
• new and enhanced manifest APIs
• thumbnail databox support
• bug fixes and optimizations

0.25.0

14 July 2023

• (important!) the add_thumbnails feature is no longer tied to file_io, so you will need to specify it or thumbnails will not be generated.
• removed User and UserCbor assertions from public API. They were not generating correct manifest data.
• use manifest_add_labeled_assertion instead - see docs on manifest.embed for an example.
• DataHash and BoxHash SDK support (generates a signed manifest ready to write into a file without writing to the file)
• The SDK will no longer remove duplicate ingredients based on hash
• make_test_images updated to fix issue 195, actions without required ingredients
• updated the test fixtures generated by make_test_images
• Expose CAIRead and CAIWrite traits required by some SDK calls.
• Bug fix for certain BMFF formats (AVIF) that causes images to be unreadable

0.24.0

21 June 2023

• Bump minor version to 0.24.0 to signify change in signature (back to the compatible one)
• Reverts to 1.2 Cose signatures when signing while still validating 1.3 Cose signatures
• We want to allow some time for clients to upgrade to validating 1.3 before writing this breaking change.
• Fix embed_from_memory to correctly return the updated image
• includes the cert serial number in the ValidationInfo output
• support adding claim_generator_info field
• support Actions V2 and Ingredients V2
• BMFF V2
• Json Schema generation

0.19.0

23 March 2023

• Added support for many new file formats, see Supported File Formats above.
• New api to return supported formats.
• Streaming APIs for manifest creation without file_io for some formats.
• Manifest and Ingredient JSON formats replace the is_parent field with relationship.
• ResourceRef replaces content-type with format.
• The bmff feature no longer required.