cosmian_kms_cli 5.20.0

Command Line Interface used to manage the 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
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
use std::path::PathBuf;

use cosmian_kmip::kmip_2_1::{
    kmip_operations::Sign,
    kmip_types::{UniqueIdentifier, ValidityIndicator},
};
use cosmian_kms_client::reexport::cosmian_kms_client_utils::create_utils::Curve;
use cosmian_logger::log_init;
use sha2::Digest;
use tempfile::TempDir;
use test_kms_server::start_default_test_kms_server;

use crate::{
    actions::kms::elliptic_curves::{
        keys::create_key_pair::CreateKeyPairAction, signature_verify::SignatureVerifyAction,
    },
    error::result::KmsCliResult,
};

// Deterministic ECDSA under RFC6979 (non-fips): two signatures over same digest must match
#[cfg(feature = "non-fips")]
#[tokio::test]
async fn ecdsa_deterministic_cli_rfc6979() -> KmsCliResult<()> {
    log_init(None);
    let ctx = start_default_test_kms_server().await;

    let tmp_dir = TempDir::new()?;
    let tmp_path = tmp_dir.path();

    let input_file = PathBuf::from("../../test_data/plain.txt");
    let digest_file = tmp_path.join("plain.sha256");

    // Pre-compute SHA-256 digest
    let data = std::fs::read(&input_file)?;
    let digest = sha2::Sha256::digest(&data);
    std::fs::write(&digest_file, digest)?;

    // Create P-256 key pair
    let (private_key_id, _public_key_id) = CreateKeyPairAction::default()
        .run(ctx.get_owner_client())
        .await?;

    // KMIP Sign on digested data twice
    let cp = None;
    let sign_req = Sign {
        unique_identifier: Some(UniqueIdentifier::TextString(private_key_id.to_string())),
        cryptographic_parameters: cp,
        data: None,
        digested_data: Some(std::fs::read(&digest_file)?),
        correlation_value: None,
        init_indicator: None,
        final_indicator: None,
    };

    let sig1 = ctx
        .get_owner_client()
        .sign(sign_req.clone())
        .await?
        .signature_data
        .expect("signature_data");
    let sig2 = ctx
        .get_owner_client()
        .sign(sign_req)
        .await?
        .signature_data
        .expect("signature_data");

    assert_eq!(
        sig1, sig2,
        "ECDSA signatures must be deterministic under RFC6979 path"
    );
    Ok(())
}

// Additional coverage: end-to-end EC CLI digested sign and verify
#[tokio::test]
async fn ecdsa_digested_sign_verify_cli_end_to_end() -> crate::error::result::KmsCliResult<()> {
    cosmian_logger::log_init(None);
    let ctx = test_kms_server::start_default_test_kms_server().await;

    let tmp_dir = tempfile::TempDir::new()?;
    let tmp_path = tmp_dir.path();

    let input_file = std::path::PathBuf::from("../../test_data/plain.txt");
    let digest_file = tmp_path.join("plain.sha256");
    let sig_file = tmp_path.join("plain.sha256.ec.sig");

    // Pre-compute digest
    let data = std::fs::read(&input_file)?;
    let digest = sha2::Sha256::digest(&data);
    std::fs::write(&digest_file, digest)?;

    // Create EC key pair
    let (private_key_id, public_key_id) =
        crate::actions::kms::elliptic_curves::keys::create_key_pair::CreateKeyPairAction::default()
            .run(ctx.get_owner_client())
            .await?;

    // Use CLI SignAction with --digested path and explicit output
    crate::actions::kms::elliptic_curves::sign::SignAction {
        curve:
            cosmian_kms_client::reexport::cosmian_kms_client_utils::create_utils::Curve::NistP256,
        input_file: digest_file.clone(),
        key_id: Some(private_key_id.to_string()),
        tags: None,
        output_file: Some(sig_file.clone()),
        digested: true,
    }
    .run(ctx.get_owner_client())
    .await?;

    assert!(sig_file.exists());

    // Verify via CLI with digested flag
    let validity = crate::actions::kms::elliptic_curves::signature_verify::SignatureVerifyAction {
        data_file: digest_file.clone(),
        signature_file: sig_file.clone(),
        key_id: Some(public_key_id.to_string()),
        tags: None,
        output_file: None,
        digested: true,
    }
    .run(ctx.get_owner_client())
    .await?;

    assert_eq!(
        validity,
        cosmian_kmip::kmip_2_1::kmip_types::ValidityIndicator::Valid
    );
    Ok(())
}

