nono-proxy 0.60.0

Network filtering proxy for the nono sandbox
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
//! Ephemeral, per-session CA used to sign minted leaf certificates.
//!
//! The CA exists only for the lifetime of one proxy session. Its private key
//! is held in `Zeroizing<Vec<u8>>` and destroyed via `Drop`; only the public
//! certificate is written to disk (and only by the caller — this module just
//! produces the PEM bytes).
//!
//! ## Properties
//!
//! * Algorithm: ECDSA P-256 (matches the rustls/ring stack already in use)
//! * Validity: 24 hours from generation. Long enough to outlive any plausible
//!   `nono` invocation; short enough that a leaked cert file becomes useless
//!   quickly.
//! * Subject: `CN=nono-session-ca`
//! * Basic constraints: `CA:TRUE`
//! * No CRL/OCSP — meaningless for an ephemeral, local-only CA.
//!
//! ## Security
//!
//! `EphemeralCa` deliberately holds the raw key as `Zeroizing<Vec<u8>>` *and*
//! the parsed `KeyPair`. The parsed form is what `rcgen` needs to sign leaves;
//! the byte form is what `Drop` zeroizes. We accept the redundancy because
//! `rcgen::KeyPair` does not expose its internal byte buffer to us.

use crate::error::{ProxyError, Result};
use rcgen::{
    BasicConstraints, CertificateParams, DistinguishedName, DnType, IsCa, Issuer, KeyPair,
    KeyUsagePurpose, PKCS_ECDSA_P256_SHA256,
};
use rustls::pki_types::PrivatePkcs8KeyDer;
use rustls::pki_types::pem::PemObject;
use std::time::{Duration, SystemTime};
use time::OffsetDateTime;
use zeroize::Zeroizing;

/// Default validity window for the ephemeral CA (1 day). Long enough to cover
/// any plausible session, short enough to limit blast radius if the cert file leaks.
pub const CA_VALIDITY_DEFAULT: Duration = Duration::from_secs(24 * 60 * 60);

/// Ephemeral CA used to sign per-hostname leaf certificates for TLS interception.
///
/// `Drop` zeroizes the private key bytes. The public certificate is exposed
/// via [`EphemeralCa::cert_pem`] for inclusion in the trust bundle written
/// for the sandboxed child.
pub struct EphemeralCa {
    /// Raw PKCS#8 DER bytes of the CA private key. Zeroized on `Drop`.
    /// Exposed via [`Self::key_der`] for persistence to macOS Keychain.
    key_pkcs8_der: Zeroizing<Vec<u8>>,
    /// Issuer for signing minted leaf certificates (owns CA params and key pair).
    issuer: Issuer<'static, KeyPair>,
    /// Authoritative DER bytes of the CA certificate, used in TLS chains.
    /// In `generate()` this comes from the self-signed cert. In `from_existing()`
    /// this is the original cert DER (not the re-signed reconstruction), ensuring
    /// the chain cert matches what's in the trust store.
    cert_der: Vec<u8>,
    /// Cached PEM encoding of the public certificate.
    cert_pem: String,
    /// CA certificate expiry. Leaf certificates are minted with this same
    /// `not_after` so they never outlive the issuer.
    not_after: SystemTime,
}

impl EphemeralCa {
    /// Reconstruct a CA from previously persisted key material.
    ///
    /// Used by `--trust-proxy-ca` to reuse a CA across sessions: the CLI
    /// loads the key and cert from macOS Keychain and passes them here so the
    /// proxy can sign leaves with the same CA that's already trusted in the
    /// user's system trust store.
    ///
    /// The re-signed `ca_cert` may differ in serial/timestamps from the
    /// original PEM — that's expected. We keep the original `cert_pem` and
    /// `cert_der` for the trust bundle and TLS chain; `ca_cert` is only used
    /// as rcgen's issuer type for `signed_by()`.
    pub fn from_existing(key_der: &[u8], cert_pem: &str) -> Result<Self> {
        let pkcs8 = PrivatePkcs8KeyDer::from(key_der);
        let key_pair = KeyPair::from_der_and_sign_algo(&pkcs8.into(), &PKCS_ECDSA_P256_SHA256)
            .map_err(|e| {
                ProxyError::Config(format!(
                    "failed to load CA key from persisted material: {e}"
                ))
            })?;
        let key_pkcs8_der = Zeroizing::new(key_der.to_vec());

        let cert_der = rustls::pki_types::CertificateDer::from_pem_slice(cert_pem.as_bytes())
            .map_err(|e| {
                ProxyError::Config(format!(
                    "failed to decode persisted CA cert PEM to DER: {e}"
                ))
            })?
            .to_vec();

        // Validate that the loaded key actually matches the cert's public key.
        // Without this, a corrupted Keychain (e.g. from a concurrent write race)
        // would silently produce a CA whose chain cert doesn't match its signing
        // key, causing TLS handshake failures.
        validate_key_cert_binding(&key_pair, &cert_der)?;

        let not_after = extract_not_after_from_der(&cert_der)?;
        let issuer = Issuer::from_ca_cert_pem(cert_pem, key_pair).map_err(|e| {
            ProxyError::Config(format!(
                "failed to reconstruct issuer from persisted material: {e}"
            ))
        })?;

        Ok(Self {
            key_pkcs8_der,
            issuer,
            cert_der,
            cert_pem: cert_pem.to_string(),
            not_after,
        })
    }

