bcx 0.4.0

Bifrost Causal Exchange protocol primitives for signed causal meaning and proof composition.
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

#![no_std]
#![doc = include_str!("../README.md")]

//! Public facade for the BCX protocol crates.

pub use bcx_core as core;
pub use bcx_crypto as crypto;
pub use bcx_model as model;
pub use bcx_policy as policy;
pub use bcx_wire as wire;

pub use bcx_wire::ProtocolVersion;

/// Items commonly needed by BCX integrators.
pub mod prelude {
    pub use bcx_core::{
        CapabilityRef, CheckpointId, Digest, EventId, NativeBindingId, Nonce, OperationSequence,
        PolicyEpoch, PolicyId, ProfileId, ProofSuiteId, RealmId, StatementId, SubjectId,
        ValidationError, ZeroizedDigest,
    };
    pub use bcx_crypto::{
        AlgorithmPolicy, ExactAlgorithmPolicy, SignatureAlgorithm, SignatureEnvelope,
        VerificationError, Verifier,
    };
    pub use bcx_model::{
        Admission, AdmissionResult, AssuranceLevel, CauseKind, Checkpoint, Contradiction,
        Delegation, Effect, EffectResult, Intent, OperationAction, RelationshipKind, Revocation,
        StatementKind, TruthStatus,
    };
    pub use bcx_policy::{DisclosureLevel, ProofLevel, ProtocolProfile};
    pub use bcx_wire::{ProtocolVersion, WireHeader, WireLimits};
}

/// Returns the current BCX wire version implemented by this crate.
#[must_use]
pub const fn protocol_version() -> ProtocolVersion {
    ProtocolVersion::CURRENT
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn facade_reports_current_protocol_version() {
        assert_eq!(protocol_version(), ProtocolVersion::new(1, 0));
    }

    #[test]
    fn prelude_exports_zeroized_digest() {
        use crate::prelude::*;

        let digest = ZeroizedDigest::new(Digest::new([1; Digest::LEN]));

        assert_eq!(digest.as_bytes(), &[1; Digest::LEN]);
    }
}