cosmian_kms_cli 5.17.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

use cosmian_kms_client::KmsClient;
use serial_test::serial;

use crate::tests::kms::xml::runner::{
    run_single_xml_vector_on_client as run_single_xml_vector_on_client_generic,
    run_single_xml_vector_with_server as run_single_xml_vector_with_server_generic,
};

/// Run a single XML vector using the shared default test server (single sqlite path).
/// `test_name` is used to namespace UID placeholder keys to avoid cross-test collisions.
pub(crate) async fn run_single_xml_vector(test_name: &str, path: &str) {
    run_single_xml_vector_with_server_generic(test_name, path).await;
}

// Run a single XML vector using an existing client. Useful to chain multiple vectors
// against the same KMS instance (e.g., TL-M-1 -> TL-M-2 -> TL-M-3 sequence).
pub(crate) async fn run_single_xml_vector_on_client(
    test_name: &str,
    client: &KmsClient,
    path: &str,
) {
    run_single_xml_vector_on_client_generic(test_name, client, path).await;
}

macro_rules! xml_test {
    ($name:ident, $($file:expr),+ $(,)?) => {
        #[tokio::test]
        #[serial]
        async fn $name() {
            $(
                run_single_xml_vector(stringify!($name), $file).await;
            )+
        }
    };
}

// List derived from files in ../kmip/src/kmip_2_1/specifications/XML/mandatory
// Grouped by prefix - each test runs multiple XML files with the same prefix

// AKLC - Asymmetric Key Lifecycle (3 files)
xml_test!(
    kmip_2_1_xml_aklc,
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/AKLC-M-1-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/AKLC-M-2-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/AKLC-M-3-21.xml",
);

// Focused single-file test for AKLC-M-1-21
xml_test!(
    kmip_2_1_xml_aklc_m_1_21_only,
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/AKLC-M-1-21.xml"
);

// AX - Authentication eXchange (2 files)
xml_test!(
    kmip_2_1_xml_ax,
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/AX-M-1-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/AX-M-2-21.xml",
);

// BL - Basic Lifecycle (13 files)
xml_test!(
    kmip_2_1_xml_bl,
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/BL-M-1-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/BL-M-2-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/BL-M-3-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/BL-M-4-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/BL-M-5-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/BL-M-6-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/BL-M-7-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/BL-M-8-21.xml",
    // Skipped: BL-M-9-21 contains an invalid RSA key (p and q are not prime)
    // OpenSSL 3.1.2 correctly rejects this mathematically invalid key
    // "../kmip/src/kmip_2_1/specifications/XML/mandatory/BL-M-9-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/BL-M-10-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/BL-M-11-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/BL-M-12-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/BL-M-13-21.xml",
);

// Focused single-file test for Sign ($SIGNATURE_DATA placeholder substitution)
xml_test!(
    kmip_2_1_xml_cs_ac_m_1_21_only,
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-AC-M-1-21.xml"
);

// CS-AC - Cryptographic Service - Asymmetric Cryptography (18 files)
xml_test!(
    kmip_2_1_xml_cs_ac,
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-AC-M-1-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-AC-M-2-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-AC-M-3-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-AC-M-4-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-AC-M-5-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-AC-M-6-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-AC-M-7-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-AC-M-8-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-AC-M-OAEP-1-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-AC-M-OAEP-2-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-AC-M-OAEP-3-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-AC-M-OAEP-4-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-AC-M-OAEP-5-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-AC-M-OAEP-6-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-AC-M-OAEP-7-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-AC-M-OAEP-8-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-AC-M-OAEP-9-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-AC-M-OAEP-10-21.xml",
);

// CS-BC - Cryptographic Service - Block Cryptography (21 files)
xml_test!(
    kmip_2_1_xml_cs_bc,
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-BC-M-1-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-BC-M-2-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-BC-M-3-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-BC-M-4-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-BC-M-5-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-BC-M-6-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-BC-M-7-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-BC-M-8-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-BC-M-9-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-BC-M-10-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-BC-M-11-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-BC-M-12-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-BC-M-13-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-BC-M-14-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-BC-M-CHACHA20-1-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-BC-M-CHACHA20-2-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-BC-M-CHACHA20-3-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-BC-M-CHACHA20POLY1305-1-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-BC-M-GCM-1-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-BC-M-GCM-2-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-BC-M-GCM-3-21.xml",
);

