DMSCAuthModule

Struct DMSCAuthModule 

Source
pub struct DMSCAuthModule { /* private fields */ }
Expand description

Main authentication module for DMSC.

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

Implementations§

Source§

impl DMSCAuthModule

Source

pub async fn new(config: DMSCAuthConfig) -> DMSCResult<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 DMSCResult containing the new DMSCAuthModule instance

§Errors

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

Source

pub fn with_config(config: DMSCAuthConfig) -> 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 DMSCAuthModule instance

Source

pub async fn new_async(config: DMSCAuthConfig) -> DMSCResult<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 DMSCResult containing the new DMSCAuthModule instance

§Errors

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

Source

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

Returns a reference to the JWT revocation list.

§Returns

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

Source

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

Returns a reference to the JWT manager.

§Returns

An Arc providing thread-safe access to the JWT manager

Source

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

Returns a reference to the session manager.

§Returns

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

Source

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

Returns a reference to the permission manager.

§Returns

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

Source

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

Returns a reference to the OAuth manager.

§Returns

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

Trait Implementations§

Source§

impl DMSCModule for DMSCAuthModule

Source§

fn name(&self) -> &str

Returns the name of the authentication module.

§Returns

The module name as a string

Source§

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

Source§

fn init<'life0, 'life1, 'async_trait>( &'life0 mut self, ctx: &'life1 mut DMSCServiceContext, ) -> Pin<Box<dyn Future<Output = DMSCResult<()>> + 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 DMSCResult<()> indicating success or failure

Source§

fn after_shutdown<'life0, 'life1, 'async_trait>( &'life0 mut self, _ctx: &'life1 mut DMSCServiceContext, ) -> Pin<Box<dyn Future<Output = DMSCResult<()>> + 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 DMSCResult<()> indicating success or failure

Source§

fn priority(&self) -> i32

Returns the priority of the module. Read more
Source§

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

Returns the list of module dependencies. Read more
Source§

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

Prepares the module for startup. Read more
Source§

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

Starts the service module. Read more
Source§

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

Performs post-startup operations. Read more
Source§

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

Prepares the module for shutdown. Read more
Source§

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

Shuts down the service module. Read more
Source§

impl<'py> IntoPyObject<'py> for DMSCAuthModule

Source§

type Target = DMSCAuthModule

The Python output type
Source§

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

The smart pointer type to use. Read more
Source§

type Error = PyErr

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl PyClass for DMSCAuthModule

Source§

type Frozen = False

Whether the pyclass is frozen. Read more
Source§

impl PyClassImpl for DMSCAuthModule

Source§

const IS_BASETYPE: bool = false

#[pyclass(subclass)]
Source§

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]
Source§

const IS_MAPPING: bool = false

#[pyclass(mapping)]
Source§

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]
Source§

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]
Source§

const RAW_DOC: &'static CStr = c"Main authentication module for DMSC.\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. Read more
Source§

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined. Read more
Source§

type BaseType = PyAny

Base class
Source§

type ThreadChecker = SendablePyClass<DMSCAuthModule>

This handles following two situations: Read more
Source§

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

Immutable or mutable
Source§

type Dict = PyClassDummySlot

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

type WeakRef = PyClassDummySlot

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

type BaseNativeType = PyAny

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

fn items_iter() -> PyClassItemsIter

Source§

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

§

fn dict_offset() -> Option<isize>

§

fn weaklist_offset() -> Option<isize>

Source§

impl PyClassNewTextSignature for DMSCAuthModule

Source§

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

Source§

impl PyMethods<DMSCAuthModule> for PyClassImplCollector<DMSCAuthModule>

Source§

fn py_methods(self) -> &'static PyClassItems

Source§

impl PyTypeInfo for DMSCAuthModule

Source§

const NAME: &'static str = "DMSCAuthModule"

Class name.
Source§

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

Module name, if any.
Source§

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.
Source§

impl ServiceModule for DMSCAuthModule

Source§

fn name(&self) -> &str

Returns the name of the service module. Read more
Source§

fn is_critical(&self) -> bool

Indicates if the module is critical to the operation of the system. Read more
Source§

fn priority(&self) -> i32

Returns the priority of the module. Read more
Source§

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

Returns the list of module dependencies. Read more
Source§

fn init(&mut self, _ctx: &mut DMSCServiceContext) -> DMSCResult<()>

Initializes the service module. Read more
Source§

fn start(&mut self, _ctx: &mut DMSCServiceContext) -> DMSCResult<()>

Starts the service module. Read more
Source§

fn shutdown(&mut self, _ctx: &mut DMSCServiceContext) -> DMSCResult<()>

Shuts down the service module. Read more
Source§

fn before_start(&mut self, _ctx: &mut DMSCServiceContext) -> DMSCResult<()>

Prepares the module for startup. Read more
Source§

fn after_start(&mut self, _ctx: &mut DMSCServiceContext) -> DMSCResult<()>

Performs post-startup operations. Read more
Source§

fn before_shutdown(&mut self, _ctx: &mut DMSCServiceContext) -> DMSCResult<()>

Prepares the module for shutdown. Read more
Source§

fn after_shutdown(&mut self, _ctx: &mut DMSCServiceContext) -> DMSCResult<()>

Performs post-shutdown cleanup. Read more
Source§

impl DerefToPyAny for DMSCAuthModule

Source§

impl ExtractPyClassWithClone for DMSCAuthModule

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<'py, T> IntoPyObjectExt<'py> for T
where T: IntoPyObject<'py>,

§

fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>

Converts self into an owned Python object, dropping type information.
§

fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>

Converts self into an owned Python object, dropping type information and unbinding it from the 'py lifetime.
§

fn into_pyobject_or_pyerr(self, py: Python<'py>) -> Result<Self::Output, PyErr>

Converts self into a Python object. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PyErrArguments for T
where T: for<'py> IntoPyObject<'py> + Send + Sync,

§

fn arguments(self, py: Python<'_>) -> Py<PyAny>

Arguments for exception
§

impl<T> PyTypeCheck for T
where T: PyTypeInfo,

§

const NAME: &'static str = T::NAME

👎Deprecated since 0.27.0: Use ::classinfo_object() instead and format the type name at runtime. Note that using built-in cast features is often better than manual PyTypeCheck usage.
Name of self. This is used in error messages, for example.
§

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

Checks if object is an instance of Self, which may include a subtype. Read more
§

fn classinfo_object(py: Python<'_>) -> Bound<'_, PyAny>

Returns the expected type as a possible argument for the isinstance and issubclass function. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> Ungil for T
where T: Send,