asupersync 0.3.6

Spec-first, cancel-correct, capability-secure async runtime for Rust.
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
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
//! QUIC Retry Packet Implementation
//!
//! Implements QUIC retry packets for address validation and anti-amplification
//! protection as specified in RFC 9000.

use crate::bytes::{Buf, BufMut, Bytes, BytesMut};
use crate::net::atp::handshake::state_machine::{HandshakeError, QuicVersion};
use crate::types::outcome::Outcome;
use hmac::{Hmac, KeyInit, Mac};
use sha2::Sha256;
use std::time::{SystemTime, UNIX_EPOCH};

type HmacSha256 = Hmac<Sha256>;

const MAX_QUIC_V1_CONNECTION_ID_LEN: usize = 20;

/// Retry packet structure
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct RetryPacket {
    /// QUIC version
    pub version: u32,
    /// Source connection ID from server
    pub source_cid: Bytes,
    /// Destination connection ID from client
    pub dest_cid: Bytes,
    /// Retry token for address validation
    pub retry_token: Bytes,
    /// Retry integrity tag
    pub integrity_tag: [u8; 16],
}

impl RetryPacket {
    /// Create a new retry packet
    pub fn new(version: u32, source_cid: Bytes, dest_cid: Bytes, retry_token: Bytes) -> Self {
        Self {
            version,
            source_cid,
            dest_cid,
            retry_token,
            integrity_tag: [0; 16],
        }
    }

    /// Encode packet to wire format
    pub fn encode(&self, retry_key: &[u8; 32]) -> Outcome<Bytes, HandshakeError> {
        if let Outcome::Err(error) = validate_connection_id_len("destination", self.dest_cid.len())
        {
            return Outcome::err(error);
        }
        if let Outcome::Err(error) = validate_connection_id_len("source", self.source_cid.len()) {
            return Outcome::err(error);
        }

        let mut buf = BytesMut::new();

        // Long header with Retry packet type
        let first_byte = 0x80 | 0x40 | 0x30; // Long header | Fixed bit | Retry packet type
        buf.put_u8(first_byte);
        buf.put_u32(self.version);

        // Destination Connection ID
        buf.put_u8(self.dest_cid.len() as u8);
        buf.put_slice(&self.dest_cid);

        // Source Connection ID
        buf.put_u8(self.source_cid.len() as u8);
        buf.put_slice(&self.source_cid);

        // Retry token
        buf.put_slice(&self.retry_token);

        // Calculate and append integrity tag
        let pseudo_packet = self.create_pseudo_retry_packet();
        let tag = match Self::calculate_integrity_tag(&buf, &pseudo_packet, retry_key) {
            Outcome::Ok(tag) => tag,
            Outcome::Err(e) => return Outcome::err(e),
            Outcome::Cancelled(reason) => return Outcome::cancelled(reason),
            Outcome::Panicked(payload) => return Outcome::panicked(payload),
        };
        buf.put_slice(&tag);

        Outcome::ok(buf.freeze())
    }