// CS-RNG - Cryptographic Service - Random Number Generation (1 file)
xml_test!(
    kmip_2_1_xml_cs_rng_m_1_21,
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/CS-RNG-M-1-21.xml"
);

// MSGENC - Message Encoding (3 files)
xml_test!(
    kmip_2_1_xml_msgenc,
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/MSGENC-HTTPS-M-1-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/MSGENC-JSON-M-1-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/MSGENC-XML-M-1-21.xml",
);

// OMOS - Object Management and Object State (1 file)
xml_test!(
    kmip_2_1_xml_omos_m_1_21,
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/OMOS-M-1-21.xml"
);

// PKCS11 - PKCS#11 Interface Compatibility (1 file)
// This test requires Utimaco HSM and only runs on Linux
#[ignore = "Requires Linux, Utimaco PKCS#11 library, and HSM environment"]
#[cfg(target_os = "linux")]
#[tokio::test]
#[serial]
async fn kmip_2_1_xml_pkcs11_m_1_21() {
    use cosmian_logger::log_init;
    use test_kms_server::start_default_test_kms_server_with_utimaco_hsm;

    log_init(None);
    let ctx = start_default_test_kms_server_with_utimaco_hsm().await;
    run_single_xml_vector_on_client(
        "kmip_2_1_xml_pkcs11_m_1_21",
        &ctx.get_owner_client(),
        "../kmip/src/kmip_2_1/specifications/XML/mandatory/PKCS11-M-1-21.xml",
    )
    .await;
}

// QS - Query Server (2 files)
xml_test!(
    kmip_2_1_xml_qs,
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/QS-M-1-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/QS-M-2-21.xml",
);

// SASED - Secure Authentication Session Establishment and Destruction
xml_test!(
    kmip_2_1_xml_sased,
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/SASED-M-1-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/SASED-M-2-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/SASED-M-3-21.xml",
);

// SKFF - Symmetric Key Format and Features (9 files)
xml_test!(
    kmip_2_1_xml_skff,
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/SKFF-M-1-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/SKFF-M-2-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/SKFF-M-3-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/SKFF-M-4-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/SKFF-M-5-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/SKFF-M-6-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/SKFF-M-7-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/SKFF-M-8-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/SKFF-M-9-21.xml",
);

// SKLC - Symmetric Key Lifecycle (3 files)
xml_test!(
    kmip_2_1_xml_sklc,
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/SKLC-M-1-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/SKLC-M-2-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/SKLC-M-3-21.xml",
);

// TL - Template Locate (3 files)
xml_test!(
    kmip_2_1_xml_tl_m_3_21,
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/TL-M-1-21.xml",
    "../kmip/src/kmip_2_1/specifications/XML/mandatory/TL-M-2-21.xml",
    // "../kmip/src/kmip_2_1/specifications/XML/mandatory/TL-M-3-21.xml",
);

// Optional vectors (KMIP 2.1 XML optional profile)
// AKLC - Asymmetric Key Lifecycle (optional)
xml_test!(
    kmip_2_1_xml_aklc_o_1_21,
    "../kmip/src/kmip_2_1/specifications/XML/optional/AKLC-O-1-21.xml"
);

// OMOS - Object Management and Object State (optional)
xml_test!(
    kmip_2_1_xml_omos_o_1_21,
    "../kmip/src/kmip_2_1/specifications/XML/optional/OMOS-O-1-21.xml"
);

// SKLC - Symmetric Key Lifecycle (optional)
xml_test!(
    kmip_2_1_xml_sklc_o_1_21,
    "../kmip/src/kmip_2_1/specifications/XML/optional/SKLC-O-1-21.xml"
);