Struct DeviceAuthorizationPlugin 

pub struct DeviceAuthorizationPlugin { /* private fields */ }

OAuth 2.0 device authorization grant plugin.

Implementations

impl DeviceAuthorizationPlugin

pub fn grant<S: AuthSchema>(self, grant: DeviceGrant<S>) -> impl AuthPlugin<S>

Attach a grant after configuring ordinary plugin options and request fields.

impl DeviceAuthorizationPlugin

pub fn new() -> Self

Create the plugin with TS-aligned defaults.

pub fn request_fields(self, fields: DeviceRequestFields) -> Self

Validate additional request fields without changing client authorization or storing those fields.

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

Override the device-code expiration window.

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

Override the minimum polling interval enforced by /device/token.

pub fn device_code_length(self, length: usize) -> Self

Override the generated device-code length.

pub fn user_code_length(self, length: usize) -> Self

Override the generated user-code length.

pub fn verification_uri(self, uri: impl Into<String>) -> Self

Override the verification page URI returned to devices.

pub fn generate_device_code_with<F, Fut>(self, generator: F) -> Self

where F: Fn() -> Fut + Send + Sync + 'static, Fut: Future<Output = AuthResult<String>> + Send + 'static,

Await a custom device-code generator before generating the user code.

pub fn generate_user_code_with<F, Fut>(self, generator: F) -> Self

where F: Fn() -> Fut + Send + Sync + 'static, Fut: Future<Output = AuthResult<String>> + Send + 'static,

Await a custom user-code generator before persisting the code pair.

pub fn validate_client<F, Fut>(self, callback: F) -> Self

where F: Fn(String) -> Fut + Send + Sync + 'static, Fut: Future<Output = AuthResult<bool>> + Send + 'static,

Validate the OAuth client identifier before issuing or redeeming codes.

pub fn on_device_auth_request<F, Fut>(self, callback: F) -> Self

where F: Fn(String, Option<String>) -> Fut + Send + Sync + 'static, Fut: Future<Output = AuthResult<()>> + Send + 'static,

Run a hook when a device authorization request is created.

Trait Implementations

impl<S: AuthSchema> AuthPlugin<S> for DeviceAuthorizationPlugin

fn name(&self) -> &'static str

Plugin name - should be unique

fn openapi(&self) -> AuthResult<OpenApiPluginMetadata>

Document this configured plugin without invoking application field policies.

fn routes(&self) -> Vec<AuthRoute>

Routes that this plugin handles

fn on_request<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, req: &'life1 AuthRequest, ctx: &'life2 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = AuthResult<Option<AuthResponse>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Called for each request - return Some(response) to handle, None to pass through

fn on_init<'life0, 'life1, 'async_trait>( &'life0 self, ctx: &'life1 mut AuthInitContext<S>, ) -> Pin<Box<dyn Future<Output = AuthResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Called when the plugin is initialized

fn rate_limits(&self) -> AuthResult<Vec<PluginRateLimit>>

Default endpoint limits, overridden by explicit application limits.

fn telemetry_plugin_id(&self) -> Option<&'static str>

Return the upstream plugin ID; core option wrappers have no plugin ID.

fn password_hasher(&self) -> Option<Arc<dyn PasswordHasher>>

Select the base password hasher before plugin initialization wraps it.

fn telemetry(&self, _options: &mut PluginTelemetry)

Report configured options without invoking callbacks or initializing the plugin.

fn on_http_request<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _req: &'life1 AuthRequest, _ctx: &'life2 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = Result<Option<AuthResponse>, AuthError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Inspect an HTTP request after rate limiting and before endpoint middleware. Native API calls do not run this hook. A response skips endpoint hooks.

fn on_http_response<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _req: &'life1 AuthRequest, _response: &'life2 mut AuthResponse, _ctx: &'life3 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = Result<Option<AuthResponse>, AuthError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, Self: 'async_trait,

Inspect the HTTP router response, including route misses and body errors. Early HTTP request responses and native endpoint calls skip this hook. A replacement response stops the remaining HTTP response hooks.

fn before_request<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _req: &'life1 AuthRequest, _ctx: &'life2 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = Result<Option<BeforeRequestAction>, AuthError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Called for a registered endpoint after HTTP body decoding and origin checks.

fn after_request<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _req: &'life1 AuthRequest, _response: &'life2 mut AuthResponse, _ctx: &'life3 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = Result<(), AuthError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, Self: 'async_trait,

Inspect or extend the final route response after session cookies are applied.

impl Default for DeviceAuthorizationPlugin

fn default() -> Self

Returns the “default value” for a type.