ckms 5.20.1

Command Line Interface used to manage the Cosmian KMS server. If any assistance is needed, please either visit the Cosmian technical documentation at https://docs.cosmian.com or contact the Cosmian support team on Discord https://discord.com/invite/7kPMNtHpnz
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
use std::process::Command;

use assert_cmd::prelude::CommandCargoExt;
use cosmian_kms_cli_actions::{
    actions::symmetric::keys::create_key::CreateKeyAction,
    reexport::cosmian_kms_client::{
        kmip_2_1::kmip_data_structures::{KeyMaterial, KeyValue},
        read_object_from_json_ttlv_file,
    },
};
#[cfg(feature = "non-fips")]
use cosmian_logger::trace;
use tempfile::TempDir;
use test_kms_server::start_default_test_kms_server;

#[cfg(feature = "non-fips")]
use crate::tests::cover_crypt::{
    master_key_pair::create_cc_master_key_pair, user_decryption_keys::create_user_decryption_key,
};
#[cfg(feature = "non-fips")]
use crate::tests::elliptic_curve::create_key_pair::create_ec_key_pair;
use crate::{
    cli_bail,
    config::CKMS_CONF_ENV,
    error::{CosmianError, result::CosmianResult},
    tests::{
        PROG_NAME, save_kms_cli_config,
        shared::{ExportKeyParams, export::export_key, revoke::revoke},
        symmetric::create_key::create_symmetric_key,
        utils::recover_cmd_logs,
    },
};

pub(crate) fn destroy(
    cli_conf_path: &str,
    sub_command: &str,
    key_id: &str,
    remove: bool,
) -> CosmianResult<()> {
    let mut args: Vec<String> = ["keys", "destroy", "--key-id", key_id]
        .iter()
        .map(std::string::ToString::to_string)
        .collect();
    if remove {
        args.push("--remove".to_owned());
    }
    let mut cmd = Command::cargo_bin(PROG_NAME)?;
    cmd.env(CKMS_CONF_ENV, cli_conf_path);

    cmd.arg(sub_command).args(args);
    let output = recover_cmd_logs(&mut cmd);
    if output.status.success() {
        return Ok(());
    }
    Err(CosmianError::Default(
        std::str::from_utf8(&output.stderr)?.to_owned(),
    ))
}

fn assert_destroyed(cli_conf_path: &str, key_id: &str, _remove: bool) -> CosmianResult<()> {
    // create a temp dir
    let tmp_dir = TempDir::new()?;
    let tmp_path = tmp_dir.path();
    // should not be able to Get....
    assert!(
        export_key(ExportKeyParams {
            cli_conf_path: cli_conf_path.to_string(),
            sub_command: "ec".to_owned(),
            key_id: key_id.to_string(),
            key_file: tmp_path.join("output.export").to_str().unwrap().to_owned(),
            ..Default::default()
        })
        .is_err()
    );

    // depending on whether the key is removed or not,
    // the key metadata should be exportable or not
    let export_res = export_key(ExportKeyParams {
        cli_conf_path: cli_conf_path.to_string(),
        sub_command: "ec".to_owned(),
        key_id: key_id.to_string(),
        key_file: tmp_path.join("output.export").to_str().unwrap().to_owned(),
        allow_revoked: true,
        ..Default::default()
    });
    // Newer KMS versions may not allow exporting destroyed objects at all and return Not_Found.
    // If export succeeds, ensure no key material is present for compatibility.
    if export_res.is_ok() {
        let object = read_object_from_json_ttlv_file(&tmp_path.join("output.export"))?;
        let Some(KeyValue::Structure { key_material, .. }) = &object.key_block()?.key_value else {
            cli_bail!("Invalid key value");
        };
        match &key_material {
            KeyMaterial::ByteString(v) => {
                assert!(v.is_empty());
            }
            _ => cli_bail!("Invalid key material"),
        }
    }

    Ok(())
}

#[tokio::test]
async fn test_destroy_symmetric_key() -> CosmianResult<()> {
    // init the test server
    let ctx = start_default_test_kms_server().await;
    let (owner_client_conf_path, _) = save_kms_cli_config(ctx);

    // syn
    let key_id = create_symmetric_key(&owner_client_conf_path, CreateKeyAction::default())?;

    // destroy should not work when not revoked
    assert!(destroy(&owner_client_conf_path, "sym", &key_id, false).is_err());

    // revoke then destroy
    revoke(&owner_client_conf_path, "sym", &key_id, "revocation test")?;
    destroy(&owner_client_conf_path, "sym", &key_id, false)?;

    // assert
    assert_destroyed(&owner_client_conf_path, &key_id, false)
}

