btdt 0.4.4

"been there, done that" - a tool for flexible CI caching
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
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
//! A simple HTTP/1.1 client implementation with support for TLS using rustls.
//!
//! The client uses the type state pattern to enforce correct usage at compile time.
//! It avoids storing the entire request or response in memory, allowing for streaming of large
//! bodies.
//!
//! # Examples
//!
//! ```rust
//! use btdt::util::http::{HttpClient, Url};
//! use std::io::{Read, Write};
//!
//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
//! let url = Url::parse("https://www.example.com/")?;
//! let mut request = HttpClient::default()?.get(&url)?;
//! request.header("X-Foo", "bar")?;
//! let response = request.no_body()?;
//! let (status, mut response) = response.read_status()?;
//! if status.is_success() {
//!     let mut response_body = String::new();
//!     response.read_body().unwrap().read_to_string(&mut response_body)?;
//! }
//! # Ok(())
//! # }
//! ```

use crate::util::http::error::HttpClientError;
pub use rustls::RootCertStore;
use rustls::pki_types::{CertificateDer, ServerName, TrustAnchor};
use rustls::{ClientConfig, ClientConnection, StreamOwned, crypto};
use rustls_pki_types::pem::PemObject;
use rustls_platform_verifier::BuilderVerifierExt;
use std::error::Error;
use std::io;
use std::io::{BufRead, BufReader, BufWriter, Read, Write};
use std::marker::PhantomData;
use std::net::TcpStream;
use std::path::Path;
use std::sync::Arc;
pub use url::Url;
use webpki::anchor_from_trusted_cert;

pub mod error;

const CRLF: &[u8] = b"\r\n";
const HTTP_VERSION: &str = "HTTP/1.1";

#[derive(Debug, Copy, Clone)]
enum TransferEncodingType {
    Chunked,
    FixedSize(usize),
}

/// Marker trait for HTTP message states.
pub trait State {}
/// Marker type for the state of awaiting request headers.
pub struct AwaitingRequestHeaders<T: OptionTransferEncoding> {
    _transfer_encoding: PhantomData<T>,
}
/// Marker type for the state of awaiting the request body.
pub struct AwaitingRequestBody<T: TransferEncoding> {
    _transfer_encoding: PhantomData<T>,
}
/// Marker type for the state of reading the response status line.
pub struct ReadResponseStatus;
/// Marker type for the state of reading the response headers.
pub struct ReadResponseHeaders;
/// Marker type for the state of reading the response body.
pub struct ReadResponseBody;
impl<T: OptionTransferEncoding> State for AwaitingRequestHeaders<T> {}
impl<T: TransferEncoding> State for AwaitingRequestBody<T> {}
impl State for ReadResponseStatus {}
impl State for ReadResponseHeaders {}
impl State for ReadResponseBody {}

/// Marker trait for transfer encoding types.
pub trait TransferEncoding {}
/// Marker type for undefined transfer encoding because no body is included in the message.
pub struct NoBodyTransferEncoding;
/// Marker type for chunked transfer encoding.
pub struct ChunkedTransferEncoding;
/// Marker type for fixed-size transfer encoding.
pub struct FixedSizeTransferEncoding;
impl TransferEncoding for NoBodyTransferEncoding {}
impl TransferEncoding for ChunkedTransferEncoding {}
impl TransferEncoding for FixedSizeTransferEncoding {}

/// Marker trait for optional transfer encoding types.
pub trait OptionTransferEncoding {}
/// Marker type for no defined transfer encoding.
pub struct TNone;
/// Marker type for some defined transfer encoding.
pub struct TSome<T> {
    _type: PhantomData<T>,
}
impl OptionTransferEncoding for TNone {}
impl<T: TransferEncoding> OptionTransferEncoding for TSome<T> {}

pub(crate) type Result<T> = std::result::Result<T, HttpClientError>;

/// A simple HTTP/1.1 client with TLS support using rustls.
///
/// See the module documentation for usage examples.
pub struct HttpClient {
    tls_client_config: Arc<ClientConfig>,
}

impl HttpClient {
    /// Creates a new HTTP client with the given TLS client configuration.
    pub fn new(tls_client_config: Arc<ClientConfig>) -> Self {
        Self { tls_client_config }
    }

