spiffe 0.13.0

Core SPIFFE identity types and Workload API sources
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
//! These tests requires a running SPIRE server and agent with workloads registered (see `scripts/run-spire.sh`).

#![expect(unused_crate_dependencies, reason = "used in the library target")]

#[cfg(test)]
#[cfg(feature = "workload-api-full")]
mod integration_tests_workload_api_client {
    use futures::StreamExt as _;
    use spiffe::bundle::BundleSource as _;
    use spiffe::{SpiffeId, TrustDomain, WorkloadApiClient};
    use std::sync::LazyLock;

    static SPIFFE_ID_1: LazyLock<SpiffeId> =
        LazyLock::new(|| SpiffeId::new("spiffe://example.org/myservice").unwrap());

    static SPIFFE_ID_2: LazyLock<SpiffeId> =
        LazyLock::new(|| SpiffeId::new("spiffe://example.org/myservice2").unwrap());

    static TRUST_DOMAIN: LazyLock<TrustDomain> =
        LazyLock::new(|| TrustDomain::new("example.org").unwrap());
    static FEDERATED_TRUST_DOMAIN: LazyLock<TrustDomain> =
        LazyLock::new(|| TrustDomain::new("example-federated.org").unwrap());

    async fn get_client() -> WorkloadApiClient {
        WorkloadApiClient::connect_env()
            .await
            .expect("Failed to create client")
    }

    #[tokio::test]
    #[ignore = "requires running SPIFFE Workload API"]
    async fn fetch_jwt_svid() {
        let client = get_client().await;
        let svid = client
            .fetch_jwt_svid(&["my_audience"], None)
            .await
            .expect("Failed to fetch JWT SVID");
        assert_eq!(svid.audience(), &["my_audience"]);
    }

    #[tokio::test]
    #[ignore = "requires running SPIFFE Workload API"]
    async fn fetch_and_validate_jwt_token() {
        let client = get_client().await;

        let token = client
            .fetch_jwt_token(&["my_audience"], Some(&*SPIFFE_ID_1))
            .await
            .expect("Failed to fetch JWT token");
        let jwt_svid = client
            .validate_jwt_token("my_audience", &token)
            .await
            .expect("Failed to validate JWT token");
        assert_eq!(jwt_svid.audience(), &["my_audience"]);
        assert_eq!(jwt_svid.spiffe_id(), &*SPIFFE_ID_1);

        let token = client
            .fetch_jwt_token(&["other_audience"], Some(&*SPIFFE_ID_2))
            .await
            .expect("Failed to fetch JWT token");
        let jwt_svid = client
            .validate_jwt_token("other_audience", &token)
            .await
            .expect("Failed to validate JWT token");
        assert_eq!(jwt_svid.audience(), &["other_audience"]);
        assert_eq!(jwt_svid.spiffe_id(), &*SPIFFE_ID_2);
    }

    #[tokio::test]
    #[ignore = "requires running SPIFFE Workload API"]
    async fn fetch_all_jwt_svids_includes_hints() {
        let client = get_client().await;

        let svids = client
            .fetch_all_jwt_svids(&["my_audience"], None)
            .await
            .expect("Failed to fetch all JWT SVIDs");

        assert!(
            svids.len() >= 2,
            "Expected at least two JWT-SVIDs (configure two workload entries with hints)"
        );

        let hints: Vec<_> = svids.iter().filter_map(|s| s.hint()).collect();
        assert!(
            hints.len() >= 2,
            "Expected hints to be present on returned JWT-SVIDs"
        );

        assert!(hints.contains(&"myservice"));
        assert!(hints.contains(&"myservice2"));
    }

    #[tokio::test]
    #[ignore = "requires running SPIFFE Workload API"]
    async fn fetch_jwt_svid_by_hint_selects_correct_one() {
        let client = get_client().await;

        let svid = client
            .fetch_jwt_svid_by_hint(&["my_audience"], None, "myservice2")
            .await
            .expect("Failed to fetch JWT-SVID by hint");

        assert_eq!(svid.hint(), Some("myservice2"));

        assert_eq!(svid.spiffe_id(), &*SPIFFE_ID_2);
    }

    #[tokio::test]
    #[ignore = "requires running SPIFFE Workload API"]
    async fn fetch_jwt_bundles() {
        let client = get_client().await;
        let bundles = client
            .fetch_jwt_bundles()
            .await
            .expect("Failed to fetch JWT bundles");

        let bundle = bundles.bundle_for_trust_domain(&TRUST_DOMAIN);
        let bundle = bundle
            .expect("Bundle was None")
            .expect("Failed to unwrap bundle");

        let svid = client
            .fetch_jwt_svid(&["my_audience"], None)
            .await
            .expect("Failed to fetch JWT SVID");
        let key_id = svid.key_id();

        assert_eq!(bundle.trust_domain().as_ref(), TRUST_DOMAIN.as_ref());
        assert_eq!(
            bundle.find_jwt_authority(key_id).unwrap().key_id(),
            key_id.to_string()
        );
    }

