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

use serial_test::serial;

use crate::tests::kms::xml::runner::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;
}

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

// KMIP 1.4 XML mandatory vectors (grouped similarly to kmip_2_1.rs)

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

// AX - Authentication eXchange (2 files)
xml_test!(
    kmip_1_4_xml_ax,
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/AX-M-1-14.xml",
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/AX-M-2-14.xml",
);

// CS-AC - Cryptographic Service - Asymmetric Cryptography (Sign/Verify/MAC/OAEP)
xml_test!(
    kmip_1_4_xml_cs_ac,
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/CS-AC-M-1-14.xml",
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/CS-AC-M-2-14.xml",
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/CS-AC-M-3-14.xml",
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/CS-AC-M-4-14.xml",
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/CS-AC-M-5-14.xml",
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/CS-AC-M-6-14.xml",
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/CS-AC-M-7-14.xml",
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/CS-AC-M-8-14.xml",
    // OAEP variants
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/CS-AC-M-OAEP-1-14.xml",
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/CS-AC-M-OAEP-2-14.xml",
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/CS-AC-M-OAEP-3-14.xml",
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/CS-AC-M-OAEP-4-14.xml",
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/CS-AC-M-OAEP-5-14.xml",
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/CS-AC-M-OAEP-6-14.xml",
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/CS-AC-M-OAEP-7-14.xml",
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/CS-AC-M-OAEP-8-14.xml",
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/CS-AC-M-OAEP-9-14.xml",
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/CS-AC-M-OAEP-10-14.xml",
);

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

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

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

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

// SASED - Secure Authentication Session Establishment and Destruction (3 files)
xml_test!(
    kmip_1_4_xml_sased,
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/SASED-M-1-14.xml",
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/SASED-M-2-14.xml",
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/SASED-M-3-14.xml",
);

// SKFF - Symmetric Key Format and Features (12 files)
xml_test!(
    kmip_1_4_xml_skff,
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/SKFF-M-1-14.xml",
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/SKFF-M-2-14.xml",
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/SKFF-M-3-14.xml",
    // Skipped: SKFF-M-4-14 (3DES key creation) is not supported by the server policy
    // "../kmip/src/kmip_1_4/specifications/XML/mandatory/SKFF-M-4-14.xml",
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/SKFF-M-5-14.xml",
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/SKFF-M-6-14.xml",
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/SKFF-M-7-14.xml",
    // Skipped: SKFF-M-8-14 uses 3DES which is not supported
    // "../kmip/src/kmip_1_4/specifications/XML/mandatory/SKFF-M-8-14.xml",
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/SKFF-M-9-14.xml",
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/SKFF-M-10-14.xml",
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/SKFF-M-11-14.xml",
    // Skipped: SKFF-M-12-14 uses 3DES which is not supported
    // "../kmip/src/kmip_1_4/specifications/XML/mandatory/SKFF-M-12-14.xml",
);

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

// SUITEB (2 files)
xml_test!(
    kmip_1_4_xml_suiteb,
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/SUITEB_128-M-1-14.xml",
    "../kmip/src/kmip_1_4/specifications/XML/mandatory/SUITEB_192-M-1-14.xml",
);

// TL - Template Locate (3 files)
// Note: This test suite is sensitive to objects left over from other tests (specifically KMIP 2.1 TL tests)
// because it uses Locate operations that search by ApplicationSpecificInformation.
// We need to ensure a clean state before running these tests.
#[tokio::test]
#[serial]
async fn kmip_1_4_xml_tl() {
    use cosmian_kms_client::cosmian_kmip::{
        kmip_0::kmip_types::ApplicationSpecificInformation,
        kmip_2_1::{
            kmip_attributes::Attributes,
            kmip_operations::{Destroy, Locate},
        },
    };
    use test_kms_server::start_default_test_kms_server;

    // Get the test server
    let ctx = start_default_test_kms_server().await;
    let client = ctx.get_owner_client();

    // Clean up any objects with LIBRARY-LTO application specific information
    // that might have been left over from KMIP 2.1 tests
    let locate_req = Locate {
        attributes: Attributes {
            application_specific_information: Some(ApplicationSpecificInformation {
                application_namespace: "LIBRARY-LTO".to_owned(),
                application_data: Some(
                    "123456789ABCDEF123456789123456789ABCDEF123456789ABCDEF1234000000".to_owned(),
                ),
            }),
            ..Default::default()
        },
        ..Default::default()
    };

    if let Ok(locate_resp) = client.locate(locate_req).await {
        for uid in locate_resp.unique_identifier.unwrap_or_default() {
            // Try to destroy each found object - ignore errors as objects might not be destroyable
            drop(
                client
                    .destroy(Destroy {
                        unique_identifier: Some(uid),
                        cascade: false,
                        remove: false,
                        expected_object_type: None,
                    })
                    .await,
            );
        }
    }

    // Now run the actual tests
    run_single_xml_vector(
        "kmip_1_4_xml_tl",
        "../kmip/src/kmip_1_4/specifications/XML/mandatory/TL-M-1-14.xml",
    )
    .await;
    run_single_xml_vector(
        "kmip_1_4_xml_tl",
        "../kmip/src/kmip_1_4/specifications/XML/mandatory/TL-M-2-14.xml",
    )
    .await;
    run_single_xml_vector(
        "kmip_1_4_xml_tl",
        "../kmip/src/kmip_1_4/specifications/XML/mandatory/TL-M-3-14.xml",
    )
    .await;
}

// KMIP 1.4 XML optional vectors

// OMOS - Object Management and Object State (optional)
xml_test!(
    kmip_1_4_xml_omos_o_1_14,
    "../kmip/src/kmip_1_4/specifications/XML/optional/OMOS-O-1-14.xml"
);