koi-certmesh 0.5.1

Zero-config private CA, certificate enrollment, and mesh trust for the local network
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
//! Enrollment flow logic.
//!
//! Processes join requests: verifies auth (TOTP), issues certificate,
//! adds member to roster, writes cert files, appends audit log.

use chrono::{Duration, Utc};
use koi_crypto::auth::{AuthChallenge, AuthState};
use koi_crypto::totp::RateLimiter;

use crate::audit;
use crate::ca::{self, CaState, IssuedCert};
use crate::error::CertmeshError;
use crate::protocol::{JoinRequest, JoinResponse};
use crate::roster::{MemberRole, MemberStatus, Roster, RosterMember};

/// Process an enrollment request from a joining member.
///
/// 1. Check enrollment is open
/// 2. Verify the join credential (invite token OR TOTP)
/// 3. Reject revoked members
/// 4. Check not already enrolled
/// 5. Approval (handled by caller)
/// 6. Issue certificate
/// 7. Write cert files
/// 8. Add to roster
/// 9. Audit log
#[allow(clippy::too_many_arguments)]
pub fn process_enrollment(
    ca: &CaState,
    roster: &mut Roster,
    auth_state: Option<&AuthState>,
    challenge: &AuthChallenge,
    rate_limiter: &mut RateLimiter,
    request: &JoinRequest,
    hostname: &str,
    sans: &[String],
    approved_by: Option<String>,
    paths: &crate::CertmeshPaths,
) -> Result<(JoinResponse, IssuedCert), CertmeshError> {
    // Every denial below is audited *before* the error is returned (ADR-017
    // F9/F14): a refused enrollment leaves a trail even though the roster is not
    // mutated. `audit_denied` is a best-effort append (its own error is swallowed).
    let audit_denied = |event: &str| {
        let _ = audit::append_entry_to(
            &paths.audit_log_path(),
            event,
            &[("hostname", hostname), ("result", "denied")],
        );
    };

    // 1. Check enrollment is open
    if !roster.is_enrollment_open() {
        audit_denied("enroll_closed");
        return Err(CertmeshError::EnrollmentClosed);
    }

    // 2. Verify the join credential. Two mutually exclusive paths (ADR-015 F2):
    //
    //    - invite_token: per-host, single-use, hostname-bound — the automatable
    //      path. The token IS the credential; it does not depend on the
    //      enrollment auth credential being loaded in memory. Single-use is
    //      enforced by burning the token on a successful match.
    //    - auth (TOTP): the interactive mesh-wide enrollment secret, rate-limited.
    //
    // The posture booleans (`enrollment_open` above, `requires_approval` at
    // step 5) gate both paths identically — the invite only swaps the credential.
    if let Some(token) = request.invite_token.as_deref() {
        if !crate::invite::verify_and_consume(&paths.invites_path(), token, hostname) {
            // verify_and_consume folds invalid / expired / reused / wrong-host into
            // one fail-closed false, so a single event covers the token rejection.
            audit_denied("enroll_token_invalid");
            return Err(CertmeshError::InvalidAuth);
        }
    } else {
        let auth = match request.auth.as_ref() {
            Some(a) => a,
            None => {
                audit_denied("enroll_auth_missing");
                return Err(CertmeshError::InvalidAuth);
            }
        };
        let auth_state = match auth_state {
            Some(s) => s,
            None => {
                audit_denied("enroll_ca_locked");
                return Err(CertmeshError::CaLocked);
            }
        };
        let adapter = koi_crypto::auth::adapter_for(auth_state);
        let valid = adapter.verify(auth_state, challenge, auth).unwrap_or(false);

        match rate_limiter.check_and_record(valid) {
            Ok(()) => {} // Valid, proceed
            Err(koi_crypto::totp::RateLimitError::LockedOut { remaining_secs }) => {
                audit_denied("enroll_rate_limited");
                return Err(CertmeshError::RateLimited { remaining_secs });
            }
            Err(koi_crypto::totp::RateLimitError::InvalidCode { .. }) => {
                audit_denied("enroll_auth_failed");
                return Err(CertmeshError::InvalidAuth);
            }
        }
    }

    // 3. Reject revoked members
    if roster.is_revoked(hostname) {
        audit_denied("enroll_revoked_attempt");
        return Err(CertmeshError::Revoked(hostname.to_string()));
    }

    // 4. Check not already enrolled
    if roster.is_enrolled(hostname) {
        audit_denied("enroll_already_enrolled");
        return Err(CertmeshError::AlreadyEnrolled(hostname.to_string()));
    }

    // 5. Approval handled by caller when required
    if roster.requires_approval() && approved_by.as_deref().unwrap_or("").is_empty() {
        audit_denied("enroll_approval_denied");
        return Err(CertmeshError::ApprovalDenied);
    }

    // 6. Sign the member's CSR (ADR-015 F1). The member generated its own keypair
    //    and sent ONLY this CSR; the CA signs a leaf and never sees the private
    //    key. Remote enrollment REQUIRES a CSR — the CA refuses to generate and
    //    ship member keys (the key-custody fault this fixes).
    let csr_pem = match request.csr.as_deref() {
        Some(csr) => csr,
        None => {
            audit_denied("enroll_no_csr");
            return Err(CertmeshError::InvalidPayload(
                "a CSR is required to enroll; the CA does not generate member keys".to_string(),
            ));
        }
    };
    // Leaf lifetime is the CA-held policy (ADR-017), not a hardcoded constant.
    let lifetime_days = roster.metadata.policy.leaf_lifetime_days;
    let leaf_pem = crate::csr::sign_csr(ca, csr_pem, sans, lifetime_days)?;

    // Fingerprint + expiry derived from the issued leaf. The member persists its
    // own cert files locally; the CA records membership only (no cert_path here).
    let leaf_der = pem::parse(&leaf_pem)
        .map_err(|e| CertmeshError::Certificate(format!("issued leaf parse: {e}")))?;
    let fingerprint = koi_crypto::pinning::fingerprint_sha256(leaf_der.contents());
    let expires = Utc::now() + Duration::days(i64::from(lifetime_days));

    // 7. Add to roster (cert_path empty — the member holds the files, not the CA).
    let is_primary = roster.members.is_empty();
    let role = if is_primary {
        MemberRole::Primary
    } else {
        MemberRole::Member
    };
    let role_str = if is_primary { "primary" } else { "member" };

    let ca_fp = ca::ca_fingerprint(ca);
    let member = RosterMember {
        hostname: hostname.to_string(),
        role,
        enrolled_at: Utc::now(),
        enrolled_by: approved_by
            .clone()
            .or_else(|| roster.metadata.operator.clone()),
        cert_fingerprint: fingerprint.clone(),
        cert_expires: expires,
        cert_sans: sans.to_vec(),
        cert_path: String::new(),
        status: MemberStatus::Active,
        reload_hook: None,
        last_seen: Some(Utc::now()),
        pinned_ca_fingerprint: Some(ca_fp),
        proxy_entries: Vec::new(),
    };
    roster.members.push(member);

    // 9. Audit log
    let operator_str = approved_by
        .as_deref()
        .or(roster.metadata.operator.as_deref())
        .unwrap_or("self");
    let _ = audit::append_entry_to(
        &paths.audit_log_path(),
        "member_joined",
        &[
            ("hostname", hostname),
            ("fingerprint", &fingerprint),
            ("role", role_str),
            ("approved_by", operator_str),
        ],
    );

    let ca_fingerprint = ca::ca_fingerprint(ca);
    let ca_pem = ca.cert_pem.clone();
    let fullchain_pem = format!("{leaf_pem}{ca_pem}");

    let response = JoinResponse {
        hostname: hostname.to_string(),
        ca_cert: ca_pem.clone(),
        service_cert: leaf_pem.clone(),
        // CSR flow: the CA has no member key to return — the member kept it.
        service_key: String::new(),
        ca_fingerprint,
        cert_path: String::new(),
        // The member persists this to drive its pull-renewal loop (ADR-017 F6).
        policy: roster.metadata.policy.clone(),
    };

    let issued = IssuedCert {
        cert_pem: leaf_pem,
        key_pem: String::new(),
        ca_pem,
        fullchain_pem,
        fingerprint,
        expires,
    };

    Ok((response, issued))
}

