tvc 0.7.0

CLI for Turnkey Verifiable Cloud
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
//! Re-encrypt share command.

use crate::operator_key::load_operator_pair;
use crate::pair::Pair;
use crate::provisioning::ProvisionBundle;
use crate::quorum_key_metadata::QuorumKeyMetadata;
use crate::util::{read_json_file, write_file};
use anyhow::{anyhow, Context};
use clap::Args as ClapArgs;
use qos_core::protocol::services::boot::{Approval, ManifestEnvelope, QuorumMember};
use qos_core::protocol::QosHash;
use serde::Serialize;
use std::path::{Path, PathBuf};
use zeroize::Zeroizing;

/// Re-encrypt a share with an ephemeral key.
#[derive(Debug, ClapArgs)]
#[command(about, long_about = None)]
pub struct Args {
    /// Path to the quorum key metadata file, which is generated by the `generate-quorum-key` command
    /// and includes the share to re-encrypt.
    /// The relevant share is assumed to be encrypted by the operator key.
    #[arg(long, value_name = "PATH", env = "TVC_QUORUM_KEY_METADATA")]
    pub quorum_key_metadata: PathBuf,

    /// Provision bundle from a deployment.
    /// This should match the output format of `tvc deploy provisioning-details`.
    #[arg(long, value_name = "PATH", env = "TVC_PROVISION_BUNDLE")]
    pub provision_bundle: PathBuf,

    /// Path to the file containing the master seed for the operator key.
    /// If not provided, uses the operator key from the logged-in org config.
    #[arg(long, value_name = "PATH", env = "TVC_OPERATOR_SEED")]
    pub operator_seed: Option<PathBuf>,

    /// Never use for sensitive applications! Skip attestation and manifest approval verification.
    #[arg(long, env = "TVC_DANGEROUS_SKIP_VERIFICATION")]
    pub dangerous_skip_verification: bool,

