hpx 2.5.17

High Performance HTTP Client
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
#[cfg(feature = "boring-tls")]
use boring::{
    pkcs12::Pkcs12,
    pkey::{PKey, Private},
    x509::X509,
};
#[cfg(all(feature = "rustls-tls", not(feature = "boring-tls")))]
use const_oid::db::{
    rfc5911::{ID_DATA, ID_ENCRYPTED_DATA},
    rfc5912::{ID_SHA_1, ID_SHA_224, ID_SHA_256, ID_SHA_384, ID_SHA_512},
};
#[cfg(all(feature = "rustls-tls", not(feature = "boring-tls")))]
use der::{
    Decode, Encode,
    asn1::{ContextSpecific, OctetString},
};
#[cfg(all(feature = "rustls-tls", not(feature = "boring-tls")))]
use hmac::{Hmac, KeyInit, Mac};
#[cfg(all(feature = "openssl-tls", not(feature = "boring-tls")))]
use openssl::{
    pkcs12::Pkcs12,
    pkey::{PKey, Private},
    x509::X509,
};
#[cfg(all(feature = "rustls-tls", not(feature = "boring-tls")))]
use pkcs8::{EncryptedPrivateKeyInfoRef, pkcs5::EncryptionScheme};
#[cfg(all(feature = "rustls-tls", not(feature = "boring-tls")))]
use pkcs12::{
    AuthenticatedSafe, CertBag, PKCS_12_CERT_BAG_OID, PKCS_12_KEY_BAG_OID,
    PKCS_12_PKCS8_KEY_BAG_OID, PKCS_12_X509_CERT_OID, Pfx,
    safe_bag::{PrivateKeyInfo, SafeBag, SafeContents},
};
#[cfg(all(feature = "rustls-tls", not(feature = "boring-tls")))]
use rustls_pki_types::{CertificateDer, PrivateKeyDer};
#[cfg(all(feature = "rustls-tls", not(feature = "boring-tls")))]
use sha1::Sha1;
#[cfg(all(feature = "rustls-tls", not(feature = "boring-tls")))]
use sha2::{Sha224, Sha256, Sha384, Sha512};

use crate::Error;

/// Represents a private key and X509 cert as a client certificate.
#[derive(Debug, Clone)]
pub struct Identity {
    #[cfg(feature = "boring-tls")]
    pkey: PKey<Private>,
    #[cfg(feature = "boring-tls")]
    cert: X509,
    #[cfg(feature = "boring-tls")]
    chain: Vec<X509>,

    #[cfg(all(feature = "openssl-tls", not(feature = "boring-tls")))]
    pkey: PKey<Private>,
    #[cfg(all(feature = "openssl-tls", not(feature = "boring-tls")))]
    cert: X509,
    #[cfg(all(feature = "openssl-tls", not(feature = "boring-tls")))]
    chain: Vec<X509>,

    #[cfg(all(feature = "rustls-tls", not(feature = "boring-tls")))]
    pub(crate) cert: Vec<CertificateDer<'static>>,
    #[cfg(all(feature = "rustls-tls", not(feature = "boring-tls")))]
    pub(crate) key: std::sync::Arc<PrivateKeyDer<'static>>,
    #[cfg(not(any(
        feature = "boring-tls",
        feature = "openssl-tls",
        feature = "rustls-tls"
    )))]
    _marker: std::marker::PhantomData<()>,
}

