message-packetizer 0.1.0

Sign and packetize structs messages over SRT
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
419
420
use bytes::{Buf, BufMut, Bytes, BytesMut};
use hmac::{Hmac, Mac};
use pot::{from_slice, to_vec};
use serde::{Deserialize, Serialize};
use sha2::{Digest, Sha256};
use std::collections::HashMap;
use std::error::Error;
use std::time::{SystemTime, UNIX_EPOCH};
use tls_helpers::privkey_from_base64;

type HmacSha256 = Hmac<Sha256>;

const MAX_PACKET_SIZE: usize = 1316; // SRT MTU size
const PACKET_HEADER_SIZE: usize = 13; // 1 byte flags + 8 bytes msg sequence + 4 bytes packet sequence
const MAX_PAYLOAD_SIZE: usize = MAX_PACKET_SIZE - PACKET_HEADER_SIZE;

/// Trait for messages that can be signed
pub trait SignableMessage: Serialize + for<'de> Deserialize<'de> {
    /// Optional validation logic for the message content
    fn validate(&self) -> Result<(), Box<dyn Error>> {
        Ok(()) // Default implementation does no validation
    }
}

/// A signed message envelope that can contain any SignableMessage
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SignedMessageEnvelope {
    pub sequence: u64,
    pub content: Vec<u8>,
    pub timestamp: u64,
    pub signature: Vec<u8>,
}

impl SignedMessageEnvelope {
    pub fn to_bytes(&self) -> Bytes {
        let mut buf = BytesMut::new();
        buf.put_u64(self.sequence);
        buf.put_u64(self.timestamp);
        buf.put_u32(self.content.len() as u32);
        buf.extend_from_slice(&self.content);
        buf.put_u32(self.signature.len() as u32);
        buf.extend_from_slice(&self.signature);
        buf.freeze()
    }

    pub fn from_bytes(bytes: &[u8]) -> Result<Self, Box<dyn Error>> {
        if bytes.len() < 16 {
            return Err("Buffer too small".into());
        }

        let mut buf = &bytes[..];
        let sequence = buf.get_u64();
        let timestamp = buf.get_u64();

        let content_len = buf.get_u32() as usize;
        if buf.remaining() < content_len {
            return Err("Invalid content length".into());
        }
        let content = buf[..content_len].to_vec();
        buf.advance(content_len);

        let signature_len = buf.get_u32() as usize;
        if buf.remaining() != signature_len {
            return Err("Invalid signature length".into());
        }
        let signature = buf[..signature_len].to_vec();

        Ok(SignedMessageEnvelope {
            sequence,
            content,
            timestamp,
            signature,
        })
    }

    pub fn to_packets(&self) -> Vec<Bytes> {
        let full_data = self.to_bytes();
        let mut packets = Vec::new();
        let mut remaining = full_data.as_ref();
        let mut packet_sequence = 0u32;

        while !remaining.is_empty() {
            let chunk_size = remaining.len().min(MAX_PAYLOAD_SIZE);
            let (chunk, rest) = remaining.split_at(chunk_size);

            let mut packet = BytesMut::with_capacity(PACKET_HEADER_SIZE + chunk_size);
            packet.put_u8(if rest.is_empty() { 1 } else { 0 }); // flags
            packet.put_u64(self.sequence); // message sequence
            packet.put_u32(packet_sequence); // packet sequence
            packet.extend_from_slice(chunk);

            packets.push(packet.freeze());
            remaining = rest;
            packet_sequence += 1;
        }

        packets
    }
}

pub struct MessageSigner {
    signing_key: Vec<u8>,
    sequence: u64,
}

impl MessageSigner {
    pub fn new(base64_encoded_pem_key: &str) -> Result<Self, Box<dyn Error + Send + Sync>> {
        let private_key = privkey_from_base64(base64_encoded_pem_key)?;
        let mut hasher = Sha256::new();
        hasher.update(&private_key.0);
        let signing_key = hasher.finalize().to_vec();

        Ok(Self {
            signing_key,
            sequence: 0,
        })
    }

