qbase 0.5.0

Core structure of the QUIC protocol, a part of dquic
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
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
use std::{any::Any, mem};

use bytes::BytesMut;
use nom::{Parser, multi::length_data};

use super::{
    error::Error,
    header::io::be_header,
    r#type::{Type, io::be_packet_type},
    *,
};
use crate::{
    Epoch,
    frame::{io::WriteFrame, *},
    net::tx::Signals,
    util::{ContinuousData, NonData, WriteData},
    varint::be_varint,
};

/// Parse the payload of a packet.
///
/// - For long packets, the payload is a [`nom::multi::length_data`].
/// - For 1-RTT packet, the payload is the remaining content of the datagram.
fn be_payload(
    pkty: Type,
    datagram: &mut BytesMut,
    remain_len: usize,
) -> Result<(BytesMut, usize), Error> {
    let offset = datagram.len() - remain_len;
    let input = &datagram[offset..];
    let (remain, payload) = length_data(be_varint).parse(input).map_err(|e| match e {
        ne @ nom::Err::Incomplete(_) => Error::IncompleteHeader(pkty, ne.to_string()),
        _ => unreachable!("parsing packet header never generates error or failure"),
    })?;
    let payload_len = payload.len();
    if payload_len < 20 {
        // The payload needs at least 20 bytes to have enough samples to remove the packet header protection.
        return Err(Error::UnderSampling(pkty, payload.len()));
    }
    let packet_length = datagram.len() - remain.len();
    let bytes = datagram.split_to(packet_length);
    Ok((bytes, packet_length - payload_len))
}

/// Parse the QUIC packet from the datagram, given the length of the DCID.
/// Returns the parsed packet or an error, and the datagram removed the packet's content.
pub fn be_packet(datagram: &mut BytesMut, dcid_len: usize) -> Result<Packet, Error> {
    let input = datagram.as_ref();
    let (remain, pkty) = be_packet_type(input).map_err(|e| match e {
        ne @ nom::Err::Incomplete(_) => Error::IncompleteType(ne.to_string()),
        nom::Err::Error(e) => e,
        _ => unreachable!("parsing packet type never generates failure"),
    })?;
    let (remain, header) = be_header(pkty, dcid_len, remain).map_err(|e| match e {
        ne @ nom::Err::Incomplete(_) => Error::IncompleteHeader(pkty, ne.to_string()),
        _ => unreachable!("parsing packet header never generates error or failure"),
    })?;
    match header {
        Header::VN(header) => {
            datagram.clear();
            Ok(Packet::VN(header))
        }
        Header::Retry(header) => {
            datagram.clear();
            Ok(Packet::Retry(header))
        }
        Header::Initial(header) => {
            let (bytes, offset) = be_payload(pkty, datagram, remain.len())?;
            Ok(Packet::Data(DataPacket {
                header: DataHeader::Long(long::DataHeader::Initial(header)),
                bytes,
                offset,
            }))
        }
        Header::ZeroRtt(header) => {
            let (bytes, offset) = be_payload(pkty, datagram, remain.len())?;
            Ok(Packet::Data(DataPacket {
                header: DataHeader::Long(long::DataHeader::ZeroRtt(header)),
                bytes,
                offset,
            }))
        }
        Header::Handshake(header) => {
            let (bytes, offset) = be_payload(pkty, datagram, remain.len())?;
            Ok(Packet::Data(DataPacket {
                header: DataHeader::Long(long::DataHeader::Handshake(header)),
                bytes,
                offset,
            }))
        }
        Header::OneRtt(header) => {
            if remain.len() < 20 {
                // The payload needs at least 20 bytes to have enough samples to remove the packet header protection.
                return Err(Error::UnderSampling(pkty, remain.len()));
            }
            let remain_len = remain.len();
            let bytes = mem::replace(datagram, BytesMut::new());
            let offset = bytes.len() - remain_len;
            datagram.clear();
            Ok(Packet::Data(DataPacket {
                header: DataHeader::Short(header),
                bytes,
                offset,
            }))
        }
    }
}

pub trait ProductHeader<H> {
    fn new_header(&self) -> Result<H, Signals>;
}

pub trait PacketSpace<H> {
    type PacketAssembler<'b>: AssemblePacket
    where
        Self: 'b;

