Struct SupportCode 

pub struct SupportCode {
    pub scope: String,
    pub hash: String,
    pub label: Option<String>,
    pub ttl_minutes: Option<u32>,
    pub disabled: bool,
}

One operator-issued support code — the “裏コマンド” that reveals client.unlock-scoped jobs in the Client App (see crate::manifest::ClientHint::unlock).

Only the argon2id hash is stored. Verification needs no plaintext, so unlike the SMTP password (#884, which must stay in the HKLM registry because SMTP AUTH needs the real string) a support code can live in KV safely — an agent reads the hash to verify a typed code locally, which is what keeps unlocking working while the backend is down, exactly when the desk needs it most.

The plaintext exists only in transit: the operator types it once into the SPA, the backend hashes it, and no layer ever stores or returns it. The API blanks hash on the way out too — an operator rotating a code sets a new one, they never read the old one back.

Fields

scope: String

The scope this code opens, matched byte-for-byte against a job’s client.unlock. Unique within the list; a slug ([A-Za-z0-9._-]).

hash: String

argon2id PHC-format hash of the code. Empty ⇒ no code configured for this scope, which fails closed (nothing can be unlocked with it) — that’s also what an API response looks like, since the hash is blanked before it leaves the backend.

label: Option<String>

Human label for the code ("ヘルプデスク一次窓口"), shown in the Client App’s support-mode banner so the user can see which desk opened their machine. None ⇒ the banner falls back to the scope slug.

ttl_minutes: Option<u32>

How long a grant from this code lasts, in minutes. None ⇒ DEFAULT_SUPPORT_UNLOCK_TTL_MINUTES. Clamped to 1..=MAX_SUPPORT_UNLOCK_TTL_MINUTES.

disabled: bool

Temporarily suspend the code without deleting it (and without having to re-issue a new secret afterwards) — a disabled code never verifies. false (the default) ⇒ live.

Implementations

impl SupportCode

pub fn effective_ttl_minutes(&self) -> u32

The grant window this code mints, in minutes: the configured value if set, else DEFAULT_SUPPORT_UNLOCK_TTL_MINUTES. Floored at 1 and clamped to MAX_SUPPORT_UNLOCK_TTL_MINUTES so a 0 (which would mint an already-expired grant, i.e. an unlock that silently does nothing) or an out-of-band giant value can’t reach the grant store.

pub fn is_usable(&self) -> bool

Whether this entry can ever grant anything: live and carrying a hash. Both halves fail closed — a blanked (API-redacted) or hand-cleared hash opens nothing, and neither does a disabled code.

Trait Implementations

impl Clone for SupportCode

fn clone(&self) -> SupportCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SupportCode

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

Formats the value using the given formatter.

impl Default for SupportCode

fn default() -> SupportCode

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SupportCode

where SupportCode: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SupportCode

impl PartialEq for SupportCode

fn eq(&self, other: &SupportCode) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for SupportCode

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SupportCode