Struct DeviceAuthBuilder 

pub struct DeviceAuthBuilder { /* private fields */ }

Builds a DeviceAuth. Everything the module cannot decide for a venture — who its clients are, who may approve, what a credential looks like, where entropy comes from — is set here.

Implementations

impl DeviceAuthBuilder

pub fn new() -> Self

The RFC 8628 defaults: a ten-minute code, a five-second poll interval and a five-wrong-entry allowance.

pub fn client(self, client: DeviceClient) -> Self

Adds one client. Repeatable.

pub fn clients(self, clients: impl IntoIterator<Item = DeviceClient>) -> Self

Declares the whole client list. Replaces any previous one.

pub fn approver(self, approver: impl Approver + 'static) -> Self

Sets the approver hook. Without one, the module uses CallerApprover over the Auth port when a deployment mounts one.

pub fn issuer(self, issuer: impl Issuer + 'static) -> Self

Sets the issuer hook.

pub fn random(self, random: impl RandomBytes + 'static) -> Self

Sets the entropy source the two codes are drawn from. Required: core carries no CSPRNG, so the venture supplies one (ADR 0002).

pub fn sign_in_url(self, url: impl Into<String>) -> Self

Where the stock CallerApprover sends an anonymous browser. Defaults to /login.

pub fn expires_in(self, ttl: Duration) -> Self

How long a device code stays usable. Clamped to at least one second, and at most MAX_EXPIRES_IN.

pub fn interval(self, interval: Duration) -> Self

The poll interval a client is told to use, and the shortest gap a poll may arrive at. Clamped to at least one second.

pub fn max_wrong_entries(self, allowance: u32) -> Self

The wrong-entry allowance per approver before the limiter refuses. Clamped to at least one.

pub fn build(self) -> DeviceAuth

Builds the module.

Trait Implementations

impl Default for DeviceAuthBuilder

fn default() -> Self

Returns the “default value” for a type.