    fn new_packet<'b>(
        &'b self,
        header: H,
        buffer: &'b mut [u8],
    ) -> Result<Self::PacketAssembler<'b>, Signals>;
}

// Target -> Target
pub trait Package<Target: ?Sized> {
    fn dump(&mut self, target: &mut Target) -> Result<(), Signals>;
}

impl<Target: BufMut + ?Sized, P: Package<Target> + ?Sized> Package<Target> for &mut P {
    #[inline]
    fn dump(&mut self, target: &mut Target) -> Result<(), Signals> {
        P::dump(self, target)
    }
}

impl<Target: BufMut + ?Sized, P: Package<Target> + ?Sized> Package<Target> for Box<P> {
    #[inline]
    fn dump(&mut self, target: &mut Target) -> Result<(), Signals> {
        P::dump(self, target)
    }
}

impl<Target: BufMut + ?Sized, P: Package<Target>> Package<Target> for Option<P> {
    #[inline]
    fn dump(&mut self, target: &mut Target) -> Result<(), Signals> {
        self.take()
            .map_or_else(|| Err(Signals::empty()), |mut package| package.dump(target))
    }
}

impl<Target: BufMut + ?Sized, P: Package<Target>> Package<Target> for [P] {
    #[inline]
    fn dump(&mut self, target: &mut Target) -> Result<(), Signals> {
        let origin = target.remaining_mut();
        let mut signals = Signals::empty();
        for package in self {
            if let Err(s) = package.dump(target) {
                signals |= s
            }
        }

        (origin != target.remaining_mut())
            .then_some(())
            .ok_or(signals)
    }
}

impl<Target: BufMut + ?Sized, P: Package<Target>, const N: usize> Package<Target> for [P; N] {
    #[inline]
    fn dump(&mut self, target: &mut Target) -> Result<(), Signals> {
        let origin = target.remaining_mut();
        let mut signals = Signals::empty();
        for package in self {
            if let Err(s) = package.dump(target) {
                signals |= s
            }
        }

        (origin != target.remaining_mut())
            .then_some(())
            .ok_or(signals)
    }
}

pub struct PadTo20;

impl<'b, P> Package<P> for PadTo20
where
    P: AsRef<PacketWriter<'b>> + BufMut + ?Sized,
{
    #[inline]
    fn dump(&mut self, target: &mut P) -> Result<(), Signals> {
        let packet = target.as_ref();
        match packet.payload_len() + packet.tag_len() {
            _ if packet.is_empty() => Err(Signals::empty()),
            len if len < 20 => {
                target.put_bytes(0, 20 - len);
                Ok(())
            }
            _ => Ok(()),
        }
    }
}

pub struct PadToFull;

impl<'b, P> Package<P> for PadToFull
where
    P: AsRef<PacketWriter<'b>> + BufMut + ?Sized,
{
    #[inline]
    fn dump(&mut self, target: &mut P) -> Result<(), Signals> {
        let packet = target.as_ref();
        match packet.payload_len() + packet.tag_len() {
            _ if packet.is_empty() => Err(Signals::empty()),
            len if len < packet.buffer().len() => {
                target.put_bytes(0, packet.remaining_mut());
                Ok(())
            }
            _ => Ok(()),
        }
    }
}

pub struct PadProbe;

impl<'b, P> Package<P> for PadProbe
where
    P: AsRef<PacketWriter<'b>> + BufMut + ?Sized,
{
    #[inline]
    fn dump(&mut self, target: &mut P) -> Result<(), Signals> {
        if target.as_ref().is_probe_new_path() {
            return PadToFull.dump(target);
        }
        Err(Signals::empty())
    }
}

#[derive(Debug, Clone, Copy)]
pub struct Repeat<P>(pub P);

impl<Target: ?Sized + BufMut, P: Package<Target>> Package<Target> for Repeat<P> {
    #[inline]
    fn dump(&mut self, target: &mut Target) -> Result<(), Signals> {
        let origin = target.remaining_mut();
        let signals = loop {
            if let Err(signals) = self.0.dump(target) {
                break signals;
            }
        };

        (origin != target.remaining_mut())
            .then_some(())
            .ok_or(signals)
    }
}

pub struct Packages<T>(pub T);