    /// Creates a new HTTP client with the default TLS configuration.
    #[allow(clippy::should_implement_trait)]
    pub fn default() -> std::result::Result<Self, rustls::Error> {
        Ok(Self::new(Arc::new(
            ClientConfig::builder_with_provider(Arc::new(crypto::aws_lc_rs::default_provider()))
                .with_safe_default_protocol_versions()?
                .with_platform_verifier()
                .with_no_client_auth(),
        )))
    }

    /// Creates a new HTTP client with the given root certificates for TLS.
    pub fn with_tls_root_certs(
        root_store: impl Into<Arc<RootCertStore>>,
    ) -> std::result::Result<Self, rustls::Error> {
        Ok(Self::new(Arc::new(
            ClientConfig::builder_with_provider(Arc::new(crypto::aws_lc_rs::default_provider()))
                .with_safe_default_protocol_versions()?
                .with_root_certificates(root_store)
                .with_no_client_auth(),
        )))
    }

    /// Creates a new HTTP client with the given root certificate file paths for TLS.
    pub fn with_tls_root_cert_paths(
        root_cert_paths: &[impl AsRef<Path>],
    ) -> std::result::Result<Self, rustls::Error> {
        let root_cert_store = RootCertStore::from_iter(
            root_cert_paths
                .iter()
                .map(|path| {
                    Ok(anchor_from_trusted_cert(&CertificateDer::from_pem_file(path)?)?.to_owned())
                })
                .flat_map(
                    |result: std::result::Result<TrustAnchor, Box<dyn Error>>| match result {
                        Ok(cert) => Some(cert),
                        Err(err) => {
                            eprintln!("error {err}");
                            None
                        }
                    },
                ),
        );
        Self::with_tls_root_certs(Arc::new(root_cert_store))
    }

    /// Creates a new HTTP request with the given method and URL.
    pub fn method(
        &self,
        method: &str,
        url: &Url,
    ) -> Result<HttpRequest<AwaitingRequestHeaders<TNone>>> {
        let mut stream = self.connect(url)?;
        stream.write_all(method.as_bytes())?;
        stream.write_all(b" ")?;
        stream.write_all(url.path().as_bytes())?;
        if let Some(query) = url.query() {
            stream.write_all(b"?")?;
            stream.write_all(query.as_bytes())?;
        }
        stream.write_all(b" ")?;
        stream.write_all(HTTP_VERSION.as_bytes())?;
        stream.write_all(CRLF)?;

        let mut client = HttpRequest {
            stream,
            _state: PhantomData,
        };

        client.header("Host", url.host_str().ok_or(HttpClientError::MissingHost)?)?;
        client.header("Connection", "close")?;
        client.header("User-Agent", concat!("btdt/", env!("CARGO_PKG_VERSION")))?;

        Ok(client)
    }

    /// Creates a new HTTP GET request for the given URL.
    pub fn get(
        &self,
        url: &Url,
    ) -> Result<HttpRequest<AwaitingRequestHeaders<TSome<NoBodyTransferEncoding>>>> {
        let client = self.method("GET", url)?;
        Ok(HttpRequest {
            stream: client.stream,
            _state: PhantomData,
        })
    }

    /// Creates a new HTTP POST request for the given URL.
    #[allow(unused)]
    pub fn post(&self, url: &Url) -> Result<HttpRequest<AwaitingRequestHeaders<TNone>>> {
        self.method("POST", url)
    }

    /// Creates a new HTTP PUT request for the given URL.
    pub fn put(&self, url: &Url) -> Result<HttpRequest<AwaitingRequestHeaders<TNone>>> {
        self.method("PUT", url)
    }

    fn connect(&self, url: &Url) -> Result<Box<dyn WriteThenRead + Send>> {
        let use_tls = match url.scheme() {
            "http" => false,
            "https" => true,
            scheme => Err(HttpClientError::InvalidScheme(scheme.into()))?,
        };
        if url.username() != "" || url.password().is_some() {
            return Err(HttpClientError::UnsupportedFeature(
                "username/password in URL",
            ));
        }
        let host = url.host_str().ok_or(HttpClientError::MissingHost)?;
        let port = url.port_or_known_default().expect("default port not known");
        let stream = TcpStream::connect((host, port))?;
        if use_tls {
            let connection = ClientConnection::new(
                self.tls_client_config.clone(),
                ServerName::try_from(host.to_string())?,
            )?;
            let tls_stream = StreamOwned::new(connection, stream);
            Ok(Box::new(BufWriter::new(tls_stream)))
        } else {
            Ok(Box::new(BufWriter::new(stream)))
        }
    }
}