impl Identity {
    /// Parses a PEM bundle containing a leaf certificate, optional certificate chain, and the
    /// corresponding private key.
    ///
    /// This is useful for client certificate bundles where the certificate chain and private key
    /// are delivered in a single PEM file.
    #[cfg_attr(
        not(any(
            feature = "boring-tls",
            feature = "openssl-tls",
            feature = "rustls-tls"
        )),
        expect(unused_variables)
    )]
    pub fn from_pem(buf: &[u8]) -> crate::Result<Self> {
        #[cfg(feature = "boring-tls")]
        {
            let key = extract_private_key_pem(buf)
                .ok_or_else(|| Error::builder("no private key found"))?;
            let pkey = PKey::private_key_from_pem(key).map_err(Error::tls)?;
            let mut cert_chain = extract_certificate_pems(buf)
                .into_iter()
                .map(|pem| X509::from_pem(pem).map_err(Error::tls))
                .collect::<crate::Result<Vec<_>>>()?
                .into_iter();
            let cert = cert_chain.next().ok_or_else(|| {
                Error::builder("at least one certificate must be provided to create an identity")
            })?;
            let chain = cert_chain.collect();
            Ok(Self { pkey, cert, chain })
        }
        #[cfg(all(feature = "openssl-tls", not(feature = "boring-tls")))]
        {
            let key = extract_private_key_pem(buf)
                .ok_or_else(|| Error::builder("no private key found"))?;
            let pkey = PKey::private_key_from_pem(key).map_err(Error::tls)?;
            let mut cert_chain = extract_certificate_pems(buf)
                .into_iter()
                .map(|pem| X509::from_pem(pem).map_err(Error::tls))
                .collect::<crate::Result<Vec<_>>>()?
                .into_iter();
            let cert = cert_chain.next().ok_or_else(|| {
                Error::builder("at least one certificate must be provided to create an identity")
            })?;
            let chain = cert_chain.collect();
            Ok(Self { pkey, cert, chain })
        }
        #[cfg(all(feature = "rustls-tls", not(feature = "boring-tls")))]
        {
            use std::io::Cursor;

            let mut reader = Cursor::new(buf);
            let certs = rustls_pemfile::certs(&mut reader)
                .collect::<Result<Vec<_>, _>>()
                .map_err(|e| Error::tls(Box::new(e)))?;

            if certs.is_empty() {
                return Err(Error::builder(
                    "at least one certificate must be provided to create an identity",
                ));
            }

            // `rustls_pemfile::private_key` only inspects the *first* PEM item,
            // so it cannot find a key that follows a certificate in a combined
            // bundle (the cert parser consumes the leading sections). Scan the
            // raw text for a private-key PEM block and decode it explicitly.
            let text = std::str::from_utf8(buf).unwrap_or_default();
            let key = extract_private_key_der(text)
                .ok_or_else(|| Error::builder("no private key found"))?;

            Ok(Self {
                cert: certs,
                key: std::sync::Arc::new(key),
            })
        }
        #[cfg(not(any(
            feature = "boring-tls",
            feature = "openssl-tls",
            feature = "rustls-tls"
        )))]
        {
            Err(Error::tls("TLS not supported"))
        }
    }

    /// Parses a DER-formatted PKCS #12 archive, using the specified password to decrypt the key.
    ///
    /// The archive should contain a leaf certificate and its private key, as well any intermediate
    /// certificates that allow clients to build a chain to a trusted root.
    /// The chain certificates should be in order from the leaf certificate towards the root.
    ///
    /// PKCS #12 archives typically have the file extension `.p12` or `.pfx`, and can be created
    /// with the OpenSSL `pkcs12` tool:
    ///
    /// ```bash
    /// openssl pkcs12 -export -out identity.pfx -inkey key.pem -in cert.pem -certfile chain_certs.pem
    /// ```
    ///
    /// # Examples
    ///
    /// ```
    /// # use std::fs::File;
    /// # use std::io::Read;
    /// # fn pkcs12() -> Result<(), Box<dyn std::error::Error>> {
    /// let mut buf = Vec::new();
    /// File::open("my-ident.pfx")?.read_to_end(&mut buf)?;
    /// let pkcs12 = hpx::tls::Identity::from_pkcs12_der(&buf, "my-privkey-password")?;
    /// # drop(pkcs12);
    /// # Ok(())
    /// # }
    /// ```
    #[cfg_attr(
        not(any(
            feature = "boring-tls",
            feature = "openssl-tls",
            feature = "rustls-tls"
        )),
        expect(unused_variables)
    )]
    pub fn from_pkcs12_der(buf: &[u8], pass: &str) -> crate::Result<Self> {
        #[cfg(feature = "boring-tls")]
        {
            let pkcs12 = Pkcs12::from_der(buf).map_err(Error::tls)?;
            let parsed = pkcs12.parse(pass).map_err(Error::tls)?;
            Ok(Self {
                pkey: parsed.pkey,
                cert: parsed.cert,
                // > The stack is the reverse of what you might expect due to the way
                // > PKCS12_parse is implemented, so we need to load it backwards.
                // > https://github.com/sfackler/rust-native-tls/commit/05fb5e583be589ab63d9f83d986d095639f8ec44
                chain: parsed.chain.into_iter().flatten().rev().collect(),
            })
        }
        #[cfg(all(feature = "openssl-tls", not(feature = "boring-tls")))]
        {
            let pkcs12 = Pkcs12::from_der(buf).map_err(Error::tls)?;
            let parsed = pkcs12.parse2(pass).map_err(Error::tls)?;
            let cert = parsed
                .cert
                .ok_or_else(|| Error::tls("no certificate in PKCS12"))?;
            let pkey = parsed
                .pkey
                .ok_or_else(|| Error::tls("no private key in PKCS12"))?;
            Ok(Self {
                pkey,
                cert,
                chain: parsed.ca.into_iter().flatten().rev().collect(),
            })
        }
        #[cfg(all(feature = "rustls-tls", not(feature = "boring-tls")))]
        {
            identity_from_pkcs12_archive(buf, pass)
        }
        #[cfg(not(any(
            feature = "boring-tls",
            feature = "openssl-tls",
            feature = "rustls-tls"
        )))]
        {
            Err(Error::tls("TLS not supported"))
        }
    }

    /// Parses a chain of PEM encoded X509 certificates, with the leaf certificate first.
    /// `key` is a PEM encoded PKCS #8 formatted private key for the leaf certificate.
    ///
    /// The certificate chain should contain any intermediate certificates that should be sent to
    /// clients to allow them to build a chain to a trusted root.
    ///
    /// A certificate chain here means a series of PEM encoded certificates concatenated together.
    ///
    /// # Examples
    ///
    /// ```
    /// # use std::fs;
    /// # fn pkcs8() -> Result<(), Box<dyn std::error::Error>> {
    /// let cert = fs::read("client.pem")?;
    /// let key = fs::read("key.pem")?;
    /// let pkcs8 = hpx::tls::Identity::from_pkcs8_pem(&cert, &key)?;
    /// # drop(pkcs8);
    /// # Ok(())
    /// # }
    /// ```
    #[cfg_attr(
        not(any(
            feature = "boring-tls",
            feature = "openssl-tls",
            feature = "rustls-tls"
        )),
        expect(unused_variables)
    )]
    pub fn from_pkcs8_pem(buf: &[u8], key: &[u8]) -> crate::Result<Self> {
        #[cfg(feature = "boring-tls")]
        {
            if !key.starts_with(b"-----BEGIN PRIVATE KEY-----") {
                return Err(Error::builder("expected PKCS#8 PEM"));
            }

            let pkey = PKey::private_key_from_pem(key).map_err(Error::tls)?;
            let mut cert_chain = X509::stack_from_pem(buf).map_err(Error::tls)?.into_iter();
            let cert = cert_chain.next().ok_or_else(|| {
                Error::builder("at least one certificate must be provided to create an identity")
            })?;
            let chain = cert_chain.collect();
            Ok(Self { pkey, cert, chain })
        }
        #[cfg(all(feature = "openssl-tls", not(feature = "boring-tls")))]
        {
            if !key.starts_with(b"-----BEGIN PRIVATE KEY-----") {
                return Err(Error::builder("expected PKCS#8 PEM"));
            }

            let pkey = PKey::private_key_from_pem(key).map_err(Error::tls)?;
            let mut cert_chain = X509::stack_from_pem(buf).map_err(Error::tls)?.into_iter();
            let cert = cert_chain.next().ok_or_else(|| {
                Error::builder("at least one certificate must be provided to create an identity")
            })?;
            let chain = cert_chain.collect();
            Ok(Self { pkey, cert, chain })
        }
        #[cfg(all(feature = "rustls-tls", not(feature = "boring-tls")))]
        {
            use std::io::Cursor;
            let mut cert_reader = Cursor::new(buf);
            let certs = rustls_pemfile::certs(&mut cert_reader)
                .collect::<Result<Vec<_>, _>>()
                .map_err(|e| Error::tls(Box::new(e)))?;

            let mut key_reader = Cursor::new(key);
            let key = rustls_pemfile::private_key(&mut key_reader)
                .map_err(|e| Error::tls(Box::new(e)))?
                .ok_or_else(|| Error::builder("no private key found"))?;

            Ok(Self {
                cert: certs,
                key: std::sync::Arc::new(key),
            })
        }
        #[cfg(not(any(
            feature = "boring-tls",
            feature = "openssl-tls",
            feature = "rustls-tls"
        )))]
        {
            Err(Error::tls("TLS not supported"))
        }
    }

    #[cfg(feature = "boring-tls")]
    pub(crate) fn add_to_tls(
        &self,
        connector: &mut boring::ssl::SslConnectorBuilder,
    ) -> crate::Result<()> {
        connector.set_certificate(&self.cert).map_err(Error::tls)?;
        connector.set_private_key(&self.pkey).map_err(Error::tls)?;
        for cert in &self.chain {
            connector
                .add_extra_chain_cert(cert.clone())
                .map_err(Error::tls)?;
        }
        Ok(())
    }

    #[cfg(all(feature = "openssl-tls", not(feature = "boring-tls")))]
    pub(crate) fn add_to_tls(
        &self,
        connector: &mut openssl::ssl::SslConnectorBuilder,
    ) -> crate::Result<()> {
        connector.set_certificate(&self.cert).map_err(Error::tls)?;
        connector.set_private_key(&self.pkey).map_err(Error::tls)?;
        for cert in &self.chain {
            connector
                .add_extra_chain_cert(cert.clone())
                .map_err(Error::tls)?;
        }
        Ok(())
    }
}