macro_rules! impl_package_for_tuple {
    () => {};
    ($head:ident $($tail:ident)*) => {
        impl_package_for_tuple!(@imp $head $($tail)*);
        impl_package_for_tuple!(           $($tail)*);

    };
    (@imp $($t:ident)*) => {
        impl<Target: BufMut + ?Sized, $($t: Package<Target>),*> Package<Target> for Packages<($($t,)*)> {
            #[inline]
            fn dump(&mut self, target: &mut Target) -> Result<(), Signals> {
                let origin = target.remaining_mut();
                let mut signals = Signals::empty();

                #[allow(non_snake_case)]
                let ($($t,)*) = &mut self.0;

                $( #[allow(non_snake_case)]
                if let Err(s) = $t.dump(target) {
                    signals |= s;
                } )*

                (origin != target.remaining_mut())
                    .then_some(())
                    .ok_or(signals)
            }
        }
    }
}

impl_package_for_tuple! {
    Z Y X W V U T S R Q P O N M L K J I H G F E D C B A
}

macro_rules! frame_packages {
    () => {};
    (@imp_frame $($frame:tt)*) => {
        impl<Target> Package<Target> for $($frame)*
        where
            Target: BufMut + RecordFrame<Frame<NonData>, NonData> + ?Sized,
        {
            #[inline]
            fn dump(&mut self, target: &mut Target) -> Result<(), Signals> {
                if !(target.remaining_mut() >= self.max_encoding_size()
                    || target.remaining_mut() >= self.encoding_size())
                {
                    return Err(Signals::CONGESTION);
                }
                let frame = self.clone().into();
                target.record_frame(&frame);
                target.put_frame(&frame);
                Ok(())
            }
        }
    };
    (impl<Target: WriteFrame<Self>> Package<Target> for $frame:ident {} $($tail:tt)*) => {
        frame_packages!{ @imp_frame $frame }
        frame_packages!{ @imp_frame &$frame }
        frame_packages!{ $($tail)* }
    };
    (@imp_data_frame $($frame_with_data:tt)*) => {
        impl<Target,D> Package<Target> for $($frame_with_data)*
        where
            Target: BufMut + RecordFrame<Frame<D>, D> + ?Sized,
            D: ContinuousData + Clone,
            for<'b> &'b mut Target: WriteData<D>,
        {
            #[inline]
            fn dump(&mut self, target: &mut Target) -> Result<(), Signals> {
                let (frame, data) = self;
                if !(target.remaining_mut() >= frame.max_encoding_size()
                    || target.remaining_mut() >= frame.encoding_size())
                {
                    return Err(Signals::CONGESTION);
                }
                let frame = (frame.clone(), data.clone()).into();
                target.record_frame(&frame);
                target.put_frame(&frame);
                Ok(())
            }
        }
    };
    (impl<Target: WriteDataFrame<Self, D>, D: ContinuousData> Package<Target> for ($frame:ident, D) {} $($tail:tt)*) => {
        frame_packages!{ @imp_data_frame ($frame, D) }
        frame_packages!{ @imp_data_frame &($frame, D) }
        frame_packages!{ $($tail)* }
    };
}

frame_packages! {
    impl<Target: WriteFrame<Self>> Package<Target> for PaddingFrame {}
    impl<Target: WriteFrame<Self>> Package<Target> for PingFrame {}
    impl<Target: WriteFrame<Self>> Package<Target> for AckFrame {}
    impl<Target: WriteFrame<Self>> Package<Target> for ConnectionCloseFrame {}
    impl<Target: WriteFrame<Self>> Package<Target> for NewTokenFrame {}
    impl<Target: WriteFrame<Self>> Package<Target> for MaxDataFrame {}
    impl<Target: WriteFrame<Self>> Package<Target> for DataBlockedFrame {}
    impl<Target: WriteFrame<Self>> Package<Target> for HandshakeDoneFrame {}
    impl<Target: WriteFrame<Self>> Package<Target> for PathChallengeFrame {}
    impl<Target: WriteFrame<Self>> Package<Target> for PathResponseFrame {}
    impl<Target: WriteFrame<Self>> Package<Target> for StreamCtlFrame {}
    impl<Target: WriteFrame<Self>> Package<Target> for ReliableFrame {}
    impl<Target: WriteFrame<Self>> Package<Target> for PunchHelloFrame {}
    impl<Target: WriteFrame<Self>> Package<Target> for PunchDoneFrame {}
    impl<Target: WriteDataFrame<Self, D>, D: ContinuousData> Package<Target> for (StreamFrame, D) {}
    impl<Target: WriteDataFrame<Self, D>, D: ContinuousData> Package<Target> for (CryptoFrame, D) {}
    impl<Target: WriteDataFrame<Self, D>, D: ContinuousData> Package<Target> for (DatagramFrame, D) {}
}