trait WriteThenRead: Write {
    fn into_reader(
        self: Box<Self>,
    ) -> io::Result<HttpMessageReader<Box<dyn BufRead + Send>, ReadResponseStatus>>;
}

impl WriteThenRead for BufWriter<TcpStream> {
    fn into_reader(
        self: Box<Self>,
    ) -> io::Result<HttpMessageReader<Box<dyn BufRead + Send>, ReadResponseStatus>> {
        Ok(HttpMessageReader::new(Box::new(BufReader::new(
            self.into_inner()?,
        ))))
    }
}

impl WriteThenRead for BufWriter<StreamOwned<ClientConnection, TcpStream>> {
    fn into_reader(
        self: Box<Self>,
    ) -> io::Result<HttpMessageReader<Box<dyn BufRead + Send>, ReadResponseStatus>> {
        Ok(HttpMessageReader::new(Box::new(self.into_inner()?)))
    }
}

/// Represents an HTTP status line.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct HttpStatus {
    status_line: String,
}

impl HttpStatus {
    /// Creates a new `HttpStatus` from the given status line.
    fn new(status_line: String) -> Result<HttpStatus> {
        if !status_line.starts_with(HTTP_VERSION) {
            return Err(HttpClientError::invalid_data("unsupported HTTP version"));
        }
        if status_line.as_bytes()[HTTP_VERSION.len()] != b' '
            || status_line.as_bytes()[HTTP_VERSION.len() + 4] != b' '
        {
            return Err(HttpClientError::invalid_data("malformed status line"));
        }
        let status = Self { status_line };
        if status.code().as_bytes().iter().any(|c| !c.is_ascii_digit()) {
            return Err(HttpClientError::invalid_data("invalid HTTP status code"));
        }
        Ok(status)
    }

    /// Returns the status line as a string slice.
    pub fn as_str(&self) -> &str {
        &self.status_line
    }

    /// Returns the HTTP status code as a string slice.
    pub fn code(&self) -> &str {
        &self.status_line[HTTP_VERSION.len() + 1..HTTP_VERSION.len() + 4]
    }

    /// Returns the HTTP status code as a u16.
    pub fn code_u16(&self) -> u16 {
        self.code().parse().expect("invalid HTTP staus code")
    }

    /// Returns true if the status code indicates success (2xx).
    pub fn is_success(&self) -> bool {
        self.code().as_bytes()[0] == b'2'
    }

    /// Returns the reason phrase as a string slice.
    pub fn reason(&self) -> &str {
        self.status_line[HTTP_VERSION.len() + 5..].trim_end()
    }
}

/// An HTTP request in a specific state.
pub struct HttpRequest<S: State> {
    stream: Box<dyn WriteThenRead + Send>,
    _state: PhantomData<S>,
}

impl<T: OptionTransferEncoding> HttpRequest<AwaitingRequestHeaders<T>> {
    /// Adds a header to the HTTP request.
    pub fn header(&mut self, key: &str, value: &str) -> Result<()> {
        self.stream.write_all(key.as_bytes())?;
        self.stream.write_all(b": ")?;
        self.stream.write_all(value.as_bytes())?;
        self.stream.write_all(CRLF)?;
        Ok(())
    }

    /// Finalizes the HTTP request without a body and sends it.
    pub fn no_body(mut self) -> Result<HttpResponse<ReadResponseStatus>> {
        self.stream.write_all(CRLF)?;
        Ok(HttpResponse {
            inner: self.stream.into_reader()?,
        })
    }
}

impl HttpRequest<AwaitingRequestHeaders<TNone>> {
    /// Finalizes the HTTP request header section with fixed-size transfer encoding and awaits
    /// the request body.
    #[allow(unused)]
    pub fn body_with_size(
        mut self,
        size: usize,
    ) -> Result<HttpRequest<AwaitingRequestBody<FixedSizeTransferEncoding>>> {
        self.header("Content-Length", &size.to_string())?;
        self.stream.write_all(CRLF)?;
        Ok(HttpRequest {
            stream: self.stream,
            _state: PhantomData,
        })
    }