    /// Generate a fresh ephemeral CA with the default session CN and validity.
    ///
    /// All material is created in-memory; nothing is persisted.
    pub fn generate() -> Result<Self> {
        Self::generate_with_cn("nono-session-ca", CA_VALIDITY_DEFAULT)
    }

    /// Generate a fresh CA with a custom Common Name and validity duration.
    ///
    /// Used by `--trust-proxy-ca` to create a CA with `CN=nono-proxy-ca` so
    /// it appears with a recognizable name in macOS Keychain and trust store.
    pub fn generate_with_cn(cn: &str, validity: Duration) -> Result<Self> {
        let key_pair = KeyPair::generate_for(&PKCS_ECDSA_P256_SHA256).map_err(|e| {
            ProxyError::Config(format!("failed to generate ephemeral CA key pair: {}", e))
        })?;
        let key_pkcs8_der = Zeroizing::new(key_pair.serialize_der());

        let mut params = CertificateParams::default();
        params.is_ca = IsCa::Ca(BasicConstraints::Unconstrained);
        params.key_usages = vec![
            KeyUsagePurpose::KeyCertSign,
            KeyUsagePurpose::CrlSign,
            KeyUsagePurpose::DigitalSignature,
        ];

        let now = SystemTime::now();
        let not_after = now + validity;
        params.not_before = system_time_to_offset(now)?;
        params.not_after = system_time_to_offset(not_after)?;

        let mut dn = DistinguishedName::new();
        dn.push(DnType::CommonName, cn);
        params.distinguished_name = dn;

        let self_signed = params
            .self_signed(&key_pair)
            .map_err(|e| ProxyError::Config(format!("failed to self-sign ephemeral CA: {}", e)))?;
        let cert_pem = self_signed.pem();
        let cert_der = self_signed.der().to_vec();
        let issuer = Issuer::new(params, key_pair);

        Ok(Self {
            key_pkcs8_der,
            issuer,
            cert_der,
            cert_pem,
            not_after,
        })
    }

    /// Public certificate PEM for inclusion in the trust bundle.
    #[must_use]
    pub fn cert_pem(&self) -> &str {
        &self.cert_pem
    }

    /// PKCS#8 DER-encoded private key bytes for external persistence.
    ///
    /// Used by `--trust-proxy-ca` to store the CA key in macOS Keychain so it
    /// can be reused across sessions via [`Self::from_existing`].
    #[must_use]
    pub fn key_der(&self) -> &[u8] {
        &self.key_pkcs8_der
    }

    /// PKCS#8 PEM-encoded private key for combined storage. Zeroized on drop.
    #[must_use]
    pub fn key_pem(&self) -> Zeroizing<String> {
        use base64::Engine;
        use zeroize::Zeroize;
        let mut encoded = base64::engine::general_purpose::STANDARD.encode(&*self.key_pkcs8_der);
        let mut pem = String::with_capacity(encoded.len() + 64);
        pem.push_str("-----BEGIN PRIVATE KEY-----\n");
        for chunk in encoded.as_bytes().chunks(64) {
            pem.push_str(std::str::from_utf8(chunk).unwrap_or_default());
            pem.push('\n');
        }
        pem.push_str("-----END PRIVATE KEY-----\n");
        encoded.zeroize();
        Zeroizing::new(pem)
    }

    /// Authoritative DER bytes of the CA certificate for TLS chains.
    ///
    /// In `from_existing()` this is the original cert (matching the trust
    /// store), not the re-signed reconstruction.
    #[must_use]
    pub(super) fn cert_der(&self) -> &[u8] {
        &self.cert_der
    }

    /// Issuer used by [`super::cert_cache`] to sign minted leaf certificates.
    pub(super) fn issuer(&self) -> &Issuer<'static, KeyPair> {
        &self.issuer
    }

    /// CA certificate expiry time. Leaf certs are minted with this same
    /// `not_after` so they never outlive the issuer.
    pub(super) fn not_after(&self) -> SystemTime {
        self.not_after
    }
}