#[cfg(all(feature = "rustls-tls", not(feature = "boring-tls")))]
fn identity_from_pkcs12_archive(buf: &[u8], pass: &str) -> crate::Result<Identity> {
    let archive = Pfx::from_der(buf)
        .map_err(|error| pkcs12_tls_error("failed to parse PKCS12 archive", error))?;
    verify_pkcs12_mac(&archive, pass)?;

    let mut cert = Vec::new();
    let mut key = None;

    for safe_bag in pkcs12_safe_contents(&archive, pass)? {
        if let Some(certificate) = pkcs12_certificate(&safe_bag)? {
            cert.push(certificate);
            continue;
        }

        if key.is_none() {
            key = pkcs12_private_key(&safe_bag, pass)?;
        }
    }

    if cert.is_empty() {
        return Err(Error::builder(
            "at least one certificate must be provided to create an identity",
        ));
    }

    let key = key.ok_or_else(|| Error::builder("no private key found"))?;

    Ok(Identity {
        cert,
        key: std::sync::Arc::new(key),
    })
}

#[cfg(all(feature = "rustls-tls", not(feature = "boring-tls")))]
fn verify_pkcs12_mac(archive: &Pfx, pass: &str) -> crate::Result<()> {
    let Some(mac_data) = archive.mac_data.as_ref() else {
        return Ok(());
    };

    let auth_safe = pkcs12_data_content(&archive.auth_safe, "PKCS12 authenticated safe")?;
    let expected = mac_data.mac.digest.as_bytes();
    let actual = pkcs12_mac(
        &mac_data.mac.algorithm.oid,
        pass,
        mac_data.mac_salt.as_bytes(),
        mac_data.iterations,
        &auth_safe,
        expected.len(),
    )?;

    if actual.as_slice() != expected {
        return Err(Error::tls(std::io::Error::new(
            std::io::ErrorKind::PermissionDenied,
            "PKCS12 archive MAC verification failed",
        )));
    }

    Ok(())
}