    /// Decode packet from wire format
    pub fn decode(data: &[u8], retry_key: &[u8; 32]) -> Outcome<Self, HandshakeError> {
        if data.len() < 23 {
            // Minimum: header(1) + version(4) + dcid_len(1) + scid_len(1) + tag(16)
            return Outcome::err(HandshakeError::InvalidPacket {
                reason: "retry packet too short".to_string(),
            });
        }

        let mut buf = data;

        // Check packet type
        let first_byte = buf.get_u8();
        if first_byte & 0xF0 != 0xF0 {
            return Outcome::err(HandshakeError::InvalidPacket {
                reason: "not a retry packet".to_string(),
            });
        }

        let version = buf.get_u32();
        if !QuicVersion::is_supported(version) {
            return Outcome::err(HandshakeError::UnsupportedVersion { version });
        }

        // Destination Connection ID
        let dest_cid_len = buf.get_u8() as usize;
        if let Outcome::Err(error) = validate_connection_id_len("destination", dest_cid_len) {
            return Outcome::err(error);
        }
        if buf.remaining() < dest_cid_len {
            return Outcome::err(HandshakeError::InvalidPacket {
                reason: "insufficient data for destination CID".to_string(),
            });
        }
        let dest_cid = Bytes::copy_from_slice(&buf[..dest_cid_len]);
        buf.advance(dest_cid_len);

        // Source Connection ID
        if buf.is_empty() {
            return Outcome::err(HandshakeError::InvalidPacket {
                reason: "missing source CID length".to_string(),
            });
        }
        let source_cid_len = buf.get_u8() as usize;
        if let Outcome::Err(error) = validate_connection_id_len("source", source_cid_len) {
            return Outcome::err(error);
        }
        if buf.remaining() < source_cid_len {
            return Outcome::err(HandshakeError::InvalidPacket {
                reason: "insufficient data for source CID".to_string(),
            });
        }
        let source_cid = Bytes::copy_from_slice(&buf[..source_cid_len]);
        buf.advance(source_cid_len);

        // Integrity tag is last 16 bytes
        if buf.remaining() < 16 {
            return Outcome::err(HandshakeError::InvalidPacket {
                reason: "missing retry integrity tag".to_string(),
            });
        }

        let retry_token_len = buf.remaining() - 16;
        let retry_token = Bytes::copy_from_slice(&buf[..retry_token_len]);
        buf.advance(retry_token_len);

        let mut integrity_tag = [0u8; 16];
        buf.copy_to_slice(&mut integrity_tag);

        let packet = Self {
            version,
            source_cid,
            dest_cid,
            retry_token,
            integrity_tag,
        };

        // Verify integrity tag
        let packet_without_tag = &data[..data.len() - 16];
        let pseudo_packet = packet.create_pseudo_retry_packet();
        let expected_tag =
            match Self::calculate_integrity_tag(packet_without_tag, &pseudo_packet, retry_key) {
                Outcome::Ok(tag) => tag,
                Outcome::Err(error) => return Outcome::Err(error),
                Outcome::Cancelled(reason) => return Outcome::Cancelled(reason),
                Outcome::Panicked(payload) => return Outcome::Panicked(payload),
            };

        if integrity_tag != expected_tag {
            return Outcome::err(HandshakeError::InvalidRetryToken);
        }

        Outcome::ok(packet)
    }

    /// Create pseudo retry packet for integrity tag calculation
    fn create_pseudo_retry_packet(&self) -> Bytes {
        let mut buf = BytesMut::new();
        buf.put_u8(self.dest_cid.len() as u8);
        buf.put_slice(&self.dest_cid);
        buf.freeze()
    }

    /// Calculate retry packet integrity tag
    fn calculate_integrity_tag(
        retry_packet: &[u8],
        pseudo_packet: &[u8],
        key: &[u8; 32],
    ) -> Outcome<[u8; 16], HandshakeError> {
        let mut mac = match HmacSha256::new_from_slice(key) {
            Ok(mac) => mac,
            Err(_) => {
                return Outcome::err(HandshakeError::ProtectionError {
                    reason: "invalid retry key".to_string(),
                });
            }
        };

        mac.update(pseudo_packet);
        mac.update(retry_packet);

        let result = mac.finalize();
        let mut tag = [0u8; 16];
        tag.copy_from_slice(&result.into_bytes()[..16]);
        Outcome::ok(tag)
    }
}

fn validate_connection_id_len(field: &str, len: usize) -> Outcome<(), HandshakeError> {
    if len > MAX_QUIC_V1_CONNECTION_ID_LEN {
        return Outcome::err(HandshakeError::ConnectionIdError {
            reason: format!("{field} CID too long: {len} bytes"),
        });
    }

    Outcome::ok(())
}

/// Retry token generator and validator
pub struct RetryTokenHandler {
    /// Secret key for token generation
    secret_key: [u8; 32],
    /// Token lifetime in seconds
    token_lifetime: u64,
}

