Struct Params 

pub struct Params {
    pub kind: Kind,
    pub algorithm: Algorithm,
    pub digits: u32,
    pub period: u64,
    pub counter: u64,
}

The three numbers a stored seed is generated under.

Defaults are what an otpauth:// URI means when it omits the parameter, and therefore what an entry that stores only a bare base32 seed means too.

Fields

kind: Kind

Time-based, counter-based or Steam. #[serde(default)] because every entry written before Phase 22.2 has no such field and means Totp.

algorithm: Algorithm

digits: u32

period: u64

counter: u64

The next counter value an Hotp seed will use. Meaningless for the other two kinds, and zero for them.

It is state, not configuration — the only number in this struct that a correct implementation writes back — which is why advancing it is an explicit action rather than a side effect of reading a code. See advance in unv-cli/src/totp_cmd.rs.

Implementations

impl Params

pub fn from_fields( kind: Option<&str>, algorithm: Option<&str>, digits: Option<u64>, period: Option<u64>, counter: Option<u64>, ) -> Self

The parameters an entry’s four stored fields mean, with anything unusable falling back to the otpauth:// default.

This is the only place a vault’s TOTP fields become Params. They were read three separate ways before — unv totp code clamped, unv totp ls did not, and the IPC command did neither — so one entry carrying totp_digits: 99 listed as a 99-digit credential, produced six digits when asked for a code, and returned an error rather than a code to any caller of entry_totp_code that had not clamped first. Three readings of one field is three answers.

A vault is untrusted input (invariant 4): these fields arrive from an imported backup or a remote server as readily as from this CLI, and the unions are not enforced at rest. Falling back rather than refusing is what an omitted otpauth:// parameter already means, and it keeps a single mistyped number from making the whole entry unreadable.

The twin is totpParamsOf in src/ts/totp.ts — the form needs these before anything is saved — and the two are pinned by the params section of tests/fixtures/parity/totp-seeds.json.

pub fn validate(&self) -> Result<(), String>

Refuses a combination that cannot produce a code, naming the field.

Called at every boundary a number can enter through — the URI parser, the CLI flags, the IPC command — rather than at the generator, so that a period of zero is a message about the value the user typed instead of a division by zero three frames deeper.

pub fn is_default(&self) -> bool

True when these are the values an otpauth:// URI may omit.

Used to keep the stored entry honest: writing algorithm: "SHA1" onto every entry would make the field look chosen when it was defaulted, and the UI would then have to distinguish “the issuer said SHA-1” from “we wrote SHA-1 because nobody said anything”. They are the same thing, so the field is simply absent.

Trait Implementations

impl Clone for Params

fn clone(&self) -> Params

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Params

impl Debug for Params

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

Formats the value using the given formatter.

impl Default for Params

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Params

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Params

impl PartialEq for Params

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Params

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 Params