cdx-core

Overview

Features

Installation

[dependencies]
cdx-core = "0.7"

Feature Flags

Quick Start

Creating a Document

use cdx_core::{Document, Result};
fn main() -> Result<()> {
 let document = Document::builder()
 .title("My Document")
 .creator("Jane Doe")
 .add_heading(1, "Introduction")
 .add_paragraph("This is my first CDX document.")
 .add_heading(2, "Features")
 .add_paragraph("CDX provides semantic structure and verifiable integrity.")
 .build()?;
 // Compute the document ID
 let doc_id = document.compute_id()?;
 println!("Document ID: {doc_id}");
 // Save the document
 document.save("output.cdx")?;
 Ok(())
}

Opening and Verifying

use cdx_core::{Document, Result};
fn main() -> Result<()> {
 let document = Document::open("example.cdx")?;
 println!("Title: {:?}", document.dublin_core().terms.title);
 println!("State: {:?}", document.state());
 // Verify document integrity
 let report = document.verify()?;
 if report.is_valid() {
 println!("Document integrity verified!");
 }
 Ok(())
}

Digital Signatures

use cdx_core::{Document, Result};
use cdx_core::security::{EcdsaSigner, SignerInfo, Signer};
fn main() -> Result<()> {
 let document = Document::builder()
 .title("Signed Document")
 .creator("Signing Example")
 .add_paragraph("This document will be signed.")
 .build()?;
 let doc_id = document.compute_id()?;
 // Create a signer
 let signer_info = SignerInfo::new("Alice")
 .with_email("alice@example.com");
 let (signer, public_key) = EcdsaSigner::generate(signer_info)?;
 // Sign the document
 let signature = signer.sign(&doc_id)?;
 println!("Signed with algorithm: {}", signature.algorithm);
 Ok(())
}

Examples

# Create a document from scratch
cargo run --example create_document
# Extract content from a document
cargo run --example extract_content
# Sign a document (requires signatures feature)
cargo run --example sign_document --features signatures
# Open and verify a document
cargo run --example open_and_verify path/to/document.cdx

Specification Compliance

Module Status

Development

Quick Start

cargo build --all-features # Build
cargo test --all-features # Test
cargo clippy --all-features # Lint

API Documentation

Contributing

License

Contribution