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

//! X.509-SVID and JWT-SVID types.

use std::error::Error;
use std::sync::Arc;

#[cfg(feature = "jwt")]
pub mod jwt;
#[cfg(feature = "x509")]
pub mod x509;

/// Represents a source of SVIDs.
///
/// This trait returns an `Arc` to avoid forcing either:
/// - cloning large SVID structs, or
/// - exposing borrowing lifetimes in the public API.
///
/// Implementations are free to internally cache and rotate SVIDs.
pub trait SvidSource {
    /// The type of the SVIDs provided by the source.
    type Item: Send + Sync + 'static;

    /// The error type returned by the source.
    type Error: Error + Send + Sync + 'static;

    /// Returns the current SVID.
    ///
    /// # Errors
    ///
    /// Returns `Self::Error` if the SVID cannot be retrieved.
    fn svid(&self) -> Result<Arc<Self::Item>, Self::Error>;
}