#[cfg(test)]
mod tests {
    use super::*;
    use koi_crypto::totp;

    // Posture booleans for the named presets (UX labels only).
    const JUST_ME: (bool, bool) = (true, false);
    const MY_ORG: (bool, bool) = (false, true);

    fn test_paths() -> crate::CertmeshPaths {
        crate::CertmeshPaths::with_data_dir(koi_common::test::ensure_data_dir(
            "koi-certmesh-enrollment-tests",
        ))
    }

    /// A per-test data dir so invite-store / cert-file state never races with
    /// other parallel tests sharing the suite-wide `test_paths()`.
    fn unique_test_paths(name: &str) -> crate::CertmeshPaths {
        crate::CertmeshPaths::with_data_dir(
            koi_common::test::ensure_data_dir("koi-certmesh-enrollment-tests").join(name),
        )
    }

    fn make_test_ca() -> CaState {
        ca::create_ca("test-pass", &[42u8; 32], &test_paths())
            .unwrap()
            .0
    }

    fn make_auth_and_code(
        secret: &totp::TotpSecret,
        valid: bool,
    ) -> (AuthState, AuthChallenge, koi_crypto::auth::AuthResponse) {
        let state = AuthState::Totp(totp::TotpSecret::from_bytes(secret.as_bytes().to_vec()));
        let challenge = AuthChallenge::Totp;
        let code = if valid {
            koi_crypto::totp::current_code(secret).expect("current_code")
        } else {
            let v = koi_crypto::totp::current_code(secret).expect("current_code");
            if v != "000000" {
                "000000".to_string()
            } else {
                "111111".to_string()
            }
        };
        let response = koi_crypto::auth::AuthResponse::Totp { code };
        (state, challenge, response)
    }

