vta-service 0.10.0

Service for Verifiable Trust Agents operating in Verifiable Trust Communities
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
use std::sync::Arc;

use tracing::info;

use crate::audit::{self, audit};
use vta_sdk::keys::KeyOrigin;
use vta_sdk::protocols::seed_management::{
    list::{ListSeedsResultBody, SeedInfo},
    rotate::RotateSeedResultBody,
};

use crate::error::AppError;
use crate::keys::KeyRecord;
use crate::keys::imported;
use crate::keys::seed_store::SeedStore;
use crate::keys::seeds::{self as seeds, get_active_seed_id, load_seed_bytes};
use crate::store::KeyspaceHandle;

pub async fn list_seeds(
    keys_ks: &KeyspaceHandle,
    channel: &str,
) -> Result<ListSeedsResultBody, AppError> {
    let active_id = get_active_seed_id(keys_ks)
        .await
        .map_err(|e| AppError::Internal(format!("{e}")))?;
    let records = seeds::list_seed_records(keys_ks)
        .await
        .map_err(|e| AppError::Internal(format!("{e}")))?;

    let seeds_info: Vec<SeedInfo> = records
        .into_iter()
        .map(|r| SeedInfo {
            id: r.id,
            status: if r.retired_at.is_some() {
                "retired".into()
            } else {
                "active".into()
            },
            created_at: r.created_at,
            retired_at: r.retired_at,
        })
        .collect();

    info!(channel, count = seeds_info.len(), active_id, "seeds listed");

    Ok(ListSeedsResultBody {
        seeds: seeds_info,
        active_seed_id: active_id,
    })
}

/// Serialises seed rotation process-wide. Two concurrent rotations
/// would both read active generation N and both write N+1 — corrupting
/// the generation chain and racing `reencrypt_all` with mismatched
/// old/new seed pairs.
static ROTATE_LOCK: std::sync::LazyLock<tokio::sync::Mutex<()>> =
    std::sync::LazyLock::new(|| tokio::sync::Mutex::new(()));

