Struct AuthClient 

pub struct AuthClient { /* private fields */ }

The auth service’s client.

Implementations

impl AuthClient

pub fn new(base_url: impl Into<String>) -> Self

A client for the auth service at base_url, without a token.

pub fn with_token(self, token: &str) -> Self

For the calls that need a logged-in device (see Session::token).

pub async fn server_key(&self) -> Result<PublicKey, ClientError>

The key the server signs tokens with. Clients remember it the first time and check it on every login after.

pub async fn wait_for_server_key( &self, patience: Duration, ) -> Result<PublicKey, ClientError>

AuthClient::server_key, retrying while the auth service can’t be reached (e.g. it’s still starting), for up to patience.

pub async fn setup( &self, code: &str, key: &DeviceKey, name: &str, ) -> Result<Campaign, ClientError>

Makes key the DM of the campaign a one-time setup code is for.

pub async fn login( &self, campaign: Uuid, key: &DeviceKey, expected_server: Option<PublicKey>, ) -> Result<Session, ClientError>

Answers a login challenge with key, returning a short-lived token. With expected_server, refuses to sign for any other server.

pub async fn campaign(&self) -> Result<Campaign, ClientError>

The token’s campaign.

pub async fn devices(&self) -> Result<Vec<Device>, ClientError>

The campaign’s devices, revoked ones too.

pub async fn add_device(&self, cert: &SignedCert) -> Result<Device, ClientError>

Adds a device, vouched for by a certificate signed with the DM key this client is logged in with.

pub async fn revoke(&self, key: PublicKey) -> Result<Device, ClientError>

Revokes a device (DM devices only).

impl AuthClient

pub async fn invite(&self, role: Role) -> Result<Invitation, ClientError>

Opens a pairing (DM devices only) and makes up its code. The words are made here and never sent anywhere.

pub async fn cancel_pairing(&self, slot: u16) -> Result<(), ClientError>

Cancels a pairing this DM device opened.

Trait Implementations

impl Clone for AuthClient

fn clone(&self) -> AuthClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthClient

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

Formats the value using the given formatter.