DMSCOAuthManager

Struct DMSCOAuthManager 

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

OAuth manager for handling multiple identity providers.

This struct manages OAuth providers, handles token exchange, and retrieves user information. It supports concurrent access through RwLock and integrates with the DMSC cache system for token storage.

Implementations§

Source§

impl DMSCOAuthManager

Source

pub fn new(cache: Arc<dyn DMSCCache>) -> Self

Creates a new OAuth manager with the specified cache.

§Parameters
  • cache: Cache implementation for storing tokens
§Returns

A new instance of DMSCOAuthManager

Source

pub async fn register_provider( &self, provider: DMSCOAuthProvider, ) -> DMSCResult<()>

Registers a new OAuth provider.

§Parameters
  • provider: OAuth provider configuration
§Returns

Ok(()) if the provider was successfully registered

Source

pub async fn get_provider( &self, provider_id: &str, ) -> DMSCResult<Option<DMSCOAuthProvider>>

Gets an OAuth provider by ID.

§Parameters
  • provider_id: Unique identifier of the provider
§Returns

Some(DMSCOAuthProvider) if the provider exists, otherwise None

Source

pub async fn get_auth_url( &self, provider_id: &str, state: &str, ) -> DMSCResult<Option<String>>

Gets the authentication URL for a provider.

§Parameters
  • provider_id: Unique identifier of the provider
  • state: State parameter for CSRF protection
§Returns

Some(String) containing the authentication URL if the provider is enabled, otherwise None

Source

pub async fn exchange_code_for_token( &self, provider_id: &str, code: &str, redirect_uri: &str, ) -> DMSCResult<Option<DMSCOAuthToken>>

Exchanges an authorization code for an access token.

§Parameters
  • provider_id: Unique identifier of the provider
  • code: Authorization code from the provider
  • redirect_uri: Redirect URI used in the authentication request
§Returns

Some(DMSCOAuthToken) if the code exchange was successful, otherwise None

Source

pub async fn get_user_info( &self, provider_id: &str, access_token: &str, ) -> DMSCResult<Option<DMSCOAuthUserInfo>>

Retrieves user information from an OAuth provider.

§Parameters
  • provider_id: Unique identifier of the provider
  • access_token: Access token for authentication
§Returns

Some(DMSCOAuthUserInfo) if the user information was successfully retrieved, otherwise None

Source

pub async fn refresh_token( &self, provider_id: &str, refresh_token: &str, ) -> DMSCResult<Option<DMSCOAuthToken>>

Refreshes an access token using a refresh token.

§Parameters
  • provider_id: Unique identifier of the provider
  • refresh_token: Refresh token for obtaining a new access token
§Returns

Some(DMSCOAuthToken) if the token refresh was successful, otherwise None

Source

pub async fn revoke_token( &self, provider_id: &str, access_token: &str, ) -> DMSCResult<bool>

Revokes an access token.

§Parameters
  • provider_id: Unique identifier of the provider
  • access_token: Access token to revoke
§Returns

true if the token was successfully revoked, otherwise false

Source

pub async fn list_providers(&self) -> DMSCResult<Vec<DMSCOAuthProvider>>

Lists all registered OAuth providers.

§Returns

A vector of all registered OAuth providers

Source

pub async fn disable_provider(&self, provider_id: &str) -> DMSCResult<bool>

Disables an OAuth provider.

§Parameters
  • provider_id: Unique identifier of the provider
§Returns

true if the provider was successfully disabled, otherwise false

Source

pub async fn enable_provider(&self, provider_id: &str) -> DMSCResult<bool>

Enables an OAuth provider.

§Parameters
  • provider_id: Unique identifier of the provider
§Returns

true if the provider was successfully enabled, otherwise false

Trait Implementations§

Source§

impl<'py> IntoPyObject<'py> for DMSCOAuthManager

Source§

type Target = DMSCOAuthManager

The Python output type
Source§

type Output = Bound<'py, <DMSCOAuthManager 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 DMSCOAuthManager

Source§

type Frozen = False

Whether the pyclass is frozen. Read more
Source§

impl PyClassImpl for DMSCOAuthManager

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 = /// for token storage.

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<DMSCOAuthManager>

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 DMSCOAuthManager

Source§

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

Source§

impl PyMethods<DMSCOAuthManager> for PyClassImplCollector<DMSCOAuthManager>

Source§

fn py_methods(self) -> &'static PyClassItems

Source§

impl PyTypeInfo for DMSCOAuthManager

Source§

const NAME: &'static str = "DMSCOAuthManager"

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 DerefToPyAny for DMSCOAuthManager

Source§

impl ExtractPyClassWithClone for DMSCOAuthManager

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,