impl RetryTokenHandler {
    /// Create a new retry token handler
    pub fn new(secret_key: [u8; 32], token_lifetime: u64) -> Self {
        Self {
            secret_key,
            token_lifetime,
        }
    }

    /// Generate a retry token for client validation
    pub fn generate_token(
        &self,
        client_addr: std::net::SocketAddr,
        original_dest_cid: &[u8],
    ) -> Outcome<Bytes, HandshakeError> {
        if let Outcome::Err(error) =
            validate_connection_id_len("original destination", original_dest_cid.len())
        {
            return Outcome::err(error);
        }

        let now = match SystemTime::now().duration_since(UNIX_EPOCH) {
            Ok(duration) => duration.as_secs(),
            Err(_) => {
                return Outcome::err(HandshakeError::ProtectionError {
                    reason: "system time error".to_string(),
                });
            }
        };

        let mut token = BytesMut::new();

        // Timestamp (8 bytes)
        token.put_u64(now);

        // Client address
        match client_addr {
            std::net::SocketAddr::V4(addr) => {
                token.put_u8(4); // IPv4 marker
                token.put_slice(&addr.ip().octets());
                token.put_u16(addr.port());
            }
            std::net::SocketAddr::V6(addr) => {
                token.put_u8(6); // IPv6 marker
                token.put_slice(&addr.ip().octets());
                token.put_u16(addr.port());
            }
        }

        // Original destination CID length and value
        token.put_u8(original_dest_cid.len() as u8);
        token.put_slice(original_dest_cid);

        // Calculate HMAC
        let mut mac = match HmacSha256::new_from_slice(&self.secret_key) {
            Ok(mac) => mac,
            Err(_) => {
                return Outcome::err(HandshakeError::ProtectionError {
                    reason: "invalid token key".to_string(),
                });
            }
        };
        mac.update(&token);
        let hmac_result = mac.finalize();

        // Append HMAC to token
        token.put_slice(&hmac_result.into_bytes());

        Outcome::ok(token.freeze())
    }