#[cfg(all(feature = "rustls-tls", not(feature = "boring-tls")))]
fn pkcs12_mac(
    algorithm: &const_oid::ObjectIdentifier,
    pass: &str,
    salt: &[u8],
    iterations: i32,
    data: &[u8],
    output_len: usize,
) -> crate::Result<Vec<u8>> {
    macro_rules! compute_mac {
        ($digest:ty) => {{
            let key = pkcs12::kdf::derive_key_utf8::<$digest>(
                pass,
                salt,
                pkcs12::kdf::Pkcs12KeyType::Mac,
                iterations,
                output_len,
            )
            .map_err(|error| pkcs12_tls_error("failed to derive PKCS12 MAC key", error))?;
            let mut mac = Hmac::<$digest>::new_from_slice(&key)
                .map_err(|error| pkcs12_tls_error("failed to initialize PKCS12 MAC", error))?;
            mac.update(data);
            Ok::<Vec<u8>, crate::Error>(mac.finalize().into_bytes().to_vec())
        }};
    }

    if *algorithm == ID_SHA_1 {
        compute_mac!(Sha1)
    } else if *algorithm == ID_SHA_224 {
        compute_mac!(Sha224)
    } else if *algorithm == ID_SHA_256 {
        compute_mac!(Sha256)
    } else if *algorithm == ID_SHA_384 {
        compute_mac!(Sha384)
    } else if *algorithm == ID_SHA_512 {
        compute_mac!(Sha512)
    } else {
        Err(Error::tls(std::io::Error::new(
            std::io::ErrorKind::InvalidData,
            format!("unsupported PKCS12 MAC algorithm: {algorithm}"),
        )))
    }
}

