Skip to main content

AdminRecoveryCode

Struct AdminRecoveryCode 

Source
pub struct AdminRecoveryCode {
    pub id: Uuid,
    pub user_id: Uuid,
    pub code_hash: String,
    pub created_at: i64,
    pub used_at: Option<i64>,
}
Expand description

One single-use recovery code of an crate::sqlite::admin_user::AdminUser.

This layer never sees a plaintext code. code_hash arrives already hashed from admin::mfa, through the very same crate::admin::password this crate hashes operator passwords with – a recovery code is only ever compared, never needed back, so a read of this table yields nothing replayable. That is the opposite of admin_users.totp_secret, which verification needs in the clear.

§Methods

  • replace_all: mint a set, superseding the previous one, in one transaction
  • list_unused / count_unused: what verification walks, and what the panel shows
  • consume: spend one, single-use decided by the database
  • delete_for_user: what removing the factor takes with it

Fields§

§id: Uuid§user_id: Uuid§code_hash: String

<algo>$<params>$<salt>$<hash>, exactly a password_hash.

§created_at: i64§used_at: Option<i64>

When it was spent. None is the only usable state.

Implementations§

Source§

impl AdminRecoveryCode

Source

pub async fn replace_all( user_id: Uuid, hashes: &[String], database: &Database, ) -> Result<(), Error>

Replaces this user’s whole set with hashes.

One transaction, and that is the point: a regeneration that failed halfway between the DELETE and the INSERTs would leave the operator holding a printed set that no longer works, or – worse – half the old set still live alongside the new one.

Deletes the used rows too. They are an audit trail of the set being superseded, not of anything still reachable, and keeping them would make “10 minted, 7 remaining” a sum over sets.

Source

pub async fn list_unused( user_id: Uuid, database: &Database, ) -> Result<Vec<AdminRecoveryCode>, Error>

The unspent codes, oldest first – what admin::mfa walks one PBKDF2 run at a time when a submission is not a TOTP code.

Source

pub async fn count_unused( user_id: Uuid, database: &Database, ) -> Result<i64, Error>

How many are left – the “7 of 10 remaining” the panel and admin user totp status both show.

Source

pub async fn consume(id: Uuid, database: &Database) -> Result<bool, Error>

Spends one code. false means it was already spent, or gone.

The used_at IS NULL test lives in the WHERE clause rather than in a read the caller does first: two submissions of one code racing must not both succeed, and rows_affected is what decides which one did. Same primitive as Nonce::verify.

Stamps rather than deletes – see the migration’s comment: “this code was spent, at T” is the audit trail a recovery-code use exists to leave.

Source

pub async fn delete_for_user( user_id: Uuid, database: &Database, ) -> Result<u64, Error>

Drops every code of one user – what removing the second factor takes with it, since a recovery code recovers access to a factor that no longer exists.

Source

pub fn to_json(&self) -> Value

The admin-facing rendering. Never code_hash: it is a password hash, and no front end has a reason to see one.

Trait Implementations§

Source§

impl Clone for AdminRecoveryCode

Source§

fn clone(&self) -> AdminRecoveryCode

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AdminRecoveryCode

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more