rsiprtp 0.4.1

Modular SIP/RTP communications stack for Rust with Sans-IO state machines
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
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
//! SDES (SDP Security Descriptions) parsing (RFC 4568).
//!
//! Parses a=crypto attributes for SRTP key exchange.

use crate::srtp::kdf::CryptoSuite;

/// SDES crypto attribute.
///
/// Represents a parsed `a=crypto:` line from SDP.
#[derive(Debug, Clone)]
pub struct SdesAttribute {
    /// Tag number (unique identifier within the SDP).
    pub tag: u32,
    /// Crypto suite.
    pub crypto_suite: CryptoSuite,
    /// Master key (16 bytes for AES-128).
    pub master_key: Vec<u8>,
    /// Master salt (14 bytes).
    pub master_salt: Vec<u8>,
    /// Optional lifetime (2^n packets).
    pub lifetime: Option<u64>,
    /// Optional MKI (Master Key Identifier).
    pub mki: Option<(u32, u8)>, // (value, length in bytes)
}

impl SdesAttribute {
    /// Parse an SDES attribute from a string.
    ///
    /// Format: `<tag> <crypto-suite> <key-params> [session-params]`
    ///
    /// Key params format: `inline:<base64-key>[|lifetime][|MKI:value:length]`
    pub fn parse(s: &str) -> Result<Self, String> {
        let parts: Vec<&str> = s.split_whitespace().collect();
        if parts.len() < 3 {
            return Err("Invalid SDES attribute format".into());
        }

        // Parse tag
        let tag: u32 = parts[0].parse().map_err(|_| "Invalid tag number")?;

        // Parse crypto suite
        let crypto_suite = CryptoSuite::parse(parts[1])
            .ok_or_else(|| format!("Unknown crypto suite: {}", parts[1]))?;

        // Parse key params
        let key_params = parts[2];
        if !key_params.starts_with("inline:") {
            return Err("Key params must start with 'inline:'".into());
        }

        let key_data = &key_params[7..]; // Skip "inline:"
        let parsed = parse_key_params(key_data)?;

        Ok(Self {
            tag,
            crypto_suite,
            master_key: parsed.master_key,
            master_salt: parsed.master_salt,
            lifetime: parsed.lifetime,
            mki: parsed.mki,
        })
    }

    /// Generate an SDES attribute string.
    pub fn to_sdp(&self) -> String {
        use base64::{engine::general_purpose::STANDARD, Engine as _};

        // Concatenate master key and salt for base64 encoding
        let mut key_material = self.master_key.clone();
        key_material.extend_from_slice(&self.master_salt);
        let key_b64 = STANDARD.encode(&key_material);

        let mut result = format!("{} {} inline:{}", self.tag, self.crypto_suite, key_b64);

        if let Some(lifetime) = self.lifetime {
            result.push_str(&format!("|2^{}", (lifetime as f64).log2() as u32));
        }

        if let Some((value, len)) = self.mki {
            result.push_str(&format!("|{}:{}", value, len));
        }

        result
    }

    /// Create a new SDES attribute with random key material.
    pub fn new_random(tag: u32, crypto_suite: CryptoSuite) -> Self {
        use rand::RngCore;

        let mut rng = rand::thread_rng();

        let mut master_key = vec![0u8; crypto_suite.master_key_len()];
        rng.fill_bytes(&mut master_key);

        let mut master_salt = vec![0u8; crypto_suite.master_salt_len()];
        rng.fill_bytes(&mut master_salt);

        Self {
            tag,
            crypto_suite,
            master_key,
            master_salt,
            lifetime: None,
            mki: None,
        }
    }
}

/// Parsed key parameters from SDES.
struct ParsedKeyParams {
    master_key: Vec<u8>,
    master_salt: Vec<u8>,
    lifetime: Option<u64>,
    mki: Option<(u32, u8)>,
}

