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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
// Copyright 2020 MaidSafe.net limited.
//
// This SAFE Network Software is licensed to you under The General Public License (GPL), version 3.
// Unless required by applicable law or agreed to in writing, the SAFE Network Software distributed
// under the GPL Licence is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. Please review the Licences for the specific language governing
// permissions and limitations relating to use of the SAFE Network Software.
use super::{
agreement::{DkgFailureSigned, DkgFailureSignedSet, DkgKey, Proposal, SectionSigned},
join::{JoinRequest, JoinResponse},
join_as_relocated::{JoinAsRelocatedRequest, JoinAsRelocatedResponse},
network::Network,
relocation::{RelocateDetails, RelocatePromise},
section::{ElderCandidates, Section},
signed::SignedShare,
RoutingMsg,
};
use crate::{DestInfo, SectionAuthorityProvider};
use bls_dkg::key_gen::message::Message as DkgMessage;
use hex_fmt::HexFmt;
use itertools::Itertools;
use secured_linked_list::SecuredLinkedList;
use serde::{Deserialize, Serialize};
use std::{
collections::BTreeSet,
fmt::{self, Debug, Formatter},
};
use threshold_crypto::PublicKey as BlsPublicKey;
use xor_name::XorName;
#[derive(Clone, Eq, PartialEq, Serialize, Deserialize)]
#[allow(clippy::large_enum_variant)]
/// Message variant
pub enum Variant {
/// Inform other sections about our section or vice-versa.
SectionKnowledge {
/// `SectionAuthorityProvider` and `SecuredLinkedList` of the sender's section, with the proof chain.
src_info: (SectionSigned<SectionAuthorityProvider>, SecuredLinkedList),
/// Message
msg: Option<Box<RoutingMsg>>,
},
/// User-facing message
#[serde(with = "serde_bytes")]
UserMessage(Vec<u8>),
/// Message sent to all members to update them about the state of our section.
Sync {
// Information about our section.
section: Section,
// Information about the rest of the network that we know of.
network: Network,
},
/// Send from a section to the node to be immediately relocated.
Relocate(RelocateDetails),
/// Send:
/// - from a section to a current elder to be relocated after they are demoted.
/// - from the node to be relocated back to its section after it was demoted.
RelocatePromise(RelocatePromise),
/// Sent from a bootstrapping peer to the section requesting to join as a new member
JoinRequest(Box<JoinRequest>),
/// Response to a `JoinRequest`
JoinResponse(Box<JoinResponse>),
/// Sent from a peer to the section requesting to join as relocated from another section
JoinAsRelocatedRequest(Box<JoinAsRelocatedRequest>),
/// Response to a `JoinAsRelocatedRequest`
JoinAsRelocatedResponse(Box<JoinAsRelocatedResponse>),
/// Sent from a node that can't establish the trust of the contained message to its original
/// source in order for them to provide new proof that the node would trust.
BouncedUntrustedMessage {
msg: Box<RoutingMsg>,
dest_info: DestInfo,
},
/// Sent to the new elder candidates to start the DKG process.
DkgStart {
/// The identifier of the DKG session to start.
dkg_key: DkgKey,
/// The DKG particpants.
elder_candidates: ElderCandidates,
},
/// Message exchanged for DKG process.
DkgMessage {
/// The identifier of the DKG session this message is for.
dkg_key: DkgKey,
/// The DKG message.
message: DkgMessage,
},
/// Broadcasted to the other DKG participants when a DKG failure is observed.
DkgFailureObservation {
dkg_key: DkgKey,
signed: DkgFailureSigned,
non_participants: BTreeSet<XorName>,
},
/// Sent to the current elders by the DKG participants when at least majority of them observe
/// a DKG failure.
DkgFailureAgreement(DkgFailureSignedSet),
/// Message containing a single `Proposal` to be aggregated in the proposal aggregator.
Propose {
content: Proposal,
signed_share: SignedShare,
},
/// Message that notifies a section to test
/// the connectivity to a node
StartConnectivityTest(XorName),
/// Message sent by a node to indicate it received a message from a node which was ahead in knowledge.
/// A reply is expected with a `SectionKnowledge` message.
SectionKnowledgeQuery {
last_known_key: Option<BlsPublicKey>,
msg: Box<RoutingMsg>,
},
}
impl Debug for Variant {
fn fmt(&self, f: &mut Formatter) -> fmt::Result {
match self {
Self::SectionKnowledge { .. } => f.debug_struct("SectionKnowledge").finish(),
Self::UserMessage(payload) => write!(f, "UserMessage({:10})", HexFmt(payload)),
Self::Sync { section, network } => f
.debug_struct("Sync")
.field("section_auth", §ion.section_auth.value)
.field("section_key", section.chain.last_key())
.field(
"other_prefixes",
&format_args!(
"({:b})",
network
.sections
.iter()
.map(|info| &info.section_auth.value.prefix)
.format(", ")
),
)
.finish(),
Self::Relocate(payload) => write!(f, "Relocate({:?})", payload),
Self::StartConnectivityTest(name) => write!(f, "StartConnectivityTest({:?})", name),
Self::RelocatePromise(payload) => write!(f, "RelocatePromise({:?})", payload),
Self::JoinRequest(payload) => write!(f, "JoinRequest({:?})", payload),
Self::JoinResponse(response) => write!(f, "JoinResponse({:?})", response),
Self::JoinAsRelocatedRequest(payload) => {
write!(f, "JoinAsRelocatedRequest({:?})", payload)
}
Self::JoinAsRelocatedResponse(response) => {
write!(f, "JoinAsRelocatedResponse({:?})", response)
}
Self::BouncedUntrustedMessage { msg, dest_info } => f
.debug_struct("BouncedUntrustedMessage")
.field("message", msg)
.field("dest_info", dest_info)
.finish(),
Self::DkgStart {
dkg_key,
elder_candidates,
} => f
.debug_struct("DkgStart")
.field("dkg_key", dkg_key)
.field("elder_candidates", elder_candidates)
.finish(),
Self::DkgMessage { dkg_key, message } => f
.debug_struct("DkgMessage")
.field("dkg_key", &dkg_key)
.field("message", message)
.finish(),
Self::DkgFailureObservation {
dkg_key,
signed,
non_participants,
} => f
.debug_struct("DkgFailureObservation")
.field("dkg_key", dkg_key)
.field("signed", signed)
.field("non_participants", non_participants)
.finish(),
Self::DkgFailureAgreement(proofs) => {
f.debug_tuple("DkgFailureAgreement").field(proofs).finish()
}
Self::Propose {
content,
signed_share,
} => f
.debug_struct("Propose")
.field("content", content)
.field("signed_share", signed_share)
.finish(),
Self::SectionKnowledgeQuery { .. } => write!(f, "SectionKnowledgeQuery"),
}
}
}