pub enum Keys {
    LongHeaderPacket {
        keys: DirectionalKeys,
    },
    ShortHeaderPacket {
        keys: DirectionalKeys,
        key_phase: KeyPhaseBit,
    },
}

impl Debug for Keys {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::LongHeaderPacket { .. } => f
                .debug_struct("LongHeaderPacket")
                .field("keys", &"...")
                .finish(),
            Self::ShortHeaderPacket { key_phase, .. } => f
                .debug_struct("ShortHeaderPacket")
                .field("keys", &"...")
                .field("key_phase", key_phase)
                .finish(),
        }
    }
}

impl Keys {
    fn hpk(&self) -> &dyn rustls::quic::HeaderProtectionKey {
        match self {
            Self::LongHeaderPacket { keys } | Self::ShortHeaderPacket { keys, .. } => {
                keys.header.as_ref()
            }
        }
    }

    fn pk(&self) -> &dyn rustls::quic::PacketKey {
        match self {
            Self::LongHeaderPacket { keys } | Self::ShortHeaderPacket { keys, .. } => {
                keys.packet.as_ref()
            }
        }
    }

    fn key_phase(&self) -> Option<KeyPhaseBit> {
        match self {
            Self::LongHeaderPacket { .. } => None,
            Self::ShortHeaderPacket { key_phase, .. } => Some(*key_phase),
        }
    }
}

#[derive(Debug)]
struct PacketLayout {
    hdr_len: usize,
    len_encoding: usize,
    pn_len: usize,

    cursor: usize,
    end: usize,
}

impl PacketLayout {
    pub fn payload_len(&self) -> usize {
        self.cursor - self.hdr_len - self.len_encoding
    }

    pub fn is_empty(&self) -> bool {
        self.payload_len() == self.pn_len
    }
}

#[derive(Debug, CopyGetters)]
pub struct PacketProperties {
    #[getset(get_copy = "pub")]
    packet_type: Type,
    #[getset(get_copy = "pub")]
    packet_number: u64,
    // Packets containing only frames with [`Spec::N`] are not ack-eliciting;
    // otherwise, they are ack-eliciting.
    #[getset(get_copy = "pub")]
    ack_eliciting: bool,
    // A Boolean that indicates whether the packet counts toward bytes in flight.
    // See [Section 2](https://www.rfc-editor.org/rfc/rfc9002#section-2)
    // and [Appendix A.1](https://www.rfc-editor.org/rfc/rfc9002#section-a.1)
    // of [QUIC Recovery](https://www.rfc-editor.org/rfc/rfc9002).
    //
    // Packets containing only frames with [`Spec::C`] do not
    // count toward bytes in flight for congestion control purposes.
    #[getset(get_copy = "pub")]
    in_flight: bool,
    // Packets containing only frames with [`Spec::P`] can be used to
    // probe new network paths during connection migration.
    #[getset(get_copy = "pub")]
    probe_new_path: bool,
    #[getset(get_copy = "pub")]
    largest_ack: Option<u64>,
}

impl PacketProperties {
    pub fn new(ty: Type, pn: u64) -> Self {
        Self {
            packet_type: ty,
            packet_number: pn,
            ack_eliciting: false,
            in_flight: false,
            probe_new_path: false,
            largest_ack: None,
        }
    }