/// Parse key params from base64-encoded string.
fn parse_key_params(s: &str) -> Result<ParsedKeyParams, String> {
    use base64::{engine::general_purpose::STANDARD, Engine as _};

    // Split by | for optional lifetime and MKI
    let parts: Vec<&str> = s.split('|').collect();

    // Decode base64 key material (key + salt = 30 bytes for AES-128)
    let key_material = STANDARD
        .decode(parts[0])
        .map_err(|e| format!("Invalid base64: {}", e))?;

    if key_material.len() != 30 {
        return Err(format!(
            "Invalid key material length: {} (expected 30)",
            key_material.len()
        ));
    }

    let master_key = key_material[..16].to_vec();
    let master_salt = key_material[16..].to_vec();

    let mut lifetime = None;
    let mut mki = None;

    // Parse optional parameters
    for part in parts.iter().skip(1) {
        if let Some(exp_str) = part.strip_prefix("2^") {
            // Lifetime
            let exp: u32 = exp_str.parse().map_err(|_| "Invalid lifetime exponent")?;
            // RFC 4568 §6.1: SRTP lifetime SHALL NOT exceed 2^48 for the
            // supported AES-CM crypto suites. Bound the shift to avoid
            // a debug-build overflow panic for attacker-controlled exponents.
            if exp > 48 {
                return Err(format!(
                    "Lifetime exponent {} exceeds RFC 4568 max of 48",
                    exp
                ));
            }
            lifetime = Some(1u64 << exp);
        } else if part.contains(':') {
            // MKI
            let mki_parts: Vec<&str> = part.split(':').collect();
            if mki_parts.len() == 2 {
                let value: u32 = mki_parts[0].parse().map_err(|_| "Invalid MKI value")?;
                let len: u8 = mki_parts[1].parse().map_err(|_| "Invalid MKI length")?;
                mki = Some((value, len));
            }
        }
    }

    Ok(ParsedKeyParams {
        master_key,
        master_salt,
        lifetime,
        mki,
    })
}

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

    #[test]
    fn test_parse_sdes_basic() {
        // 30 bytes = 40 base64 chars (no padding needed)
        let sdes = SdesAttribute::parse(
            "1 AES_CM_128_HMAC_SHA1_80 inline:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
        )
        .unwrap();

        assert_eq!(sdes.tag, 1);
        assert_eq!(sdes.crypto_suite, CryptoSuite::AesCm128HmacSha1_80);
        assert_eq!(sdes.master_key.len(), 16);
        assert_eq!(sdes.master_salt.len(), 14);
        assert!(sdes.lifetime.is_none());
        assert!(sdes.mki.is_none());
    }

    #[test]
    fn test_parse_sdes_with_lifetime() {
        let sdes = SdesAttribute::parse(
            "1 AES_CM_128_HMAC_SHA1_80 inline:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA|2^31",
        )
        .unwrap();

        assert_eq!(sdes.lifetime, Some(1u64 << 31));
    }

    /// Regression test for fuzz crash srtp_sdes-001:
    /// `parse_key_params` previously computed `1u64 << exp` without bounding
    /// `exp`, panicking with "attempt to shift left with overflow" in debug
    /// builds for any `2^N` lifetime where N >= 64. The fix rejects exponents
    /// above the RFC 4568 §6.1 maximum of 2^48.
    #[test]
    fn test_sdes_parse_huge_lifetime_fuzz_001() {
        // Original fuzz-found input (lifetime "2^292") must return Err, not panic.
        let result = SdesAttribute::parse(
            "1 AES_CM_128_HMAC_SHA1_80 inline:WVNfX19zKDBGgmRT3RVTuqgr9TWJaPLzNG6BDfGc|2^292",
        );
        assert!(result.is_err(), "huge lifetime exponent must be rejected");

        // Boundary: exp == 64 is the smallest value that overflows u64; reject.
        let result = SdesAttribute::parse(
            "1 AES_CM_128_HMAC_SHA1_80 inline:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA|2^64",
        );
        assert!(result.is_err(), "exp == 64 must be rejected");

        // Boundary: exp == 49 is just above RFC 4568 max; reject.
        let result = SdesAttribute::parse(
            "1 AES_CM_128_HMAC_SHA1_80 inline:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA|2^49",
        );
        assert!(result.is_err(), "exp > 48 must be rejected");

        // Sanity: a normal lifetime (2^31) still parses successfully.
        let sdes = SdesAttribute::parse(
            "1 AES_CM_128_HMAC_SHA1_80 inline:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA|2^31",
        )
        .unwrap();
        assert_eq!(sdes.lifetime, Some(1u64 << 31));

        // Sanity: 2^48 (RFC 4568 max) still accepted.
        let sdes = SdesAttribute::parse(
            "1 AES_CM_128_HMAC_SHA1_80 inline:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA|2^48",
        )
        .unwrap();
        assert_eq!(sdes.lifetime, Some(1u64 << 48));
    }

    #[test]
    fn test_parse_sdes_with_mki() {
        let sdes = SdesAttribute::parse(
            "1 AES_CM_128_HMAC_SHA1_80 inline:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA|1:4",
        )
        .unwrap();

        assert_eq!(sdes.mki, Some((1, 4)));
    }

    #[test]
    fn test_parse_sdes_with_invalid_mki_format() {
        let sdes = SdesAttribute::parse(
            "1 AES_CM_128_HMAC_SHA1_80 inline:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA|1:2:3",
        )
        .unwrap();

        assert!(sdes.mki.is_none());
    }

    #[test]
    fn test_parse_sdes_with_unknown_param() {
        let sdes = SdesAttribute::parse(
            "1 AES_CM_128_HMAC_SHA1_80 inline:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA|foo",
        )
        .unwrap();

        assert!(sdes.lifetime.is_none());
        assert!(sdes.mki.is_none());
    }

    #[test]
    fn test_parse_sdes_invalid_suite() {
        let result = SdesAttribute::parse(
            "1 UNKNOWN_SUITE inline:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA==",
        );
        assert!(result.is_err());
    }

    #[test]
    fn test_sdes_to_sdp() {
        let sdes = SdesAttribute {
            tag: 1,
            crypto_suite: CryptoSuite::AesCm128HmacSha1_80,
            master_key: vec![0u8; 16],
            master_salt: vec![0u8; 14],
            lifetime: None,
            mki: None,
        };

        let sdp = sdes.to_sdp();
        assert!(sdp.contains("AES_CM_128_HMAC_SHA1_80"));
        assert!(sdp.contains("inline:"));
    }

    #[test]
    fn test_new_random() {
        let sdes = SdesAttribute::new_random(1, CryptoSuite::AesCm128HmacSha1_80);

        assert_eq!(sdes.tag, 1);
        assert_eq!(sdes.master_key.len(), 16);
        assert_eq!(sdes.master_salt.len(), 14);

        // Verify key is not all zeros (extremely unlikely for random)
        assert!(!sdes.master_key.iter().all(|&b| b == 0));
    }

    #[test]
    fn test_roundtrip() {
        let original = SdesAttribute::new_random(2, CryptoSuite::AesCm128HmacSha1_32);
        let sdp = original.to_sdp();
        let parsed = SdesAttribute::parse(&sdp).unwrap();

        assert_eq!(parsed.tag, original.tag);
        assert_eq!(parsed.crypto_suite, original.crypto_suite);
        assert_eq!(parsed.master_key, original.master_key);
        assert_eq!(parsed.master_salt, original.master_salt);
    }

    // Additional tests for better coverage

    #[test]
    fn test_parse_too_few_parts() {
        let result = SdesAttribute::parse("1 AES_CM_128_HMAC_SHA1_80");
        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .contains("Invalid SDES attribute format"));
    }

    #[test]
    fn test_parse_invalid_tag() {
        let result = SdesAttribute::parse(
            "notanumber AES_CM_128_HMAC_SHA1_80 inline:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
        );
        assert!(result.is_err());
        assert!(result.unwrap_err().contains("Invalid tag"));
    }

    #[test]
    fn test_parse_no_inline_prefix() {
        let result = SdesAttribute::parse(
            "1 AES_CM_128_HMAC_SHA1_80 noprefix:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
        );
        assert!(result.is_err());
        assert!(result.unwrap_err().contains("inline:"));
    }

    #[test]
    fn test_parse_invalid_base64() {
        let result = SdesAttribute::parse("1 AES_CM_128_HMAC_SHA1_80 inline:!!!notvalidbase64!!!");
        assert!(result.is_err());
        assert!(result.unwrap_err().contains("Invalid base64"));
    }

    #[test]
    fn test_parse_wrong_key_length() {
        // Too short key material (only 10 bytes encoded)
        let result = SdesAttribute::parse("1 AES_CM_128_HMAC_SHA1_80 inline:AAAAAAAAAAAAAA==");
        assert!(result.is_err());
        assert!(result.unwrap_err().contains("Invalid key material length"));
    }

    #[test]
    fn test_to_sdp_with_lifetime() {
        let sdes = SdesAttribute {
            tag: 1,
            crypto_suite: CryptoSuite::AesCm128HmacSha1_80,
            master_key: vec![0u8; 16],
            master_salt: vec![0u8; 14],
            lifetime: Some(1u64 << 31),
            mki: None,
        };

        let sdp = sdes.to_sdp();
        assert!(sdp.contains("|2^31"));
    }

    #[test]
    fn test_to_sdp_with_mki() {
        let sdes = SdesAttribute {
            tag: 1,
            crypto_suite: CryptoSuite::AesCm128HmacSha1_80,
            master_key: vec![0u8; 16],
            master_salt: vec![0u8; 14],
            lifetime: None,
            mki: Some((1, 4)),
        };

        let sdp = sdes.to_sdp();
        assert!(sdp.contains("|1:4"));
    }

    #[test]
    fn test_to_sdp_with_lifetime_and_mki() {
        let sdes = SdesAttribute {
            tag: 1,
            crypto_suite: CryptoSuite::AesCm128HmacSha1_80,
            master_key: vec![0u8; 16],
            master_salt: vec![0u8; 14],
            lifetime: Some(1u64 << 48),
            mki: Some((2, 2)),
        };

        let sdp = sdes.to_sdp();
        assert!(sdp.contains("|2^48"));
        assert!(sdp.contains("|2:2"));
    }

    #[test]
    fn test_sdes_attribute_debug() {
        let sdes = SdesAttribute::new_random(1, CryptoSuite::AesCm128HmacSha1_80);
        let debug = format!("{:?}", sdes);
        assert!(debug.contains("SdesAttribute"));
        assert!(debug.contains("tag"));
    }

    #[test]
    fn test_sdes_attribute_clone() {
        let sdes = SdesAttribute::new_random(1, CryptoSuite::AesCm128HmacSha1_80);
        let cloned = sdes.clone();
        assert_eq!(sdes.tag, cloned.tag);
        assert_eq!(sdes.crypto_suite, cloned.crypto_suite);
        assert_eq!(sdes.master_key, cloned.master_key);
        assert_eq!(sdes.master_salt, cloned.master_salt);
    }

    #[test]
    fn test_parse_with_all_optional_params() {
        let sdes = SdesAttribute::parse(
            "1 AES_CM_128_HMAC_SHA1_80 inline:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA|2^20|3:2",
        )
        .unwrap();

        assert_eq!(sdes.tag, 1);
        assert_eq!(sdes.lifetime, Some(1u64 << 20));
        assert_eq!(sdes.mki, Some((3, 2)));
    }

    #[test]
    fn test_parse_32_bit_crypto_suite() {
        let sdes = SdesAttribute::parse(
            "1 AES_CM_128_HMAC_SHA1_32 inline:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
        )
        .unwrap();

        assert_eq!(sdes.crypto_suite, CryptoSuite::AesCm128HmacSha1_32);
    }

    #[test]
    fn test_new_random_different_keys() {
        let sdes1 = SdesAttribute::new_random(1, CryptoSuite::AesCm128HmacSha1_80);
        let sdes2 = SdesAttribute::new_random(2, CryptoSuite::AesCm128HmacSha1_80);

        // Keys should be different (with overwhelming probability)
        assert_ne!(sdes1.master_key, sdes2.master_key);
    }

    #[test]
    fn test_roundtrip_with_80_bit_suite() {
        let original = SdesAttribute::new_random(1, CryptoSuite::AesCm128HmacSha1_80);
        let sdp = original.to_sdp();
        let parsed = SdesAttribute::parse(&sdp).unwrap();

        assert_eq!(parsed.crypto_suite, CryptoSuite::AesCm128HmacSha1_80);
    }

    #[test]
    fn test_empty_input() {
        let result = SdesAttribute::parse("");
        assert!(result.is_err());
    }

    #[test]
    fn test_whitespace_only_input() {
        let result = SdesAttribute::parse("   ");
        assert!(result.is_err());
    }

    #[test]
    fn test_tag_number_ranges() {
        // Tag 0
        let sdes = SdesAttribute::parse(
            "0 AES_CM_128_HMAC_SHA1_80 inline:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
        )
        .unwrap();
        assert_eq!(sdes.tag, 0);

        // Large tag number
        let sdes = SdesAttribute::parse(
            "999 AES_CM_128_HMAC_SHA1_80 inline:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
        )
        .unwrap();
        assert_eq!(sdes.tag, 999);
    }

    #[test]
    fn test_invalid_mki_value() {
        // MKI with invalid value format (not parseable)
        let result = SdesAttribute::parse(
            "1 AES_CM_128_HMAC_SHA1_80 inline:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA|abc:4",
        );
        assert!(result.is_err());
    }

    #[test]
    fn test_invalid_mki_length() {
        let result = SdesAttribute::parse(
            "1 AES_CM_128_HMAC_SHA1_80 inline:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA|1:abc",
        );
        assert!(result.is_err());
    }

    #[test]
    fn test_invalid_lifetime_exponent() {
        let result = SdesAttribute::parse(
            "1 AES_CM_128_HMAC_SHA1_80 inline:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA|2^abc",
        );
        assert!(result.is_err());
    }

    #[test]
    fn test_valid_lifetime_and_mki() {
        let sdes = SdesAttribute::parse(
            "1 AES_CM_128_HMAC_SHA1_80 inline:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA|2^4|1:4",
        )
        .unwrap();
        assert_eq!(sdes.lifetime, Some(1u64 << 4));
        assert_eq!(sdes.mki, Some((1, 4)));
    }

    #[test]
    fn test_mki_with_single_colon() {
        // MKI with only one part after split (should fail to parse as MKI)
        let result = SdesAttribute::parse(
            "1 AES_CM_128_HMAC_SHA1_80 inline:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA|singlepart:",
        );
        assert!(result.is_err());
    }
}