c2pa 0.91.11

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

// Copyright 2026 Adobe. All rights reserved.
// This file is licensed to you under the Apache License,
// Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
// or the MIT license (http://opensource.org/licenses/MIT),
// at your option.

// Unless required by applicable law or agreed to in writing,
// this software is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR REPRESENTATIONS OF ANY KIND, either express or
// implied. See the LICENSE-MIT and LICENSE-APACHE files for the
// specific language governing permissions and limitations under
// each license.

//! Shared helpers for the structured-text handler: whole-stream read with a checked
//! allocation, the `c2pa.hash.data` object layout, and A.9 delimiter / `data:` URI encoding.

use crate::{
    asset_io::{ObjectLocations, ObjectType, ReadSeek},
    crypto::base64,
    error::{Error, Result},
    utils::io_utils::{stream_len, ReaderUtils},
};

/// `c2pa.hash.data` layout: excluded manifest region, plus content before/after.
pub(crate) fn hash_positions(
    full_len: usize,
    region_start: usize,
    region_len: usize,
) -> Vec<ObjectLocations> {
    let region_end = region_start + region_len;
    vec![
        ObjectLocations {
            offset: region_start as u64,
            length: region_len as u64,
            htype: ObjectType::C2pa,
        },
        ObjectLocations {
            offset: 0,
            length: region_start as u64,
            htype: ObjectType::Other,
        },
        ObjectLocations {
            offset: region_end as u64,
            length: full_len.saturating_sub(region_end) as u64,
            htype: ObjectType::Other,
        },
    ]
}

/// Reads a text asset into a `String`. The allocation is checked, so an oversized stream
/// fails with `Error::InsufficientMemory` rather than aborting.
pub(crate) fn read_text_stream(mut reader: &mut dyn ReadSeek) -> Result<String> {
    reader.rewind()?;
    let len = stream_len(reader)?;
    let bytes = reader.read_to_vec(len)?;
    String::from_utf8(bytes)
        .map_err(|_| Error::InvalidAsset("text asset is not valid UTF-8".to_string()))
}

pub(crate) const BEGIN_DELIMITER: &str = "-----BEGIN C2PA MANIFEST-----";
pub(crate) const END_DELIMITER: &str = "-----END C2PA MANIFEST-----";
pub(crate) const DATA_URI_PREFIX: &str = "data:application/c2pa;base64,";

pub(crate) fn encode_data_uri(store_bytes: &[u8]) -> String {
    format!("{DATA_URI_PREFIX}{}", base64::encode(store_bytes))
}

pub(crate) enum ManifestReference {
    Embedded(Vec<u8>),
    /// External reference; handlers treat it as no embedded store.
    External,
}

pub(crate) fn parse_manifest_reference(reference: &str) -> Result<ManifestReference> {
    let reference = reference.trim();
    match reference.strip_prefix(DATA_URI_PREFIX) {
        Some(b64) => {
            let bytes = base64::decode(b64.trim())
                .map_err(|_| Error::InvalidAsset("invalid base64 in c2pa data URI".into()))?;
            Ok(ManifestReference::Embedded(bytes))
        }
        None => Ok(ManifestReference::External),
    }
}

/// Whether the text between the delimiters is a manifest reference at all: A.9.3 admits
/// only a URL or a `data:` URI, and A.9.5 treats an empty one as a failure. Text that is
/// neither means the surrounding delimiters are ordinary content (prose describing the
/// format, say) rather than a manifest block, so handlers must leave it alone.
pub(crate) fn is_manifest_reference(reference: &str) -> bool {
    let reference = reference.trim();
    if reference.starts_with(DATA_URI_PREFIX) {
        return true;
    }
    if reference.is_empty() || reference.contains(char::is_whitespace) {
        return false;
    }
    // Absolute URI: an RFC 3986 scheme followed by a non-empty remainder.
    match reference.split_once(':') {
        Some((scheme, rest)) => {
            !rest.is_empty()
                && scheme.starts_with(|c: char| c.is_ascii_alphabetic())
                && scheme
                    .chars()
                    .all(|c| c.is_ascii_alphanumeric() || matches!(c, '+' | '-' | '.'))
        }
        None => false,
    }
}

#[cfg(test)]
mod tests {
    #![allow(clippy::panic)]
    #![allow(clippy::unwrap_used)]

    use super::*;

    #[test]
    fn data_uri_round_trip_and_external() {
        let store = b"\x00\x01\x02manifest";
        let uri = encode_data_uri(store);
        assert!(uri.starts_with(DATA_URI_PREFIX));
        match parse_manifest_reference(&uri).unwrap() {
            ManifestReference::Embedded(b) => assert_eq!(b, store),
            ManifestReference::External => panic!("expected embedded"),
        }
        match parse_manifest_reference("https://example.com/a.c2pa").unwrap() {
            ManifestReference::External => {}
            ManifestReference::Embedded(_) => panic!("expected external"),
        }
    }
}