Struct SignatureScope 

pub struct SignatureScope {
    pub document_id: DocumentId,
    pub layouts: Option<HashMap<String, DocumentId>>,
}

Available on crate feature signatures only.

Signature scope for scoped signatures.

Scoped signatures allow attesting to specific layout renditions in addition to the semantic content. The scope is serialized using JSON Canonicalization Scheme (JCS, RFC 8785) before signing.

Example

use cdx_core::security::SignatureScope;
use cdx_core::{HashAlgorithm, Hasher};
use std::collections::HashMap;

let doc_id = Hasher::hash(HashAlgorithm::Sha256, b"content");
let layout_hash = Hasher::hash(HashAlgorithm::Sha256, b"layout");

let mut layouts = HashMap::new();
layouts.insert("presentation/print.json".to_string(), layout_hash);

let scope = SignatureScope::new(doc_id).with_layouts(layouts);

Fields

document_id: DocumentId

Document ID that must match the top-level document ID.

layouts: Option<HashMap<String, DocumentId>>

Layout paths and their content hashes for layout attestation.

Keys are presentation file paths (e.g., “presentation/print.json”), values are the content hashes of those files.

Implementations

impl SignatureScope

pub fn new(document_id: DocumentId) -> Self

Create a new signature scope for a document.

pub fn with_layouts(self, layouts: HashMap<String, DocumentId>) -> Self

Add layout attestations.

pub fn with_layout(self, path: impl Into<String>, hash: DocumentId) -> Self

Add a single layout attestation.

pub fn has_layouts(&self) -> bool

Check if this scope attests to any layouts.

pub fn to_jcs(&self) -> Result<Vec<u8>>

Serialize the scope using JSON Canonicalization Scheme (JCS).

This produces a deterministic JSON representation suitable for signing.

Errors

Returns an error if serialization fails.

Trait Implementations

impl Clone for SignatureScope

fn clone(&self) -> SignatureScope

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SignatureScope

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SignatureScope

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SignatureScope

fn eq(&self, other: &SignatureScope) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SignatureScope

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SignatureScope

impl StructuralPartialEq for SignatureScope