    /// Finalizes the HTTP request header section with chunked transfer encoding and awaits the
    /// request body.
    pub fn body(mut self) -> Result<HttpRequest<AwaitingRequestBody<ChunkedTransferEncoding>>> {
        self.header("Transfer-Encoding", "chunked")?;
        self.stream.write_all(CRLF)?;
        Ok(HttpRequest {
            stream: self.stream,
            _state: PhantomData,
        })
    }
}

impl Write for HttpRequest<AwaitingRequestBody<FixedSizeTransferEncoding>> {
    fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
        self.stream.write(buf)
    }

    fn flush(&mut self) -> io::Result<()> {
        self.stream.flush()
    }
}

impl Write for HttpRequest<AwaitingRequestBody<ChunkedTransferEncoding>> {
    fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
        let chunk_size = buf.len();
        if chunk_size > 0 {
            self.stream
                .write_all(format!("{chunk_size:X}").as_bytes())?;
            self.stream.write_all(CRLF)?;
            self.stream.write_all(buf)?;
            self.stream.write_all(CRLF)?;
        }
        Ok(chunk_size)
    }

    fn flush(&mut self) -> io::Result<()> {
        self.stream.flush()
    }
}

impl HttpRequest<AwaitingRequestBody<FixedSizeTransferEncoding>> {
    /// Finalizes the HTTP request and sends it, returning the HTTP response.
    #[allow(unused)]
    pub fn response(self) -> Result<HttpResponse<ReadResponseStatus>> {
        Ok(HttpResponse {
            inner: self.stream.into_reader()?,
        })
    }
}

impl HttpRequest<AwaitingRequestBody<ChunkedTransferEncoding>> {
    /// Finalizes the HTTP request and sends it, returning the HTTP response.
    pub fn response(mut self) -> Result<HttpResponse<ReadResponseStatus>> {
        self.stream.write_all(b"0")?;
        self.stream.write_all(CRLF)?;
        self.stream.write_all(CRLF)?;
        Ok(HttpResponse {
            inner: self.stream.into_reader()?,
        })
    }
}

/// Represents an HTTP header.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Header {
    header_line: String,
    key_end: usize,
    value_start: usize,
    value_end: usize,
}

impl Header {
    /// Creates a new `Header` from the given header line.
    fn new(header_line: String) -> Result<Header> {
        let key_end = header_line.find(':').ok_or_else(|| {
            HttpClientError::invalid_data("malformed header: missing colon separator")
        })?;
        let value_start = header_line[key_end + 1..]
            .find(|c: char| !c.is_whitespace())
            .unwrap_or(0)
            + key_end
            + 1;
        let value_end = header_line
            .rfind(|c: char| !c.is_whitespace())
            .map(|i| i + 1)
            .unwrap_or(header_line.len())
            .max(value_start);
        Ok(Header {
            header_line,
            key_end,
            value_start,
            value_end,
        })
    }

    /// Returns the header key as a string slice.
    pub fn key(&self) -> &str {
        &self.header_line[..self.key_end]
    }

    /// Returns the header value as a string slice.
    pub fn value(&self) -> &str {
        &self.header_line[self.value_start..self.value_end]
    }
}

/// An HTTP message reader in a specific state.
///
/// This allows, for example, reading the status line, headers, and body of an HTTP response.
struct HttpMessageReader<R: BufRead, S: State> {
    reader: R,
    transfer_encoding: Option<TransferEncodingType>,
    headers_exhausted: bool,
    is_eof: bool,
    chunk_bytes_remaining: usize,
    _state: PhantomData<S>,
}

impl<R: BufRead, S: State> HttpMessageReader<R, S> {
    /// Creates a new `HttpMessageReader` with the given underlying reader.
    pub fn new(reader: R) -> Self {
        Self {
            reader,
            transfer_encoding: None,
            headers_exhausted: false,
            is_eof: false,
            chunk_bytes_remaining: 0,
            _state: PhantomData,
        }
    }
}

impl<R: BufRead> HttpMessageReader<R, ReadResponseStatus> {
    /// Reads the HTTP status line and returns the status along with a reader for the headers.
    pub fn read_status(
        mut self,
    ) -> Result<(HttpStatus, HttpMessageReader<R, ReadResponseHeaders>)> {
        let mut status_line = String::new();
        self.reader.read_line(&mut status_line)?;
        let status = HttpStatus::new(status_line.trim_end().to_string())?;

        Ok((
            status,
            HttpMessageReader {
                reader: self.reader,
                transfer_encoding: self.transfer_encoding,
                headers_exhausted: self.headers_exhausted,
                is_eof: self.is_eof,
                chunk_bytes_remaining: self.chunk_bytes_remaining,
                _state: PhantomData,
            },
        ))
    }
}