// Negative test: providing both data and digested_data must fail
#[tokio::test]
async fn ecdsa_sign_both_data_and_digest_should_fail() -> crate::error::result::KmsCliResult<()> {
    cosmian_logger::log_init(None);
    let ctx = test_kms_server::start_default_test_kms_server().await;

    let input_file = std::path::PathBuf::from("../../test_data/plain.txt");
    let data = std::fs::read(&input_file)?;
    let digest = sha2::Sha256::digest(&data).to_vec();

    // Create EC key pair
    let (private_key_id, _public_key_id) =
        crate::actions::kms::elliptic_curves::keys::create_key_pair::CreateKeyPairAction::default()
            .run(ctx.get_owner_client())
            .await?;

    // Build invalid KMIP Sign request with both fields
    let sign_request = cosmian_kmip::kmip_2_1::kmip_operations::Sign {
        unique_identifier: Some(
            cosmian_kmip::kmip_2_1::kmip_types::UniqueIdentifier::TextString(
                private_key_id.to_string(),
            ),
        ),
        cryptographic_parameters: None,
        data: Some(data.into()),
        digested_data: Some(digest),
        correlation_value: None,
        init_indicator: None,
        final_indicator: None,
    };

    // Expect server-side error
    let res = ctx.get_owner_client().sign(sign_request).await;
    assert!(
        res.is_err(),
        "Expected error when both data and digested_data are set"
    );
    Ok(())
}

#[tokio::test]
async fn test_ecdsa_sign_with_digested_data() -> KmsCliResult<()> {
    log_init(None);

    let ctx = start_default_test_kms_server().await;

    // create a temp dir
    let tmp_dir = TempDir::new()?;
    let tmp_path = tmp_dir.path();

    let input_file = PathBuf::from("../../test_data/plain_1k.bin");
    let digest_file = tmp_path.join("plain.sha256");
    let sig_file = tmp_path.join("plain.sha256.ec.sig");

    // compute SHA-256 digest of input and write to digest_file
    let data = std::fs::read(&input_file)?;
    let digest = sha2::Sha256::digest(&data);
    std::fs::write(&digest_file, digest)?;

    let (private_key_id, public_key_id) = CreateKeyPairAction::default()
        .run(ctx.get_owner_client())
        .await?;

    // Sign the pre-digested data using direct KMIP Sign request
    let sign_request = Sign {
        unique_identifier: Some(UniqueIdentifier::TextString(private_key_id.to_string())),
        cryptographic_parameters: None,
        data: None,
        digested_data: Some(std::fs::read(&digest_file)?),
        correlation_value: None,
        init_indicator: None,
        final_indicator: None,
    };
    let sign_response = ctx.get_owner_client().sign(sign_request).await?;
    let signature = sign_response.signature_data.expect("signature_data");
    std::fs::write(&sig_file, &signature)?;

    // Verify using digested_data
    let validity = SignatureVerifyAction {
        data_file: digest_file.clone(),
        signature_file: sig_file.clone(),
        key_id: Some(public_key_id.to_string()),
        tags: None,
        output_file: None,
        digested: true,
    }
    .run(ctx.get_owner_client())
    .await?;
    assert_eq!(validity, ValidityIndicator::Valid);

    Ok(())
}

#[tokio::test]
async fn test_ecdsa_streaming_sign_and_verify() -> KmsCliResult<()> {
    log_init(None);

    let ctx = start_default_test_kms_server().await;

    let tmp_dir = TempDir::new()?;
    let tmp_path = tmp_dir.path();

    let input_file = PathBuf::from("../../test_data/plain_1k.bin");
    let sig_file = tmp_path.join("plain.stream.ec.sig");

    let (private_key_id, public_key_id) = CreateKeyPairAction::default()
        .run(ctx.get_owner_client())
        .await?;

    let data = std::fs::read(&input_file)?;
    let chunk_size: usize = 64;
    let mut offset: usize = 0;
    let mut correlation_value: Option<Vec<u8>> = None;

    while offset < data.len() {
        let end = (offset + chunk_size).min(data.len());
        let chunk = data[offset..end].to_vec();
        let init_indicator = if offset == 0 { Some(true) } else { None };
        let final_indicator = if end == data.len() { Some(true) } else { None };

        let sign_request = Sign {
            unique_identifier: Some(UniqueIdentifier::TextString(private_key_id.to_string())),
            cryptographic_parameters: None,
            data: Some(chunk.into()),
            digested_data: None,
            correlation_value: correlation_value.clone(),
            init_indicator,
            final_indicator,
        };

        let response = ctx.get_owner_client().sign(sign_request).await?;
        // Carry forward accumulated correlation value for streaming
        correlation_value = response.correlation_value.clone();
        if final_indicator == Some(true) {
            let signature = response.signature_data.expect("signature_data");
            std::fs::write(&sig_file, &signature)?;
        }

        offset = end;
    }

    let validity = SignatureVerifyAction {
        data_file: input_file.clone(),
        signature_file: sig_file.clone(),
        key_id: Some(public_key_id.to_string()),
        tags: None,
        output_file: None,
        digested: false,
    }
    .run(ctx.get_owner_client())
    .await?;
    assert_eq!(validity, ValidityIndicator::Valid);

    Ok(())
}

