cipherstash-client 0.39.1

The official CipherStash SDK
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
#![cfg(feature = "test-utils")]

mod prelude;
use prelude::*;
use zerokms_protocol::UnverifiedContext;

#[tokio::test]
#[ignore = "e2e"]
async fn create_keyset_e2e() {
    let (client, _, _) = setup_zerokms_client().await;

    let keyset_name: String = Faker.fake();

    let keyset = client
        .create_keyset(&keyset_name, "new keyset description")
        .await
        .expect("failed to create keyset");

    assert_eq!(keyset.description, "new keyset description");
    assert_eq!(keyset.name, keyset_name);
}

#[tokio::test]
#[ignore = "e2e"]
async fn list_keysets() {
    let (client, _, _) = setup_zerokms_client().await;

    let keyset_name: String = Faker.fake();

    let keyset = client
        .create_keyset(&keyset_name, "keyset to list description")
        .await
        .expect("failed to create keyset");

    let retrieved_keyset = client
        .list_keysets(false)
        .await
        .expect("failed to list keysets")
        .into_iter()
        .find(|x| x.id == keyset.id)
        .expect("could not find keyset in listed output");

    assert_eq!(keyset.description, retrieved_keyset.description);
    assert_eq!(keyset.name, retrieved_keyset.name);
}

#[tokio::test]
#[ignore = "e2e"]
async fn modify_keyset() {
    let (client, _, _) = setup_zerokms_client().await;

    let keyset_name: String = Faker.fake();

    let keyset = client
        .create_keyset(&keyset_name, "keyset to modify description")
        .await
        .expect("failed to create keyset");

    let modified_keyset_name: String = Faker.fake();

    client
        .modify_keyset(
            keyset.id,
            Some(&modified_keyset_name),
            Some("modified keyset description"),
        )
        .await
        .expect("failed to modify keyset");

    let retrieved_keyset = client
        .list_keysets(false)
        .await
        .expect("failed to list keysets")
        .into_iter()
        .find(|x| x.id == keyset.id)
        .expect("could not find modified keyset in listed output");

    assert_eq!(retrieved_keyset.description, "modified keyset description");
    assert_eq!(retrieved_keyset.name, modified_keyset_name);
}

#[tokio::test]
#[ignore = "e2e"]
async fn create_client_e2e() {
    let (zero_kms, _, _) = setup_zerokms_client().await;

    let keyset_name: String = Faker.fake();

    let keyset = zero_kms
        .create_keyset(&keyset_name, "keyset for client description")
        .await
        .expect("failed to create keyset");

    let client = zero_kms
        .create_client(
            "created client",
            "created client description",
            Some(keyset.id),
        )
        .await
        .expect("failed to create client");

    assert_eq!(client.name, "created client");
    assert_eq!(client.description, "created client description");
}

#[tokio::test]
#[ignore = "e2e"]
async fn list_clients() {
    let (zero_kms, _, _) = setup_zerokms_client().await;

    let keyset_name: String = Faker.fake();

    let keyset = zero_kms
        .create_keyset(&keyset_name, "keyset for client description")
        .await
        .expect("failed to create keyset");

    let client = zero_kms
        .create_client(
            "client to list",
            "client to list description",
            Some(keyset.id),
        )
        .await
        .expect("failed to create client");

    let retrieved_client = zero_kms
        .list_clients(None)
        .await
        .expect("failed to list clients")
        .into_iter()
        .find(|x| x.id == client.id)
        .expect("failed to find client in list output");

    assert_eq!(retrieved_client.name, client.name);
    assert_eq!(retrieved_client.description, client.description);
}

#[tokio::test]
#[ignore = "e2e"]
async fn encrypt_record() {
    let (zerokms_client, _, _, _) = setup_zerokms_client_with_client_key().await;

    let _ = zerokms_client
        .encrypt_single(
            EncryptPayload::new_with_descriptor(b"message to encrypt", "test-descriptor"),
            None,
        )
        .await
        .expect("failed to encrypt record");
}

#[tokio::test]
#[ignore = "e2e"]
async fn decrypt_record() {
    let (zerokms_client, _, _, _) = setup_zerokms_client_with_client_key().await;

    let record = zerokms_client
        .encrypt_single(
            EncryptPayload::new_with_descriptor(b"message to decrypt", "test-descriptor"),
            None,
        )
        .await
        .expect("failed to encrypt record");

    let message = zerokms_client
        .decrypt_single(record, None, None)
        .await
        .expect("failed to decrypt record");

    assert_eq!(message, b"message to decrypt")
}

#[tokio::test]
#[ignore = "e2e"]
async fn disable_keyset() {
    let (zerokms_client, _, keyset, _) = setup_zerokms_client_with_client_key().await;

    zerokms_client
        .disable_keyset(keyset.id)
        .await
        .expect("failed to disable keyset");
}

#[tokio::test]
#[ignore = "e2e"]
async fn encrypt_with_disabled_keyset() {
    let (zerokms_client, _, keyset, _) = setup_zerokms_client_with_client_key().await;

    zerokms_client
        .disable_keyset(keyset.id)
        .await
        .expect("failed to disable keyset");

    let _ = zerokms_client
        .encrypt_single(
            EncryptPayload::new_with_descriptor(b"message to fail to encrypt", "test-descriptor"),
            None,
        )
        .await
        .expect_err("encryption should fail against disabled keyset");
}

