citadel_proto 0.13.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

/*!
# Peer Key Exchange Management State Container Module

This module manages the state of peer-to-peer key exchange processes in the Citadel Protocol, handling cryptographic operations and security settings.

## Features
- **Key Exchange State**: Manages key exchange constructor state
- **Security Settings**: Handles session security configuration
- **UDP Channel Management**: Controls UDP communication channels
- **Initiator Role**: Tracks local peer's role in key exchange
- **Session Security**: Manages session passwords and security

## Core Components
- `PeerKemStateContainer`: Main structure for key exchange state
- `StackedRatchetConstructor`: Handles cryptographic key construction
- `SessionSecuritySettings`: Configures security parameters
- `UdpChannelSender`: Manages UDP channel communication

## Important Notes
1. Key exchange state is critical for secure communication
2. UDP channels are optional based on configuration
3. Security settings determine encryption strength
4. Session passwords must be properly managed

## Related Components
- `peer_crypt`: Handles peer encryption
- `session`: Manages session security
- `packet_processor`: Uses key exchange for packets
- `state_container`: Parent state management

*/

use crate::prelude::PreSharedKey;
use crate::proto::state_subcontainers::preconnect_state_container::UdpChannelSender;
use citadel_crypt::ratchets::Ratchet;
use citadel_types::proto::SessionSecuritySettings;

pub struct PeerKemStateContainer<R: Ratchet> {
    pub(crate) constructor: Option<R::Constructor>,
    pub(crate) local_is_initiator: bool,
    pub(crate) session_security_settings: SessionSecuritySettings,
    pub(crate) udp_channel_sender: UdpChannelSender<R>,
    pub(crate) session_password: PreSharedKey,
}

impl<R: Ratchet> PeerKemStateContainer<R> {
    pub fn new(
        session_security_settings: SessionSecuritySettings,
        udp_enabled: bool,
        session_password: PreSharedKey,
    ) -> Self {
        Self {
            constructor: None,
            session_password,
            local_is_initiator: false,
            session_security_settings,
            udp_channel_sender: if udp_enabled {
                UdpChannelSender::default()
            } else {
                UdpChannelSender::empty()
            },
        }
    }
}