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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
use super::includes::*;
use crate::error::NetworkError;
use crate::proto::node_result::{RegisterFailure, RegisterOkay};
use citadel_crypt::prelude::ConstructorOpts;
use citadel_crypt::stacked_ratchet::constructor::{
BobToAliceTransfer, BobToAliceTransferType, StackedRatchetConstructor,
};
use std::sync::atomic::Ordering;
/// This will handle a registration packet
#[cfg_attr(feature = "localhost-testing", tracing::instrument(target = "citadel", skip_all, ret, err, fields(is_server = session_ref.is_server, src = packet.parse().unwrap().0.session_cid.get(), target = packet.parse().unwrap().0.target_cid.get())))]
pub async fn process_register(
session_ref: &HdpSession,
packet: HdpPacket,
remote_addr: SocketAddr,
) -> Result<PrimaryProcessorResult, NetworkError> {
let session = session_ref.clone();
let state = session.state.load(Ordering::Relaxed);
if state != SessionState::NeedsRegister
&& state != SessionState::SocketJustOpened
&& state != SessionState::NeedsConnect
{
log::error!(target: "citadel", "Register packet received, but the system's state is not NeedsRegister. Dropping packet");
return Ok(PrimaryProcessorResult::Void);
}
let task = async move {
let (header, payload, _, _) = packet.decompose();
let header = return_if_none!(LayoutVerified::new(&header[..]), "Unable to parse header")
as LayoutVerified<&[u8], HdpHeader>;
debug_assert_eq!(packet_flags::cmd::primary::DO_REGISTER, header.cmd_primary);
let security_level = header.security_level.into();
match header.cmd_aux {
packet_flags::cmd::aux::do_register::STAGE0 => {
log::trace!(target: "citadel", "STAGE 0 REGISTER PACKET");
let task = {
let mut state_container = inner_mut_state!(session.state_container);
// This node is Bob (receives a stage 0 packet from Alice). The payload should have Alice's public key
if state_container.register_state.last_stage
== packet_flags::cmd::aux::do_register::STAGE0
{
let algorithm = header.algorithm;
match validation::do_register::validate_stage0(&payload) {
Some((transfer, passwordless)) => {
// Now, create a stage 1 packet
let timestamp = session.time_tracker.get_global_time_ns();
state_container.register_state.passwordless = Some(passwordless);
if passwordless
&& !session
.account_manager
.get_misc_settings()
.allow_passwordless
{
// passwordless is not allowed on this node
let err = packet_crafter::do_register::craft_failure(algorithm, timestamp, "Passwordless connections are not enabled on the target node", header.session_cid.get());
return Ok(PrimaryProcessorResult::ReplyToSender(err));
}
std::mem::drop(state_container);
async move {
let cid = header.session_cid.get();
let bob_constructor = StackedRatchetConstructor::new_bob(
cid,
0,
ConstructorOpts::new_vec_init(
Some(transfer.params),
(transfer.security_level.value() + 1) as usize,
),
transfer,
)
.ok_or(NetworkError::InvalidRequest("Bad bob transfer"))?;
let transfer = return_if_none!(
bob_constructor.stage0_bob(),
"Unable to advance past stage0-bob"
);
let stage1_packet = packet_crafter::do_register::craft_stage1(
algorithm,
timestamp,
transfer,
header.session_cid.get(),
);
let mut state_container =
inner_mut_state!(session.state_container);
state_container.register_state.created_hyper_ratchet =
Some(return_if_none!(
bob_constructor.finish(),
"Unable to finish bob constructor"
));
state_container.register_state.last_stage =
packet_flags::cmd::aux::do_register::STAGE1;
state_container.register_state.on_register_packet_received();
Ok(PrimaryProcessorResult::ReplyToSender(stage1_packet))
}
}
_ => {
log::error!(target: "citadel", "Unable to validate STAGE0_REGISTER packet");
state_container.register_state.on_fail();
state_container.register_state.on_register_packet_received();
std::mem::drop(state_container);
session
.state
.store(SessionState::NeedsRegister, Ordering::Relaxed);
return Ok(PrimaryProcessorResult::Void);
}
}
} else {
warn!(target: "citadel", "Inconsistency between the session's stage and the packet's state. Dropping");
return Ok(PrimaryProcessorResult::Void);
}
};
return task.await;
}
packet_flags::cmd::aux::do_register::STAGE1 => {
log::trace!(target: "citadel", "STAGE 1 REGISTER PACKET");
// Node is Alice. This packet will contain Bob's ciphertext; Alice will now be able to create the shared private key
let mut state_container = inner_mut_state!(session.state_container);
if state_container.register_state.last_stage
== packet_flags::cmd::aux::do_register::STAGE0
{
let algorithm = header.algorithm;
// pqc is stored in the register state container for now
//debug_assert!(session.post_quantum.is_none());
if let Some(mut alice_constructor) =
state_container.register_state.constructor.take()
{
let transfer = return_if_none!(
BobToAliceTransfer::deserialize_from(&payload[..]),
"Unable to deserialize BobToAliceTransfer"
);
let security_level = transfer.security_level;
alice_constructor
.stage1_alice(BobToAliceTransferType::Default(transfer))
.map_err(|err| NetworkError::Generic(err.to_string()))?;
let new_hyper_ratchet = return_if_none!(
alice_constructor.finish(),
"Unable to finish alice constructor"
);
let timestamp = session.time_tracker.get_global_time_ns();
let proposed_credentials = return_if_none!(
state_container.connect_state.proposed_credentials.as_ref(),
"Unable to load proposed credentials"
);
let stage2_packet = packet_crafter::do_register::craft_stage2(
&new_hyper_ratchet,
algorithm,
timestamp,
proposed_credentials,
security_level,
);
//let mut state_container = inner_mut!(session.state_container);
state_container.register_state.created_hyper_ratchet =
Some(new_hyper_ratchet);
state_container.register_state.last_stage =
packet_flags::cmd::aux::do_register::STAGE2;
state_container.register_state.on_register_packet_received();
Ok(PrimaryProcessorResult::ReplyToSender(stage2_packet))
} else {
log::error!(target: "citadel", "Register stage is one, yet, no PQC is present. Aborting.");
Ok(PrimaryProcessorResult::Void)
}
} else {
warn!(target: "citadel", "Inconsistency between the session's stage and the packet's state. Dropping");
Ok(PrimaryProcessorResult::Void)
}
}
packet_flags::cmd::aux::do_register::STAGE2 => {
log::trace!(target: "citadel", "STAGE 2 REGISTER PACKET");
// Bob receives this packet. It contains the proposed credentials. We need to register and we're good to go
let task = {
let state_container = inner_state!(session.state_container);
if state_container.register_state.last_stage
== packet_flags::cmd::aux::do_register::STAGE1
{
let algorithm = header.algorithm;
let hyper_ratchet = return_if_none!(
state_container.register_state.created_hyper_ratchet.clone(),
"Unable to load created hyper ratchet"
);
if let Some((stage2_packet, conn_info)) =
validation::do_register::validate_stage2(
&hyper_ratchet,
&header,
payload,
remote_addr,
)
{
let creds = stage2_packet.credentials;
let timestamp = session.time_tracker.get_global_time_ns();
let account_manager = session.account_manager.clone();
std::mem::drop(state_container);
// we must now create the CNAC
async move {
match account_manager
.register_impersonal_hyperlan_client_network_account(
conn_info,
creds,
hyper_ratchet.clone(),
)
.await
{
Ok(peer_cnac) => {
log::trace!(target: "citadel", "Server successfully created a CNAC during the DO_REGISTER process! CID: {}", peer_cnac.get_cid());
let success_message =
session.create_register_success_message();
let packet = packet_crafter::do_register::craft_success(
&hyper_ratchet,
algorithm,
timestamp,
success_message,
security_level,
);
Ok(PrimaryProcessorResult::ReplyToSender(packet))
}
Err(err) => {
let err = err.into_string();
log::error!(target: "citadel", "Server unsuccessfully created a CNAC during the DO_REGISTER process. Reason: {}", &err);
let packet = packet_crafter::do_register::craft_failure(
algorithm,
timestamp,
err,
header.session_cid.get(),
);
Ok(PrimaryProcessorResult::ReplyToSender(packet))
}
}
}
} else {
log::error!(target: "citadel", "Unable to validate stage2 packet. Aborting");
return Ok(PrimaryProcessorResult::Void);
}
} else {
warn!(target: "citadel", "Inconsistency between the session's stage and the packet's state. Dropping");
return Ok(PrimaryProcessorResult::Void);
}
};
return task.await;
}
packet_flags::cmd::aux::do_register::SUCCESS => {
log::trace!(target: "citadel", "STAGE SUCCESS REGISTER PACKET");
// This will follow stage 4 in the case of a successful registration. The packet's payload contains the CNAC bytes, encrypted using AES-GCM.
// The CNAC does not have the credentials (Serde skips the serialization thereof)
let task = {
let state_container = inner_state!(session.state_container);
if state_container.register_state.last_stage
== packet_flags::cmd::aux::do_register::STAGE2
{
let hyper_ratchet = return_if_none!(
state_container.register_state.created_hyper_ratchet.clone(),
"Unable to load created hyper ratchet"
);
if let Some((success_message, conn_info)) =
validation::do_register::validate_success(
&hyper_ratchet,
&header,
payload,
remote_addr,
)
{
// Now, register the CNAC locally
let credentials = return_if_none!(
state_container.connect_state.proposed_credentials.clone(),
"Unable to take proposed credentials"
);
let passwordless = return_if_none!(
state_container.register_state.passwordless,
"Passwordless unset (reg)"
);
std::mem::drop(state_container);
let reg_ticket = session.kernel_ticket.clone();
let account_manager = session.account_manager.clone();
let kernel_tx = session.kernel_tx.clone();
async move {
match account_manager
.register_personal_hyperlan_server(
hyper_ratchet,
credentials,
conn_info,
)
.await
{
Ok(new_cnac) => {
if passwordless {
HdpSession::begin_connect(&session, &new_cnac)?;
inner_mut_state!(session.state_container).cnac =
Some(new_cnac);
// begin_connect will handle the connection process from here on out
Ok(PrimaryProcessorResult::Void)
} else {
// Finally, alert the higher-level kernel about the success
session
.session_manager
.clear_provisional_session(&remote_addr);
kernel_tx.unbounded_send(NodeResult::RegisterOkay(
RegisterOkay {
ticket: reg_ticket.get(),
cnac: new_cnac,
welcome_message: success_message,
},
))?;
session.shutdown();
Ok(PrimaryProcessorResult::Void)
}
}
Err(err) => {
kernel_tx.unbounded_send(NodeResult::RegisterFailure(
RegisterFailure {
ticket: reg_ticket.get(),
error_message: err.into_string(),
},
))?;
Ok(PrimaryProcessorResult::EndSession(
"Registration subroutine ended (STATUS: ERR)",
))
}
}
}
} else {
log::error!(target: "citadel", "Unable to validate SUCCESS packet");
return Ok(PrimaryProcessorResult::Void);
}
} else {
warn!(target: "citadel", "Inconsistency between the session's stage and the packet's state. Dropping");
return Ok(PrimaryProcessorResult::Void);
}
};
return task.await;
}
packet_flags::cmd::aux::do_register::FAILURE => {
log::trace!(target: "citadel", "STAGE FAILURE REGISTER PACKET");
// This node is again Bob. Alice received Bob's stage1 packet, but was unable to connect
// A failure can be sent at any stage greater than the zeroth
if inner_state!(session.state_container)
.register_state
.last_stage
> packet_flags::cmd::aux::do_register::STAGE0
{
if let Some(error_message) =
validation::do_register::validate_failure(&header, &payload[..])
{
session.send_to_kernel(NodeResult::RegisterFailure(RegisterFailure {
ticket: session.kernel_ticket.get(),
error_message: String::from_utf8(error_message)
.unwrap_or_else(|_| "Non-UTF8 error message".to_string()),
}))?;
//session.needs_close_message.set(false);
session.shutdown();
} else {
log::error!(target: "citadel", "Error validating FAILURE packet");
return Ok(PrimaryProcessorResult::Void);
}
Ok(PrimaryProcessorResult::EndSession(
"Registration subroutine ended (Status: FAIL)",
))
} else {
log::warn!(target: "citadel", "A failure packet was received, but the program's registration did not advance past stage 0. Dropping");
Ok(PrimaryProcessorResult::Void)
}
}
_ => {
warn!(target: "citadel", "Invalid auxiliary command. Dropping packet");
Ok(PrimaryProcessorResult::Void)
}
}
};
to_concurrent_processor!(task)
}