    /// Validate a retry token
    pub fn validate_token(
        &self,
        token: &[u8],
        client_addr: std::net::SocketAddr,
        original_dest_cid: &[u8],
    ) -> Outcome<(), HandshakeError> {
        if token.len() < 32 {
            // Minimum size: timestamp(8) + addr(6+) + cid_len(1) + hmac(32)
            return Outcome::err(HandshakeError::InvalidRetryToken);
        }

        // Split token and HMAC
        let (token_data, hmac_bytes) = token.split_at(token.len() - 32);

        // Verify HMAC
        let mut mac = match HmacSha256::new_from_slice(&self.secret_key) {
            Ok(mac) => mac,
            Err(_) => {
                return Outcome::err(HandshakeError::ProtectionError {
                    reason: "invalid token key".to_string(),
                });
            }
        };
        mac.update(token_data);

        if mac.verify_slice(hmac_bytes).is_err() {
            return Outcome::err(HandshakeError::InvalidRetryToken);
        }

        let mut buf = token_data;

        // Check timestamp
        if buf.len() < 8 {
            return Outcome::err(HandshakeError::InvalidRetryToken);
        }
        let timestamp = (&mut buf).get_u64();
        let now = match SystemTime::now().duration_since(UNIX_EPOCH) {
            Ok(duration) => duration.as_secs(),
            Err(_) => {
                return Outcome::err(HandshakeError::ProtectionError {
                    reason: "system time error".to_string(),
                });
            }
        };

        if now.saturating_sub(timestamp) > self.token_lifetime {
            return Outcome::err(HandshakeError::InvalidRetryToken);
        }

        // Validate client address
        if buf.is_empty() {
            return Outcome::err(HandshakeError::InvalidRetryToken);
        }
        let addr_type = buf.get_u8();

        let expected_addr_bytes = match (addr_type, client_addr) {
            (4, std::net::SocketAddr::V4(addr)) => {
                let mut bytes = Vec::new();
                bytes.extend_from_slice(&addr.ip().octets());
                bytes.extend_from_slice(&addr.port().to_be_bytes());
                bytes
            }
            (6, std::net::SocketAddr::V6(addr)) => {
                let mut bytes = Vec::new();
                bytes.extend_from_slice(&addr.ip().octets());
                bytes.extend_from_slice(&addr.port().to_be_bytes());
                bytes
            }
            _ => return Outcome::err(HandshakeError::InvalidRetryToken),
        };

        if buf.len() < expected_addr_bytes.len() {
            return Outcome::err(HandshakeError::InvalidRetryToken);
        }

        let token_addr_bytes = &buf[..expected_addr_bytes.len()];
        if token_addr_bytes != expected_addr_bytes {
            return Outcome::err(HandshakeError::InvalidRetryToken);
        }
        buf.advance(expected_addr_bytes.len());

        // Validate original destination CID
        if buf.is_empty() {
            return Outcome::err(HandshakeError::InvalidRetryToken);
        }
        let cid_len = buf.get_u8() as usize;
        if cid_len > MAX_QUIC_V1_CONNECTION_ID_LEN {
            return Outcome::err(HandshakeError::InvalidRetryToken);
        }
        if buf.len() < cid_len {
            return Outcome::err(HandshakeError::InvalidRetryToken);
        }
        let token_cid = &buf[..cid_len];
        if token_cid != original_dest_cid {
            return Outcome::err(HandshakeError::InvalidRetryToken);
        }

        Outcome::ok(())
    }
}

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

    #[test]
    fn test_retry_packet_roundtrip() {
        let retry_key = [0u8; 32];
        let packet = RetryPacket::new(
            QuicVersion::V1 as u32,
            Bytes::from_static(b"server_cid"),
            Bytes::from_static(b"client_cid"),
            Bytes::from_static(b"retry_token_data"),
        );

        let encoded = packet.encode(&retry_key).unwrap();
        let decoded = RetryPacket::decode(&encoded, &retry_key).unwrap();

        assert_eq!(decoded.version, packet.version);
        assert_eq!(decoded.source_cid, packet.source_cid);
        assert_eq!(decoded.dest_cid, packet.dest_cid);
        assert_eq!(decoded.retry_token, packet.retry_token);
    }

    #[test]
    fn test_retry_packet_rejects_oversized_connection_ids() {
        let retry_key = [0u8; 32];
        let oversized_cid = Bytes::from(vec![0xab; MAX_QUIC_V1_CONNECTION_ID_LEN + 1]);

        let oversized_dest = RetryPacket::new(
            QuicVersion::V1 as u32,
            Bytes::from_static(b"server_cid"),
            oversized_cid.clone(),
            Bytes::from_static(b"retry_token_data"),
        );
        assert!(oversized_dest.encode(&retry_key).is_err());

        let oversized_source = RetryPacket::new(
            QuicVersion::V1 as u32,
            oversized_cid,
            Bytes::from_static(b"client_cid"),
            Bytes::from_static(b"retry_token_data"),
        );
        assert!(oversized_source.encode(&retry_key).is_err());
    }

    #[test]
    fn test_retry_packet_decode_rejects_oversized_connection_ids() {
        let retry_key = [0u8; 32];
        let oversized_cid = vec![0xab; MAX_QUIC_V1_CONNECTION_ID_LEN + 1];

        let mut oversized_dest = BytesMut::new();
        oversized_dest.put_u8(0xf0);
        oversized_dest.put_u32(QuicVersion::V1 as u32);
        oversized_dest.put_u8(oversized_cid.len() as u8);
        oversized_dest.put_slice(&oversized_cid);
        oversized_dest.put_u8(0);
        oversized_dest.put_slice(&[0; 16]);
        assert!(RetryPacket::decode(&oversized_dest, &retry_key).is_err());

        let mut oversized_source = BytesMut::new();
        oversized_source.put_u8(0xf0);
        oversized_source.put_u32(QuicVersion::V1 as u32);
        oversized_source.put_u8(0);
        oversized_source.put_u8(oversized_cid.len() as u8);
        oversized_source.put_slice(&oversized_cid);
        oversized_source.put_slice(&[0; 16]);
        assert!(RetryPacket::decode(&oversized_source, &retry_key).is_err());
    }

    #[test]
    fn test_retry_token_roundtrip() {
        let secret_key = [1u8; 32];
        let handler = RetryTokenHandler::new(secret_key, 300); // 5 minute lifetime

        let client_addr = SocketAddr::new(Ipv4Addr::LOCALHOST.into(), 12345);
        let original_dest_cid = b"original_cid";

        let token = handler
            .generate_token(client_addr, original_dest_cid)
            .unwrap();
        let result = handler.validate_token(&token, client_addr, original_dest_cid);

        assert!(result.is_ok());
    }

    #[test]
    fn test_retry_token_rejects_oversized_original_destination_cid() {
        let secret_key = [1u8; 32];
        let handler = RetryTokenHandler::new(secret_key, 300);
        let client_addr = SocketAddr::new(Ipv4Addr::LOCALHOST.into(), 12345);
        let oversized_cid = [0xab; MAX_QUIC_V1_CONNECTION_ID_LEN + 1];

        assert!(handler.generate_token(client_addr, &oversized_cid).is_err());

        let forged_token = forge_retry_token(&secret_key, client_addr, &oversized_cid);
        assert!(
            handler
                .validate_token(&forged_token, client_addr, &oversized_cid)
                .is_err()
        );
    }

    #[test]
    fn test_retry_token_invalid_address() {
        let secret_key = [1u8; 32];
        let handler = RetryTokenHandler::new(secret_key, 300);

        let client_addr1 = SocketAddr::new(Ipv4Addr::LOCALHOST.into(), 12345);
        let client_addr2 = SocketAddr::new(Ipv4Addr::new(127, 0, 0, 2).into(), 12345);
        let original_dest_cid = b"original_cid";

        let token = handler
            .generate_token(client_addr1, original_dest_cid)
            .unwrap();
        let result = handler.validate_token(&token, client_addr2, original_dest_cid);

        assert!(result.is_err());
    }

    #[test]
    fn test_retry_token_invalid_cid() {
        let secret_key = [1u8; 32];
        let handler = RetryTokenHandler::new(secret_key, 300);

        let client_addr = SocketAddr::new(Ipv4Addr::LOCALHOST.into(), 12345);
        let original_dest_cid1 = b"original_cid1";
        let original_dest_cid2 = b"original_cid2";

        let token = handler
            .generate_token(client_addr, original_dest_cid1)
            .unwrap();
        let result = handler.validate_token(&token, client_addr, original_dest_cid2);

        assert!(result.is_err());
    }

    fn forge_retry_token(
        secret_key: &[u8; 32],
        client_addr: SocketAddr,
        original_dest_cid: &[u8],
    ) -> Bytes {
        let now = SystemTime::now()
            .duration_since(UNIX_EPOCH)
            .expect("system time")
            .as_secs();

        let mut token = BytesMut::new();
        token.put_u64(now);

        match client_addr {
            SocketAddr::V4(addr) => {
                token.put_u8(4);
                token.put_slice(&addr.ip().octets());
                token.put_u16(addr.port());
            }
            SocketAddr::V6(addr) => {
                token.put_u8(6);
                token.put_slice(&addr.ip().octets());
                token.put_u16(addr.port());
            }
        }

        token.put_u8(original_dest_cid.len() as u8);
        token.put_slice(original_dest_cid);

        let mut mac = HmacSha256::new_from_slice(secret_key).expect("valid hmac key");
        mac.update(&token);
        token.put_slice(&mac.finalize().into_bytes());

        token.freeze()
    }
}