    #[tokio::test]
    #[ignore = "requires running SPIFFE Workload API"]
    async fn fetch_x509_svid() {
        let client = get_client().await;
        let svid = client
            .fetch_x509_svid()
            .await
            .expect("Failed to fetch X509 SVID");

        let expected_ids = [&*SPIFFE_ID_1, &*SPIFFE_ID_2];
        assert!(
            expected_ids.contains(&svid.spiffe_id()),
            "Unexpected SPIFFE ID"
        );
        assert_eq!(svid.cert_chain().len(), 1);
    }

    #[tokio::test]
    #[ignore = "requires running SPIFFE Workload API"]
    async fn fetch_all_x509_svids() {
        let client = get_client().await;
        let svids = client
            .fetch_all_x509_svids()
            .await
            .expect("Failed to fetch X509 SVID");

        assert_eq!(svids.len(), 2, "Expected exactly two SVIDs");

        let expected_ids = [&*SPIFFE_ID_1, &*SPIFFE_ID_2];

        match svids.as_slice() {
            [first_svid, second_svid] => {
                // Checking the first SVID
                assert!(
                    expected_ids.contains(&first_svid.spiffe_id()),
                    "Unexpected SPIFFE ID"
                );
                assert_eq!(first_svid.cert_chain().len(), 1);

                // Checking the second SVID
                assert!(
                    expected_ids.contains(&second_svid.spiffe_id()),
                    "Unexpected SPIFFE ID"
                );
                assert_eq!(second_svid.cert_chain().len(), 1);

                assert_ne!(
                    first_svid.spiffe_id(),
                    second_svid.spiffe_id(),
                    "Expected different SPIFFE IDs"
                );
            }
            svids => panic!("Expected exactly two SVIDs, got {svids:?}"),
        }
    }

    #[tokio::test]
    #[ignore = "requires running SPIFFE Workload API"]
    async fn fetch_x509_context() {
        let client = get_client().await;
        let x509_context = client
            .fetch_x509_context()
            .await
            .expect("Failed to fetch X509 context");

        let expected_ids = [&*SPIFFE_ID_1, &*SPIFFE_ID_2];

        let svid = x509_context.default_svid().unwrap();
        assert!(
            expected_ids.contains(&svid.spiffe_id()),
            "Unexpected SPIFFE ID"
        );
        assert_eq!(svid.cert_chain().len(), 1);

        let bundle = x509_context
            .bundle_set()
            .bundle_for_trust_domain(&TRUST_DOMAIN);
        let bundle = bundle
            .expect("Bundle was None")
            .expect("Failed to unwrap bundle");

        assert_eq!(bundle.trust_domain().as_ref(), TRUST_DOMAIN.as_ref());
        assert_eq!(bundle.authorities().len(), 1);

        let federated_bundle = x509_context
            .bundle_set()
            .bundle_for_trust_domain(&FEDERATED_TRUST_DOMAIN);
        let federated_bundle = federated_bundle
            .expect("Federated bundle was None")
            .expect("Failed to unwrap federated bundle");

        assert_eq!(
            federated_bundle.trust_domain().as_ref(),
            FEDERATED_TRUST_DOMAIN.as_ref()
        );
        assert_eq!(federated_bundle.authorities().len(), 1);
    }

    #[tokio::test]
    #[ignore = "requires running SPIFFE Workload API"]
    async fn fetch_x509_context_includes_hints_on_all_svids() {
        let client = get_client().await;

        let ctx = client
            .fetch_x509_context()
            .await
            .expect("Failed to fetch X509 context");

        let svids = ctx.svids();
        assert!(
            svids.len() >= 2,
            "Expected at least two X509-SVIDs (configure two workload entries with hints)"
        );

        let hints: Vec<_> = svids.iter().filter_map(|s| s.hint()).collect();
        assert!(
            hints.len() >= 2,
            "Expected hints to be present on returned X509-SVIDs"
        );

        assert!(hints.contains(&"myservice"));
        assert!(hints.contains(&"myservice2"));
    }

    #[tokio::test]
    #[ignore = "requires running SPIFFE Workload API"]
    async fn fetch_x509_bundles() {
        let client = get_client().await;
        let bundles = client
            .fetch_x509_bundles()
            .await
            .expect("Failed to fetch X509 bundles");

        let bundle = bundles.bundle_for_trust_domain(&TRUST_DOMAIN);
        let bundle = bundle
            .expect("Bundle was None")
            .expect("Failed to unwrap bundle");

        assert_eq!(bundle.trust_domain().as_ref(), TRUST_DOMAIN.as_ref());
        assert_eq!(bundle.authorities().len(), 1);
    }

