Struct DeviceToken 

#[non_exhaustive]
pub struct DeviceToken {
    pub id: i64,
    pub device: String,
    pub name: String,
    pub abilities: Option<Vec<String>>,
    pub last_used_at: Option<DateTime>,
    pub expires_at: Option<DateTime>,
    pub created_at: Option<DateTime>,
}

A stored API token of a device. Only a SHA-256 hash of the secret is stored.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: i64

The device_tokens row id, also what follows the d in the plain token.

device: String

The app’s key for the device that owns the token, e.g. kiosk:3.

name: String

A label chosen at creation.

abilities: Option<Vec<String>>

What the token may do (Device::can); None for everything.

last_used_at: Option<DateTime>

When a request last authenticated with it; None if never used.

expires_at: Option<DateTime>

When it stops working; None for never.

created_at: Option<DateTime>

When it was created.

Implementations

impl DeviceToken

pub async fn create( db: &Db, device: &str, name: &str, abilities: Option<&[&str]>, expires_at: Option<DateTime>, ) -> Result<NewDeviceToken>

Creates a token for device (the app’s key, e.g. "kiosk:3"). abilities limits it (Some(&["sales:create"]), "*" allows everything); None allows everything. It stops working at expires_at.

use renox::auth::DeviceToken;
let made = DeviceToken::create(&db, "kiosk:3", "front desk", Some(&["sales:create"]), None).await?;
println!("give this to the kiosk once: {}", made.plain);

pub async fn for_device(db: &Db, device: &str) -> Result<Vec<DeviceToken>>

The tokens of device, newest first.

pub async fn revoke(db: &Db, device: &str, token_id: i64) -> Result<bool>

Revokes one token of device; returns whether it existed.

pub async fn revoke_all(db: &Db, device: &str) -> Result<u64>

Revokes every token of device (when it is retired or lost); returns how many.

pub async fn prune_expired(db: &Db, grace: Duration) -> Result<u64>

Deletes device tokens that expired more than grace ago; returns how many. tokens:prune (from the Auth module) runs it too.

Trait Implementations

impl Clone for DeviceToken

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceToken

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

Formats the value using the given formatter.

impl Serialize for DeviceToken

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.