a3s-box-runtime 2.5.2

MicroVM runtime engine — VM lifecycle, OCI images, attestation, networking
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
//! Version-based rollback protection for sealed storage.
//!
//! Extends sealed storage with a monotonic version counter to prevent
//! replay attacks where an attacker replaces a newer sealed blob with
//! an older one.
//!
//! ## How It Works
//!
//! - Each sealed blob includes a `version` field (monotonically increasing)
//! - A `VersionStore` persists the latest known version per context
//! - On unseal, the blob's version is checked against the stored version
//! - If the blob's version is older than the stored version, unseal is rejected
//!
//! ## Storage
//!
//! Version state is stored in `~/.a3s/sealed-versions.json` (or a custom path).
//! The file is atomically updated on each seal operation.

use std::collections::HashMap;
use std::path::{Path, PathBuf};

use a3s_box_core::error::{BoxError, Result};
use serde::{Deserialize, Serialize};

/// Versioned sealed data — extends SealedData with rollback protection.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VersionedSealedData {
    /// Monotonically increasing version number
    pub version: u64,
    /// Context string (key derivation + version tracking)
    pub context: String,
    /// Sealing policy used
    pub policy: super::sealed::SealingPolicy,
    /// Sealed blob: nonce || ciphertext || tag
    #[serde(with = "base64_serde")]
    pub blob: Vec<u8>,
}

/// Persistent store for version counters per context.
pub struct VersionStore {
    path: PathBuf,
    versions: HashMap<String, u64>,
}

impl VersionStore {
    /// Load or create a version store at the given path.
    pub fn load(path: &Path) -> Result<Self> {
        if let Some(parent) = path.parent() {
            std::fs::create_dir_all(parent).map_err(|e| {
                BoxError::ConfigError(format!(
                    "Failed to create version store directory {}: {}",
                    parent.display(),
                    e
                ))
            })?;
        }

        let versions = if path.exists() {
            let data = std::fs::read_to_string(path).map_err(|e| {
                BoxError::ConfigError(format!(
                    "Failed to read version store {}: {}",
                    path.display(),
                    e
                ))
            })?;
            serde_json::from_str(&data).unwrap_or_default()
        } else {
            HashMap::new()
        };

        Ok(Self {
            path: path.to_path_buf(),
            versions,
        })
    }

    /// Load from the default path (~/.a3s/sealed-versions.json).
    pub fn load_default() -> Result<Self> {
        let home = a3s_box_core::dirs_home();
        Self::load(&home.join("sealed-versions.json"))
    }

    /// Get the current version for a context (0 if never sealed).
    pub fn current_version(&self, context: &str) -> u64 {
        self.versions.get(context).copied().unwrap_or(0)
    }

    /// Advance the version for a context and persist.
    /// Returns the new version number.
    pub fn advance(&mut self, context: &str) -> Result<u64> {
        let next = self.current_version(context) + 1;
        self.versions.insert(context.to_string(), next);
        self.save()?;
        Ok(next)
    }

    /// Check if a versioned blob is current (not rolled back).
    ///
    /// Returns `Ok(())` if the blob's version >= stored version,
    /// or an error if the blob is older (rollback detected).
    pub fn check_version(&self, context: &str, blob_version: u64) -> Result<()> {
        let stored = self.current_version(context);
        if blob_version < stored {
            return Err(BoxError::AttestationError(format!(
                "Rollback detected for context '{}': blob version {} < stored version {}",
                context, blob_version, stored
            )));
        }
        Ok(())
    }

    /// Update the stored version after successful unseal.
    /// Only advances if the blob version is newer.
    pub fn update_version(&mut self, context: &str, blob_version: u64) -> Result<()> {
        let stored = self.current_version(context);
        if blob_version > stored {
            self.versions.insert(context.to_string(), blob_version);
            self.save()?;
        }
        Ok(())
    }

    /// List all tracked contexts and their versions.
    pub fn list(&self) -> &HashMap<String, u64> {
        &self.versions
    }

    /// Remove version tracking for a context.
    pub fn remove(&mut self, context: &str) -> Result<bool> {
        if self.versions.remove(context).is_some() {
            self.save()?;
            Ok(true)
        } else {
            Ok(false)
        }
    }