    pub fn epoch(&self) -> Option<Epoch> {
        match self.packet_type() {
            Type::Long(long) => match long {
                r#type::long::Type::VersionNegotiation => None,
                r#type::long::Type::V1(version) => match version.0 {
                    r#type::long::v1::Type::Initial => Some(Epoch::Initial),
                    r#type::long::v1::Type::ZeroRtt => Some(Epoch::Data),
                    r#type::long::v1::Type::Handshake => Some(Epoch::Handshake),
                    r#type::long::v1::Type::Retry => None,
                },
            },
            Type::Short(..) => Some(Epoch::Data),
        }
    }

    pub fn add_frame<F: FrameFeature + 'static>(&mut self, frame: &F) {
        debug_assert!(
            frame.belongs_to(self.packet_type()),
            "Frame {:?} does not belong to packet type {:?}",
            std::any::type_name_of_val(frame),
            self.packet_type()
        );
        self.ack_eliciting |= !frame.specs().contain(Spec::NonAckEliciting);
        self.in_flight |= !frame.specs().contain(Spec::CongestionControlFree);
        self.probe_new_path |= frame.specs().contain(Spec::ProbeNewPath);
        if let Some(ack_frame) = (frame as &dyn Any).downcast_ref::<AckFrame>() {
            self.largest_ack = Some(match self.largest_ack {
                Some(largest_ack) => largest_ack.max(ack_frame.largest()),
                None => ack_frame.largest(),
            });
        }
    }
}

pub trait RecordFrame<F, D: ContinuousData> {
    fn record_frame(&mut self, frame: &F);
}

impl<D: ContinuousData> RecordFrame<Frame<D>, D> for PacketProperties {
    fn record_frame(&mut self, frame: &Frame<D>) {
        debug_assert!(
            frame.belongs_to(self.packet_type(),),
            "Frame {:?} does not belong to packet type {:?}",
            frame.frame_type(),
            self.packet_type()
        );
        self.ack_eliciting |= !frame.specs().contain(Spec::NonAckEliciting);
        self.in_flight |= !frame.specs().contain(Spec::CongestionControlFree);
        self.probe_new_path |= frame.specs().contain(Spec::ProbeNewPath);
        if let Frame::Ack(ack_frame) = frame {
            self.largest_ack = Some(match self.largest_ack {
                Some(largest_ack) => largest_ack.max(ack_frame.largest()),
                None => ack_frame.largest(),
            });
        }
    }
}

impl<F, D: ContinuousData> RecordFrame<F, D> for PacketWriter<'_>
where
    PacketProperties: RecordFrame<F, D>,
{
    #[inline]
    fn record_frame(&mut self, frame: &F) {
        self.props.record_frame(frame);
    }
}

pub struct PacketWriter<'b> {
    keys: Keys,
    layout: PacketLayout,
    props: PacketProperties,
    buffer: &'b mut [u8],
}

impl<'b> PacketWriter<'b> {
    pub fn new_long<S>(
        header: &LongHeader<S>,
        buffer: &'b mut [u8],
        (actual_pn, encoded_pn): (u64, PacketNumber),
        keys: DirectionalKeys,
    ) -> Result<Self, Signals>
    where
        S: EncodeHeader,
        LongHeader<S>: GetType,
        for<'a> &'a mut [u8]: WriteHeader<LongHeader<S>>,
    {
        let hdr_len = header.size();
        let len_encoding = header.length_encoding();
        if buffer.len() < hdr_len + len_encoding + 20 {
            return Err(Signals::CONGESTION);
        }

        let (mut hdr_buf, mut payload_buf) = buffer.split_at_mut(hdr_len + len_encoding);
        hdr_buf.put_header(header);
        payload_buf.put_packet_number(encoded_pn);

        let cursor = hdr_len + len_encoding + encoded_pn.size();
        Ok(Self {
            layout: PacketLayout {
                hdr_len,
                len_encoding,
                pn_len: encoded_pn.size(),
                cursor,
                end: buffer.len() - keys.packet.tag_len(),
            },
            keys: Keys::LongHeaderPacket { keys },
            props: PacketProperties::new(header.get_type(), actual_pn),
            buffer,
        })
    }

    pub fn new_short(
        header: &OneRttHeader,
        buffer: &'b mut [u8],
        (actual_pn, encoded_pn): (u64, PacketNumber),
        keys: DirectionalKeys,
        key_phase: KeyPhaseBit,
    ) -> Result<Self, Signals> {
        let hdr_len = header.size();
        if buffer.len() < hdr_len + 20 {
            return Err(Signals::CONGESTION);
        }

        let (mut hdr_buf, mut payload_buf) = buffer.split_at_mut(hdr_len);
        hdr_buf.put_header(header);
        payload_buf.put_packet_number(encoded_pn);
        Ok(Self {
            layout: PacketLayout {
                hdr_len,
                len_encoding: 0,
                pn_len: encoded_pn.size(),
                cursor: hdr_len + encoded_pn.size(),
                end: buffer.len() - keys.packet.tag_len(),
            },
            keys: Keys::ShortHeaderPacket { keys, key_phase },
            props: PacketProperties::new(header.get_type(), actual_pn),
            buffer,
        })
    }