    #[tokio::test]
    #[ignore = "requires running SPIFFE Workload API"]
    async fn stream_x509_contexts() {
        let client = get_client().await;
        let test_duration = std::time::Duration::from_secs(60);
        let expected_ids = [&*SPIFFE_ID_1, &*SPIFFE_ID_2];

        let result = tokio::time::timeout(test_duration, async {
            let mut update_count = 0;
            let mut stream = client
                .stream_x509_contexts()
                .await
                .expect("Failed to get stream");

            while let Some(update) = stream.next().await {
                match update {
                    Ok(x509_context) => {
                        let svid = x509_context.default_svid().unwrap();
                        assert!(
                            expected_ids.contains(&svid.spiffe_id()),
                            "Unexpected SPIFFE ID"
                        );
                        assert_eq!(svid.cert_chain().len(), 1);

                        let bundle = x509_context
                            .bundle_set()
                            .bundle_for_trust_domain(&TRUST_DOMAIN);
                        let bundle = bundle
                            .expect("Bundle was None")
                            .expect("Failed to unwrap bundle");

                        assert_eq!(bundle.trust_domain().as_ref(), TRUST_DOMAIN.as_ref());
                        assert_eq!(bundle.authorities().len(), 1);

                        let federated_bundle = x509_context
                            .bundle_set()
                            .bundle_for_trust_domain(&FEDERATED_TRUST_DOMAIN);
                        let federated_bundle = federated_bundle
                            .expect("Federated bundle was None")
                            .expect("Failed to unwrap federated bundle");

                        assert_eq!(
                            federated_bundle.trust_domain().as_ref(),
                            FEDERATED_TRUST_DOMAIN.as_ref()
                        );
                        assert_eq!(federated_bundle.authorities().len(), 1);

                        update_count += 1;
                        if update_count == 3 {
                            break;
                        }
                    }
                    Err(e) => eprintln!("Error in stream: {e:?}"),
                }
            }

            assert_eq!(update_count, 3, "Expected 3 updates from the stream");
        })
        .await;

        assert!(
            result.is_ok(),
            "Test did not complete in the expected duration"
        );
    }

    #[tokio::test]
    #[ignore = "requires running SPIFFE Workload API"]
    async fn stream_x509_svids() {
        let client = get_client().await;
        let test_duration = std::time::Duration::from_secs(60);
        let expected_ids = [&*SPIFFE_ID_1, &*SPIFFE_ID_2];

        let result = tokio::time::timeout(test_duration, async {
            let mut update_count = 0;
            let mut stream = client
                .stream_x509_svids()
                .await
                .expect("Failed to get stream");

            while let Some(update) = stream.next().await {
                match update {
                    Ok(svid) => {
                        assert!(
                            expected_ids.contains(&svid.spiffe_id()),
                            "Unexpected SPIFFE ID"
                        );
                        assert_eq!(svid.cert_chain().len(), 1);

                        update_count += 1;
                        if update_count == 3 {
                            break;
                        }
                    }
                    Err(e) => eprintln!("Error in stream: {e:?}"),
                }
            }

            assert_eq!(update_count, 3, "Expected 3 updates from the stream");
        })
        .await;

        assert!(
            result.is_ok(),
            "Test did not complete in the expected duration"
        );
    }

    #[tokio::test]
    #[ignore = "requires running SPIFFE Workload API"]
    async fn stream_x509_bundles() {
        let client = get_client().await;
        let test_duration = std::time::Duration::from_secs(60);

        let result = tokio::time::timeout(test_duration, async {
            let mut stream = client
                .stream_x509_bundles()
                .await
                .expect("Failed to get stream");
            if let Some(update) = stream.next().await {
                match update {
                    Ok(bundles) => {
                        let bundle = bundles.bundle_for_trust_domain(&TRUST_DOMAIN);
                        let bundle = bundle
                            .expect("Bundle was None")
                            .expect("Failed to unwrap bundle");

                        assert_eq!(bundle.trust_domain().as_ref(), TRUST_DOMAIN.as_ref());
                        assert_eq!(bundle.authorities().len(), 1);
                    }
                    Err(e) => eprintln!("Error in stream: {e:?}"),
                }
            }
        })
        .await;

        assert!(
            result.is_ok(),
            "Test did not complete in the expected duration"
        );
    }

    #[tokio::test]
    #[ignore = "requires running SPIFFE Workload API"]
    async fn stream_jwt_bundles() {
        let client = get_client().await;
        let test_duration = std::time::Duration::from_secs(60);

        let result = tokio::time::timeout(test_duration, async {
            let mut stream = client
                .stream_jwt_bundles()
                .await
                .expect("Failed to get stream");
            if let Some(update) = stream.next().await {
                match update {
                    Ok(bundles) => {
                        let bundle = bundles.bundle_for_trust_domain(&TRUST_DOMAIN);
                        let bundle = bundle
                            .expect("Bundle was None")
                            .expect("Failed to unwrap bundle");

                        let svid = client
                            .fetch_jwt_svid(&["my_audience"], None)
                            .await
                            .expect("Failed to fetch JWT SVID");
                        let key_id = svid.key_id();

                        assert_eq!(bundle.trust_domain().as_ref(), TRUST_DOMAIN.as_ref());
                        assert_eq!(
                            bundle.find_jwt_authority(key_id).unwrap().key_id(),
                            key_id.to_string()
                        );
                    }
                    Err(e) => eprintln!("Error in stream: {e:?}"),
                }
            }
        })
        .await;

        assert!(
            result.is_ok(),
            "Test did not complete in the expected duration"
        );
    }
}