fips-core 0.3.6

Reusable FIPS mesh, endpoint, transport, and protocol library
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

//! Spanning Tree Protocol Entities
//!
//! Tree coordinates and parent declarations for the FIPS spanning tree.
//! The spanning tree provides a routing topology where each node maintains
//! a path to a common root, enabling greedy distance-based routing.

mod coordinate;
mod declaration;
mod state;

use thiserror::Error;

use crate::{IdentityError, NodeAddr};

pub use coordinate::{CoordEntry, TreeCoordinate};
pub use declaration::ParentDeclaration;
pub use state::TreeState;

/// Errors related to spanning tree operations.
#[derive(Debug, Error)]
pub enum TreeError {
    #[error("invalid tree coordinate: empty path")]
    EmptyCoordinate,

    #[error("invalid ancestry: does not reach claimed root")]
    AncestryNotToRoot,

    #[error("invalid ancestry: root declaration must contain only the sender")]
    RootDeclarationMismatch,

    #[error("invalid ancestry: non-root declaration must include a parent hop")]
    AncestryTooShort,

    #[error("invalid ancestry: sender {declared} does not match first path entry {ancestry}")]
    AncestryNodeMismatch {
        declared: NodeAddr,
        ancestry: NodeAddr,
    },

    #[error(
        "invalid ancestry: signed parent {declared} does not match first ancestry hop {ancestry}"
    )]
    AncestryParentMismatch {
        declared: NodeAddr,
        ancestry: NodeAddr,
    },

    #[error(
        "invalid ancestry: advertised root {advertised} is not the minimum path entry {minimum}"
    )]
    AncestryRootNotMinimum {
        advertised: NodeAddr,
        minimum: NodeAddr,
    },

    #[error("signature verification failed for node {0:?}")]
    InvalidSignature(NodeAddr),

    #[error("sequence number regression: got {got}, expected > {expected}")]
    SequenceRegression { got: u64, expected: u64 },

    #[error("parent not in peers: {0:?}")]
    ParentNotPeer(NodeAddr),

    #[error("identity error: {0}")]
    Identity(#[from] IdentityError),
}

#[cfg(test)]
mod tests;