    #[inline]
    pub fn buffer(&self) -> &[u8] {
        self.buffer
    }

    #[inline]
    pub fn is_short_header(&self) -> bool {
        self.keys.key_phase().is_some()
    }

    #[inline]
    pub fn packet_type(&self) -> Type {
        self.props.packet_type()
    }

    #[inline]
    pub fn packet_number(&self) -> u64 {
        self.props.packet_number
    }

    #[inline]
    pub fn is_ack_eliciting(&self) -> bool {
        self.props.ack_eliciting
    }

    #[inline]
    pub fn in_flight(&self) -> bool {
        self.props.in_flight
    }

    #[inline]
    pub fn is_probe_new_path(&self) -> bool {
        self.props.probe_new_path
    }

    #[inline]
    pub fn payload_len(&self) -> usize {
        self.layout.payload_len()
    }

    #[inline]
    pub fn tag_len(&self) -> usize {
        self.keys.pk().tag_len()
    }

    #[inline]
    pub fn is_empty(&self) -> bool {
        self.layout.is_empty()
    }

    #[inline]
    pub fn packet_len(&self) -> usize {
        self.layout.cursor + self.keys.pk().tag_len()
    }
}

unsafe impl BufMut for PacketWriter<'_> {
    #[inline]
    fn remaining_mut(&self) -> usize {
        self.layout.end - self.layout.cursor
    }

    #[inline]
    unsafe fn advance_mut(&mut self, cnt: usize) {
        if self.remaining_mut() < cnt {
            panic!(
                "advance out of bounds: the len is {} but advancing by {}",
                cnt,
                self.remaining_mut()
            );
        }

        self.layout.cursor += cnt;
    }

    #[inline]
    fn chunk_mut(&mut self) -> &mut UninitSlice {
        let range = self.layout.cursor..self.layout.end;
        UninitSlice::new(&mut self.buffer[range])
    }
}

pub trait AssemblePacket: BufMut {
    #[inline]
    fn assemble_packet(&mut self, package: &mut dyn Package<Self>) -> Result<(), Signals> {
        package.dump(self)
    }

    fn encrypt_and_protect_packet(self) -> (usize, PacketProperties);
}

impl AssemblePacket for PacketWriter<'_> {
    fn encrypt_and_protect_packet(self) -> (usize, PacketProperties) {
        use crate::{
            packet::encrypt::*,
            varint::{EncodeBytes, VarInt, WriteVarInt},
        };

        let Self {
            keys,
            layout,
            props,
            buffer,
        } = self;

        let payload_len = layout.payload_len();
        let tag_len = keys.pk().tag_len();

        let actual_pn = props.packet_number;
        let pn_len = layout.pn_len;
        let pkt_size = layout.cursor + tag_len;

        assert!(
            payload_len + tag_len >= 20,
            "The payload and tag needs at least 20 bytes to have enough samples for the packet header protection."
        );

        if let Some(key_phase) = keys.key_phase() {
            encode_short_first_byte(&mut buffer[0], pn_len, key_phase);

            let pk = keys.pk();
            let payload_offset = layout.hdr_len;
            let body_offset = payload_offset + pn_len;
            encrypt_packet(pk, actual_pn, &mut buffer[..pkt_size], body_offset);

            let hpk = keys.hpk();
            protect_header(hpk, &mut buffer[..pkt_size], payload_offset, pn_len);
        } else {
            let packet_len = payload_len + tag_len;
            let len_buffer_range = layout.hdr_len..layout.hdr_len + layout.len_encoding;
            let mut len_buf = &mut buffer[len_buffer_range];
            len_buf.encode_varint(&VarInt::try_from(packet_len).unwrap(), EncodeBytes::Two);

            encode_long_first_byte(&mut buffer[0], pn_len);

            let pk = keys.pk();
            let payload_offset = layout.hdr_len + layout.len_encoding;
            let body_offset = payload_offset + pn_len;
            encrypt_packet(pk, actual_pn, &mut buffer[..pkt_size], body_offset);

            let hpk = keys.hpk();
            protect_header(hpk, &mut buffer[..pkt_size], payload_offset, pn_len);
        }
        (pkt_size, props)
    }
}