    pub fn sign<T: SignableMessage>(
        &mut self,
        message: &T,
    ) -> Result<SignedMessageEnvelope, Box<dyn Error>> {
        message.validate()?;
        let content = to_vec(message)?;
        let timestamp = SystemTime::now().duration_since(UNIX_EPOCH)?.as_secs();

        let sequence = self.sequence;
        self.sequence = self.sequence.wrapping_add(1);

        let mut data = Vec::with_capacity(content.len() + 16);
        data.extend_from_slice(&sequence.to_be_bytes());
        data.extend_from_slice(&content);
        data.extend_from_slice(&timestamp.to_be_bytes());

        let mut mac = HmacSha256::new_from_slice(&self.signing_key)?;
        mac.update(&data);
        let signature = mac.finalize().into_bytes();

        Ok(SignedMessageEnvelope {
            sequence,
            content,
            timestamp,
            signature: signature.to_vec(),
        })
    }

    pub fn verify<T: SignableMessage>(
        &self,
        envelope: &SignedMessageEnvelope,
    ) -> Result<T, Box<dyn Error>> {
        let mut data = Vec::with_capacity(envelope.content.len() + 16);
        data.extend_from_slice(&envelope.sequence.to_be_bytes());
        data.extend_from_slice(&envelope.content);
        data.extend_from_slice(&envelope.timestamp.to_be_bytes());

        let mut mac = HmacSha256::new_from_slice(&self.signing_key)?;
        mac.update(&data);
        mac.verify_slice(&envelope.signature)?;

        let message: T = from_slice(&envelope.content)?;
        message.validate()?;
        Ok(message)
    }
}

struct PartialMessage {
    packets: Vec<(u32, BytesMut)>, // (packet_sequence, payload)
    total_size: usize,
    got_last: bool,
}

pub struct SignedMessageDemuxer {
    partial_messages: HashMap<u64, PartialMessage>,
}

impl SignedMessageDemuxer {
    pub fn new() -> Self {
        Self {
            partial_messages: HashMap::new(),
        }
    }
}

#[derive(Debug)]
pub enum DemuxError {
    InvalidPacket(String),
    MessageCorrupted {
        sequence: u64,
        reason: String,
    },
    EnvelopeParseError {
        sequence: u64,
        error: Box<dyn Error>,
    },
}

impl std::fmt::Display for DemuxError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            DemuxError::InvalidPacket(msg) => write!(f, "Invalid packet: {}", msg),
            DemuxError::MessageCorrupted { sequence, reason } => {
                write!(f, "Message {} corrupted: {}", sequence, reason)
            }
            DemuxError::EnvelopeParseError { sequence, error } => {
                write!(f, "Failed to parse message {}: {}", sequence, error)
            }
        }
    }
}

impl Error for DemuxError {}

#[derive(Debug)]
pub struct DemuxResult {
    pub messages: Vec<SignedMessageEnvelope>,
    pub errors: Vec<DemuxError>,
}

impl DemuxResult {
    fn new() -> Self {
        Self {
            messages: Vec::new(),
            errors: Vec::new(),
        }
    }
}

impl SignedMessageDemuxer {
    pub fn process_packet(&mut self, packet: &[u8]) -> DemuxResult {
        let mut result = DemuxResult::new();

        if packet.len() < PACKET_HEADER_SIZE {
            result
                .errors
                .push(DemuxError::InvalidPacket("Packet too small".into()));
            return result;
        }

        let mut buf = &packet[..];
        let flags = buf.get_u8();
        let msg_sequence = buf.get_u64();
        let packet_sequence = buf.get_u32();
        let payload = BytesMut::from(&packet[PACKET_HEADER_SIZE..]);
        let is_last = (flags & 1) == 1;

        let message = self
            .partial_messages
            .entry(msg_sequence)
            .or_insert_with(|| PartialMessage {
                packets: Vec::new(),
                total_size: 0,
                got_last: false,
            });

        // Check for duplicate packet sequence
        if message
            .packets
            .iter()
            .any(|(seq, _)| *seq == packet_sequence)
        {
            result.errors.push(DemuxError::MessageCorrupted {
                sequence: msg_sequence,
                reason: format!("Duplicate packet sequence {}", packet_sequence),
            });
            self.partial_messages.remove(&msg_sequence);
            return result;
        }

        message.packets.push((packet_sequence, payload.clone()));
        message.total_size += payload.len();
        if is_last {
            message.got_last = true;
        }

        // Check all messages for completeness
        let mut complete_sequences = Vec::new();
        for (&sequence, message) in &mut self.partial_messages {
            if message.got_last {
                message.packets.sort_by_key(|(seq, _)| *seq);
                let expected_sequences: Vec<_> = (0..message.packets.len() as u32).collect();
                let actual_sequences: Vec<_> =
                    message.packets.iter().map(|(seq, _)| *seq).collect();
                if expected_sequences == actual_sequences {
                    complete_sequences.push(sequence);
                }
            }
        }

        // Process all complete messages
        for sequence in complete_sequences {
            if let Some(message) = self.partial_messages.remove(&sequence) {
                let mut combined = BytesMut::with_capacity(message.total_size);
                for (_, payload) in message.packets {
                    combined.extend_from_slice(&payload);
                }

                match SignedMessageEnvelope::from_bytes(&combined) {
                    Ok(envelope) => result.messages.push(envelope),
                    Err(e) => {
                        result
                            .errors
                            .push(DemuxError::EnvelopeParseError { sequence, error: e });
                    }
                }
            }
        }

        result
    }