pub async fn rotate_seed(
    keys_ks: &KeyspaceHandle,
    imported_ks: &KeyspaceHandle,
    seed_store: &Arc<dyn SeedStore>,
    audit_ks: &KeyspaceHandle,
    actor: &str,
    mnemonic: Option<&str>,
    channel: &str,
) -> Result<RotateSeedResultBody, AppError> {
    // Held across read-generation → archive → write-new → re-encrypt.
    let _rotation_guard = ROTATE_LOCK.lock().await;

    // Refuse rotation on a seed store whose `set` does not survive a
    // restart (the TEE KMS store). Rotating would bump `active_seed_id`
    // to a generation whose bytes live only in enclave memory; the next
    // boot would restore the original seed and every key minted after
    // rotation would be permanently unrecoverable. Typed Conflict so the
    // CLI can render operator guidance rather than a generic 500.
    if !seed_store.set_persists_across_restart() {
        return Err(AppError::Conflict(
            "seed rotation is unavailable on this VTA: the active seed store does \
             not persist a rotated seed across a restart, so every key minted after \
             rotation would become unrecoverable on the next boot. TEE/KMS \
             deployments re-seed via a fresh enclave bootstrap, not in-place rotation."
                .into(),
        ));
    }

    let previous_id = get_active_seed_id(keys_ks)
        .await
        .map_err(|e| AppError::Internal(format!("{e}")))?;

    // Load old seed for re-encryption of imported secrets
    let old_seed = load_seed_bytes(keys_ks, &**seed_store, Some(previous_id))
        .await
        .map_err(|e| AppError::Internal(format!("{e}")))?;

    let new_id = seeds::rotate_seed(keys_ks, &**seed_store, mnemonic)
        .await
        .map_err(|e| AppError::Internal(format!("{e}")))?;

    // Re-encrypt imported secrets with the new seed
    let new_seed = load_seed_bytes(keys_ks, &**seed_store, Some(new_id))
        .await
        .map_err(|e| AppError::Internal(format!("{e}")))?;

    // Collect imported key records for AAD
    let raw = keys_ks.prefix_iter_raw("key:").await?;
    let imported_keys: Vec<(String, String)> = raw
        .into_iter()
        .filter_map(|(_, v)| serde_json::from_slice::<KeyRecord>(&v).ok())
        .filter(|r| r.origin == KeyOrigin::Imported && r.status == vta_sdk::keys::KeyStatus::Active)
        .map(|r| (r.key_id, r.key_type.to_string()))
        .collect();

    if !imported_keys.is_empty() {
        let count =
            imported::reencrypt_all(imported_ks, keys_ks, &old_seed, &new_seed, &imported_keys)
                .await?;
        info!(
            channel,
            count, "re-encrypted imported secrets after seed rotation"
        );
    }

    info!(channel, previous_id, new_id, "seed rotated");
    audit!(
        "seed.rotate",
        actor = actor,
        resource = "seed",
        outcome = "success"
    );
    let _ = audit::record(
        audit_ks,
        "seed.rotate",
        actor,
        Some("seed"),
        "success",
        Some(channel),
        None,
    )
    .await;

    Ok(RotateSeedResultBody {
        previous_seed_id: previous_id,
        new_seed_id: new_id,
    })
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::pin::Pin;
    use std::sync::Arc;
    use tokio::sync::Mutex;

    use vti_common::config::StoreConfig;
    use vti_common::store::Store;

    use crate::keys::seed_store::SeedStore;
    use crate::keys::seeds::{SeedRecord, get_seed_record, save_seed_record};
    use crate::store::KeyspaceHandle;

    /// A mock seed store backed by a Mutex so `set` persists across calls.
    struct MockSeedStore(Mutex<Option<Vec<u8>>>);

    impl SeedStore for MockSeedStore {
        fn get(
            &self,
        ) -> Pin<
            Box<
                dyn std::future::Future<Output = Result<Option<Vec<u8>>, crate::error::AppError>>
                    + Send
                    + '_,
            >,
        > {
            Box::pin(async { Ok(self.0.lock().await.clone()) })
        }
        fn set(
            &self,
            seed: &[u8],
        ) -> Pin<
            Box<dyn std::future::Future<Output = Result<(), crate::error::AppError>> + Send + '_>,
        > {
            let seed = seed.to_vec();
            Box::pin(async move {
                *self.0.lock().await = Some(seed);
                Ok(())
            })
        }
    }

    struct TestHarness {
        keys_ks: KeyspaceHandle,
        imported_ks: KeyspaceHandle,
        audit_ks: KeyspaceHandle,
        seed_store: Arc<dyn SeedStore>,
        _dir: tempfile::TempDir,
    }

    impl TestHarness {
        async fn new() -> Self {
            let dir = tempfile::tempdir().expect("temp dir");
            let store_config = StoreConfig {
                data_dir: dir.path().to_path_buf(),
            };
            let store = Store::open(&store_config).expect("open store");

            let keys_ks = store.keyspace(crate::keyspaces::KEYS).unwrap();
            let imported_ks = store.keyspace(crate::keyspaces::IMPORTED_SECRETS).unwrap();
            let audit_ks = store.keyspace(crate::keyspaces::AUDIT).unwrap();

            let initial_seed = vec![0xABu8; 32];
            let seed_store: Arc<dyn SeedStore> =
                Arc::new(MockSeedStore(Mutex::new(Some(initial_seed))));

            // Bootstrap: create a seed record for generation 0 so rotation works
            let now = chrono::Utc::now();
            save_seed_record(
                &keys_ks,
                &SeedRecord {
                    id: 0,
                    seed_hex: None,
                    seed_enc: None,
                    created_at: now,
                    retired_at: None,
                },
            )
            .await
            .expect("save initial seed record");

            Self {
                keys_ks,
                imported_ks,
                audit_ks,
                seed_store,
                _dir: dir,
            }
        }
    }

    /// P0.6: rotation must refuse on a seed store whose `set` does not
    /// survive a restart (the TEE KMS store), and must mutate nothing —
    /// otherwise a TEE operator who runs `keys rotate-seed` silently
    /// loses every key minted afterwards on the next enclave boot.
    #[cfg(feature = "tee")]
    #[tokio::test]
    async fn rotate_seed_refused_on_non_durable_store_and_leaves_state_intact() {
        use crate::keys::seed_store::KmsTeeSeedStore;

        let dir = tempfile::tempdir().expect("temp dir");
        let store = Store::open(&StoreConfig {
            data_dir: dir.path().to_path_buf(),
        })
        .expect("open store");
        let keys_ks = store.keyspace(crate::keyspaces::KEYS).unwrap();
        let imported_ks = store.keyspace(crate::keyspaces::IMPORTED_SECRETS).unwrap();
        let audit_ks = store.keyspace(crate::keyspaces::AUDIT).unwrap();

        // Bootstrap generation 0 as the active seed.
        save_seed_record(
            &keys_ks,
            &SeedRecord {
                id: 0,
                seed_hex: None,
                seed_enc: None,
                created_at: chrono::Utc::now(),
                retired_at: None,
            },
        )
        .await
        .expect("save gen-0 record");

        let seed_store: Arc<dyn SeedStore> = Arc::new(KmsTeeSeedStore::new(
            vec![0xABu8; 32],
            "arn:aws:kms:test".into(),
            "us-east-1".into(),
        ));

        let err = rotate_seed(
            &keys_ks,
            &imported_ks,
            &seed_store,
            &audit_ks,
            "did:key:z6MkTestAdmin",
            None,
            "test",
        )
        .await
        .expect_err("TEE rotation must be refused");
        assert!(matches!(err, AppError::Conflict(_)), "got {err:?}");

        // Nothing mutated: active id unchanged, gen-0 still active (not
        // archived/retired), no gen-1 record created.
        assert_eq!(get_active_seed_id(&keys_ks).await.unwrap(), 0);
        let gen0 = get_seed_record(&keys_ks, 0).await.unwrap().unwrap();
        assert!(gen0.retired_at.is_none(), "gen-0 must not be retired");
        assert!(gen0.seed_hex.is_none(), "gen-0 must stay active");
        assert!(
            get_seed_record(&keys_ks, 1).await.unwrap().is_none(),
            "no gen-1 record may be created by a refused rotation"
        );
    }

    #[tokio::test(flavor = "multi_thread", worker_threads = 4)]
    async fn concurrent_rotations_produce_distinct_generations() {
        // Without ROTATE_LOCK both rotations read active generation 0
        // and both write generation 1, corrupting the chain.
        let h = TestHarness::new().await;

        let mut handles = Vec::new();
        for _ in 0..2 {
            let keys_ks = h.keys_ks.clone();
            let imported_ks = h.imported_ks.clone();
            let audit_ks = h.audit_ks.clone();
            let seed_store = h.seed_store.clone();
            handles.push(tokio::spawn(async move {
                rotate_seed(
                    &keys_ks,
                    &imported_ks,
                    &seed_store,
                    &audit_ks,
                    "did:key:z6MkTestAdmin",
                    None,
                    "test",
                )
                .await
                .expect("rotate")
            }));
        }
        let mut new_ids = Vec::new();
        for hd in handles {
            new_ids.push(hd.await.expect("join").new_seed_id);
        }
        new_ids.sort_unstable();
        assert_eq!(
            new_ids,
            vec![1, 2],
            "two concurrent rotations must produce generations 1 and 2"
        );
        let active = get_active_seed_id(&h.keys_ks).await.expect("active id");
        assert_eq!(active, 2);
    }

    #[tokio::test]
    async fn test_rotate_seed() {
        let h = TestHarness::new().await;

        // Verify initial state: active_seed_id == 0
        let initial_id = get_active_seed_id(&h.keys_ks)
            .await
            .expect("get active seed id");
        assert_eq!(initial_id, 0);

        // Capture the generation-0 seed before rotation so we can assert it is
        // recoverable from the (now encrypted) archive afterwards.
        let gen0_seed = h
            .seed_store
            .get()
            .await
            .expect("seed get")
            .expect("gen-0 seed present");

        // Rotate the seed
        let result = rotate_seed(
            &h.keys_ks,
            &h.imported_ks,
            &h.seed_store,
            &h.audit_ks,
            "did:key:z6MkTestAdmin",
            None,
            "test",
        )
        .await
        .expect("rotate_seed should succeed");

        assert_eq!(result.previous_seed_id, 0);
        assert_eq!(result.new_seed_id, 1);

        // The old seed (generation 0) is now retired and archived as CIPHERTEXT
        // (P0.7b) — never plaintext hex.
        let old_record = get_seed_record(&h.keys_ks, 0)
            .await
            .expect("get seed record")
            .expect("old seed record should exist");
        assert!(
            old_record.seed_enc.is_some(),
            "retired seed should have an encrypted archive"
        );
        assert!(
            old_record.seed_hex.is_none(),
            "retired seed must NOT be archived as plaintext hex (P0.7b)"
        );
        assert!(
            old_record.retired_at.is_some(),
            "retired seed should have retired_at timestamp"
        );

        // The new seed (generation 1) is active — no archive of either kind.
        let new_record = get_seed_record(&h.keys_ks, 1)
            .await
            .expect("get seed record")
            .expect("new seed record should exist");
        assert!(
            new_record.seed_hex.is_none() && new_record.seed_enc.is_none(),
            "active seed should not carry an archive"
        );
        assert!(
            new_record.retired_at.is_none(),
            "active seed should not have retired_at"
        );

        // Active seed ID should now be 1
        let new_active_id = get_active_seed_id(&h.keys_ks)
            .await
            .expect("get active seed id");
        assert_eq!(new_active_id, 1);

        // The retired generation-0 seed must still be recoverable (the whole
        // point of archiving) — and it must come back as the ORIGINAL bytes,
        // decrypted from the archive, not the new active seed.
        let recovered = load_seed_bytes(&h.keys_ks, &*h.seed_store, Some(0))
            .await
            .expect("load retired gen-0 seed");
        assert_eq!(
            recovered.as_slice(),
            gen0_seed.as_slice(),
            "decrypted archive must yield the original generation-0 seed"
        );
        let active_seed = load_seed_bytes(&h.keys_ks, &*h.seed_store, Some(1))
            .await
            .expect("load active gen-1 seed");
        assert_ne!(
            recovered.as_slice(),
            active_seed.as_slice(),
            "retired and active seeds must differ"
        );
    }
}