#[tokio::test]
#[ignore = "e2e"]
async fn decrypt_with_disabled_keyset() {
    let (zerokms_client, _, keyset, _) = setup_zerokms_client_with_client_key().await;

    let record = zerokms_client
        .encrypt_single(
            EncryptPayload::new_with_descriptor(b"message to fail to decrypt", "test-descriptor"),
            None,
        )
        .await
        .expect("failed to encrypt record");

    zerokms_client
        .disable_keyset(keyset.id)
        .await
        .expect("failed to disable keyset");

    let _ = zerokms_client
        .decrypt_single(record, None, None)
        .await
        .expect_err("decryption should fail against disabled keyset");
}

#[tokio::test]
#[ignore = "e2e"]
async fn enable_keyset() {
    let (zerokms_client, _, keyset, _) = setup_zerokms_client_with_client_key().await;

    zerokms_client
        .disable_keyset(keyset.id)
        .await
        .expect("failed to disable keyset");

    zerokms_client
        .enable_keyset(keyset.id)
        .await
        .expect("failed to enable keyset");
}

#[tokio::test]
#[ignore = "e2e"]
async fn encrypt_record_reenabled() {
    let (zerokms_client, _, keyset, _) = setup_zerokms_client_with_client_key().await;

    zerokms_client
        .disable_keyset(keyset.id)
        .await
        .expect("failed to disable keyset");

    zerokms_client
        .enable_keyset(keyset.id)
        .await
        .expect("failed to enable keyset");

    let _ = zerokms_client
        .encrypt_single(
            EncryptPayload::new_with_descriptor(b"message to encrypt", "test-descriptor"),
            None,
        )
        .await
        .expect("failed to encrypt record");
}

#[tokio::test]
#[ignore = "e2e"]
async fn decrypt_record_reenabled() {
    let (zerokms_client, _, keyset, _) = setup_zerokms_client_with_client_key().await;

    zerokms_client
        .disable_keyset(keyset.id)
        .await
        .expect("failed to disable keyset");

    zerokms_client
        .enable_keyset(keyset.id)
        .await
        .expect("failed to enable keyset");

    let record = zerokms_client
        .encrypt_single(
            EncryptPayload::new_with_descriptor(
                b"message to decrypt after re-enabling",
                "test-descriptor",
            ),
            None,
        )
        .await
        .expect("failed to encrypt record");

    let message = zerokms_client
        .decrypt_single(record, None, None)
        .await
        .expect("failed to decrypt record");

    assert_eq!(message, b"message to decrypt after re-enabling")
}

#[tokio::test]
#[ignore = "e2e"]
async fn decrypt_with_tenant_keyset() {
    let (zerokms_client, _, _, client_key) = setup_zerokms_client_with_client_key().await;
    let client_id = client_key.key_id;

    // Create and grant a tenant keyset
    let tenant_keyset_name: String = Faker.fake();
    let tenant_keyset = zerokms_client
        .create_keyset(&tenant_keyset_name, "tenant-description")
        .await
        .expect("failed to create tenant keyset");

    zerokms_client
        .grant_keyset(client_id, tenant_keyset.id)
        .await
        .expect("failed to grant client keyset access");

    let record = zerokms_client
        .encrypt_single(
            EncryptPayload::new_with_descriptor(b"message to fail to decrypt", "test-descriptor"),
            None,
        )
        .await
        .expect("failed to encrypt record");

    let _ = zerokms_client
        .decrypt_single(record, Some(tenant_keyset.id), None)
        .await
        .expect_err("decryption should fail when keyset id does not match record");
}

#[tokio::test]
#[ignore = "e2e"]
async fn decrypt_single_with_unverified_context() {
    let (zerokms_client, _, _, _) = setup_zerokms_client_with_client_key().await;

    let record = zerokms_client
        .encrypt_single(
            EncryptPayload::new_with_descriptor(b"message", "test-descriptor"),
            None,
        )
        .await
        .expect("failed to encrypt record");

    let unverified_context: UnverifiedContext = serde_json::from_value(json!({
        "sub": "user_123"
    }))
    .unwrap();

    let message = zerokms_client
        .decrypt_single(record, None, Some(&unverified_context))
        .await
        .expect("failed to decrypt record");

    assert_eq!(message, b"message");
}

#[tokio::test]
#[ignore = "e2e"]
async fn decrypt_with_unverified_context() {
    let (zerokms_client, _, _, _) = setup_zerokms_client_with_client_key().await;

    let record = zerokms_client
        .encrypt_single(
            EncryptPayload::new_with_descriptor(b"message", "test-descriptor"),
            None,
        )
        .await
        .expect("failed to encrypt record");

    let unverified_context: UnverifiedContext = serde_json::from_value(json!({
        "sub": "user_123"
    }))
    .unwrap();

    let message = zerokms_client
        .decrypt(vec![record], None, Some(&unverified_context))
        .await
        .expect("failed to decrypt record");

    assert_eq!(message.len(), 1);
    assert_eq!(message[0], b"message");
}

#[tokio::test]
#[ignore = "e2e"]
async fn decrypt_fallible_with_unverified_context() {
    let (zerokms_client, _, _, _) = setup_zerokms_client_with_client_key().await;

    let record = zerokms_client
        .encrypt_single(
            EncryptPayload::new_with_descriptor(b"message", "test-descriptor"),
            None,
        )
        .await
        .expect("failed to encrypt record");

    let unverified_context: Cow<UnverifiedContext> = serde_json::from_value(json!({
        "sub": "user_123"
    }))
    .unwrap();

    let message = zerokms_client
        .decrypt_fallible(vec![record], Some(unverified_context))
        .await
        .expect("failed to decrypt record");

    assert_eq!(message.len(), 1);
    assert_eq!(message[0].clone().unwrap(), b"message");
}