Struct RiAuthModule 

pub struct RiAuthModule { /* private fields */ }

Main authentication module for Ri.

This module provides comprehensive authentication and authorization functionality, including JWT management, session management, permission management, and OAuth integration.

Implementations

impl RiAuthModule

pub async fn new(config: RiAuthConfig) -> RiResult<Self>

Creates a new authentication module with the given configuration.

Performance Note: This method creates a permission manager using the synchronous new() method which uses blocking_write during initialization. For async contexts, consider using new_async() to avoid blocking the runtime.

Parameters

• config: The authentication configuration to use

Returns

A RiResult containing the new RiAuthModule instance

Errors

Returns an error if Redis cache creation fails when Redis backend is configured

pub fn with_config(config: RiAuthConfig) -> Self

Creates a new authentication module with the given configuration (synchronous version).

This is a synchronous wrapper for use in the builder pattern.

Parameters

• config: The authentication configuration to use

Returns

A new RiAuthModule instance

pub async fn new_async(config: RiAuthConfig) -> RiResult<Self>

Creates a new authentication module with the given configuration asynchronously.

This method is preferred for async contexts as it avoids blocking the runtime during permission manager initialization by using the async new_async() method.

Parameters

• config: The authentication configuration to use

Returns

A RiResult containing the new RiAuthModule instance

Errors

Returns an error if Redis cache creation fails when Redis backend is configured

pub fn revocation_list(&self) -> Arc<RiJWTRevocationList>

Returns a reference to the JWT revocation list.

Returns

An Arc providing thread-safe access to the token revocation list

pub fn jwt_manager(&self) -> Arc<RiJWTManager>

Returns a reference to the JWT manager.

Returns

An Arc providing thread-safe access to the JWT manager

pub fn session_manager(&self) -> Arc<RwLock<RiSessionManager>>

Returns a reference to the session manager.

Returns

An Arc<RwLock> providing thread-safe access to the session manager

pub fn permission_manager(&self) -> Arc<RwLock<RiPermissionManager>>

Returns a reference to the permission manager.

Returns

An Arc<RwLock> providing thread-safe access to the permission manager

pub fn oauth_manager(&self) -> Arc<RwLock<RiOAuthManager>>

Returns a reference to the OAuth manager.

Returns

An Arc<RwLock> providing thread-safe access to the OAuth manager

Trait Implementations

impl<'py> IntoPyObject<'py> for RiAuthModule

type Target = RiAuthModule

The Python output type

type Output = Bound<'py, <RiAuthModule as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for RiAuthModule

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for RiAuthModule

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = c"Main authentication module for Ri.\n\nThis module provides comprehensive authentication and authorization functionality,\nincluding JWT management, session management, permission management, and OAuth integration.\x00"

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<RiAuthModule>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for RiAuthModule

const TEXT_SIGNATURE: &'static str = "(config)"

impl PyMethods<RiAuthModule> for PyClassImplCollector<RiAuthModule>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for RiAuthModule

const NAME: &'static str = "RiAuthModule"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl RiModule for RiAuthModule

fn name(&self) -> &str

Returns the name of the authentication module.

Returns

The module name as a string

fn is_critical(&self) -> bool

Indicates whether the authentication module is critical.

The authentication module is non-critical, meaning that if it fails to initialize or operate, it should not break the entire application. This allows the core functionality to continue even if authentication features are unavailable.

Returns

false since authentication is non-critical

fn init<'life0, 'life1, 'async_trait>( &'life0 mut self, ctx: &'life1 mut RiServiceContext, ) -> Pin<Box<dyn Future<Output = RiResult<()>> + Send + 'async_trait>>

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

Initializes the authentication module asynchronously.

This method performs the following steps:

1. Loads configuration from the service context
2. Updates the module configuration if provided
3. Reinitializes the JWT manager with the new configuration
4. Initializes OAuth providers if configured

Parameters

• ctx: The service context containing configuration

Returns

A RiResult<()> indicating success or failure

fn after_shutdown<'life0, 'life1, 'async_trait>( &'life0 mut self, _ctx: &'life1 mut RiServiceContext, ) -> Pin<Box<dyn Future<Output = RiResult<()>> + Send + 'async_trait>>

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

Performs asynchronous cleanup after the application has shut down.

This method cleans up all sessions managed by the session manager.

Parameters

• _ctx: The service context (not used in this implementation)

Returns

A RiResult<()> indicating success or failure

fn priority(&self) -> i32

Returns the priority of the module.

fn dependencies(&self) -> Vec<&str>

Returns the list of module dependencies.

fn before_start<'life0, 'life1, 'async_trait>( &'life0 mut self, _ctx: &'life1 mut RiServiceContext, ) -> Pin<Box<dyn Future<Output = RiResult<()>> + Send + 'async_trait>>

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

Prepares the module for startup.

fn start<'life0, 'life1, 'async_trait>( &'life0 mut self, _ctx: &'life1 mut RiServiceContext, ) -> Pin<Box<dyn Future<Output = RiResult<()>> + Send + 'async_trait>>

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

Starts the service module.

fn after_start<'life0, 'life1, 'async_trait>( &'life0 mut self, _ctx: &'life1 mut RiServiceContext, ) -> Pin<Box<dyn Future<Output = RiResult<()>> + Send + 'async_trait>>

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

Performs post-startup operations.

fn before_shutdown<'life0, 'life1, 'async_trait>( &'life0 mut self, _ctx: &'life1 mut RiServiceContext, ) -> Pin<Box<dyn Future<Output = RiResult<()>> + Send + 'async_trait>>

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

Prepares the module for shutdown.

fn shutdown<'life0, 'life1, 'async_trait>( &'life0 mut self, _ctx: &'life1 mut RiServiceContext, ) -> Pin<Box<dyn Future<Output = RiResult<()>> + Send + 'async_trait>>

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

Shuts down the service module.

impl ServiceModule for RiAuthModule

fn name(&self) -> &str

Returns the name of the service module.

fn is_critical(&self) -> bool

Indicates if the module is critical to the operation of the system.

fn priority(&self) -> i32

Returns the priority of the module.

fn dependencies(&self) -> Vec<&str>

Returns the list of module dependencies.

fn init(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Initializes the service module.

fn start(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Starts the service module.

fn shutdown(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Shuts down the service module.

fn before_start(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Prepares the module for startup.

fn after_start(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Performs post-startup operations.

fn before_shutdown(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Prepares the module for shutdown.

fn after_shutdown(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Performs post-shutdown cleanup.

impl DerefToPyAny for RiAuthModule

impl ExtractPyClassWithClone for RiAuthModule