#[tokio::test]
async fn test_destroy_and_remove_symmetric_key() -> CosmianResult<()> {
    // init the test server
    let ctx = start_default_test_kms_server().await;
    let (owner_client_conf_path, _) = save_kms_cli_config(ctx);

    // syn
    let key_id = create_symmetric_key(&owner_client_conf_path, CreateKeyAction::default())?;

    // destroy should not work when not revoked
    assert!(destroy(&owner_client_conf_path, "sym", &key_id, true).is_err());

    // revoke then destroy
    revoke(&owner_client_conf_path, "sym", &key_id, "revocation test")?;
    destroy(&owner_client_conf_path, "sym", &key_id, true)?;

    // assert
    assert_destroyed(&owner_client_conf_path, &key_id, true)
}

#[cfg(feature = "non-fips")]
#[tokio::test]
async fn test_destroy_ec_key() -> CosmianResult<()> {
    // init the test server
    let ctx = start_default_test_kms_server().await;
    let (owner_client_conf_path, _) = save_kms_cli_config(ctx);

    // destroy via private key
    {
        // syn
        let (private_key_id, public_key_id) =
            create_ec_key_pair(&owner_client_conf_path, "nist-p256", &[], false)?;

        // destroy should not work when not revoked
        assert!(destroy(&owner_client_conf_path, "ec", &private_key_id, false).is_err());

        // revoke then destroy
        revoke(
            &owner_client_conf_path,
            "ec",
            &private_key_id,
            "revocation test",
        )?;
        // destroy via the private key
        destroy(&owner_client_conf_path, "ec", &private_key_id, false)?;

        // assert
        assert_destroyed(&owner_client_conf_path, &private_key_id, false)?;
        assert_destroyed(&owner_client_conf_path, &public_key_id, false)?;
    }

    // destroy via public key
    {
        // syn
        let (private_key_id, public_key_id) =
            create_ec_key_pair(&owner_client_conf_path, "nist-p256", &[], false)?;

        // destroy should not work when not revoked
        assert!(destroy(&owner_client_conf_path, "ec", &public_key_id, false).is_err());

        trace!("OK. revoking");

        // revoke then destroy
        revoke(
            &owner_client_conf_path,
            "ec",
            &public_key_id,
            "revocation test",
        )?;

        trace!("OK. destroying");

        // destroy via the private key
        destroy(&owner_client_conf_path, "ec", &public_key_id, false)?;

        // assert
        assert_destroyed(&owner_client_conf_path, &private_key_id, false)?;
        assert_destroyed(&owner_client_conf_path, &public_key_id, false)?;
    }

    Ok(())
}

#[cfg(feature = "non-fips")]
#[tokio::test]
async fn test_destroy_and_remove_ec_key() -> CosmianResult<()> {
    // init the test server
    let ctx = start_default_test_kms_server().await;
    let (owner_client_conf_path, _) = save_kms_cli_config(ctx);

    // destroy via private key
    {
        // syn
        let (private_key_id, public_key_id) =
            create_ec_key_pair(&owner_client_conf_path, "nist-p256", &[], false)?;

        // destroy should not work when not revoked
        assert!(destroy(&owner_client_conf_path, "ec", &private_key_id, true).is_err());

        // revoke then destroy
        revoke(
            &owner_client_conf_path,
            "ec",
            &private_key_id,
            "revocation test",
        )?;
        // destroy via the private key
        destroy(&owner_client_conf_path, "ec", &private_key_id, true)?;

        // assert
        assert_destroyed(&owner_client_conf_path, &private_key_id, true)?;
        assert_destroyed(&owner_client_conf_path, &public_key_id, true)?;
    }

    // destroy via public key
    {
        // syn
        let (private_key_id, public_key_id) =
            create_ec_key_pair(&owner_client_conf_path, "nist-p256", &[], false)?;

        // destroy should not work when not revoked
        assert!(destroy(&owner_client_conf_path, "ec", &public_key_id, true).is_err());

        trace!("OK. revoking");

        // revoke then destroy
        revoke(
            &owner_client_conf_path,
            "ec",
            &public_key_id,
            "revocation test",
        )?;

        trace!("OK. destroying");

        // destroy via the private key
        destroy(&owner_client_conf_path, "ec", &public_key_id, true)?;

        // assert
        assert_destroyed(&owner_client_conf_path, &private_key_id, true)?;
        assert_destroyed(&owner_client_conf_path, &public_key_id, true)?;
    }

    Ok(())
}