    /// Save the version store atomically.
    fn save(&self) -> Result<()> {
        let data = serde_json::to_string_pretty(&self.versions).map_err(|e| {
            BoxError::SerializationError(format!("Failed to serialize version store: {}", e))
        })?;
        let tmp = self.path.with_extension("json.tmp");
        std::fs::write(&tmp, &data).map_err(BoxError::IoError)?;
        std::fs::rename(&tmp, &self.path).map_err(BoxError::IoError)?;
        Ok(())
    }
}

/// Bind a context and version into the string used for sealing.
///
/// The underlying `sealed::seal` uses its `context` argument as BOTH the HKDF
/// key-derivation `info` and the AES-GCM additional-authenticated-data. By
/// folding the version into that string we make the version part of the key
/// and the AAD: any tampering with the stored `version` field (e.g. forging an
/// old blob to a newer version to defeat `check_version`) yields a different
/// key/AAD and makes unseal fail authentication. The NUL separator cannot
/// appear in a normal context string, so `(context, version)` maps to a unique,
/// unambiguous binding.
fn versioned_seal_context(context: &str, version: u64) -> String {
    format!("{context}\0v{version}")
}

/// Seal data with version-based rollback protection.
///
/// Advances the version counter for the context, then seals the data with the
/// version cryptographically bound into the sealing context (see
/// [`versioned_seal_context`]).
pub fn seal_versioned(
    report: &[u8],
    plaintext: &[u8],
    context: &str,
    policy: super::sealed::SealingPolicy,
    version_store: &mut VersionStore,
) -> Result<VersionedSealedData> {
    let version = version_store.advance(context)?;
    let bound_context = versioned_seal_context(context, version);
    let sealed = super::sealed::seal(report, plaintext, &bound_context, policy)?;

    Ok(VersionedSealedData {
        version,
        // Store the ORIGINAL context for version tracking / rollback checks; the
        // version is bound into the sealing context separately.
        context: context.to_string(),
        policy: sealed.policy,
        blob: sealed.blob,
    })
}

/// Unseal data with rollback protection check.
///
/// Verifies the blob's version against the stored version before unsealing.
/// After successful unseal, updates the stored version.
pub fn unseal_versioned(
    report: &[u8],
    versioned: &VersionedSealedData,
    version_store: &mut VersionStore,
) -> Result<Vec<u8>> {
    // Check for rollback
    version_store.check_version(&versioned.context, versioned.version)?;

    // Reconstruct SealedData for the underlying unseal. The version is bound
    // into the sealing context, so a forged `version` field (one that slips past
    // check_version) produces a mismatched key/AAD and unseal fails to
    // authenticate.
    let sealed = super::sealed::SealedData {
        policy: versioned.policy,
        context: versioned_seal_context(&versioned.context, versioned.version),
        blob: versioned.blob.clone(),
    };

    let plaintext = super::sealed::unseal(report, &sealed)?;

    // Update version after successful unseal
    version_store.update_version(&versioned.context, versioned.version)?;

    Ok(plaintext)
}

// Base64 serde helper (same as sealed.rs)
mod base64_serde {
    use serde::{Deserialize, Deserializer, Serializer};

    pub fn serialize<S: Serializer>(bytes: &Vec<u8>, s: S) -> std::result::Result<S::Ok, S::Error> {
        use base64::Engine;
        s.serialize_str(&base64::engine::general_purpose::STANDARD.encode(bytes))
    }

    pub fn deserialize<'de, D: Deserializer<'de>>(d: D) -> std::result::Result<Vec<u8>, D::Error> {
        use base64::Engine;
        let s = String::deserialize(d)?;
        base64::engine::general_purpose::STANDARD
            .decode(&s)
            .map_err(serde::de::Error::custom)
    }
}

#[cfg(test)]
mod tests {
    use super::super::sealed::SealingPolicy;
    use super::*;
    use tempfile::TempDir;

    fn make_test_report() -> Vec<u8> {
        let mut report = vec![0u8; 1184];
        for i in 0..48 {
            report[0x90 + i] = (i as u8).wrapping_mul(0xA3);
        }
        for b in &mut report[0x1A0..0x1E0] {
            *b = 0xA3;
        }
        report
    }