#[cfg(test)]
mod tests {
    use std::sync::Arc;

    use super::*;
    use crate::{frame::CryptoFrame, varint::VarInt};

    struct TransparentKeys;

    impl rustls::quic::PacketKey for TransparentKeys {
        fn decrypt_in_place<'a>(
            &self,
            _packet_number: u64,
            _header: &[u8],
            payload: &'a mut [u8],
        ) -> Result<&'a [u8], rustls::Error> {
            Ok(&payload[..payload.len() - self.tag_len()])
        }

        fn encrypt_in_place(
            &self,
            _packet_number: u64,
            _header: &[u8],
            _payload: &mut [u8],
        ) -> Result<rustls::quic::Tag, rustls::Error> {
            Ok(rustls::quic::Tag::from("transparent_keys".as_bytes()))
        }

        fn confidentiality_limit(&self) -> u64 {
            0
        }

        fn integrity_limit(&self) -> u64 {
            0
        }

        fn tag_len(&self) -> usize {
            16
        }
    }

    impl rustls::quic::HeaderProtectionKey for TransparentKeys {
        fn decrypt_in_place(
            &self,
            _sample: &[u8],
            _first_byte: &mut u8,
            _payload: &mut [u8],
        ) -> Result<(), rustls::Error> {
            Ok(())
        }

        fn encrypt_in_place(
            &self,
            _sample: &[u8],
            _first_byte: &mut u8,
            _payload: &mut [u8],
        ) -> Result<(), rustls::Error> {
            Ok(())
        }

        fn sample_len(&self) -> usize {
            20
        }
    }

    #[test]
    fn test_initial_packet_writer() {
        let mut buffer = vec![0u8; 128];
        let header = LongHeaderBuilder::with_cid(
            ConnectionId::from_slice("testdcid".as_bytes()),
            ConnectionId::from_slice("testscid".as_bytes()),
        )
        .initial(b"test_token".to_vec());

        let pn = (0, PacketNumber::encode(0, 0));

        let keys = DirectionalKeys {
            packet: Arc::new(TransparentKeys),
            header: Arc::new(TransparentKeys),
        };

        let mut writer = PacketWriter::new_long(&header, &mut buffer, pn, keys).unwrap();
        let frame = CryptoFrame::new(VarInt::from_u32(0), VarInt::from_u32(12));
        writer
            .assemble_packet(&mut (frame, "client_hello".as_bytes()))
            .unwrap();
        assert!(writer.is_ack_eliciting());
        assert!(writer.in_flight());

        let (sent_bytes, final_packet_layout) = writer.encrypt_and_protect_packet();
        assert!(final_packet_layout.ack_eliciting());
        assert!(final_packet_layout.in_flight());
        assert_eq!(sent_bytes, 69);
        assert_eq!(
            &buffer[..sent_bytes],
            [
                // initial packet:
                // header form (1) = 1,, long header
                // fixed bit (1) = 1,
                // long packet type (2) = 0, initial packet
                // reserved bits (2) = 0,
                // packet number length (2) = 0, 1 byte
                193, // first byte
                0, 0, 0, 1, // quic version
                // destination connection id, "testdcid"
                8, // dcid length
                b't', b'e', b's', b't', b'd', b'c', b'i', b'd', // dcid bytes
                // source connection id, "testscid"
                8, // scid length
                b't', b'e', b's', b't', b's', b'c', b'i', b'd', // scid bytes
                10,   // token length, no token
                b't', b'e', b's', b't', b'_', b't', b'o', b'k', b'e', b'n', // token bytes
                64, 33, // payload length, 2 bytes encoded varint
                0, 0, // encoded packet number
                // crypto frame header
                6,  // crypto frame type
                0,  // crypto frame offset
                12, // crypto frame length
                // crypto frame data, "client hello"
                b'c', b'l', b'i', b'e', b'n', b't', b'_', b'h', b'e', b'l', b'l', b'o',
                // tag, "transparent_keys"
                b't', b'r', b'a', b'n', b's', b'p', b'a', b'r', b'e', b'n', b't', b'_', b'k', b'e',
                b'y', b's',
            ]
            .as_slice()
        );
    }
}