Struct SqliteStore 

pub struct SqliteStore { /* private fields */ }

Implementations

impl SqliteStore

pub fn roles(&self, user_id: i64) -> StoreResult<(String, Role)>

(kind, role) of a user; defaults ("agent", User).

pub fn set_roles( &self, user_id: i64, kind: Option<&str>, role: Option<Role>, ) -> StoreResult<(String, Role)>

Sets either axis (or both); the other keeps its value.

impl SqliteStore

pub fn new(db: Db) -> Result<Self, String>

The product database in an opened store (shared with the event queue: one writer per file).

pub fn open(cfg: &DbConfig) -> Result<Self, String>

Opens the store described by cfg (see m4a_product_kit::dbkey).

pub fn memory() -> Result<Self, String>

Plaintext in-memory database, for tests only.

pub fn db(&self) -> Db

The underlying store, to share its single writer with the event queue.

Trait Implementations

impl UserStore for SqliteStore

fn user_by_nick(&self, nick: &str) -> StoreResult<Option<User>>

fn insert_user( &self, nick: &str, tier: &str, secret_hash: Option<&str>, now_ms: i64, ) -> StoreResult<User>

secret_hash is an opaque password hash (or None for door-only users).

fn secret_hash(&self, user_id: i64) -> StoreResult<Option<String>>

fn update_nick( &self, user_id: i64, new_nick: &str, now_ms: i64, ) -> StoreResult<User>

Changes the nick; must fail with StoreError::NickTaken on a collision.

fn set_tier(&self, user_id: i64, tier: &str) -> StoreResult<()>

fn delete_user(&self, user_id: i64) -> StoreResult<()>

Removes the user and all its credentials and door links.

fn add_credential( &self, user_id: i64, cred_ref: &str, token_hash: &str, now_ms: i64, ) -> StoreResult<()>

fn user_by_token_hash( &self, token_hash: &str, ) -> StoreResult<Option<(User, String)>>

fn delete_credential(&self, cred_ref: &str) -> StoreResult<Option<i64>>

Removes one credential; returns the owner’s id when it existed.

fn credentials_of(&self, user_id: i64) -> StoreResult<Vec<String>>

fn live_credentials(&self) -> StoreResult<Vec<(String, Vec<String>)>>

Every user with the references of all its live credentials (users without any are included).

fn user_by_door(&self, source: &str, subject: &str) -> StoreResult<Option<User>>

fn set_secret_hash(&self, user_id: i64, hash: &str) -> StoreResult<()>

Replaces the password hash (account/password).

fn supports_refresh(&self) -> bool

Does the store keep expiry and refresh tokens for credentials?

fn set_refresh( &self, cred_ref: &str, refresh_hash: &str, access_expires_ms: i64, refresh_expires_ms: i64, ) -> StoreResult<()>

Gives a credential an access-token expiry and a refresh token (only its hash is kept). user_by_token_hash must stop finding the credential once access_expires_ms has passed.

fn take_refresh( &self, refresh_hash: &str, now_ms: i64, ) -> StoreResult<Option<String>>

Consumes a refresh token (one use): the credential it belongs to, if valid at now_ms.

fn replace_token( &self, cred_ref: &str, token_hash: &str, access_expires_ms: i64, ) -> StoreResult<()>

Swaps a credential’s access-token hash (the credential reference stays, so the messenger’s device stays) and sets its new expiry.

fn supports_keys(&self) -> bool

fn create_invite( &self, code_hash: &str, user_id: i64, expires_ms: i64, ) -> StoreResult<()>

Remembers an invite (only the hash of its code) for an existing user, valid until expires_ms.

fn create_invite_with( &self, code_hash: &str, user_id: i64, expires_ms: i64, reserved: bool, ) -> StoreResult<()>

Self::create_invite that also records whether the operator reserved the nick (true) or left it a placeholder that the enrolling client may replace by asking for its own. A store that does not record it treats every invite as reserved: no rename.

fn peek_invite( &self, code_hash: &str, now_ms: i64, ) -> StoreResult<Option<(User, bool)>>

The invite’s user and its reserved flag without consuming it; None when it does not exist, has expired, or the store cannot look without consuming.

fn take_invite(&self, code_hash: &str, now_ms: i64) -> StoreResult<Option<User>>

Consumes an invite (one use): the user it was made for, if it exists and has not expired.

fn take_invite_with( &self, code_hash: &str, now_ms: i64, ) -> StoreResult<Option<(User, bool)>>

Self::take_invite with the reserved flag.

fn add_key( &self, user_id: i64, key_id: &str, public_key: &str, label: &str, now_ms: i64, ) -> StoreResult<()>

Binds a public key (base64url) to a user. key_id is also the key credential’s reference.

fn user_by_key(&self, key_id: &str) -> StoreResult<Option<(User, String)>>

The user and public key (base64url) behind a key_id.

fn delete_key(&self, key_id: &str) -> StoreResult<bool>

Removes a key (its login stops working); true when it existed.

fn link_door( &self, user_id: i64, source: &str, subject: &str, ) -> StoreResult<()>