keri 0.3.0

Core library for the Key Event Receipt Infrastructure
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

pub mod delegated;
pub mod signatory;

use crate::error::Error;
use crate::prefix::{IdentifierPrefix, SelfAddressingPrefix};
use delegated::DelegatedIdentifierState;
use signatory::Signatory;

/// Identifier State
///
/// represents the accumulated state after applying events, based on section 13 of the paper
#[derive(Default, PartialEq, Debug, Clone)]
pub struct IdentifierState {
    pub prefix: IdentifierPrefix,
    pub sn: u64,
    pub last: SelfAddressingPrefix,
    pub current: Signatory,
    pub next: SelfAddressingPrefix,
    pub delegated_keys: Vec<DelegatedIdentifierState>,
    pub tally: u64,
    pub witnesses: Vec<IdentifierPrefix>,
}

impl IdentifierState {
    /// Verify
    ///
    /// ensures that the signatures of the event message are correct
    pub fn verify<T: Verifiable>(&self, message: &T) -> Result<bool, Error> {
        message.verify_against(self)
    }

    /// Apply
    ///
    /// validates and applies the semantic rules of the event to the event state
    fn apply<T: EventSemantics>(self, event: &T) -> Result<Self, Error> {
        event.apply_to(self)
    }

    /// Verify and Apply
    ///
    /// Verifies the message and applies the event
    /// NOTE that, for many events, the event must be applied semantically before the state is able
    /// to verify the message (e.g. rotation events), consuming the state.
    /// this could be optimised later perhaps.
    pub fn verify_and_apply<T: EventSemantics + Verifiable>(
        self,
        event_message: &T,
    ) -> Result<Self, Error> {
        let next = self.apply(event_message)?;
        if next.verify(event_message)? {
            Ok(next)
        } else {
            Err(Error::SemanticError("Verification Failure".to_string()))
        }
    }
}

/// EventSemantics
///
/// Describes an interface for applying the semantic rule of an event to the state of an Identifier
pub trait EventSemantics {
    fn apply_to(&self, state: IdentifierState) -> Result<IdentifierState, Error> {
        // default impl is the identity transition
        Ok(state)
    }
}

/// Verifiable
///
/// Describes an interface for using an IdentifierState to verify a message
pub trait Verifiable {
    fn verify_against(&self, state: &IdentifierState) -> Result<bool, Error>;
}