#[cfg(all(feature = "rustls-tls", not(feature = "boring-tls")))]
fn pkcs12_safe_contents(archive: &Pfx, pass: &str) -> crate::Result<SafeContents> {
    if archive.auth_safe.content_type != ID_DATA {
        return Err(Error::tls(std::io::Error::new(
            std::io::ErrorKind::InvalidData,
            format!(
                "unsupported PKCS12 authenticated safe content type: {}",
                archive.auth_safe.content_type
            ),
        )));
    }

    let auth_safe = pkcs12_data_content(&archive.auth_safe, "PKCS12 authenticated safe")?;
    let content_infos = AuthenticatedSafe::from_der(&auth_safe)
        .map_err(|error| pkcs12_tls_error("failed to decode PKCS12 authenticated safe", error))?;

    let mut safe_bags = Vec::new();

    for content_info in content_infos {
        if content_info.content_type == ID_DATA {
            let plaintext = pkcs12_data_content(&content_info, "PKCS12 safe contents")?;
            safe_bags.extend(SafeContents::from_der(&plaintext).map_err(|error| {
                pkcs12_tls_error("failed to decode PKCS12 safe contents", error)
            })?);
            continue;
        }

        if content_info.content_type == ID_ENCRYPTED_DATA {
            let encrypted_data = pkcs12::cms::encrypted_data::EncryptedData::from_der(
                &content_info.content.to_der().map_err(|error| {
                    pkcs12_tls_error("failed to encode PKCS12 encrypted content", error)
                })?,
            )
            .map_err(|error| {
                pkcs12_tls_error("failed to decode PKCS12 encrypted content", error)
            })?;

            let parameters = encrypted_data
                .enc_content_info
                .content_enc_alg
                .parameters
                .as_ref()
                .ok_or_else(|| {
                    Error::tls(std::io::Error::new(
                        std::io::ErrorKind::InvalidData,
                        "PKCS12 encrypted content is missing algorithm parameters",
                    ))
                })?
                .to_der()
                .map_err(|error| {
                    pkcs12_tls_error(
                        "failed to encode PKCS12 encrypted content parameters",
                        error,
                    )
                })?;
            let params =
                pkcs8::pkcs5::pbes2::Parameters::from_der(&parameters).map_err(|error| {
                    pkcs12_tls_error(
                        "failed to decode PKCS12 encrypted content parameters",
                        error,
                    )
                })?;
            let encrypted_content = encrypted_data
                .enc_content_info
                .encrypted_content
                .clone()
                .ok_or_else(|| {
                    Error::tls(std::io::Error::new(
                        std::io::ErrorKind::InvalidData,
                        "PKCS12 encrypted content is missing ciphertext",
                    ))
                })?;
            let mut ciphertext = encrypted_content.as_bytes().to_vec();
            let plaintext = EncryptionScheme::from(params)
                .decrypt_in_place(pass, &mut ciphertext)
                .map_err(|error| {
                    pkcs12_tls_error("failed to decrypt PKCS12 safe contents", error)
                })?;

            safe_bags.extend(SafeContents::from_der(plaintext).map_err(|error| {
                pkcs12_tls_error("failed to decode decrypted PKCS12 safe contents", error)
            })?);
            continue;
        }

        return Err(Error::tls(std::io::Error::new(
            std::io::ErrorKind::InvalidData,
            format!(
                "unsupported PKCS12 content type: {}",
                content_info.content_type
            ),
        )));
    }

    Ok(safe_bags)
}

#[cfg(all(feature = "rustls-tls", not(feature = "boring-tls")))]
fn pkcs12_data_content(
    content_info: &pkcs12::cms::content_info::ContentInfo,
    context: &'static str,
) -> crate::Result<Vec<u8>> {
    let der = content_info
        .content
        .to_der()
        .map_err(|error| pkcs12_tls_error("failed to encode PKCS12 content", error))?;
    let octets = OctetString::from_der(&der).map_err(|error| pkcs12_tls_error(context, error))?;
    Ok(octets.as_bytes().to_vec())
}

