Struct Store 

pub struct Store { /* private fields */ }

Campaigns, devices, setup codes and challenges, in Postgres.

Implementations

impl Store

pub fn new(pool: PgPool) -> Self

A store in pool’s database.

pub fn pool(&self) -> &PgPool

The database.

pub async fn token_key(&self) -> Result<DeviceKey, ApiError>

The token signing key, created by whichever instance starts first.

pub async fn create_campaign( &self, name: &str, edition: Edition, ) -> Result<Campaign, ApiError>

Creates a campaign.

pub async fn campaign(&self, id: Uuid) -> Result<Campaign, ApiError>

A campaign by id.

pub async fn delete_campaign( &self, id: Uuid, ) -> Result<Option<(Campaign, u64)>, ApiError>

Deletes a campaign with its devices, setup codes, pairings and login challenges, returning what it was; None if there’s no such campaign. Its devices can’t log in from then on.

pub async fn new_setup_code( &self, campaign: Uuid, valid_for: Duration, ) -> Result<String, ApiError>

A fresh one-time code that lets a device make itself DM of campaign.

pub async fn peek_setup_code( &self, code: &str, ) -> Result<Option<Uuid>, ApiError>

The campaign a setup code is for, without using it up.

pub async fn take_setup_code( &self, executor: impl PgExecutor<'_>, code: &str, ) -> Result<Option<Uuid>, ApiError>

Uses up a setup code, returning its campaign if it was valid.

pub async fn add_device( &self, executor: impl PgExecutor<'_>, cert: &SignedCert, ) -> Result<Device, ApiError>

Adds a device with its certificate, within the campaign’s limit.

pub async fn export_campaign( &self, id: Uuid, ) -> Result<Option<AuthExport>, ApiError>

The campaign and its devices, to keep or move elsewhere; None if there’s no such campaign.

pub async fn import_campaign( &self, export: &AuthExport, ) -> Result<u64, ApiError>

Takes in a campaign exported elsewhere, as it was, ids, keys and dates included; returns how many devices came with it. All or nothing, and not over a campaign that’s here already. Every certificate must be for the campaign and properly signed.

pub async fn settings( &self, campaign: Uuid, ) -> Result<CampaignSettings, ApiError>

What was set for the campaign: by default, the services’ own limits, and changes allowed.

pub async fn set_settings( &self, campaign: Uuid, settings: &CampaignSettings, ) -> Result<(), ApiError>

Sets what the campaign may keep and do; its devices’ tokens say so from their next login.

pub async fn devices(&self, campaign: Uuid) -> Result<Vec<Device>, ApiError>

The campaign’s devices, revoked ones too.

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

Revokes a device. Refuses to revoke the campaign’s last DM device, which would leave nobody able to manage it.

pub async fn add_service( &self, name: &str, key: PublicKey, ) -> Result<(), ApiError>

Lets a service log in to any campaign with key.

pub async fn principal( &self, campaign: Uuid, key: PublicKey, ) -> Result<Option<(Principal, String)>, ApiError>

Who key is in campaign: an active device or a service.

pub async fn create_challenge( &self, campaign: Uuid, key: PublicKey, server: PublicKey, valid_for: Duration, ) -> Result<Challenge, ApiError>

A challenge for a device of the campaign to sign.

pub async fn take_challenge( &self, id: Uuid, ) -> Result<Option<IssuedChallenge>, ApiError>

Removes a challenge, returning it if it existed. Whoever gets it first wins, so each challenge is answered at most once.

Trait Implementations

impl Clone for Store

fn clone(&self) -> Store

Returns a duplicate of the value.

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

Performs copy-assignment from source.