    fn test_version_store(tmp: &TempDir) -> VersionStore {
        VersionStore::load(&tmp.path().join("versions.json")).unwrap()
    }

    #[test]
    fn test_version_store_new() {
        let tmp = TempDir::new().unwrap();
        let store = test_version_store(&tmp);
        assert_eq!(store.current_version("test"), 0);
        assert!(store.list().is_empty());
    }

    #[test]
    fn test_version_store_advance() {
        let tmp = TempDir::new().unwrap();
        let mut store = test_version_store(&tmp);

        assert_eq!(store.advance("ctx-a").unwrap(), 1);
        assert_eq!(store.advance("ctx-a").unwrap(), 2);
        assert_eq!(store.advance("ctx-b").unwrap(), 1);
        assert_eq!(store.current_version("ctx-a"), 2);
        assert_eq!(store.current_version("ctx-b"), 1);
    }

    #[test]
    fn test_version_store_persistence() {
        let tmp = TempDir::new().unwrap();
        let path = tmp.path().join("versions.json");

        {
            let mut store = VersionStore::load(&path).unwrap();
            store.advance("ctx-1").unwrap();
            store.advance("ctx-1").unwrap();
            store.advance("ctx-2").unwrap();
        }

        {
            let store = VersionStore::load(&path).unwrap();
            assert_eq!(store.current_version("ctx-1"), 2);
            assert_eq!(store.current_version("ctx-2"), 1);
        }
    }

    #[test]
    fn test_version_store_check_version_ok() {
        let tmp = TempDir::new().unwrap();
        let mut store = test_version_store(&tmp);
        store.advance("ctx").unwrap(); // version = 1

        // Blob version >= stored version → OK
        assert!(store.check_version("ctx", 1).is_ok());
        assert!(store.check_version("ctx", 2).is_ok());
    }

