citadel_proto 0.3.0

Networking library for the Citadel Protocol
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
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
405
406
407
408
409
410
411
412
413
414
415
416
417
418
use super::includes::*;
use crate::error::NetworkError;
use crate::proto::node::ConnectMode;
use crate::proto::node_result::{ConnectFail, ConnectSuccess, MailboxDelivery};
use crate::proto::packet_processor::primary_group_packet::get_proper_hyper_ratchet;
use crate::proto::state_container::VirtualConnectionType;
use citadel_user::external_services::ServicesObject;
use std::sync::atomic::Ordering;

/// This will optionally return an HdpPacket as a response if deemed necessary
#[cfg_attr(feature = "localhost-testing", tracing::instrument(target = "citadel", skip_all, ret, err, fields(is_server = sess_ref.is_server, src = packet.parse().unwrap().0.session_cid.get(), target = packet.parse().unwrap().0.target_cid.get())))]
pub async fn process_connect(
    sess_ref: &HdpSession,
    packet: HdpPacket,
    header_drill_vers: u32,
) -> Result<PrimaryProcessorResult, NetworkError> {
    let session = sess_ref.clone();

    let (hr, cnac) = {
        let state_container = inner_state!(session.state_container);
        if !session.is_provisional()
            && state_container.connect_state.last_stage
                != packet_flags::cmd::aux::do_connect::SUCCESS
        {
            log::error!(target: "citadel", "Connect packet received, but the system is not in a provisional state. Dropping");
            return Ok(PrimaryProcessorResult::Void);
        }

        if !state_container.pre_connect_state.success {
            log::error!(target: "citadel", "Connect packet received, but the system has not yet completed the pre-connect stage. Dropping");
            return Ok(PrimaryProcessorResult::Void);
        }

        let hr = return_if_none!(
            get_proper_hyper_ratchet(header_drill_vers, &state_container, None),
            "Could not get proper HR [connect]"
        );
        let cnac = return_if_none!(state_container.cnac.clone(), "CNAC missing");
        (hr, cnac)
    };

    let (header, payload, _, _) = packet.decompose();

    let (header, payload, hyper_ratchet) = return_if_none!(
        validation::aead::validate(hr, &header, payload),
        "Unable to validate connect packet"
    );
    let header = header.clone();
    let security_level = header.security_level.into();

    let time_tracker = session.time_tracker;

    let task = async move {
        let session = &session;
        match header.cmd_aux {
            // Node is Bob. Bob gets the encrypted username and password (separately encrypted)
            packet_flags::cmd::aux::do_connect::STAGE0 => {
                log::trace!(target: "citadel", "STAGE 2 CONNECT PACKET");
                let task = {
                    match validation::do_connect::validate_stage0_packet(&cnac, &payload).await {
                        Ok(_) => {
                            let mut state_container = inner_mut_state!(session.state_container);

                            let cid = hyper_ratchet.get_cid();
                            let success_time = session.time_tracker.get_global_time_ns();
                            let addr = session.remote_peer;
                            let is_personal = !session.is_server;
                            let kernel_ticket = session.kernel_ticket.get();

                            //let pqc = state_container.connect_stage.generated_pqc.take();
                            state_container.connect_state.last_stage =
                                packet_flags::cmd::aux::do_connect::SUCCESS;
                            state_container.connect_state.fail_time = None;
                            state_container.connect_state.on_connect_packet_received();
                            let udp_channel_rx = state_container
                                .pre_connect_state
                                .udp_channel_oneshot_tx
                                .rx
                                .take();
                            let channel = state_container.init_new_c2s_virtual_connection(
                                &cnac,
                                security_level,
                                kernel_ticket,
                                header.session_cid.get(),
                                session,
                            );

                            std::mem::drop(state_container);

                            // Upgrade the connect BEFORE updating the CNAC
                            if !session.session_manager.upgrade_connection(addr, cid) {
                                return Ok(PrimaryProcessorResult::EndSession("Unable to upgrade from a provisional to a protected connection"));
                            }

                            //cnac.update_post_quantum_container(post_quantum).await?;
                            //cnac.spawn_save_task_on_threadpool();
                            // register w/ peer layer, get mail in the process
                            let account_manager = session.account_manager.clone();

                            async move {
                                let mailbox_items = session
                                    .session_manager
                                    .register_session_with_peer_layer(cid)
                                    .await?;
                                let peers = account_manager
                                    .get_persistence_handler()
                                    .get_hyperlan_peer_list_as_server(cid)
                                    .await?
                                    .unwrap_or_default();

                                #[cfg(feature = "google-services")]
                                let post_login_object = account_manager
                                    .services_handler()
                                    .on_post_login_serverside(cid)
                                    .await?;
                                #[cfg(not(feature = "google-services"))]
                                let post_login_object =
                                    citadel_user::external_services::ServicesObject::default();

                                let success_packet =
                                    packet_crafter::do_connect::craft_final_status_packet(
                                        &hyper_ratchet,
                                        true,
                                        mailbox_items,
                                        post_login_object.clone(),
                                        session.create_welcome_message(cid),
                                        peers,
                                        success_time,
                                        security_level,
                                    );

                                session.implicated_cid.set(Some(cid));
                                session
                                    .state
                                    .store(SessionState::Connected, Ordering::Relaxed);

                                let cxn_type = VirtualConnectionType::LocalGroupServer(cid);
                                let channel_signal = NodeResult::ConnectSuccess(ConnectSuccess {
                                    ticket: kernel_ticket,
                                    implicated_cid: cid,
                                    remote_addr: addr,
                                    is_personal,
                                    v_conn_type: cxn_type,
                                    services: post_login_object,
                                    welcome_message: format!("Client {} successfully established a connection to the local HyperNode", cid),
                                    channel,
                                    udp_rx_opt: udp_channel_rx
                                });
                                // safe unwrap. Store the signal
                                inner_mut_state!(session.state_container)
                                    .c2s_channel_container
                                    .as_mut()
                                    .unwrap()
                                    .channel_signal = Some(channel_signal);
                                Ok(PrimaryProcessorResult::ReplyToSender(success_packet))
                            }
                        }

                        Err(err) => {
                            log::error!(target: "citadel", "Error validating stage2 packet. Reason: {}", err.to_string());
                            let fail_time = time_tracker.get_global_time_ns();

                            //session.state = SessionState::NeedsConnect;
                            let packet = packet_crafter::do_connect::craft_final_status_packet(
                                &hyper_ratchet,
                                false,
                                None,
                                ServicesObject::default(),
                                err.to_string(),
                                Vec::new(),
                                fail_time,
                                security_level,
                            );
                            return Ok(PrimaryProcessorResult::ReplyToSender(packet));
                        }
                    }
                };

                return task.await;
            }

            packet_flags::cmd::aux::do_connect::FAILURE => {
                log::trace!(target: "citadel", "STAGE FAILURE CONNECT PACKET");
                let kernel_ticket = session.kernel_ticket.get();

                let mut state_container = inner_mut_state!(session.state_container);
                if let Some(payload) =
                    validation::do_connect::validate_final_status_packet(&payload)
                {
                    let message = String::from_utf8(payload.message.to_vec())
                        .unwrap_or_else(|_| "Invalid UTF-8 message".to_string());
                    log::trace!(target: "citadel", "The server refused to login the user. Reason: {}", &message);
                    let cid = hyper_ratchet.get_cid();
                    state_container.connect_state.on_fail();
                    std::mem::drop(state_container);

                    //session.session_manager.clear_provisional_tracker(session.kernel_ticket);

                    session.implicated_cid.set(None);
                    session
                        .state
                        .store(SessionState::NeedsConnect, Ordering::Relaxed);
                    session.disable_dc_signal();

                    session.send_to_kernel(NodeResult::ConnectFail(ConnectFail {
                        ticket: kernel_ticket,
                        cid_opt: Some(cid),
                        error_message: message,
                    }))?;
                    Ok(PrimaryProcessorResult::EndSession(
                        "Failed connecting. Try again",
                    ))
                } else {
                    trace!(target: "citadel", "An invalid FAILURE packet was received; dropping due to invalid signature");
                    Ok(PrimaryProcessorResult::Void)
                }
            }

            // Node is finally Alice. The login either failed or succeeded
            packet_flags::cmd::aux::do_connect::SUCCESS => {
                log::trace!(target: "citadel", "STAGE SUCCESS CONNECT PACKET");

                let task = {
                    let mut state_container = inner_mut_state!(session.state_container);
                    let last_stage = state_container.connect_state.last_stage;

                    if last_stage == packet_flags::cmd::aux::do_connect::STAGE1 {
                        if let Some(payload) =
                            validation::do_connect::validate_final_status_packet(&payload)
                        {
                            let cnac = cnac.clone();
                            let message = String::from_utf8(payload.message.to_vec())
                                .unwrap_or_else(|_| String::from("Invalid message"));
                            let kernel_ticket = session.kernel_ticket.get();
                            let cid = hyper_ratchet.get_cid();

                            state_container.connect_state.on_success();
                            state_container.connect_state.on_connect_packet_received();

                            let use_ka = state_container.keep_alive_timeout_ns != 0;
                            let connect_mode = return_if_none!(
                                state_container.connect_state.connect_mode,
                                "Unable to load connect mode"
                            );
                            let udp_channel_rx = state_container
                                .pre_connect_state
                                .udp_channel_oneshot_tx
                                .rx
                                .take();

                            let channel = state_container.init_new_c2s_virtual_connection(
                                &cnac,
                                security_level,
                                kernel_ticket,
                                header.session_cid.get(),
                                session,
                            );
                            std::mem::drop(state_container);

                            session.implicated_cid.set(Some(cid)); // This makes is_provisional equal to false

                            let addr = session.remote_peer;
                            let is_personal = !session.is_server;

                            // Upgrade the connect BEFORE updating the CNAC
                            if !session
                                .session_manager
                                .upgrade_connection(session.remote_peer, cid)
                            {
                                return Ok(PrimaryProcessorResult::EndSession("Unable to upgrade from a provisional to a protected connection"));
                            }

                            log::trace!(target: "citadel", "The login to the server was a success. Welcome Message: {}", &message);

                            let _post_login_object = payload.post_login_object.clone();
                            //session.post_quantum = pqc;
                            let cxn_type = VirtualConnectionType::LocalGroupServer(cid);
                            let peers = payload.peers;

                            let timestamp = session.time_tracker.get_global_time_ns();

                            let persistence_handler =
                                session.account_manager.get_persistence_handler().clone();
                            //session.session_manager.clear_provisional_tracker(session.kernel_ticket);
                            session
                                .state
                                .store(SessionState::Connected, Ordering::Relaxed);

                            let success_ack = packet_crafter::do_connect::craft_success_ack(
                                &hyper_ratchet,
                                timestamp,
                                security_level,
                            );
                            session.send_to_primary_stream(None, success_ack)?;

                            session.send_to_kernel(NodeResult::ConnectSuccess(ConnectSuccess {
                                ticket: kernel_ticket,
                                implicated_cid: cid,
                                remote_addr: addr,
                                is_personal,
                                v_conn_type: cxn_type,
                                services: payload.post_login_object,
                                welcome_message: message,
                                channel,
                                udp_rx_opt: udp_channel_rx,
                            }))?;
                            //finally, if there are any mailbox items, send them to the kernel for processing
                            if let Some(mailbox_delivery) = payload.mailbox {
                                session.send_to_kernel(NodeResult::MailboxDelivery(
                                    MailboxDelivery {
                                        implicated_cid: cid,
                                        ticket_opt: None,
                                        items: mailbox_delivery,
                                    },
                                ))?;
                            }
                            // TODO: Clean this up to prevent multiple saves
                            async move {
                                persistence_handler
                                    .synchronize_hyperlan_peer_list_as_client(&cnac, peers)
                                    .await?;
                                #[cfg(feature = "google-services")]
                                if let (Some(rtdb_cfg), Some(jwt)) =
                                    (_post_login_object.rtdb, _post_login_object.google_auth_jwt)
                                {
                                    log::trace!(target: "citadel", "Client detected RTDB config + Google Auth web token. Will login + store config to CNAC ...");
                                    let rtdb =
                                        citadel_user::re_exports::FirebaseRTDB::new_from_jwt(
                                            &rtdb_cfg.url,
                                            jwt.clone(),
                                            rtdb_cfg.api_key.clone(),
                                        )
                                        .await
                                        .map_err(|err| NetworkError::Generic(err.inner))?; // login

                                    let citadel_user::re_exports::FirebaseRTDB {
                                        base_url,
                                        auth,
                                        expire_time,
                                        api_key,
                                        jwt,
                                        ..
                                    } = rtdb;

                                    let client_rtdb_config =
                                        citadel_user::external_services::rtdb::RtdbClientConfig {
                                            url: base_url,
                                            api_key,
                                            auth_payload: auth,
                                            expire_time,
                                            jwt,
                                        };
                                    cnac.store_rtdb_config(client_rtdb_config);

                                    log::trace!(target: "citadel", "Successfully logged-in to RTDB + stored config inside CNAC ...");
                                };

                                if let ConnectMode::Fetch { .. } = connect_mode {
                                    log::trace!(target: "citadel", "[FETCH] complete ...");
                                    // we can end the session now. The fcm packets have already been sent alongside the connect signal above
                                    return Ok(PrimaryProcessorResult::EndSession(
                                        "Fetch succeeded",
                                    ));
                                }

                                if use_ka {
                                    let ka = packet_crafter::keep_alive::craft_keep_alive_packet(
                                        &hyper_ratchet,
                                        timestamp,
                                        security_level,
                                    );
                                    Ok(PrimaryProcessorResult::ReplyToSender(ka))
                                } else {
                                    log::warn!(target: "citadel", "Keep-alive subsystem will not be used for this session as requested");
                                    Ok(PrimaryProcessorResult::Void)
                                }
                            }
                        } else {
                            log::error!(target: "citadel", "An invalid SUCCESS packet was received; dropping due to invalid deserialization");
                            return Ok(PrimaryProcessorResult::Void);
                        }
                    } else {
                        log::error!(target: "citadel", "An invalid SUCCESS packet was received; dropping since the last local stage was not stage 1");
                        return Ok(PrimaryProcessorResult::Void);
                    }
                };

                return task.await;
            }

            packet_flags::cmd::aux::do_connect::SUCCESS_ACK => {
                log::trace!(target: "citadel", "RECV SUCCESS_ACK");
                if session.is_server {
                    let signal = inner_mut_state!(session.state_container)
                        .c2s_channel_container
                        .as_mut()
                        .ok_or_else(|| NetworkError::InternalError("C2S channel not loaded"))?
                        .channel_signal
                        .take()
                        .ok_or(NetworkError::InternalError("Channel signal missing"))?;
                    session.send_to_kernel(signal)?;
                    Ok(PrimaryProcessorResult::Void)
                } else {
                    Err(NetworkError::InvalidPacket(
                        "Received a SUCCESS_ACK as a client",
                    ))
                }
            }

            n => {
                log::error!(target: "citadel", "Invalid auxiliary command: {}", n);
                Ok(PrimaryProcessorResult::Void)
            }
        }
    };

    to_concurrent_processor!(task)
}