Struct X509Source 

pub struct X509Source { /* private fields */ }

Live source of X.509 SVIDs and bundles from the SPIFFE Workload API.

X509Source performs an initial sync before returning from X509Source::new. Updates are applied atomically and can be observed via X509Source::updated.

Implementations

impl X509Source

pub async fn new() -> Result<Arc<Self>, X509SourceError>

Creates an X509Source using the default Workload API endpoint.

The endpoint is resolved from SPIFFE_ENDPOINT_SOCKET. The source selects the default X.509 SVID when multiple SVIDs are available.

On success, the returned source is already synchronized with the agent and will keep updating in the background until it is closed.

pub async fn shutdown(&self) -> Result<(), X509SourceError>

Cancels background tasks and waits for termination.

pub fn updated(&self) -> Receiver<u64>

Returns a receiver that is notified on each successful update.

The received value is a monotonically increasing counter.

pub fn svid(&self) -> Result<X509Svid, X509SourceError>

Returns the current X.509 SVID.

impl X509Source

pub fn bundle_set(&self) -> Result<X509BundleSet, X509SourceError>

Returns the current X.509 bundle set.

pub fn x509_context(&self) -> Result<X509Context, X509SourceError>

Returns the current X.509 context (SVID + bundles) as a single value.

Trait Implementations

impl BundleSource for X509Source

type Item = X509Bundle

The type of the bundles provided by the source.

fn get_bundle_for_trust_domain( &self, trust_domain: &TrustDomain, ) -> Result<Option<Self::Item>, Box<dyn StdError + Send + Sync + 'static>>

Returns a owned bundle (set of public keys authorities) associated to the TrustDomain. If it cannot be found a bundle associated to the trust domain, it returns Ok(None). If there’s is an error in source fetching the bundle, it returns an Err<Box<dyn Error + Send + Sync + 'static>>.

impl Debug for X509Source

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for X509Source

fn drop(&mut self)

Executes the destructor for this type.

impl SvidSource for X509Source

type Item = X509Svid

The type of the SVIDs provided by the source.

fn get_svid( &self, ) -> Result<Option<Self::Item>, Box<dyn StdError + Send + Sync + 'static>>

Returns an owned SVID. If it cannot be found an SVID in the source, it returns Ok(None). If there’s is an error in source fetching the SVID, it returns an Err<Box<dyn Error + Send + Sync + 'static>>.