    #[test]
    fn enrollment_with_invalid_totp_fails() {
        let ca = make_test_ca();
        let mut roster = Roster::new(JUST_ME.0, JUST_ME.1, None);
        let secret = totp::generate_secret();
        let mut rl = RateLimiter::new();

        let (auth_state, challenge, bad_response) = make_auth_and_code(&secret, false);

        let request = JoinRequest {
            hostname: "node-05".to_string(),
            auth: Some(bad_response),
            invite_token: None,
            csr: None,
            sans: vec![],
        };

        let result = process_enrollment(
            &ca,
            &mut roster,
            Some(&auth_state),
            &challenge,
            &mut rl,
            &request,
            "node-05",
            &["node-05".to_string(), "node-05.local".to_string()],
            None,
            &test_paths(),
        );

        assert!(result.is_err());
        match result.unwrap_err() {
            CertmeshError::InvalidAuth => {}
            other => panic!("expected InvalidAuth, got: {other}"),
        }
    }

    #[test]
    fn enrollment_closed_rejects() {
        let ca = make_test_ca();
        let mut roster = Roster::new(MY_ORG.0, MY_ORG.1, Some("Admin".into()));
        // My Organization starts closed; assert it so the test is explicit.
        roster.close_enrollment();
        assert!(!roster.is_enrollment_open());

        let secret = totp::generate_secret();
        let mut rl = RateLimiter::new();

        let (auth_state, challenge, _) = make_auth_and_code(&secret, true);
        let request = JoinRequest {
            hostname: "node-05".to_string(),
            auth: Some(koi_crypto::auth::AuthResponse::Totp {
                code: "123456".to_string(),
            }),
            invite_token: None,
            csr: None,
            sans: vec![],
        };

        let result = process_enrollment(
            &ca,
            &mut roster,
            Some(&auth_state),
            &challenge,
            &mut rl,
            &request,
            "node-05",
            &["node-05".to_string()],
            None,
            &test_paths(),
        );

        assert!(matches!(result, Err(CertmeshError::EnrollmentClosed)));
    }

