rs-pfcp 0.4.0

High-performance Rust implementation of PFCP (Packet Forwarding Control Protocol) for 5G networks with 100% 3GPP TS 29.244 Release 18 compliance
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

// src/ie/fseid.rs

//! F-SEID Information Element.

use crate::error::PfcpError;
use crate::ie::IeType;
use crate::types::Seid;
use std::net::{Ipv4Addr, Ipv6Addr};

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Fseid {
    pub v4: bool,
    pub v6: bool,
    pub seid: Seid,
    pub ipv4_address: Option<Ipv4Addr>,
    pub ipv6_address: Option<Ipv6Addr>,
}

impl Fseid {
    pub fn new(
        seid: impl Into<Seid>,
        ipv4_address: Option<Ipv4Addr>,
        ipv6_address: Option<Ipv6Addr>,
    ) -> Self {
        Fseid {
            v4: ipv4_address.is_some(),
            v6: ipv6_address.is_some(),
            seid: seid.into(),
            ipv4_address,
            ipv6_address,
        }
    }

    pub fn marshal(&self) -> Vec<u8> {
        let mut data = Vec::new();
        let mut flags = 0;
        if self.v6 {
            flags |= 0b1;
        }
        if self.v4 {
            flags |= 0b10;
        }
        data.push(flags);
        data.extend_from_slice(&self.seid.0.to_be_bytes());
        if let Some(addr) = self.ipv4_address {
            data.extend_from_slice(&addr.octets());
        }
        if let Some(addr) = self.ipv6_address {
            data.extend_from_slice(&addr.octets());
        }
        data
    }

    /// Unmarshals a byte slice into an F-SEID.
    ///
    /// Per 3GPP TS 29.244, F-SEID requires minimum 9 bytes (1 byte flags + 8 bytes SEID).
    pub fn unmarshal(data: &[u8]) -> Result<Self, PfcpError> {
        if data.len() < 9 {
            return Err(PfcpError::invalid_length(
                "F-SEID",
                IeType::Fseid,
                9,
                data.len(),
            ));
        }
        let flags = data[0];
        let v6 = (flags & 0b1) == 0b1;
        let v4 = (flags & 0b10) == 0b10;
        let seid = u64::from_be_bytes(data[1..9].try_into().unwrap());

        let mut offset = 9;
        let ipv4_address = if v4 {
            if data.len() < offset + 4 {
                return Err(PfcpError::invalid_length(
                    "F-SEID IPv4",
                    IeType::Fseid,
                    offset + 4,
                    data.len(),
                ));
            }
            let addr = Ipv4Addr::from([
                data[offset],
                data[offset + 1],
                data[offset + 2],
                data[offset + 3],
            ]);
            offset += 4;
            Some(addr)
        } else {
            None
        };

        let ipv6_address = if v6 {
            if data.len() < offset + 16 {
                return Err(PfcpError::invalid_length(
                    "F-SEID IPv6",
                    IeType::Fseid,
                    offset + 16,
                    data.len(),
                ));
            }
            let mut octets = [0u8; 16];
            octets.copy_from_slice(&data[offset..offset + 16]);
            Some(Ipv6Addr::from(octets))
        } else {
            None
        };

        Ok(Fseid {
            v4,
            v6,
            seid: Seid(seid),
            ipv4_address,
            ipv6_address,
        })
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::net::{Ipv4Addr, Ipv6Addr};

    #[test]
    fn test_fseid_marshal_unmarshal_ipv4() {
        let fseid = Fseid::new(
            0x1234567890abcdef,
            Some(Ipv4Addr::new(192, 168, 0, 1)),
            None,
        );
        let marshaled = fseid.marshal();
        let unmarshaled = Fseid::unmarshal(&marshaled).unwrap();
        assert_eq!(unmarshaled, fseid);
    }

    #[test]
    fn test_fseid_marshal_unmarshal_ipv6() {
        let fseid = Fseid::new(
            0x1234567890abcdef,
            None,
            Some(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 1)),
        );
        let marshaled = fseid.marshal();
        let unmarshaled = Fseid::unmarshal(&marshaled).unwrap();
        assert_eq!(unmarshaled, fseid);
    }

    #[test]
    fn test_fseid_marshal_unmarshal_both() {
        let fseid = Fseid::new(
            0x1234567890abcdef,
            Some(Ipv4Addr::new(192, 168, 0, 1)),
            Some(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 1)),
        );
        let marshaled = fseid.marshal();
        let unmarshaled = Fseid::unmarshal(&marshaled).unwrap();
        assert_eq!(unmarshaled, fseid);
    }

    #[test]
    fn test_fseid_unmarshal_invalid_data() {
        let data = [0; 8];
        let result = Fseid::unmarshal(&data);
        assert!(result.is_err());
    }

    #[test]
    fn test_fseid_unmarshal_empty() {
        use crate::error::PfcpError;

        let result = Fseid::unmarshal(&[]);
        assert!(result.is_err());
        let err = result.unwrap_err();
        assert!(matches!(err, PfcpError::InvalidLength { .. }));
    }
}