mosaik 0.3.13

A Rust runtime for building self-organizing, leaderless distributed systems.
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

use {
	crate::{
		Digest,
		PeerId,
		groups::{GroupId, Groups},
		network::link::Link,
		tickets::TicketValidator,
	},
	core::fmt,
	serde::{Deserialize, Serialize},
};

/// Group secret key used during initial handshake to authorize group
/// membership. It's a 32-byte value that is never transmitted over the network
/// directly, only proofs of knowledge derived from it are sent during handshake
/// to authenticate peers.
pub type Secret = Digest;

/// Group secret proof of knowledge.
///
/// This is derived during bonding handshake to prove knowledge of the
/// group secret without transmitting the secret itself over the network.
pub type SecretProof = Digest;

/// Group Key is used to join a group and authorize membership.
///
/// Notes:
///
/// - Currently only secret-based authentication is implemented.
///
/// - Group Id is derived by hashing the secret bytes with the group
///   configuration and the state machine identifier. See [`GroupId`] for more
///   details on how the group id is derived.
///
/// - During handshake, peers prove knowledge of the secret without revealing
///   the secret itself by generating a proof of knowledge derived from the
///   secret and the shared random value for the link.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct GroupKey {
	/// The secret key used to derive the group id and authenticate peers during
	/// bonding handshake.
	secret: Secret,
}

impl From<Secret> for GroupKey {
	fn from(secret: Secret) -> Self {
		Self { secret }
	}
}

impl From<&Secret> for GroupKey {
	fn from(secret: &Secret) -> Self {
		Self { secret: *secret }
	}
}

impl<T: TicketValidator + ?Sized> From<&T> for GroupKey {
	fn from(validator: &T) -> Self {
		Self {
			secret: validator.signature(),
		}
	}
}

impl GroupKey {
	/// Creates a new `GroupKey` from the given secret `Digest`.
	pub const fn new(secret: Secret) -> Self {
		Self { secret }
	}

	/// Create a new `GroupKey` from the given secret `UniqueId`.
	pub fn from_secret(secret: impl Into<Secret>) -> Self {
		let secret = secret.into();
		Self { secret }
	}

	/// Creates a new `GroupKey` with a randomly generated secret.
	pub fn random() -> Self {
		Self {
			secret: Secret::random(),
		}
	}

	/// Gets the underlying secret `UniqueId`.
	///
	/// This should never be transmitted over the network, only proofs
	/// of knowledge should be sent.
	pub const fn secret(&self) -> &Secret {
		&self.secret
	}

	/// Validates the validity of the authentication proof contained in this
	/// handshake message against the provided group key and link.
	pub fn validate_proof(
		&self,
		link: &Link<Groups>,
		proof: SecretProof,
		group_id: GroupId,
	) -> bool {
		self.generate_proof(link, link.remote_id(), group_id) == proof
	}

	/// Generates a proof of knowledge of the secret key for the given peer and
	/// link.
	pub fn generate_proof(
		&self,
		link: &Link<Groups>,
		peer_id: PeerId,
		group_id: GroupId,
	) -> SecretProof {
		self
			.secret()
			.derive(link.shared_random(group_id))
			.derive(peer_id.as_bytes())
	}
}

impl fmt::Display for GroupKey {
	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
		let head = hex::encode(&self.secret().as_bytes()[..1]);
		let tail = hex::encode(&self.secret().as_bytes()[31..]);
		write!(f, "{head}****{tail}")
	}
}