Struct WorkloadApiClient 

pub struct WorkloadApiClient { /* private fields */ }

Client for the SPIFFE Workload API.

Provides one-shot calls and streaming updates for X.509 and JWT SVIDs and bundles. For an always-up-to-date, shareable source of X.509 material with automatic reconnection, see crate::X509Source.

Implementations

impl WorkloadApiClient

pub fn socket_path(&self) -> &str

Returns the configured Workload API socket path.

pub async fn new_from_path( path: impl AsRef<str>, ) -> Result<Self, GrpcClientError>

Connects to the Workload API using the given UNIX domain socket path.

The path may optionally be prefixed with unix: (e.g. unix:/tmp/spire-agent/public/api.sock).

pub async fn reconnect(&mut self) -> Result<(), GrpcClientError>

Rebuilds the underlying gRPC channel.

This is intended for manual recovery scenarios. Higher-level abstractions such as X509Source typically create fresh clients and manage reconnection automatically.

pub async fn default() -> Result<Self, GrpcClientError>

Connects to the Workload API using SPIFFE_ENDPOINT_SOCKET.

pub fn new( socket_path: impl AsRef<str>, conn: Channel, ) -> Result<Self, GrpcClientError>

Creates a client from an existing gRPC channel.

This is primarily useful for tests or advanced transport customization.

pub async fn fetch_x509_svid(&mut self) -> Result<X509Svid, GrpcClientError>

Fetches the default X.509 SVID for the calling workload.

pub async fn fetch_all_x509_svids( &mut self, ) -> Result<Vec<X509Svid>, GrpcClientError>

Fetches all X.509 SVIDs available to the calling workload.

pub async fn fetch_x509_bundles( &mut self, ) -> Result<X509BundleSet, GrpcClientError>

Fetches the current X.509 bundle set.

pub async fn fetch_jwt_bundles( &mut self, ) -> Result<JwtBundleSet, GrpcClientError>

Fetches the current JWT bundle set.

pub async fn fetch_x509_context( &mut self, ) -> Result<X509Context, GrpcClientError>

Fetches the current X.509 context (SVIDs and bundles).

pub async fn fetch_jwt_svid<T: AsRef<str> + ToString>( &mut self, audience: &[T], spiffe_id: Option<&SpiffeId>, ) -> Result<JwtSvid, GrpcClientError>

Fetches a JWT-SVID for the given audience and optional SPIFFE ID.

If spiffe_id is None, the Workload API returns the default identity.

pub async fn fetch_jwt_token<T: AsRef<str> + ToString>( &mut self, audience: &[T], spiffe_id: Option<&SpiffeId>, ) -> Result<String, GrpcClientError>

Fetches a JWT-SVID token string for the given audience and optional SPIFFE ID.

If spiffe_id is None, the Workload API returns the default identity.

pub async fn validate_jwt_token<T: AsRef<str> + ToString>( &mut self, audience: T, jwt_token: &str, ) -> Result<JwtSvid, GrpcClientError>

Validates a JWT-SVID token for the given audience and returns the parsed JwtSvid.

pub async fn stream_x509_contexts( &mut self, ) -> Result<impl Stream<Item = Result<X509Context, GrpcClientError>> + use<>, GrpcClientError>

Streams X.509 context updates from the Workload API.

pub async fn stream_x509_svids( &mut self, ) -> Result<impl Stream<Item = Result<X509Svid, GrpcClientError>> + use<>, GrpcClientError>

Streams X.509 SVID updates from the Workload API.

pub async fn stream_x509_bundles( &mut self, ) -> Result<impl Stream<Item = Result<X509BundleSet, GrpcClientError>> + use<>, GrpcClientError>

Streams X.509 bundle set updates from the Workload API.

pub async fn stream_jwt_bundles( &mut self, ) -> Result<impl Stream<Item = Result<JwtBundleSet, GrpcClientError>> + use<>, GrpcClientError>

Streams JWT bundle set updates from the Workload API.

Trait Implementations

impl Clone for WorkloadApiClient

fn clone(&self) -> WorkloadApiClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WorkloadApiClient

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

Formats the value using the given formatter.