impl std::fmt::Debug for EphemeralCa {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("EphemeralCa")
            .field("subject", &"CN=nono-session-ca")
            .field("issuer", &"[REDACTED]")
            .field("key_pkcs8_der", &"[REDACTED]")
            .field("cert_pem_len", &self.cert_pem.len())
            .finish()
    }
}

// `Zeroizing<Vec<u8>>` already zeroes on drop — explicit `Drop` isn't strictly
// necessary, but keep the field for clarity and compile-time enforcement that
// the byte buffer travels with the struct.

/// Verify that the key pair's public key matches the SubjectPublicKeyInfo
/// embedded in the certificate DER.
fn validate_key_cert_binding(key_pair: &KeyPair, cert_der: &[u8]) -> Result<()> {
    use x509_parser::prelude::FromDer;

    let (_, cert) = x509_parser::certificate::X509Certificate::from_der(cert_der).map_err(|e| {
        ProxyError::Config(format!("failed to parse cert DER for key binding: {e}"))
    })?;

    let cert_pubkey_raw = &cert.public_key().subject_public_key.data;
    let key_pubkey_raw = key_pair.public_key_raw();

    if &**cert_pubkey_raw != key_pubkey_raw {
        return Err(ProxyError::Config(
            "persisted CA key does not match cert public key (Keychain corruption?)".to_string(),
        ));
    }
    Ok(())
}

/// Extract the `not_after` timestamp from a DER-encoded X.509 certificate.
fn extract_not_after_from_der(cert_der: &[u8]) -> Result<SystemTime> {
    use x509_parser::prelude::FromDer;

    let (_, cert) = x509_parser::certificate::X509Certificate::from_der(cert_der).map_err(|e| {
        ProxyError::Config(format!(
            "failed to parse cert DER for not_after extraction: {e}"
        ))
    })?;
    let not_after_epoch = cert.validity().not_after.timestamp();
    let secs = u64::try_from(not_after_epoch).map_err(|_| {
        ProxyError::Config(format!(
            "CA certificate not_after is before Unix epoch (timestamp={not_after_epoch})"
        ))
    })?;
    let not_after = SystemTime::UNIX_EPOCH + Duration::from_secs(secs);
    Ok(not_after)
}

/// Split a combined PEM bundle (PKCS#8 key + certificate) into DER key bytes
/// and certificate PEM. The key material is returned in `Zeroizing` for safe
/// memory handling.
pub fn split_key_cert_pem(combined: &str) -> Result<(Zeroizing<Vec<u8>>, String)> {
    use base64::Engine;
    use zeroize::Zeroize;

    const BEGIN_KEY: &str = "-----BEGIN PRIVATE KEY-----";
    const END_KEY: &str = "-----END PRIVATE KEY-----";

    let key_start = combined
        .find(BEGIN_KEY)
        .ok_or_else(|| ProxyError::Config("CA bundle missing PRIVATE KEY block".to_string()))?;
    let key_end = combined
        .find(END_KEY)
        .ok_or_else(|| ProxyError::Config("CA bundle missing END PRIVATE KEY".to_string()))?;

    let b64_start = key_start + BEGIN_KEY.len();
    let mut b64 = combined[b64_start..key_end].replace(['\n', '\r', ' '], "");
    let key_der = Zeroizing::new(
        base64::engine::general_purpose::STANDARD
            .decode(&b64)
            .map_err(|e| ProxyError::Config(format!("CA key base64 invalid: {e}")))?,
    );
    b64.zeroize();

    let cert_pem = combined[key_end + END_KEY.len()..].trim_start().to_string();
    if cert_pem.is_empty() {
        return Err(ProxyError::Config(
            "CA bundle missing certificate PEM".to_string(),
        ));
    }

    Ok((key_der, cert_pem))
}

/// Convert `SystemTime` to the `time::OffsetDateTime` that `rcgen` expects.
fn system_time_to_offset(t: SystemTime) -> Result<OffsetDateTime> {
    OffsetDateTime::from_unix_timestamp(
        t.duration_since(SystemTime::UNIX_EPOCH)
            .map_err(|e| ProxyError::Config(format!("system time before unix epoch: {}", e)))?
            .as_secs()
            .try_into()
            .map_err(|_| ProxyError::Config("system time exceeds i64::MAX".to_string()))?,
    )
    .map_err(|e| ProxyError::Config(format!("invalid system time for cert validity: {}", e)))
}

#[cfg(test)]
#[allow(clippy::unwrap_used)]
mod tests {
    use super::*;
    use rustls::pki_types::CertificateDer;
    use rustls::pki_types::pem::PemObject;

