Struct Store 

pub struct Store { /* private fields */ }

Implementations

impl Store

pub fn open(index_root: &str, config: &ServerConfig) -> Result<Store>

The server’s table under the index location (<index>/_server), created when missing.

pub fn audit(&self, actor: &str, action: &str, detail: &str)

Trait Implementations

impl AccountStore for Store

fn member(&self, email: &str) -> Result<Option<Who>>

The member email, with deployment admins always present and admin.

fn remove(&self, by: &str, email: &str) -> Result<()>

Remove a member with their sessions, tokens and invitations.

fn invite( &self, by: &str, email: &str, role: Role, code: bool, ) -> Result<String>

An invitation for email only: a link token, or with code a code to hand over.

fn sign_in_link(&self, email: &str) -> Result<Option<String>>

A sign-in link token for a member, or None when email is not one.

fn redeem(&self, token: &str, client: &str) -> Result<(String, Who)>

Exchange a sign-in link, an invitation or the admin token for a new session; client limits how often one place may guess.

fn sign_in_code( &self, email: &str, code: &str, client: &str, ) -> Result<(String, Who, Option<String>)>

Sign in with an email address and a code: an invitation code, which also issues the person’s own sign-in code (returned once), or that sign-in code. client identifies where the attempt comes from: wrong codes pause that address for that client only, so nobody can lock another person out.

fn sign_in_verified( &self, email: &str, how: &str, join: bool, ) -> Result<(String, Who)>

A member, someone invited (who joins with the invitation’s role) or, with join, a newcomer who joins as a viewer; the identity provider has already checked who they are.

fn reset_code( &self, by: &str, email: &str, keep: Option<&str>, ) -> Result<String>

Give email a new sign-in code; their sessions end, except keep (the caller’s own).

fn create_token( &self, who: &Who, name: &str, expires_in_days: Option<u32>, ) -> Result<String>

A personal access token for agents; its value is returned once.

fn tidy(&self)

Drop what has expired (links, sessions, tokens); called now and then by a running server.

fn members(&self) -> Result<Vec<Member>>

fn set_role(&self, by: &str, email: &str, role: Role) -> Result<()>

fn invites(&self) -> Result<Vec<Invite>>

fn revoke_invite(&self, by: &str, email: &str) -> Result<()>

fn admit(&self, email: &str, join: bool) -> Result<Who>

The same check without a session: a member, or someone invited (or with join a newcomer) who joins now. For callers an identity provider vouched for, such as the gateway.

fn sign_out(&self, session: &str, everywhere: bool) -> Result<()>

fn tokens(&self, who: &Who) -> Result<Vec<AccessToken>>

fn revoke_token(&self, who: &Who, id: &str) -> Result<()>

fn revoke_own_token(&self, token: &str) -> Result<bool>

Revoke the personal access token whose value is token; false when none matched.

impl AuditLog for Store

fn record(&self, actor: &str, action: &str, detail: &str)

Record a change made outside the account store, such as to the prompts.

fn audit_entries(&self, query: &AuditQuery) -> Result<AuditPage>

Entries newest first, from before query.before and matching its filters.

impl Authenticator for Store

fn authenticate( &self, session: Option<&str>, bearer: Option<&str>, ) -> Result<Option<(Who, Via)>>

The member behind a session cookie or, failing that, a bearer token, and which it was.

impl DeviceSignIn for Store

fn device_start(&self, client: &str, from: &str) -> Result<(String, String)>

A device code for the command and a short code for the member to confirm.

fn device_info(&self, user_code: &str) -> Option<DeviceRequest>

fn device_approve( &self, who: &Who, user_code: &str, approve: bool, ) -> Result<()>

fn device_poll(&self, device_code: &str) -> Result<DevicePoll>

impl JobStore for Store

fn save(&self, job: &JobRecord, events: &[Event]) -> Result<()>

fn get(&self, id: &str) -> Option<(JobRecord, Vec<Event>)>

fn list(&self, limit: usize) -> Vec<JobRecord>

Most recent first.

impl SecretStore for Store

fn set_secret(&self, by: &str, name: &str, value: &str) -> Result<()>

Store value under name (an empty value removes it), sealed with COMINDLY_SECRET_KEY.

fn secret_names(&self) -> Vec<String>

Names of stored secrets.

fn secret(&self, name: &str) -> Option<String>

fn secret_info(&self, name: &str) -> Option<SecretInfo>

impl SettingsStore for Store

fn repos(&self) -> Vec<RepoEntry>

fn set_repos(&self, by: &str, repos: &[RepoEntry]) -> Result<()>

fn legacy_config(&self) -> Option<String>

The config.toml an older server kept, until it has been moved over.

fn drop_legacy_config(&self) -> Result<()>

fn log_skip(&self) -> Option<String>

The kinds of log lines an admin switched off, comma-separated; None until one did.

fn set_log_skip(&self, by: &str, skip: &str) -> Result<()>