#[cfg(all(feature = "rustls-tls", not(feature = "boring-tls")))]
fn pkcs12_certificate(safe_bag: &SafeBag) -> crate::Result<Option<CertificateDer<'static>>> {
    if safe_bag.bag_id != PKCS_12_CERT_BAG_OID {
        return Ok(None);
    }

    let cert_bag = ContextSpecific::<CertBag>::from_der(&safe_bag.bag_value)
        .map_err(|error| pkcs12_tls_error("failed to decode PKCS12 certificate bag", error))?;

    if cert_bag.value.cert_id != PKCS_12_X509_CERT_OID {
        return Ok(None);
    }

    Ok(Some(CertificateDer::from(
        cert_bag.value.cert_value.as_bytes().to_vec(),
    )))
}

#[cfg(all(feature = "rustls-tls", not(feature = "boring-tls")))]
fn pkcs12_private_key(
    safe_bag: &SafeBag,
    pass: &str,
) -> crate::Result<Option<PrivateKeyDer<'static>>> {
    if safe_bag.bag_id == PKCS_12_PKCS8_KEY_BAG_OID {
        let encrypted_key =
            ContextSpecific::<EncryptedPrivateKeyInfoRef<'_>>::from_der(&safe_bag.bag_value)
                .map_err(|error| {
                    pkcs12_tls_error("failed to decode PKCS12 encrypted key bag", error)
                })?;
        let mut ciphertext = encrypted_key.value.encrypted_data.as_bytes().to_vec();
        let plaintext = encrypted_key
            .value
            .encryption_algorithm
            .decrypt_in_place(pass, &mut ciphertext)
            .map_err(|error| pkcs12_tls_error("failed to decrypt PKCS12 private key", error))?;

        return Ok(Some(PrivateKeyDer::try_from(plaintext.to_vec()).map_err(
            |error| Error::builder(format!("invalid PKCS12 private key: {error}")),
        )?));
    }

    if safe_bag.bag_id == PKCS_12_KEY_BAG_OID {
        let key_bag = ContextSpecific::<PrivateKeyInfo>::from_der(&safe_bag.bag_value)
            .map_err(|error| pkcs12_tls_error("failed to decode PKCS12 key bag", error))?;

        return Ok(Some(
            PrivateKeyDer::try_from(
                key_bag
                    .value
                    .to_der()
                    .map_err(|error| pkcs12_tls_error("failed to encode PKCS12 key bag", error))?,
            )
            .map_err(|error| Error::builder(format!("invalid PKCS12 private key: {error}")))?,
        ));
    }

    Ok(None)
}

#[cfg(all(feature = "rustls-tls", not(feature = "boring-tls")))]
fn pkcs12_tls_error(context: &'static str, error: impl std::fmt::Display) -> Error {
    Error::tls(std::io::Error::new(
        std::io::ErrorKind::InvalidData,
        format!("{context}: {error}"),
    ))
}

#[cfg(any(feature = "boring-tls", feature = "openssl-tls"))]
fn extract_private_key_pem(buf: &[u8]) -> Option<&[u8]> {
    const KEY_MARKERS: [(&[u8], &[u8]); 3] = [
        (b"-----BEGIN PRIVATE KEY-----", b"-----END PRIVATE KEY-----"),
        (
            b"-----BEGIN RSA PRIVATE KEY-----",
            b"-----END RSA PRIVATE KEY-----",
        ),
        (
            b"-----BEGIN EC PRIVATE KEY-----",
            b"-----END EC PRIVATE KEY-----",
        ),
    ];

    KEY_MARKERS
        .iter()
        .find_map(|(begin, end)| extract_pem_block(buf, begin, end))
}

#[cfg(any(feature = "boring-tls", feature = "openssl-tls"))]
fn extract_certificate_pems(buf: &[u8]) -> Vec<&[u8]> {
    extract_all_pem_blocks(
        buf,
        b"-----BEGIN CERTIFICATE-----",
        b"-----END CERTIFICATE-----",
    )
}

#[cfg(any(feature = "boring-tls", feature = "openssl-tls"))]
fn extract_pem_block<'a>(buf: &'a [u8], begin: &[u8], end: &[u8]) -> Option<&'a [u8]> {
    let start = find_subsequence(buf, begin)?;
    let end_start = start + find_subsequence(&buf[start..], end)?;
    let mut end_idx = end_start + end.len();

    if buf.get(end_idx) == Some(&b'\r') {
        end_idx += 1;
    }
    if buf.get(end_idx) == Some(&b'\n') {
        end_idx += 1;
    }

    Some(&buf[start..end_idx])
}