// Deterministic Ed25519: two signatures over same data must match
#[cfg(feature = "non-fips")]
#[tokio::test]
async fn ed25519_deterministic_cli() -> KmsCliResult<()> {
    log_init(None);

    let ctx = start_default_test_kms_server().await;

    // Create Ed25519 key pair via CLI action
    let (private_key_id, _public_key_id) = CreateKeyPairAction {
        curve: Curve::Ed25519,
        ..Default::default()
    }
    .run(ctx.get_owner_client())
    .await?;

    // Prepare raw data
    let data = std::fs::read("../../test_data/plain.txt")?;

    // Build KMIP Sign request; EDDSA is selected by key type, CP can be None
    let sign_req = Sign {
        unique_identifier: Some(UniqueIdentifier::TextString(private_key_id.to_string())),
        cryptographic_parameters: None,
        data: Some(data.clone().into()),
        digested_data: None,
        correlation_value: None,
        init_indicator: None,
        final_indicator: None,
    };

    let sig1 = ctx
        .get_owner_client()
        .sign(sign_req.clone())
        .await?
        .signature_data
        .expect("signature_data");
    let sig2 = ctx
        .get_owner_client()
        .sign(sign_req)
        .await?
        .signature_data
        .expect("signature_data");

    assert_eq!(sig1, sig2, "Ed25519 signatures must be deterministic");
    Ok(())
}

// Deterministic Ed448: two signatures over same data must match
#[cfg(feature = "non-fips")]
#[tokio::test]
async fn ed448_deterministic_cli() -> KmsCliResult<()> {
    log_init(None);

    let ctx = start_default_test_kms_server().await;

    // Create Ed448 key pair via CLI action
    let (private_key_id, _public_key_id) = CreateKeyPairAction {
        curve: Curve::Ed448,
        ..Default::default()
    }
    .run(ctx.get_owner_client())
    .await?;

    // Prepare raw data
    let data = std::fs::read("../../test_data/plain.txt")?;

    // Build KMIP Sign request; EDDSA is selected by key type, CP can be None
    let sign_req = Sign {
        unique_identifier: Some(UniqueIdentifier::TextString(private_key_id.to_string())),
        cryptographic_parameters: None,
        data: Some(data.clone().into()),
        digested_data: None,
        correlation_value: None,
        init_indicator: None,
        final_indicator: None,
    };

    let sig1 = ctx
        .get_owner_client()
        .sign(sign_req.clone())
        .await?
        .signature_data
        .expect("signature_data");
    let sig2 = ctx
        .get_owner_client()
        .sign(sign_req)
        .await?
        .signature_data
        .expect("signature_data");

    assert_eq!(sig1, sig2, "Ed448 signatures must be deterministic");
    Ok(())
}

// ECDSA sign/verify across supported curves.
//
// Note: KMIP policy defaults may deprecate/deny some curves (e.g. P-224).
// This test should only exercise curves expected to be allowed by default.
#[tokio::test]
async fn ecdsa_sign_verify_supported_curves_cli() -> KmsCliResult<()> {
    log_init(None);
    let ctx = start_default_test_kms_server().await;

    let data = std::fs::read("../../test_data/plain.txt")?;
    let digest = sha2::Sha256::digest(&data);

    // Build curve list according to feature gating and default KMIP policy.
    #[cfg(not(feature = "non-fips"))]
    let curves = vec![Curve::NistP256, Curve::NistP384, Curve::NistP521];
    #[cfg(feature = "non-fips")]
    let curves = vec![
        Curve::NistP256,
        Curve::NistP384,
        Curve::NistP521,
        Curve::Ed448,
        Curve::Ed25519,
        Curve::Secp256k1,
        Curve::Secp224k1,
    ];

    for curve in curves {
        // Try to create the key pair; if the curve isn't supported in this build, skip it
        let maybe_ids = CreateKeyPairAction {
            curve,
            ..Default::default()
        }
        .run(ctx.get_owner_client())
        .await;
        let (private_key_id, public_key_id) = match maybe_ids {
            Ok(ids) => ids,
            Err(e) => {
                eprintln!("Skipping curve {curve:?} in ECDSA test: {e}");
                continue;
            }
        };

        // Sign digested
        let cp = None;
        let sign_req = Sign {
            unique_identifier: Some(UniqueIdentifier::TextString(private_key_id.to_string())),
            cryptographic_parameters: cp,
            data: None,
            digested_data: Some(digest.clone().to_vec()),
            correlation_value: None,
            init_indicator: None,
            final_indicator: None,
        };
        let signature = ctx
            .get_owner_client()
            .sign(sign_req)
            .await?
            .signature_data
            .expect("signature_data");

        // Verify digested
        let validity = SignatureVerifyAction {
            data_file: {
                use std::{fs, io::Write};
                let path = std::env::temp_dir()
                    .join(format!("kms_cli_test_digest_{}.bin", uuid::Uuid::new_v4()));
                let mut f = fs::File::create(&path)?;
                f.write_all(&digest)?;
                path
            },
            signature_file: {
                use std::{fs, io::Write};
                let path = std::env::temp_dir().join(format!(
                    "kms_cli_test_signature_{}.bin",
                    uuid::Uuid::new_v4()
                ));
                let mut f = fs::File::create(&path)?;
                f.write_all(&signature)?;
                path
            },
            key_id: Some(public_key_id.to_string()),
            tags: None,
            // Algorithm inferred by key type
            output_file: None,
            digested: true,
        }
        .run(ctx.get_owner_client())
        .await?;

        assert_eq!(validity, ValidityIndicator::Valid, "curve {curve:?}");
    }

    Ok(())
}