impl<R: BufRead> HttpMessageReader<R, ReadResponseHeaders> {
    #[cfg(test)]
    fn new_skip_status_line(reader: R) -> Self {
        Self {
            reader,
            transfer_encoding: None,
            headers_exhausted: false,
            is_eof: false,
            chunk_bytes_remaining: 0,
            _state: PhantomData,
        }
    }

    /// Reads the next HTTP header from the response.
    ///
    /// Returns `Ok(None)` if there are no more headers.
    pub fn read_next_header(&mut self) -> Result<Option<Header>> {
        if self.headers_exhausted {
            return Ok(None);
        }
        let mut line = String::new();
        self.reader.read_line(&mut line)?;
        if line.trim().is_empty() {
            self.headers_exhausted = true;
            return Ok(None);
        }
        let header = Header::new(line)?;
        if header.key().eq_ignore_ascii_case("Transfer-Encoding") {
            if header.value().eq_ignore_ascii_case("chunked") {
                self.transfer_encoding = Some(TransferEncodingType::Chunked);
            } else {
                return Err(HttpClientError::UnsupportedFeature("transfer encoding"));
            }
        } else if header.key().eq_ignore_ascii_case("Content-Length") {
            let size: usize = header.value().parse().map_err(|_| {
                HttpClientError::invalid_data("invalid Content-Length header value")
            })?;
            self.transfer_encoding = Some(TransferEncodingType::FixedSize(size));
        }
        Ok(Some(header))
    }

    /// Finalizes the header reading and returns a reader for the response body.
    pub fn read_body(mut self) -> Result<HttpMessageReader<R, ReadResponseBody>> {
        while !self.headers_exhausted {
            self.read_next_header()?;
        }
        Ok(HttpMessageReader {
            reader: self.reader,
            transfer_encoding: self.transfer_encoding,
            headers_exhausted: true,
            is_eof: false,
            chunk_bytes_remaining: match self.transfer_encoding {
                None => 0,
                Some(TransferEncodingType::Chunked) => 0,
                Some(TransferEncodingType::FixedSize(size)) => size,
            },
            _state: PhantomData,
        })
    }
}

impl<R: BufRead> Read for HttpMessageReader<R, ReadResponseBody> {
    fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
        if self.is_eof {
            return Ok(0);
        }
        match self.transfer_encoding {
            None => {
                self.is_eof = true;
                Ok(0)
            }
            Some(TransferEncodingType::FixedSize(_)) => {
                let max_n = buf.len().min(self.chunk_bytes_remaining);
                self.reader.read(buf[..max_n].as_mut()).inspect(|n| {
                    self.chunk_bytes_remaining -= n;
                    if self.chunk_bytes_remaining == 0 {
                        self.is_eof = true;
                    }
                })
            }
            Some(TransferEncodingType::Chunked) => {
                if self.chunk_bytes_remaining == 0 {
                    let mut octets = String::new();
                    self.reader.read_line(&mut octets)?;
                    self.chunk_bytes_remaining =
                        usize::from_str_radix(octets.trim(), 16).map_err(|_| {
                            io::Error::new(
                                io::ErrorKind::InvalidData,
                                format!("invalid chunk size: {}", octets.trim()),
                            )
                        })?;
                    if self.chunk_bytes_remaining == 0 {
                        self.reader.read([0; 2].as_mut())?; // trailing CRLF
                        self.is_eof = true;
                        return Ok(0);
                    }
                }
                let max_n = buf.len().min(self.chunk_bytes_remaining);
                let n = self.reader.read(&mut buf[..max_n]).inspect(|n| {
                    self.chunk_bytes_remaining -= n;
                })?;
                if self.chunk_bytes_remaining == 0 {
                    self.reader.read_exact([0; 2].as_mut())?; // trailing CRLF
                }
                Ok(n)
            }
        }
    }
}

/// An HTTP response in a specific state.
pub struct HttpResponse<S: State> {
    inner: HttpMessageReader<Box<dyn BufRead + Send>, S>,
}