    #[test]
    fn generate_produces_valid_pem() {
        let ca = EphemeralCa::generate().unwrap();
        assert!(ca.cert_pem().contains("BEGIN CERTIFICATE"));
        assert!(ca.cert_pem().contains("END CERTIFICATE"));

        // Round-trip through rustls' PEM parser to confirm the output is a
        // syntactically valid X.509 certificate.
        let der = CertificateDer::from_pem_slice(ca.cert_pem().as_bytes()).unwrap();
        assert!(!der.as_ref().is_empty());
    }

    #[test]
    fn each_call_produces_distinct_keys() {
        let a = EphemeralCa::generate().unwrap();
        let b = EphemeralCa::generate().unwrap();
        assert_ne!(
            a.cert_pem(),
            b.cert_pem(),
            "ephemeral CAs must not reuse key material across sessions"
        );
    }

    #[test]
    fn debug_redacts_key_material() {
        let ca = EphemeralCa::generate().unwrap();
        let dbg = format!("{:?}", ca);
        assert!(dbg.contains("[REDACTED]"));
        assert!(!dbg.contains("BEGIN PRIVATE KEY"));
    }

    #[test]
    fn from_existing_roundtrips_key_material() {
        let original = EphemeralCa::generate().unwrap();
        let key_der = original.key_der().to_vec();
        let cert_pem = original.cert_pem().to_string();

        let reconstructed = EphemeralCa::from_existing(&key_der, &cert_pem).unwrap();
        assert_eq!(reconstructed.cert_pem(), cert_pem);
    }

    #[test]
    fn from_existing_can_sign_leaves() {
        use crate::tls_intercept::CertCache;
        use std::sync::Arc;

        let original = EphemeralCa::generate().unwrap();
        let key_der = original.key_der().to_vec();
        let cert_pem = original.cert_pem().to_string();

        let ca = EphemeralCa::from_existing(&key_der, &cert_pem).unwrap();
        let cache = CertCache::new(Arc::new(ca));
        let leaf = cache.get_or_mint("api.github.com").unwrap();
        assert_eq!(leaf.cert.len(), 2);
        assert!(!leaf.cert[0].as_ref().is_empty());
    }

    #[test]
    fn from_existing_preserves_original_cert_der() {
        let original = EphemeralCa::generate().unwrap();
        let key_der = original.key_der().to_vec();
        let cert_pem = original.cert_pem().to_string();
        let original_der = CertificateDer::from_pem_slice(cert_pem.as_bytes()).unwrap();

        let reconstructed = EphemeralCa::from_existing(&key_der, &cert_pem).unwrap();
        assert_eq!(
            reconstructed.cert_der(),
            original_der.as_ref(),
            "cert_der() must return the original cert DER, not the re-signed reconstruction"
        );
    }

    #[test]
    fn from_existing_rejects_mismatched_key_cert() {
        let a = EphemeralCa::generate().unwrap();
        let b = EphemeralCa::generate().unwrap();
        let result = EphemeralCa::from_existing(a.key_der(), b.cert_pem());
        assert!(result.is_err());
        let msg = result.unwrap_err().to_string();
        assert!(
            msg.contains("does not match"),
            "expected key binding error, got: {msg}"
        );
    }

    #[test]
    fn from_existing_rejects_garbage_key() {
        let garbage = vec![0u8; 64];
        assert!(
            EphemeralCa::from_existing(
                &garbage,
                "-----BEGIN CERTIFICATE-----\nfoo\n-----END CERTIFICATE-----"
            )
            .is_err()
        );
    }

    #[test]
    fn key_pem_roundtrips_to_der() {
        use base64::Engine;

        let ca = EphemeralCa::generate().unwrap();
        let pem = ca.key_pem();

        let b64: String = pem.lines().filter(|l| !l.starts_with("-----")).collect();
        let decoded = base64::engine::general_purpose::STANDARD
            .decode(b64)
            .unwrap();
        assert_eq!(decoded, ca.key_der());
    }

    #[test]
    fn split_key_cert_pem_roundtrips() {
        let ca = EphemeralCa::generate_with_cn("nono-proxy-ca", CA_VALIDITY_DEFAULT).unwrap();
        let combined = format!("{}{}", &*ca.key_pem(), ca.cert_pem());

        let (key_der, cert_pem) = split_key_cert_pem(&combined).unwrap();
        assert_eq!(&*key_der, ca.key_der());
        assert_eq!(cert_pem, ca.cert_pem());
    }

    #[test]
    fn split_key_cert_pem_rejects_missing_key() {
        let ca = EphemeralCa::generate().unwrap();
        assert!(split_key_cert_pem(ca.cert_pem()).is_err());
    }

    #[test]
    fn split_key_cert_pem_rejects_missing_cert() {
        let ca = EphemeralCa::generate().unwrap();
        assert!(split_key_cert_pem(&ca.key_pem()).is_err());
    }
}