    /// Output path for the re-encrypted share output (share ciphertext + manifest approval).
    #[arg(long, value_name = "PATH", env = "TVC_RE_ENCRYPTED_OUT")]
    pub re_encrypted_out: Option<PathBuf>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
#[serde(rename_all = "camelCase")]
struct ReEncryptedShareOutput {
    re_encrypted_share: String,
    share_approval: Approval,
}

/// Run the re-encrypt-share command.
pub async fn run(args: Args) -> anyhow::Result<()> {
    if args.dangerous_skip_verification {
        eprintln!(
            "WARNING: Skipping verification! This is dangerous and should not be used for sensitive applications."
        );
    }

    let quorum_key_metadata: QuorumKeyMetadata =
        read_json_file(&args.quorum_key_metadata, "quorum key metadata file").await?;
    let provision_bundle: ProvisionBundle =
        read_json_file(&args.provision_bundle, "provision bundle").await?;
    let operator_pair = load_operator_pair(args.operator_seed.as_deref()).await?;

    let output = build_re_encrypted_share_output(
        &quorum_key_metadata,
        &provision_bundle,
        &operator_pair,
        args.dangerous_skip_verification,
    )
    .await?;

    write_output(args.re_encrypted_out.as_deref(), &output).await
}

async fn build_re_encrypted_share_output(
    quorum_key_metadata: &QuorumKeyMetadata,
    provision_bundle: &ProvisionBundle,
    operator_pair: &dyn Pair,
    dangerous_skip_verification: bool,
) -> anyhow::Result<ReEncryptedShareOutput> {
    ensure_quorum_key_matches_manifest(quorum_key_metadata, provision_bundle)?;

    let ephemeral_public_key =
        provision_bundle.ephemeral_public_key(dangerous_skip_verification)?;
    let operator_public_key = operator_pair.public_key();
    let encrypted_share = quorum_key_metadata.encrypted_share_for_operator(&operator_public_key)?;
    let member = find_share_set_member(provision_bundle.manifest_envelope(), &operator_public_key)?;

    let re_encrypted_share = {
        let plaintext_share = Zeroizing::new(
            operator_pair
                .decrypt(encrypted_share)
                .await
                .context("failed to decrypt share with operator key")?,
        );

        ephemeral_public_key
            .encrypt(plaintext_share.as_slice())
            .map_err(|err| anyhow!("failed to encrypt share to ephemeral key: {err:?}"))?
    };

    let signature = operator_pair
        .sign(
            provision_bundle
                .manifest_envelope()
                .manifest
                .qos_hash()
                .to_vec(),
        )
        .await
        .context("failed to sign share approval with operator key")?;
    let share_approval = Approval { signature, member };

    Ok(ReEncryptedShareOutput {
        re_encrypted_share: hex::encode(re_encrypted_share),
        share_approval,
    })
}

fn ensure_quorum_key_matches_manifest(
    quorum_key_metadata: &QuorumKeyMetadata,
    provision_bundle: &ProvisionBundle,
) -> anyhow::Result<()> {
    let metadata_quorum_key = quorum_key_metadata.quorum_key_public_bytes()?;
    let manifest_quorum_key = &provision_bundle
        .manifest_envelope()
        .manifest
        .namespace
        .quorum_key;

    if metadata_quorum_key.as_slice() != manifest_quorum_key.as_slice() {
        anyhow::bail!(
            "quorum key metadata quorumKeyPublic ({}) does not match provision bundle manifest quorumKey ({})",
            hex::encode(metadata_quorum_key),
            hex::encode(manifest_quorum_key),
        );
    }

    Ok(())
}

fn find_share_set_member(
    manifest_envelope: &ManifestEnvelope,
    operator_public_key: &[u8],
) -> anyhow::Result<QuorumMember> {
    manifest_envelope
        .manifest
        .share_set
        .members
        .iter()
        .find(|member| member.pub_key == operator_public_key)
        .cloned()
        .ok_or_else(|| {
            anyhow!(
                "operator ({}) not part of share set",
                hex::encode(operator_public_key)
            )
        })
}

async fn write_output(path: Option<&Path>, output: &ReEncryptedShareOutput) -> anyhow::Result<()> {
    let contents =
        serde_json::to_string_pretty(output).context("failed to serialize re-encrypted share")?;

    if let Some(path) = path {
        write_file(path, &contents).await?;
        eprintln!("Re-encrypted share written to: {}", path.display());
    } else {
        println!("{contents}");
    }

    Ok(())
}

#[cfg(test)]
mod tests {
    use super::{
        build_re_encrypted_share_output, ensure_quorum_key_matches_manifest, find_share_set_member,
        ReEncryptedShareOutput,
    };
    use crate::pair::LocalPair;
    use crate::provisioning::ProvisionBundle;
    use crate::quorum_key_metadata::{EncryptedShareMetadata, QuorumKeyMetadata};
    use qos_core::protocol::services::boot::{
        Approval, Manifest, ManifestEnvelope, ManifestSet, Namespace, NitroConfig, PatchSet,
        PivotConfig, QuorumMember, RestartPolicy, ShareSet,
    };
    use qos_core::protocol::QosHash;
    use qos_p256::{P256Pair, P256Public};
    use serde_json::json;

    fn sample_manifest_envelope(
        quorum_key: Vec<u8>,
        share_set_members: Vec<QuorumMember>,
    ) -> ManifestEnvelope {
        ManifestEnvelope {
            manifest: Manifest {
                namespace: Namespace {
                    name: "test-namespace".to_string(),
                    nonce: 7,
                    quorum_key,
                },
                pivot: PivotConfig {
                    hash: [0; 32],
                    restart: RestartPolicy::Never,
                    bridge_config: vec![],
                    debug_mode: false,
                    args: vec![],
                },
                manifest_set: ManifestSet {
                    threshold: 0,
                    members: vec![],
                },
                share_set: ShareSet {
                    threshold: share_set_members.len() as u32,
                    members: share_set_members,
                },
                enclave: NitroConfig {
                    pcr0: vec![0; 48],
                    pcr1: vec![1; 48],
                    pcr2: vec![2; 48],
                    pcr3: vec![3; 48],
                    aws_root_certificate: vec![],
                    qos_commit: "test-commit".to_string(),
                },
                patch_set: PatchSet {
                    threshold: 0,
                    members: vec![],
                },
            },
            manifest_set_approvals: vec![],
            share_set_approvals: vec![],
        }
    }