#[cfg(feature = "non-fips")]
#[tokio::test]
async fn test_destroy_cover_crypt() -> CosmianResult<()> {
    // init the test server
    let ctx = start_default_test_kms_server().await;
    let (owner_client_conf_path, _) = save_kms_cli_config(ctx);

    // check revocation of all keys when the private key is destroyed
    {
        // generate a new master key pair
        let (master_private_key_id, master_public_key_id) = create_cc_master_key_pair(
            &owner_client_conf_path,
            "--specification",
            "../../../test_data/access_structure_specifications.json",
            &[],
            false,
        )?;

        let user_key_id_1 = create_user_decryption_key(
            &owner_client_conf_path,
            &master_private_key_id,
            "(Department::MKG || Department::FIN) && Security Level::Top Secret",
            &[],
            false,
        )?;
        let user_key_id_2 = create_user_decryption_key(
            &owner_client_conf_path,
            &master_private_key_id,
            "(Department::MKG || Department::FIN) && Security Level::Top Secret",
            &[],
            false,
        )?;

        // destroy should not work when not revoked
        assert!(destroy(&owner_client_conf_path, "cc", &master_private_key_id, false).is_err());

        // revoke then destroy
        revoke(
            &owner_client_conf_path,
            "cc",
            &master_private_key_id,
            "revocation test",
        )?;
        destroy(&owner_client_conf_path, "cc", &master_private_key_id, false)?;

        // assert
        assert_destroyed(&owner_client_conf_path, &master_private_key_id, false)?;
        assert_destroyed(&owner_client_conf_path, &master_public_key_id, false)?;
        assert_destroyed(&owner_client_conf_path, &user_key_id_1, false)?;
        assert_destroyed(&owner_client_conf_path, &user_key_id_2, false)?;
    }

    // check revocation of all keys when the public key is destroyed
    {
        // generate a new master key pair
        let (master_private_key_id, master_public_key_id) = create_cc_master_key_pair(
            &owner_client_conf_path,
            "--specification",
            "../../../test_data/access_structure_specifications.json",
            &[],
            false,
        )?;

        let user_key_id_1 = create_user_decryption_key(
            &owner_client_conf_path,
            &master_private_key_id,
            "(Department::MKG || Department::FIN) && Security Level::Top Secret",
            &[],
            false,
        )?;
        let user_key_id_2 = create_user_decryption_key(
            &owner_client_conf_path,
            &master_private_key_id,
            "(Department::MKG || Department::FIN) && Security Level::Top Secret",
            &[],
            false,
        )?;

        // destroy should not work when not revoked
        assert!(destroy(&owner_client_conf_path, "cc", &master_public_key_id, false).is_err());

        // revoke then destroy
        revoke(
            &owner_client_conf_path,
            "cc",
            &master_public_key_id,
            "revocation test",
        )?;
        destroy(&owner_client_conf_path, "cc", &master_public_key_id, false)?;

        // assert
        assert_destroyed(&owner_client_conf_path, &master_private_key_id, false)?;
        assert_destroyed(&owner_client_conf_path, &master_public_key_id, false)?;
        assert_destroyed(&owner_client_conf_path, &user_key_id_1, false)?;
        assert_destroyed(&owner_client_conf_path, &user_key_id_2, false)?;
    }

    // check that revoking a user key, does not destroy anything else
    {
        // generate a new master key pair
        let (master_private_key_id, master_public_key_id) = create_cc_master_key_pair(
            &owner_client_conf_path,
            "--specification",
            "../../../test_data/access_structure_specifications.json",
            &[],
            false,
        )?;

        let user_key_id_1 = create_user_decryption_key(
            &owner_client_conf_path,
            &master_private_key_id,
            "(Department::MKG || Department::FIN) && Security Level::Top Secret",
            &[],
            false,
        )?;

        let user_key_id_2 = create_user_decryption_key(
            &owner_client_conf_path,
            &master_private_key_id,
            "(Department::MKG || Department::FIN) && Security Level::Top Secret",
            &[],
            false,
        )?;

        // destroy should not work when not revoked
        assert!(destroy(&owner_client_conf_path, "cc", &user_key_id_1, false).is_err());

        // revoke then destroy
        revoke(
            &owner_client_conf_path,
            "cc",
            &user_key_id_1,
            "revocation test",
        )?;
        destroy(&owner_client_conf_path, "cc", &user_key_id_1, false)?;

        // assert
        assert_destroyed(&owner_client_conf_path, &user_key_id_1, false)?;

        // create a temp dir
        let tmp_dir = TempDir::new()?;
        let tmp_path = tmp_dir.path();
        // should able to Get the Master Keys and user key 2
        assert!(
            export_key(ExportKeyParams {
                cli_conf_path: owner_client_conf_path.clone(),
                sub_command: "cc".to_owned(),
                key_id: master_private_key_id,
                key_file: tmp_path.join("output.export").to_str().unwrap().to_owned(),
                ..Default::default()
            })
            .is_ok()
        );
        assert!(
            export_key(ExportKeyParams {
                cli_conf_path: owner_client_conf_path.clone(),
                sub_command: "cc".to_owned(),
                key_id: master_public_key_id,
                key_file: tmp_path.join("output.export").to_str().unwrap().to_owned(),
                ..Default::default()
            })
            .is_ok()
        );
        assert!(
            export_key(ExportKeyParams {
                cli_conf_path: owner_client_conf_path,
                sub_command: "cc".to_owned(),
                key_id: user_key_id_2,
                key_file: tmp_path.join("output.export").to_str().unwrap().to_owned(),
                ..Default::default()
            })
            .is_ok()
        );
    }

    Ok(())
}