foctet-core 0.0.2

Core components for the Foctet
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

use std::collections::BTreeSet;

use crate::{id::NodeId, transport::TransportKind};
use serde::{Deserialize, Serialize};
use stackaddr::{segment::protocol::TransportProtocol, StackAddr};

use anyhow::Result;
use base32::Alphabet;

/// Represents a node address. Network address information for a node.
/// Contains identifiers and addresses for direct connections and relay servers.
#[derive(Serialize, Deserialize, Clone, Debug, Eq, PartialEq, Hash)]
pub struct NodeAddr {
    /// The node ID of the node.
    pub node_id: NodeId,
    /// The addresses of the node for direct connections.
    pub addresses: BTreeSet<StackAddr>,
    /// The relay server information used to connect to this node.
    pub relay_addr: Option<RelayAddr>,
}

impl NodeAddr {
    /// Converts a RFC4648 base32 string into a NodeAddr.
    pub fn from_base32(encoded: &str) -> Result<Self> {
        let decoded = base32::decode(Alphabet::Rfc4648 { padding: false }, encoded)
            .ok_or_else(|| anyhow::anyhow!("Failed to decode base32 string"))?;
        let node_addr: Self = match bincode::serde::decode_from_slice(&decoded, bincode::config::standard()) {
            Ok((node_addr, _)) => node_addr,
            Err(e) => {
                return Err(anyhow::anyhow!("Failed to decode base32 string: {}", e));
            },
        };
        Ok(node_addr)
    }
    /// Converts the NodeAddr to a single RFC4648 base32 string.
    pub fn to_base32(&self) -> Result<String> {
        let serialized = bincode::serde::encode_to_vec(self, bincode::config::standard())?;
        Ok(base32::encode(Alphabet::Rfc4648 { padding: false }, &serialized))
    }

    pub fn get_direct_addrs(&self, transport_id: &TransportKind, allow_loopback: bool) -> Vec<StackAddr> {
        let mut addrs = Vec::new();
        for addr in &self.addresses {
            match addr.ip() {
                Some(ip) => {
                    if !allow_loopback && ip.is_loopback() {
                        continue;
                    }
                }
                None => {
                    continue;
                }
            }
            match transport_id {
                TransportKind::Quic => {
                    match addr.transport() {
                        Some(TransportProtocol::Quic(_)) | Some(TransportProtocol::Udp(_)) => {
                            addrs.push(addr.clone());
                        }
                        _ => {}
                    }
                }
                TransportKind::TlsOverTcp => {
                    match addr.transport() {
                        Some(TransportProtocol::Tcp(_)) | Some(TransportProtocol::TlsOverTcp(_)) => {
                            addrs.push(addr.clone());
                        }
                        _ => {}
                    }
                }
            }
        }
        addrs
    }
}

/// Represents a node address.
#[derive(Serialize, Deserialize, Clone, Debug, Eq, PartialEq, Hash)]
pub struct RelayAddr {
    /// The node ID of the node.
    pub node_id: NodeId,
    /// The transport addresses of the node for direct connections.
    pub addresses: BTreeSet<StackAddr>,
}

impl RelayAddr {
    /// Converts a RFC4648 base32 string into a RelayAddr.
    pub fn from_base32(encoded: &str) -> Result<Self> {
        let decoded = base32::decode(Alphabet::Rfc4648 { padding: false }, encoded)
            .ok_or_else(|| anyhow::anyhow!("Failed to decode base32 string"))?;
        let relay_addr: Self = match bincode::serde::decode_from_slice(&decoded, bincode::config::standard()) {
            Ok((relay_addr, _)) => relay_addr,
            Err(e) => {
                return Err(anyhow::anyhow!("Failed to decode base32 string: {}", e));
            },
        };
        Ok(relay_addr)
    }
    /// Converts the RelayAddr to a single RFC4648 base32 string.
    pub fn to_base32(&self) -> Result<String> {
        let serialized = bincode::serde::encode_to_vec(self, bincode::config::standard())?;
        Ok(base32::encode(Alphabet::Rfc4648 { padding: false }, &serialized))
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct NodePair {
    pub src: NodeId,
    pub dst: NodeId,
}

impl NodePair {
    pub fn new(src: NodeId, dst: NodeId) -> Self {
        Self { src, dst }
    }
}