#[cfg(any(feature = "boring-tls", feature = "openssl-tls"))]
fn extract_all_pem_blocks<'a>(mut buf: &'a [u8], begin: &[u8], end: &[u8]) -> Vec<&'a [u8]> {
    let mut blocks = Vec::new();

    while let Some(start) = find_subsequence(buf, begin) {
        let remainder = &buf[start..];
        let Some(block) = extract_pem_block(remainder, begin, end) else {
            break;
        };
        blocks.push(block);
        buf = &remainder[block.len()..];
    }

    blocks
}

#[cfg(any(feature = "boring-tls", feature = "openssl-tls"))]
fn find_subsequence(haystack: &[u8], needle: &[u8]) -> Option<usize> {
    haystack
        .windows(needle.len())
        .position(|window| window == needle)
}

/// Extracts and decodes a private key from a PEM bundle for the rustls backend.
///
/// Unlike `rustls_pemfile::private_key` (which only inspects the first PEM
/// section and therefore cannot find a key that follows a certificate in a
/// combined bundle), this scans the raw text for any private-key PEM block and
/// decodes it with `rustls_pemfile::private_key`.
#[cfg(all(feature = "rustls-tls", not(feature = "boring-tls")))]
fn extract_private_key_der(pem_text: &str) -> Option<PrivateKeyDer<'static>> {
    const KEY_MARKERS: [&str; 3] = [
        "-----BEGIN PRIVATE KEY-----",
        "-----BEGIN RSA PRIVATE KEY-----",
        "-----BEGIN EC PRIVATE KEY-----",
    ];

    for marker in KEY_MARKERS {
        // Each marker type must be tried independently: a bundle may contain a
        // PKCS#1 RSA/EC key but no PKCS#8 `PRIVATE KEY` block, so a missing
        // marker is not fatal — continue scanning the next format.
        let Some(start) = pem_text.find(marker) else {
            continue;
        };
        let body = &pem_text[start..];
        let end_marker = match marker {
            "-----BEGIN PRIVATE KEY-----" => "-----END PRIVATE KEY-----",
            "-----BEGIN RSA PRIVATE KEY-----" => "-----END RSA PRIVATE KEY-----",
            _ => "-----END EC PRIVATE KEY-----",
        };
        let Some(end_rel) = body.find(end_marker) else {
            continue;
        };
        let end = start + end_rel + end_marker.len();
        let block: &str = &pem_text[start..end];
        let block_bytes = block.as_bytes();
        if let Ok(Some(key)) = rustls_pemfile::private_key(&mut std::io::Cursor::new(block_bytes)) {
            return Some(key);
        }
    }

    None
}