    fn bundle_with_ephemeral_key(
        ephemeral_key: &P256Public,
        quorum_key: Vec<u8>,
        share_set_members: Vec<QuorumMember>,
    ) -> ProvisionBundle {
        ProvisionBundle::new(
            "deploy-123".to_string(),
            b"not parsed when verification is skipped",
            sample_manifest_envelope(quorum_key, share_set_members),
            1_712_345_678_901,
            &ephemeral_key.to_bytes(),
        )
    }

    fn local_pair_from_pair(pair: &P256Pair) -> LocalPair {
        let seed_hex = String::from_utf8(pair.to_master_seed_hex()).unwrap();
        LocalPair::from_hex_seed(&seed_hex).unwrap()
    }

    fn quorum_key_metadata(
        quorum_pair: &P256Pair,
        operator_pair: &P256Pair,
        plaintext_share: &[u8],
    ) -> QuorumKeyMetadata {
        QuorumKeyMetadata {
            quorum_key_public: hex::encode(quorum_pair.public_key().to_bytes()),
            threshold: 1,
            shares: vec![EncryptedShareMetadata {
                operator_public_key: hex::encode(operator_pair.public_key().to_bytes()),
                share: hex::encode(operator_pair.public_key().encrypt(plaintext_share).unwrap()),
            }],
        }
    }

    #[test]
    fn output_serializes_expected_json_shape_with_hex() {
        let output = ReEncryptedShareOutput {
            re_encrypted_share: "010203".to_string(),
            share_approval: Approval {
                signature: vec![0xde, 0xad, 0xbe, 0xef],
                member: QuorumMember {
                    alias: "operator-1".to_string(),
                    pub_key: vec![0xaa, 0xbb, 0xcc],
                },
            },
        };

        let value = serde_json::to_value(&output).unwrap();

        assert_eq!(
            value,
            json!({
                "reEncryptedShare": "010203",
                "shareApproval": {
                    "signature": "deadbeef",
                    "member": {
                        "alias": "operator-1",
                        "pubKey": "aabbcc",
                    },
                },
            })
        );
    }

    #[test]
    fn finds_operator_share_set_member_by_public_key() {
        let operator_pair = P256Pair::generate().unwrap();
        let member = QuorumMember {
            alias: "operator-1".to_string(),
            pub_key: operator_pair.public_key().to_bytes(),
        };
        let manifest_envelope = sample_manifest_envelope(
            P256Pair::generate().unwrap().public_key().to_bytes(),
            vec![member.clone()],
        );

        let found =
            find_share_set_member(&manifest_envelope, &operator_pair.public_key().to_bytes())
                .unwrap();

        assert_eq!(found, member);
    }

    #[test]
    fn rejects_operator_missing_from_share_set() {
        let operator_pair = P256Pair::generate().unwrap();
        let other_pair = P256Pair::generate().unwrap();
        let manifest_envelope = sample_manifest_envelope(
            P256Pair::generate().unwrap().public_key().to_bytes(),
            vec![QuorumMember {
                alias: "operator-1".to_string(),
                pub_key: other_pair.public_key().to_bytes(),
            }],
        );

        assert!(
            find_share_set_member(&manifest_envelope, &operator_pair.public_key().to_bytes())
                .is_err()
        );
    }

    #[test]
    fn selects_operator_share_from_metadata() {
        let quorum_pair = P256Pair::generate().unwrap();
        let first_operator = P256Pair::generate().unwrap();
        let second_operator = P256Pair::generate().unwrap();
        let first_share = b"first share";
        let second_share = b"second share";
        let first_encrypted_share = first_operator.public_key().encrypt(first_share).unwrap();
        let second_encrypted_share = second_operator.public_key().encrypt(second_share).unwrap();
        let metadata = QuorumKeyMetadata {
            quorum_key_public: hex::encode(quorum_pair.public_key().to_bytes()),
            threshold: 1,
            shares: vec![
                EncryptedShareMetadata {
                    operator_public_key: hex::encode(first_operator.public_key().to_bytes()),
                    share: hex::encode(&first_encrypted_share),
                },
                EncryptedShareMetadata {
                    operator_public_key: hex::encode(second_operator.public_key().to_bytes())
                        .to_uppercase(),
                    share: hex::encode(&second_encrypted_share),
                },
            ],
        };

        let selected = metadata
            .encrypted_share_for_operator(&second_operator.public_key().to_bytes())
            .unwrap();

        assert_eq!(selected, second_encrypted_share);
    }