impl HttpResponse<ReadResponseStatus> {
    /// Reads the HTTP status line and returns the status along with a response reader for the headers.
    pub fn read_status(self) -> Result<(HttpStatus, HttpResponse<ReadResponseHeaders>)> {
        let (status, inner) = self.inner.read_status()?;
        Ok((status, HttpResponse { inner }))
    }
}

impl HttpResponse<ReadResponseHeaders> {
    /// Reads the next HTTP header from the response.
    pub fn read_next_header(&mut self) -> Result<Option<Header>> {
        self.inner.read_next_header()
    }

    /// Finalizes the header reading and returns a response reader for the body.
    pub fn read_body(self) -> Result<HttpResponse<ReadResponseBody>> {
        Ok(HttpResponse {
            inner: self.inner.read_body()?,
        })
    }
}

impl Read for HttpResponse<ReadResponseBody> {
    fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
        self.inner.read(buf)
    }
}

#[cfg(test)]
pub mod tests {
    use super::*;
    use rustls::pki_types::pem::PemObject;
    use rustls::pki_types::{CertificateDer, PrivateKeyDer};
    use rustls::{RootCertStore, ServerConfig, ServerConnection, StreamOwned, crypto};
    use std::net::{SocketAddr, TcpListener};
    use std::sync::Arc;
    use std::thread;
    use std::thread::JoinHandle;

    pub static CERTIFICATE_PRIVATE_KEY: &[u8] = include_bytes!("../../../../tls/leaf.key");
    pub static CERTIFICATE_PEM: &[u8] = include_bytes!("../../../../tls/leaf.pem");

    pub const EMPTY_RESPONSE: &str = "HTTP/1.1 204 No Content\r\nContent-Length: 0\r\n\r\n";

    pub struct TestServer {
        join_handle: JoinHandle<io::Result<String>>,
        addr: SocketAddr,
        base_url: Url,
    }

    impl TestServer {
        pub fn start(response: String) -> io::Result<Self> {
            let listener = TcpListener::bind("127.0.0.1:0")?;
            let addr = listener.local_addr()?;
            let base_url =
                Url::parse(&format!("http://{}:{}", addr.ip().to_string(), addr.port())).unwrap();
            let join_handle = thread::spawn(move || Self::serve_once(listener, &response, None));
            Ok(Self {
                join_handle,
                addr,
                base_url,
            })
        }

        pub fn start_with_tls(response: String) -> io::Result<Self> {
            crypto::aws_lc_rs::default_provider()
                .install_default()
                .unwrap();
            let cert = CertificateDer::from_pem_slice(CERTIFICATE_PEM).unwrap();
            let private_key = PrivateKeyDer::from_pem_slice(CERTIFICATE_PRIVATE_KEY).unwrap();
            let server_conf = ServerConfig::builder()
                .with_no_client_auth()
                .with_single_cert(vec![cert], private_key)
                .unwrap();

            let listener = TcpListener::bind("127.0.0.1:0")?;
            let addr = listener.local_addr()?;
            let base_url = Url::parse(&format!(
                "https://{}:{}",
                addr.ip().to_string(),
                addr.port()
            ))
            .unwrap();
            let join_handle = thread::spawn(move || {
                Self::serve_once(listener, &response, Some(Arc::new(server_conf)))
            });
            Ok(Self {
                join_handle,
                addr,
                base_url,
            })
        }

        fn serve_once(
            listener: TcpListener,
            response: &str,
            tls_conf: Option<Arc<ServerConfig>>,
        ) -> io::Result<String> {
            let (stream, _) = listener.accept()?;
            if let Some(tls_conf) = tls_conf {
                let tls_connection = ServerConnection::new(tls_conf).unwrap();
                let mut stream = StreamOwned::new(tls_connection, stream);
                let body = Self::read_request(&mut stream)?;
                stream.write_all(response.as_bytes())?;
                Ok(body)
            } else {
                let mut stream = BufReader::new(stream);
                let body = Self::read_request(&mut stream)?;
                stream.into_inner().write_all(response.as_bytes())?;
                Ok(body)
            }
        }

