Skip to main content

ratify_protocol/
lib.rs

1//! Ratify Protocol v1 — Rust reference SDK.
2//!
3//! Delegated-authority proofs for human-agent and agent-agent interactions.
4//! Every signature is hybrid Ed25519 + ML-DSA-65 (FIPS 204): quantum-safe
5//! by design.
6//!
7//! See docs/EXPLAINED.md and docs/AGENT_TO_AGENT.md in the repository for
8//! architecture, threat model, and agent-to-agent patterns.
9//!
10//! # `no_std` support
11//!
12//! Disable the default `std` feature to use this crate without the standard
13//! library. An `alloc` crate is required. I/O, `SystemTime`, and `serde_json`
14//! support are only available with `std`.
15
16#![cfg_attr(not(feature = "std"), no_std)]
17extern crate alloc;
18
19pub mod canonical;
20pub mod challenge_store;
21pub mod constraints;
22pub mod operation_context;
23pub mod crypto;
24pub mod receipts;
25pub mod resource_path;
26pub mod scope;
27pub mod types;
28pub mod verify;
29pub mod wire;
30
31pub use canonical::{base64_std_decode, base64_std_encode, hex_decode, hex_encode};
32#[cfg(feature = "std")]
33pub use canonical::canonical_json;
34pub use challenge_store::{ChallengeStore, UNKNOWN_CHALLENGE};
35pub use operation_context::{
36    build_session_context, operation_context_bytes, operation_context_hash,
37    session_context_bytes, OperationContext, SessionContextInputs,
38};
39#[cfg(feature = "std")]
40pub use challenge_store::MemoryChallengeStore;
41pub use crypto::{
42    chain_hash, challenge_sign_bytes, challenge_sign_bytes_with_session_context,
43    challenge_sign_bytes_with_stream, delegation_sign_bytes, derive_id, generate_challenge,
44    generate_hybrid_keypair, issue_delegation, issue_key_rotation_statement, issue_revocation_list,
45    issue_revocation_push, issue_session_token, issue_witness_entry, key_rotation_sign_bytes,
46    revocation_push_sign_bytes, revocation_sign_bytes, session_token_sign_bytes, sign_both,
47    sign_challenge, sign_challenge_with_session_context, sign_challenge_with_stream,
48    sign_transaction_receipt_party, transaction_receipt_sign_bytes, verify_both,
49    verify_challenge_signature, verify_challenge_signature_with_session_context,
50    verify_challenge_signature_with_stream, verify_delegation_signature,
51    verify_delegation_signature_e, verify_key_rotation_statement, verify_revocation_list,
52    verify_revocation_push, verify_session_token, verify_session_token_e, verify_witness_entry,
53    witness_entry_sign_bytes,
54};
55#[cfg(feature = "std")]
56pub use crypto::{generate_agent, generate_human_root};
57pub use scope::{
58    expand_scopes, has_scope, intersect_scopes, is_sensitive, scope_wildcards, validate_scopes,
59    vocabulary, CUSTOM_SCOPE_PREFIX,
60    SCOPE_COMMS_CALENDAR_READ, SCOPE_COMMS_CALENDAR_WRITE, SCOPE_COMMS_EMAIL_DELETE,
61    SCOPE_COMMS_EMAIL_READ, SCOPE_COMMS_EMAIL_SEND, SCOPE_COMMS_MESSAGE_DELETE,
62    SCOPE_COMMS_MESSAGE_READ, SCOPE_COMMS_MESSAGE_SEND, SCOPE_CONTRACT_READ, SCOPE_CONTRACT_SIGN,
63    SCOPE_DATA_DELETE, SCOPE_DATA_EXPORT, SCOPE_DATA_READ, SCOPE_DATA_SHARE, SCOPE_DATA_WRITE,
64    SCOPE_EXECUTE_CODE, SCOPE_EXECUTE_TOOL, SCOPE_FILES_READ, SCOPE_FILES_WRITE,
65    SCOPE_GENERATE_CONTENT, SCOPE_GENERATE_DEEPFAKE, SCOPE_IDENTITY_DELEGATE, SCOPE_IDENTITY_PROVE,
66    SCOPE_MEETING_ATTEND, SCOPE_MEETING_CHAT, SCOPE_MEETING_RECORD, SCOPE_MEETING_SHARE_SCREEN,
67    SCOPE_MEETING_SPEAK, SCOPE_MEETING_VIDEO, SCOPE_PAYMENTS_AUTHORIZE, SCOPE_PAYMENTS_RECEIVE,
68    SCOPE_PAYMENTS_SEND, SCOPE_PRESENCE_REPRESENT, SCOPE_TRANSACT_PURCHASE, SCOPE_TRANSACT_SELL,
69};
70pub use receipts::{
71    bundle_hash, issue_policy_verdict, issue_verification_receipt,
72    policy_verdict_sign_bytes_buf, receipt_hash, verification_receipt_sign_bytes_buf,
73    verifier_context_hash, verify_policy_verdict, verify_verification_receipt,
74};
75pub use resource_path::{
76    normalize_resource_path, resource_path_matches, validate_constraint_params,
77    validate_params_value, validate_resource_constraints,
78};
79pub use wire::{
80    check_json_nesting_depth, check_receipt_structure, encode_verification_receipt,
81};
82#[cfg(feature = "std")]
83pub use wire::{decode_delegation_cert, decode_proof_bundle, decode_verification_receipt};
84pub use types::{
85    is_canonical_constraint_type, AgentIdentity, Anchor, AnchorResolver, AuditProvider, Constraint,
86    ConstraintEvaluator, DelegationCert, HumanRoot, HybridPrivateKey, HybridPublicKey,
87    HybridSignature, IdentityStatus, KeyRotationStatement, ParamsValue, PolicyProvider,
88    PolicyVerdict, ProofBundle, ReceiptParty, ReceiptPartySignature, RevocationList,
89    RevocationProvider, RevocationPush, SessionToken, StreamContext, TransactionReceipt,
90    TransactionReceiptResult, VerificationReceipt, InvocationCounter, VerifierContext,
91    VerifyOptions, VerifyResult, WitnessEntry, CHALLENGE_WINDOW_SECONDS, ED25519_PUBLIC_KEY_SIZE,
92    ED25519_SIGNATURE_SIZE, MAX_AGENT_NAME_LENGTH_BYTES, MAX_CONSTRAINTS_PER_CERT,
93    MAX_DELEGATION_CHAIN_DEPTH, MAX_IDENTIFIER_LENGTH_BYTES, MAX_JSON_NESTING_DEPTH,
94    MAX_PROOF_BUNDLE_BYTES, MAX_SCOPES_PER_CERT, MAX_SCOPE_LENGTH_BYTES, MLDSA65_PUBLIC_KEY_SIZE,
95    MLDSA65_SIGNATURE_SIZE, NO_EXPIRY_SENTINEL, PROTOCOL_VERSION,
96};
97#[allow(deprecated)]
98pub use verify::verify_streamed_turn;
99pub use verify::{
100    verify_bundle, verify_streamed_turn_with_options, verify_transaction_receipt, StreamedTurn,
101    StreamedVerifyOptions,
102};