    pub fn pending_message_count(&self) -> usize {
        self.partial_messages.len()
    }

    pub fn clear(&mut self) {
        self.partial_messages.clear();
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
    struct TestMessage {
        data: String,
    }

    impl SignableMessage for TestMessage {}

    #[test]
    fn test_message_roundtrip() -> Result<(), Box<dyn Error>> {
        let mut signer = MessageSigner::new(&std::env::var("PRIVKEY_PEM").unwrap()).unwrap();
        let mut demuxer = SignedMessageDemuxer::new();

        // Create and sign multiple large messages
        let msg1 = TestMessage {
            data: "first".repeat(500),
        };
        let msg2 = TestMessage {
            data: "second".repeat(500),
        };

        let env1 = signer.sign(&msg1)?;
        let env2 = signer.sign(&msg2)?;

        // Split both into packets
        let packets1 = env1.to_packets();
        let packets2 = env2.to_packets();

        assert!(packets1.len() > 1);
        assert!(packets2.len() > 1);

        // Process packets, interleaving between messages
        for i in 0..packets1.len().max(packets2.len()) {
            if i < packets1.len() {
                let result = demuxer.process_packet(&packets1[i]);
                assert!(result.errors.is_empty());
                if i == packets1.len() - 1 {
                    assert_eq!(result.messages.len(), 1);
                    let decoded: TestMessage = signer.verify(&result.messages[0])?;
                    assert_eq!(decoded, msg1);
                } else {
                    assert!(result.messages.is_empty());
                }
            }

            if i < packets2.len() {
                let result = demuxer.process_packet(&packets2[i]);
                assert!(result.errors.is_empty());
                if i == packets2.len() - 1 {
                    assert_eq!(result.messages.len(), 1);
                    let decoded: TestMessage = signer.verify(&result.messages[0])?;
                    assert_eq!(decoded, msg2);
                } else {
                    assert!(result.messages.is_empty());
                }
            }
        }

        assert_eq!(demuxer.pending_message_count(), 0);
        Ok(())
    }

    #[test]
    fn test_error_handling() -> Result<(), Box<dyn Error>> {
        let mut demuxer = SignedMessageDemuxer::new();

        // Test invalid packet
        let result = demuxer.process_packet(&[1, 2, 3]);
        assert_eq!(result.messages.len(), 0);
        assert_eq!(result.errors.len(), 1);
        match &result.errors[0] {
            DemuxError::InvalidPacket(_) => (),
            _ => panic!("Expected InvalidPacket error"),
        }

        // Test duplicate packet sequence
        let mut signer = MessageSigner::new(&std::env::var("PRIVKEY_PEM").unwrap()).unwrap();
        let msg = TestMessage {
            data: "test".repeat(500),
        };
        let env = signer.sign(&msg)?;
        let packets = env.to_packets();

        // Send first packet twice
        let result1 = demuxer.process_packet(&packets[0]);
        assert!(result1.errors.is_empty());
        let result2 = demuxer.process_packet(&packets[0]);
        assert_eq!(result2.errors.len(), 1);
        match &result2.errors[0] {
            DemuxError::MessageCorrupted { sequence, .. } => {
                assert_eq!(*sequence, env.sequence);
            }
            _ => panic!("Expected MessageCorrupted error"),
        }

        Ok(())
    }
}