        fn read_request<R: BufRead>(stream: &mut R) -> io::Result<String> {
            let mut request_line = String::new();
            stream.read_line(&mut request_line)?;
            let mut lines: Vec<String> = vec![request_line];
            let mut reader = HttpMessageReader::new_skip_status_line(stream);
            while let Some(header) = reader
                .read_next_header()
                .map_err(|err| io::Error::new(io::ErrorKind::InvalidData, err))?
            {
                if header.key().eq_ignore_ascii_case("authorization") {
                    lines.push("Authorization: <auth-header-value>\r\n".into());
                } else {
                    lines.push(header.header_line);
                }
            }
            lines.push("\r\n".into());
            let mut body_reader = reader
                .read_body()
                .map_err(|err| io::Error::new(io::ErrorKind::InvalidData, err))?;
            let mut body = String::new();
            body_reader.read_to_string(&mut body)?;
            lines.push(body);
            Ok(lines.join(""))
        }

        pub fn request(self) -> io::Result<String> {
            self.join_handle.join().unwrap()
        }

        pub fn addr(&self) -> SocketAddr {
            self.addr
        }

        pub fn base_url(&self) -> &Url {
            &self.base_url
        }
    }

    #[test]
    fn test_get_request_without_body() -> Result<()> {
        let test_server = TestServer::start(EMPTY_RESPONSE.into())?;
        let addr = test_server.addr();
        let url = Url::parse(&format!(
            "http://{}:{}/path?query=foo#fragment",
            addr.ip().to_string(),
            addr.port()
        ))
        .unwrap();
        let response = HttpClient::default()?.get(&url)?.no_body()?;

        assert_eq!(
            test_server.request()?,
            format!(
                "GET /path?query=foo HTTP/1.1\r\n\
                Host: {}\r\n\
                Connection: close\r\n\
                User-Agent: btdt/{}\r\n\r\n",
                addr.ip(),
                env!("CARGO_PKG_VERSION")
            )
        );

        let (status, mut response) = response.read_status()?;
        assert_eq!(
            status,
            HttpStatus::new("HTTP/1.1 204 No Content".to_string())?
        );
        assert_eq!(
            response.read_next_header()?,
            Some(Header::new("Content-Length: 0\r\n".to_string())?)
        );
        assert_eq!(response.read_next_header()?, None);
        let mut buf = String::new();
        response.read_body().unwrap().read_to_string(&mut buf)?;
        assert!(buf.is_empty());
        Ok(())
    }

    #[test]
    fn test_post_with_fixed_size_body() -> Result<()> {
        let test_server = TestServer::start(EMPTY_RESPONSE.into())?;
        let addr = test_server.addr();
        let mut url = test_server.base_url().join("path").unwrap();
        url.query_pairs_mut().append_pair("query", "foo");
        url.set_fragment(Some("fragment"));
        let body = "{\"hello\": \"world\"}\r\n";
        let mut request = HttpClient::default()?
            .post(&url)?
            .body_with_size(body.len())?;
        request.write_all(body.as_bytes())?;
        let response = request.response()?;

        assert_eq!(
            test_server.request()?,
            format!(
                "POST /path?query=foo HTTP/1.1\r\n\
                Host: {}\r\n\
                Connection: close\r\n\
                User-Agent: btdt/{}\r\n\
                Content-Length: {}\r\n\r\n\
                {}",
                addr.ip(),
                env!("CARGO_PKG_VERSION"),
                body.len(),
                body
            )
        );

        let (status, mut response) = response.read_status()?;
        assert_eq!(
            status,
            HttpStatus::new("HTTP/1.1 204 No Content".to_string())?
        );
        assert_eq!(
            response.read_next_header()?,
            Some(Header::new("Content-Length: 0\r\n".to_string())?)
        );
        assert_eq!(response.read_next_header()?, None);
        let mut buf = String::new();
        response.read_body().unwrap().read_to_string(&mut buf)?;
        assert!(buf.is_empty());
        Ok(())
    }

