Struct Client

pub struct Client { /* private fields */ }

The authly client handle.

Implementations

impl Client

pub fn builder() -> ClientBuilder

Construct a new builder.

pub async fn metadata(&self) -> Result<ServiceMetadata, Error>

Retrieve the ServiceMetadata about service this client identifies as.

pub async fn metadata_stream( &self, ) -> Result<BoxStream<'static, ServiceMetadata>, Error>

Get a stream of ServiceMetadata changes.

The first metadata in the stream resolves immediately, and is the current metadata.

pub fn get_resource_property_mapping(&self) -> Arc<NamespacePropertyMapping>

Get the current resource properties of this service, in the form of a NamespacePropertyMapping.

pub fn decode_access_token( &self, access_token: impl Into<String>, ) -> Result<Arc<AccessToken>, Error>

Decode and validate an Authly AccessToken. The access token usually represents an entity which is a user of the system.

pub async fn get_access_token( &self, session_token: &str, ) -> Result<Arc<AccessToken>, Error>

Exchange a session token for an access token suitable for evaluating access control.

pub fn into_dyn_access_control( self, ) -> Arc<dyn AccessControl + Send + Sync + 'static>

Convert a clone of self into a dynamically dispatched access control object.

This can be useful in tests where access control needs to be mocked out.

pub async fn generate_server_tls_params( &self, subject_common_name: &str, ) -> Result<(CertificateDer<'static>, PrivateKeyDer<'static>), Error>

Generate a server certificate and a key pair for the service.

This involves sending a Certificate Signing Request for Authly to resolve.

Returns a pair of Certificate signed by the Authly Local CA, and the matching private key to be used by the server.

The common name can be any chosen text identifying the service.

pub fn connection_params_stream( &self, ) -> BoxStream<'static, Arc<ConnectionParams>>

Generates a stream of ConnectionParams that this client uses to connect to Authly.

The TLS-related parts of those parameters can be used by the client when communicating with other services in the Authly service mesh.

The first stream item will resolve immediately.

Trait Implementations

impl AccessControl for Client

fn access_control_request(&self) -> AccessControlRequestBuilder<'_>

Make a new access control request, returning a builder for building it.

fn evaluate( &self, builder: AccessControlRequestBuilder<'_>, ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + '_>>

Evaluate the access control request.

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.