#[cfg(test)]
mod test {
    #[cfg(any(
        feature = "boring-tls",
        feature = "openssl-tls",
        feature = "rustls-tls"
    ))]
    use base64_simd::STANDARD;

    use super::Identity;

    #[cfg(any(
        feature = "boring-tls",
        feature = "openssl-tls",
        feature = "rustls-tls"
    ))]
    const CLIENT_CERT_PEM: &[u8] = include_bytes!(concat!(
        env!("CARGO_MANIFEST_DIR"),
        "/tests/support/mtls/client.crt"
    ));
    #[cfg(any(
        feature = "boring-tls",
        feature = "openssl-tls",
        feature = "rustls-tls"
    ))]
    const CLIENT_KEY_PEM: &[u8] = include_bytes!(concat!(
        env!("CARGO_MANIFEST_DIR"),
        "/tests/support/mtls/client.key"
    ));
    #[cfg(any(
        feature = "boring-tls",
        feature = "openssl-tls",
        feature = "rustls-tls"
    ))]
    const CLIENT_PKCS12_DER_B64: &str = include_str!(concat!(
        env!("CARGO_MANIFEST_DIR"),
        "/tests/support/mtls/client.p12.b64"
    ));
    /// RSA private key in legacy PKCS#1 format (`-----BEGIN RSA PRIVATE KEY-----`),
    /// used to verify `extract_private_key_der` scans every key format instead of
    /// bailing out when a PKCS#8 block is absent.
    ///
    /// Only the rustls backend exercises `extract_private_key_der`, so these
    /// fixtures are gated to the same configuration as their tests.
    #[cfg(all(feature = "rustls-tls", not(feature = "boring-tls")))]
    const RSA_PKCS1_CLIENT_KEY_PEM: &[u8] = include_bytes!(concat!(
        env!("CARGO_MANIFEST_DIR"),
        "/tests/support/mtls/rsa_pkcs1_client.key"
    ));
    /// Self-signed certificate paired with `RSA_PKCS1_CLIENT_KEY_PEM`.
    #[cfg(all(feature = "rustls-tls", not(feature = "boring-tls")))]
    const RSA_CLIENT_CERT_PEM: &[u8] = include_bytes!(concat!(
        env!("CARGO_MANIFEST_DIR"),
        "/tests/support/mtls/rsa_client.crt"
    ));

    #[test]
    fn identity_from_pkcs12_der_invalid() {
        Identity::from_pkcs12_der(b"not der", "nope").unwrap_err();
    }

    #[test]
    fn identity_from_pkcs8_pem_invalid() {
        Identity::from_pkcs8_pem(b"not pem", b"not key").unwrap_err();
    }

    #[test]
    fn identity_from_pem_invalid() {
        Identity::from_pem(b"not pem").unwrap_err();
    }

    #[cfg(any(
        feature = "boring-tls",
        feature = "openssl-tls",
        feature = "rustls-tls"
    ))]
    #[test]
    fn identity_from_pem_combined_bundle() {
        let mut pem = CLIENT_CERT_PEM.to_vec();
        pem.extend_from_slice(CLIENT_KEY_PEM);

        Identity::from_pem(&pem).unwrap();
    }

    /// Regression test for `extract_private_key_der`: a combined bundle whose
    /// private key is in legacy PKCS#1 format (no PKCS#8 `PRIVATE KEY` block)
    /// must still parse. Previously the scan aborted after the first missing
    /// marker and never tried the RSA marker.
    #[cfg(all(feature = "rustls-tls", not(feature = "boring-tls")))]
    #[test]
    fn identity_from_pem_combined_rsa_pkcs1_bundle() {
        let mut pem = RSA_CLIENT_CERT_PEM.to_vec();
        pem.extend_from_slice(RSA_PKCS1_CLIENT_KEY_PEM);

        let identity = Identity::from_pem(&pem).expect("combined PKCS#1 bundle must parse");
        assert_eq!(identity.cert.len(), 1);
    }

    /// Direct unit test of `extract_private_key_der` covering every supported
    /// marker: PKCS#8, PKCS#1 RSA, and PKCS#1 EC. Each format must be located
    /// even when the others are absent from the input.
    #[cfg(all(feature = "rustls-tls", not(feature = "boring-tls")))]
    #[test]
    fn extract_private_key_der_scans_all_markers() {
        use super::extract_private_key_der;

        // PKCS#8 (PKCS8v2 / "PRIVATE KEY")
        let pkcs8 = CLIENT_KEY_PEM;
        let text = std::str::from_utf8(pkcs8).unwrap();
        assert!(
            extract_private_key_der(text).is_some(),
            "PKCS#8 marker must be found"
        );

        // PKCS#1 RSA
        let rsa = RSA_PKCS1_CLIENT_KEY_PEM;
        let text = std::str::from_utf8(rsa).unwrap();
        assert!(
            extract_private_key_der(text).is_some(),
            "PKCS#1 RSA marker must be found"
        );

        // The EC marker is exercised by scanning a PKCS#1 RSA bundle that does
        // NOT contain a PKCS#8 block, which previously returned None early.
        let mut bundle = RSA_CLIENT_CERT_PEM.to_vec();
        bundle.extend_from_slice(rsa);
        let text = std::str::from_utf8(&bundle).unwrap();
        assert!(
            extract_private_key_der(text).is_some(),
            "combined bundle without PKCS#8 block must still yield a key"
        );
    }

    #[cfg(any(
        feature = "boring-tls",
        feature = "openssl-tls",
        feature = "rustls-tls"
    ))]
    #[test]
    fn identity_from_pkcs12_der_bundle() {
        let pkcs12 = STANDARD
            .decode_to_vec(CLIENT_PKCS12_DER_B64.trim().as_bytes())
            .unwrap();

        Identity::from_pkcs12_der(&pkcs12, "changeit").unwrap();
    }
}