    #[test]
    fn test_version_store_check_version_rollback() {
        let tmp = TempDir::new().unwrap();
        let mut store = test_version_store(&tmp);
        store.advance("ctx").unwrap(); // version = 1
        store.advance("ctx").unwrap(); // version = 2

        // Blob version < stored version → rollback
        let result = store.check_version("ctx", 1);
        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .to_string()
            .contains("Rollback detected"));
    }

    #[test]
    fn test_version_store_update_version() {
        let tmp = TempDir::new().unwrap();
        let mut store = test_version_store(&tmp);

        store.update_version("ctx", 5).unwrap();
        assert_eq!(store.current_version("ctx"), 5);

        // Lower version doesn't update
        store.update_version("ctx", 3).unwrap();
        assert_eq!(store.current_version("ctx"), 5);
    }

    #[test]
    fn test_version_store_remove() {
        let tmp = TempDir::new().unwrap();
        let mut store = test_version_store(&tmp);
        store.advance("ctx").unwrap();

        assert!(store.remove("ctx").unwrap());
        assert_eq!(store.current_version("ctx"), 0);
        assert!(!store.remove("ctx").unwrap());
    }

    #[test]
    fn test_seal_versioned_roundtrip() {
        let tmp = TempDir::new().unwrap();
        let mut store = test_version_store(&tmp);
        let report = make_test_report();

        let sealed = seal_versioned(
            &report,
            b"secret data",
            "my-context",
            SealingPolicy::default(),
            &mut store,
        )
        .unwrap();

        assert_eq!(sealed.version, 1);
        assert_eq!(sealed.context, "my-context");

        let plaintext = unseal_versioned(&report, &sealed, &mut store).unwrap();
        assert_eq!(plaintext, b"secret data");
    }

    #[test]
    fn test_seal_versioned_increments() {
        let tmp = TempDir::new().unwrap();
        let mut store = test_version_store(&tmp);
        let report = make_test_report();

        let s1 =
            seal_versioned(&report, b"v1", "ctx", SealingPolicy::default(), &mut store).unwrap();
        let s2 =
            seal_versioned(&report, b"v2", "ctx", SealingPolicy::default(), &mut store).unwrap();

        assert_eq!(s1.version, 1);
        assert_eq!(s2.version, 2);
    }

    #[test]
    fn test_unseal_versioned_rollback_rejected() {
        let tmp = TempDir::new().unwrap();
        let mut store = test_version_store(&tmp);
        let report = make_test_report();

        let old =
            seal_versioned(&report, b"old", "ctx", SealingPolicy::default(), &mut store).unwrap();
        let _new =
            seal_versioned(&report, b"new", "ctx", SealingPolicy::default(), &mut store).unwrap();

        // Try to unseal the old blob — should fail (rollback)
        let result = unseal_versioned(&report, &old, &mut store);
        assert!(result.is_err());
        assert!(result.unwrap_err().to_string().contains("Rollback"));
    }

    #[test]
    fn test_unseal_versioned_forged_version_rejected() {
        let tmp = TempDir::new().unwrap();
        let mut store = test_version_store(&tmp);
        let report = make_test_report();

        // Seal at version 1 (store advances to 1).
        let mut sealed = seal_versioned(
            &report,
            b"secret-v1",
            "ctx",
            SealingPolicy::default(),
            &mut store,
        )
        .unwrap();
        assert_eq!(sealed.version, 1);

        // Forge the plaintext version field to a value that still passes the
        // rollback check (>= stored). Without cryptographic binding this would
        // let a stale blob masquerade as a newer version; because the version is
        // bound into the sealing context (key + AAD), unseal must fail to
        // authenticate instead of returning the rolled-back plaintext.
        sealed.version = 2;
        assert!(store.check_version("ctx", sealed.version).is_ok());

        let result = unseal_versioned(&report, &sealed, &mut store);
        assert!(result.is_err(), "forged version must not unseal");
        let msg = result.unwrap_err().to_string();
        assert!(
            msg.contains("Unseal failed") || msg.contains("mismatch") || msg.contains("corrupted"),
            "expected an authentication failure, got: {msg}"
        );
    }

    #[test]
    fn test_unseal_versioned_same_version_ok() {
        let tmp = TempDir::new().unwrap();
        let mut store = test_version_store(&tmp);
        let report = make_test_report();

        let sealed = seal_versioned(
            &report,
            b"data",
            "ctx",
            SealingPolicy::default(),
            &mut store,
        )
        .unwrap();

        // Unseal same version twice — should work
        let p1 = unseal_versioned(&report, &sealed, &mut store).unwrap();
        let p2 = unseal_versioned(&report, &sealed, &mut store).unwrap();
        assert_eq!(p1, b"data");
        assert_eq!(p2, b"data");
    }

    #[test]
    fn test_versioned_sealed_data_serde() {
        let tmp = TempDir::new().unwrap();
        let mut store = test_version_store(&tmp);
        let report = make_test_report();

        let sealed = seal_versioned(
            &report,
            b"serde-test",
            "ctx",
            SealingPolicy::default(),
            &mut store,
        )
        .unwrap();
        let json = serde_json::to_string(&sealed).unwrap();
        let parsed: VersionedSealedData = serde_json::from_str(&json).unwrap();

        assert_eq!(parsed.version, sealed.version);
        assert_eq!(parsed.context, sealed.context);
        assert_eq!(parsed.blob, sealed.blob);

        let plaintext = unseal_versioned(&report, &parsed, &mut store).unwrap();
        assert_eq!(plaintext, b"serde-test");
    }

    #[test]
    fn test_independent_contexts() {
        let tmp = TempDir::new().unwrap();
        let mut store = test_version_store(&tmp);
        let report = make_test_report();

        let s1 =
            seal_versioned(&report, b"a", "ctx-a", SealingPolicy::default(), &mut store).unwrap();
        let s2 =
            seal_versioned(&report, b"b", "ctx-b", SealingPolicy::default(), &mut store).unwrap();

        // Each context has independent versioning
        assert_eq!(s1.version, 1);
        assert_eq!(s2.version, 1);

        // Both can be unsealed
        assert_eq!(unseal_versioned(&report, &s1, &mut store).unwrap(), b"a");
        assert_eq!(unseal_versioned(&report, &s2, &mut store).unwrap(), b"b");
    }
}