rust-sign 0.1.0

Document signing library using BLAKE3 hashing and Ed25519 signatures
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

//! # rust-sign
//!
//! A document signing library using BLAKE3 hashing and Ed25519 signatures.
//!
//! ## Features
//!
//! - **BLAKE3 hashing** for fast, secure document fingerprinting
//! - **Ed25519 signatures** for compact, secure digital signatures
//! - **Multiple signatures** support for multi-party signing
//! - **JSON output** with timestamps and metadata
//! - **Streaming** support for large files
//!
//! ## Quick Start
//!
//! ### Generate a Keypair
//!
//! ```rust
//! use rust_sign::KeyPair;
//!
//! let keypair = KeyPair::generate();
//! // Save to file (optional)
//! // keypair.save_to_file("my_key.pem").unwrap();
//! ```
//!
//! ### Sign a Document
//!
//! ```rust
//! use rust_sign::{KeyPair, Signer};
//!
//! let keypair = KeyPair::generate();
//! let document = b"Important document content";
//!
//! let signature = Signer::new(&keypair)
//!     .with_signer_id("alice@example.com")
//!     .with_metadata("purpose", "contract")
//!     .sign_bytes(document)
//!     .unwrap();
//!
//! // Save signature to file
//! // signature.save("document.sig").unwrap();
//! println!("{}", signature.to_json().unwrap());
//! ```
//!
//! ### Verify a Signature
//!
//! ```rust
//! use rust_sign::{KeyPair, Signer, Verifier};
//!
//! let keypair = KeyPair::generate();
//! let document = b"Important document content";
//!
//! let signature = Signer::new(&keypair).sign_bytes(document).unwrap();
//!
//! let result = Verifier::verify_bytes(document, &signature).unwrap();
//! assert!(result.all_valid);
//! println!("All {} signatures valid!", result.valid_count());
//! ```
//!
//! ### Multiple Signatures
//!
//! ```rust
//! use rust_sign::{KeyPair, Signer, Verifier};
//!
//! let alice = KeyPair::generate();
//! let bob = KeyPair::generate();
//! let document = b"Contract requiring multiple signatures";
//!
//! // Alice signs first
//! let mut signature = Signer::new(&alice)
//!     .with_signer_id("alice@example.com")
//!     .sign_bytes(document)
//!     .unwrap();
//!
//! // Bob co-signs
//! Signer::new(&bob)
//!     .with_signer_id("bob@example.com")
//!     .cosign(&mut signature)
//!     .unwrap();
//!
//! // Verify all signatures
//! let result = Verifier::verify_bytes(document, &signature).unwrap();
//! assert!(result.all_valid);
//! assert_eq!(result.valid_count(), 2);
//! ```

pub mod error;
pub mod hash;
pub mod keys;
pub mod signature;
pub mod signer;
pub mod verifier;

// Re-export main types for convenience
pub use error::{Result, SignError};
pub use hash::{hash_bytes, hash_file, hash_reader, DocumentHash};
pub use keys::{KeyPair, PublicKey};
pub use signature::{DocumentSignature, SignatureEntry};
pub use signer::{sign_bytes, sign_file, Signer};
pub use verifier::{verify_bytes, verify_file, SignatureResult, VerificationResult, Verifier};