    #[test]
    fn rejects_operator_missing_from_metadata_shares() {
        let quorum_pair = P256Pair::generate().unwrap();
        let operator_pair = P256Pair::generate().unwrap();
        let missing_operator_pair = P256Pair::generate().unwrap();
        let metadata = quorum_key_metadata(&quorum_pair, &operator_pair, b"share");

        let err = metadata
            .encrypted_share_for_operator(&missing_operator_pair.public_key().to_bytes())
            .unwrap_err();

        assert!(err
            .to_string()
            .contains(&hex::encode(missing_operator_pair.public_key().to_bytes())));
    }

    #[test]
    fn rejects_quorum_key_mismatch_without_dangerous_skip() {
        let metadata_quorum_pair = P256Pair::generate().unwrap();
        let manifest_quorum_pair = P256Pair::generate().unwrap();
        let operator_pair = P256Pair::generate().unwrap();
        let ephemeral_pair = P256Pair::generate().unwrap();
        let metadata = quorum_key_metadata(&metadata_quorum_pair, &operator_pair, b"share");
        let bundle = bundle_with_ephemeral_key(
            &ephemeral_pair.public_key(),
            manifest_quorum_pair.public_key().to_bytes(),
            vec![],
        );

        let err = ensure_quorum_key_matches_manifest(&metadata, &bundle).unwrap_err();

        assert!(err.to_string().contains("does not match"));
    }

    #[tokio::test]
    async fn re_encrypt_round_trip_and_generates_verifiable_approval() {
        let quorum_pair = P256Pair::generate().unwrap();
        let operator_pair = P256Pair::generate().unwrap();
        let operator_member = QuorumMember {
            alias: "operator-1".to_string(),
            pub_key: operator_pair.public_key().to_bytes(),
        };
        let operator_local_pair = local_pair_from_pair(&operator_pair);
        let ephemeral_pair = P256Pair::generate().unwrap();
        let plaintext_share = b"arbitrary test share bytes";
        let metadata = quorum_key_metadata(&quorum_pair, &operator_pair, plaintext_share);
        let bundle = bundle_with_ephemeral_key(
            &ephemeral_pair.public_key(),
            quorum_pair.public_key().to_bytes(),
            vec![operator_member.clone()],
        );

        let output =
            build_re_encrypted_share_output(&metadata, &bundle, &operator_local_pair, true)
                .await
                .unwrap();

        let re_encrypted_share = hex::decode(&output.re_encrypted_share).unwrap();
        let decrypted_share = ephemeral_pair.decrypt(&re_encrypted_share).unwrap();
        assert_eq!(decrypted_share, plaintext_share);
        assert_eq!(output.share_approval.member, operator_member);

        let approval_public_key =
            P256Public::from_bytes(&output.share_approval.member.pub_key).unwrap();
        approval_public_key
            .verify(
                &bundle.manifest_envelope().manifest.qos_hash(),
                &output.share_approval.signature,
            )
            .unwrap();
    }

    #[tokio::test]
    async fn dangerous_skip_does_not_bypass_quorum_key_match() {
        let metadata_quorum_pair = P256Pair::generate().unwrap();
        let manifest_quorum_pair = P256Pair::generate().unwrap();
        let operator_pair = P256Pair::generate().unwrap();
        let operator_member = QuorumMember {
            alias: "operator-1".to_string(),
            pub_key: operator_pair.public_key().to_bytes(),
        };
        let operator_local_pair = local_pair_from_pair(&operator_pair);
        let ephemeral_pair = P256Pair::generate().unwrap();
        let metadata = quorum_key_metadata(&metadata_quorum_pair, &operator_pair, b"share");
        let bundle = bundle_with_ephemeral_key(
            &ephemeral_pair.public_key(),
            manifest_quorum_pair.public_key().to_bytes(),
            vec![operator_member],
        );

        let err = build_re_encrypted_share_output(&metadata, &bundle, &operator_local_pair, true)
            .await
            .unwrap_err();

        assert!(err.to_string().contains("does not match"));
    }
}