    #[test]
    fn rate_limit_after_failures() {
        let ca = make_test_ca();
        let mut roster = Roster::new(JUST_ME.0, JUST_ME.1, None);
        let secret = totp::generate_secret();
        let mut rl = RateLimiter::new();

        let (auth_state, challenge, _) = make_auth_and_code(&secret, false);
        let bad_request = JoinRequest {
            hostname: "node-05".to_string(),
            auth: Some(koi_crypto::auth::AuthResponse::Totp {
                code: "000000".to_string(),
            }),
            invite_token: None,
            csr: None,
            sans: vec![],
        };

        // Fail 3 times to trigger lockout
        for _ in 0..3 {
            let _ = process_enrollment(
                &ca,
                &mut roster,
                Some(&auth_state),
                &challenge,
                &mut rl,
                &bad_request,
                "node-05",
                &["node-05".to_string()],
                None,
                &test_paths(),
            );
        }

        // 4th attempt should be rate limited
        let result = process_enrollment(
            &ca,
            &mut roster,
            Some(&auth_state),
            &challenge,
            &mut rl,
            &bad_request,
            "node-05",
            &["node-05".to_string()],
            None,
            &test_paths(),
        );

        assert!(matches!(result, Err(CertmeshError::RateLimited { .. })));
    }

    #[test]
    fn enrollment_with_invite_token_succeeds() {
        let paths = unique_test_paths("invite-ok");
        let ca = make_test_ca();
        let mut roster = Roster::new(JUST_ME.0, JUST_ME.1, None); // enrollment open
        let mut rl = RateLimiter::new();

        // Mint an invite bound to the joining hostname. No TOTP auth is supplied
        // (auth_state = None) — the invite is the sole credential. The joiner also
        // supplies its own CSR (ADR-015 F1); the CA never generates the key.
        let token = crate::invite::mint(&paths.invites_path(), "node-invited", 60)
            .unwrap()
            .token;
        let (_key_pem, csr_pem) =
            crate::csr::generate_keypair_and_csr("node-invited", &["node-invited".to_string()])
                .unwrap();
        let request = JoinRequest {
            hostname: "node-invited".to_string(),
            auth: None,
            invite_token: Some(token.clone()),
            csr: Some(csr_pem),
            sans: vec![],
        };

        let result = process_enrollment(
            &ca,
            &mut roster,
            None,
            &AuthChallenge::Totp,
            &mut rl,
            &request,
            "node-invited",
            &["node-invited".to_string()],
            None,
            &paths,
        );
        let (resp, issued) = result.expect("invite enrollment should succeed");
        assert!(
            resp.service_key.is_empty(),
            "CSR flow: the CA must NOT return a member private key"
        );
        assert!(resp.service_cert.contains("BEGIN CERTIFICATE"));
        // Leaf lifetime comes from the CA-held policy default (90 days, ADR-017).
        let days = (issued.expires - Utc::now()).num_days();
        assert!(
            (89..=90).contains(&days),
            "expected ~90-day leaf, got {days}"
        );

        // Single-use: the now-spent token is rejected on a second attempt.
        let mut roster2 = Roster::new(JUST_ME.0, JUST_ME.1, None);
        let request2 = JoinRequest {
            hostname: "node-invited".to_string(),
            auth: None,
            invite_token: Some(token),
            csr: None,
            sans: vec![],
        };
        let result2 = process_enrollment(
            &ca,
            &mut roster2,
            None,
            &AuthChallenge::Totp,
            &mut rl,
            &request2,
            "node-invited",
            &["node-invited".to_string()],
            None,
            &paths,
        );
        assert!(
            matches!(result2, Err(CertmeshError::InvalidAuth)),
            "spent invite token must be rejected, got: {result2:?}"
        );
    }

    #[test]
    fn enrollment_without_csr_is_rejected() {
        // Even with a valid credential, the CA refuses to enroll without a CSR —
        // it never generates member keys server-side (ADR-015 F1).
        let paths = unique_test_paths("no-csr");
        let ca = make_test_ca();
        let mut roster = Roster::new(JUST_ME.0, JUST_ME.1, None);
        let mut rl = RateLimiter::new();

        let token = crate::invite::mint(&paths.invites_path(), "no-csr-host", 60)
            .unwrap()
            .token;
        let request = JoinRequest {
            hostname: "no-csr-host".to_string(),
            auth: None,
            invite_token: Some(token),
            csr: None, // no CSR supplied
            sans: vec![],
        };
        let result = process_enrollment(
            &ca,
            &mut roster,
            None,
            &AuthChallenge::Totp,
            &mut rl,
            &request,
            "no-csr-host",
            &["no-csr-host".to_string()],
            None,
            &paths,
        );
        assert!(
            matches!(result, Err(CertmeshError::InvalidPayload(_))),
            "enrollment without a CSR must be rejected, got: {result:?}"
        );
    }
}