    #[test]
    fn test_post_with_chunked_body() -> Result<()> {
        let test_server = TestServer::start(EMPTY_RESPONSE.into())?;
        let addr = test_server.addr();
        let mut url = test_server.base_url().join("path").unwrap();
        url.query_pairs_mut().append_pair("query", "foo");
        url.set_fragment(Some("fragment"));
        let body = "{\"hello\": \"world\"}\r\n";
        let mut request = HttpClient::default()?.post(&url)?.body()?;
        request.write_all(&body.as_bytes()[..5])?;
        request.write_all(&body.as_bytes()[5..])?;
        let response = request.response()?;

        assert_eq!(
            test_server.request()?,
            format!(
                "POST /path?query=foo HTTP/1.1\r\n\
                Host: {}\r\n\
                Connection: close\r\n\
                User-Agent: btdt/{}\r\n\
                Transfer-Encoding: chunked\r\n\r\n\
                {}",
                addr.ip(),
                env!("CARGO_PKG_VERSION"),
                body
            )
        );

        let (status, mut response) = response.read_status()?;
        assert_eq!(
            status,
            HttpStatus::new("HTTP/1.1 204 No Content".to_string())?
        );
        assert_eq!(
            response.read_next_header()?,
            Some(Header::new("Content-Length: 0\r\n".to_string())?)
        );
        assert_eq!(response.read_next_header()?, None);
        let mut buf = String::new();
        response.read_body().unwrap().read_to_string(&mut buf)?;
        assert!(buf.is_empty());
        Ok(())
    }

    #[test]
    fn test_response_body_with_content_length() -> Result<()> {
        let test_server = TestServer::start(
            "\
            HTTP/1.1 200 OK\r\n\
            Content-Length: 8\r\n\
            \r\n\
            Hello!\r\n"
                .into(),
        )?;
        let mut url = test_server.base_url().join("path").unwrap();
        url.query_pairs_mut().append_pair("query", "foo");
        url.set_fragment(Some("fragment"));
        let response = HttpClient::default()?.get(&url)?.no_body()?;

        let (status, response) = response.read_status()?;
        assert_eq!(status, HttpStatus::new("HTTP/1.1 200 OK".to_string())?);
        let mut buf = String::new();
        response.read_body().unwrap().read_to_string(&mut buf)?;
        assert_eq!(&buf, "Hello!\r\n");
        Ok(())
    }

    #[test]
    fn test_response_body_with_chunked_transfer_encoding() -> Result<()> {
        let test_server = TestServer::start(
            "\
            HTTP/1.1 200 OK\r\n\
            Transfer-Encoding: chunked\r\n\
            \r\n\
            a\r\nHello, wor\r\n\
            5\r\nld!\r\n\r\n\
            0\r\n\r\n"
                .into(),
        )?;
        let mut url = test_server.base_url().join("path").unwrap();
        url.query_pairs_mut().append_pair("query", "foo");
        url.set_fragment(Some("fragment"));
        let response = HttpClient::default()?.get(&url)?.no_body()?;

        let (status, response) = response.read_status()?;
        assert_eq!(status, HttpStatus::new("HTTP/1.1 200 OK".to_string())?);
        let mut buf = String::new();
        response.read_body().unwrap().read_to_string(&mut buf)?;
        assert_eq!(&buf, "Hello, world!\r\n");
        Ok(())
    }

    #[test]
    fn test_tls() -> Result<()> {
        let root_cert =
            CertificateDer::from_pem_slice(include_bytes!("../../../../tls/ca.pem")).unwrap();
        let mut cert_store = RootCertStore::empty();
        cert_store.add(root_cert)?;
        let tls_client_config = Arc::new(
            ClientConfig::builder_with_provider(Arc::new(crypto::aws_lc_rs::default_provider()))
                .with_safe_default_protocol_versions()?
                .with_root_certificates(cert_store)
                .with_no_client_auth(),
        );

        let test_server = TestServer::start_with_tls(EMPTY_RESPONSE.into())?;
        let addr = test_server.addr();
        let url = Url::parse(&format!(
            "https://{}:{}/path?query=foo#fragment",
            addr.ip().to_string(),
            addr.port()
        ))
        .unwrap();
        let response = HttpClient::new(tls_client_config).get(&url)?.no_body()?;

        assert_eq!(
            test_server.request()?,
            format!(
                "GET /path?query=foo HTTP/1.1\r\n\
                Host: {}\r\n\
                Connection: close\r\n\
                User-Agent: btdt/{}\r\n\r\n",
                addr.ip(),
                env!("CARGO_PKG_VERSION")
            )
        );

        let (status, mut response) = response.read_status()?;
        assert_eq!(
            status,
            HttpStatus::new("HTTP/1.1 204 No Content".to_string())?
        );
        assert_eq!(
            response.read_next_header()?,
            Some(Header::new("Content-Length: 0\r\n".to_string())?)
        );
        assert_eq!(response.read_next_header()?, None);
        let mut buf = String::new();
        response.read_body().unwrap().read_to_string(&mut buf)?;
        assert!(buf.is_empty());
        Ok(())
    }
}