Skip to main content

AuthorizationMetadataManager

Struct AuthorizationMetadataManager 

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

Authorization metadata manager.

This struct manages ACL (Access Control List) operations by coordinating two metadata providers:

  • AuthorizationMetadataProvider: Persists ACL data
  • AuthenticationMetadataProvider: Validates USER subject existence

§Examples

ⓘ
use rocketmq_auth::AuthorizationMetadataManager;
use rocketmq_auth::AuthConfig;

// Create manager with configuration
let config = AuthConfig::default();
let manager = AuthorizationMetadataManager::new(config)?;

// Create ACL for a user
let acl = Acl::of("user:alice", SubjectType::User, policy);
manager.create_acl(acl).await?;

// Retrieve ACL
let user = User::of("alice");
if let Some(acl) = manager.get_acl(&user).await? {
    println!("ACL found: {:?}", acl);
}

// Shutdown
manager.shutdown().await;

Implementations§

Source§

impl AuthorizationMetadataManager

Source

pub fn with_providers( authorization_provider: Arc<LocalAuthorizationMetadataProvider>, authentication_provider: Option<Arc<dyn AuthenticationMetadataProvider>>, ) -> Self

Create a new manager with the given providers.

§Arguments
  • authorization_provider - Provider for ACL storage operations
  • authentication_provider - Optional provider for subject validation
§Examples
ⓘ
let auth_provider = Arc::new(LocalAuthorizationMetadataProvider::new(...));
let manager = AuthorizationMetadataManager::with_providers(
    auth_provider,
    None
);
Source

pub fn with_registry(registry: &ProviderRegistry) -> Self

Source

pub fn new(config: AuthConfig) -> AuthServiceResult<Self>

Create a manager from configuration.

This will instantiate providers based on the configuration.

§Arguments
  • config - Authorization configuration
§Errors

Returns AuthFailureKind::InvalidConfiguration if provider initialization fails

Source

pub async fn shutdown(&mut self)

Shutdown the manager and release resources.

Managers created from configuration close their providers. Managers borrowing a registry leave provider finalization to its runtime owner.

Source

pub async fn shutdown_until( &self, deadline: ShutdownDeadline, ) -> AuthServiceResult<()>

Source

pub async fn create_acl(&self, acl: Acl) -> AuthServiceResult<()>

Create a new ACL.

This method:

  1. Validates the ACL structure
  2. Initializes default policy types
  3. Verifies the subject exists (if authentication provider is available)
  4. Checks if ACL already exists
  5. Creates or updates the ACL
§Arguments
  • acl - The ACL to create
§Errors
  • AuthFailureKind::NotFound if subject doesn’t exist
  • AuthFailureKind::InvalidInput if ACL validation fails
  • AuthFailureKind::InvalidInput if ACL already exists (and merge fails)
  • AuthFailureKind::Unavailable if storage operation fails
§Examples
ⓘ
let acl = Acl::of("user:alice", SubjectType::User, policy);
manager.create_acl(acl).await?;
Source

pub async fn update_acl(&self, acl: Acl) -> AuthServiceResult<()>

Update an existing ACL.

This method:

  1. Validates the ACL structure
  2. Initializes default policy types
  3. Verifies the subject exists
  4. Creates the ACL if it doesn’t exist, or merges with existing ACL
§Arguments
  • acl - The ACL with updated policies
§Errors
  • AuthFailureKind::NotFound if subject doesn’t exist
  • AuthFailureKind::InvalidInput if ACL validation fails
  • AuthFailureKind::Unavailable if storage operation fails
§Examples
ⓘ
let mut acl = manager.get_acl(&user).await?.unwrap();
acl.add_policy(new_policy);
manager.update_acl(acl).await?;
Source

pub async fn delete_acl<S: Subject + Send + Sync>( &self, subject: &S, ) -> AuthServiceResult<()>

Delete an ACL for a subject.

This is a convenience method that calls delete_acl_with_filter with no filters.

§Arguments
  • subject - The subject whose ACL should be deleted
§Errors
  • AuthFailureKind::NotFound if subject doesn’t exist
  • AuthFailureKind::Unavailable if storage operation fails
Source

pub async fn delete_acl_with_filter<S: Subject + Send + Sync>( &self, subject: &S, policy_type: Option<PolicyType>, resource: Option<&Resource>, ) -> AuthServiceResult<()>

Delete an ACL or specific policy entries.

This method provides fine-grained deletion:

  • If resource is specified: deletes specific policy entry for that resource
  • If only policy_type is specified: deletes entire policy of that type
  • If neither specified: deletes entire ACL
§Arguments
  • subject - The subject whose ACL to modify
  • policy_type - Optional policy type filter (defaults to CUSTOM if resource specified)
  • resource - Optional resource to delete from the policy
§Errors
  • AuthFailureKind::NotFound if subject doesn’t exist
  • AuthFailureKind::InvalidInput if ACL doesn’t exist
  • AuthFailureKind::Unavailable if storage operation fails
§Examples
ⓘ
// Delete entire ACL
manager.delete_acl_with_filter(&user, None, None).await?;

// Delete a specific policy type
manager.delete_acl_with_filter(&user, Some(PolicyType::CUSTOM), None).await?;

// Delete specific resource from policy
let resource = Resource::of_topic("test-topic");
manager.delete_acl_with_filter(&user, Some(PolicyType::CUSTOM), Some(&resource)).await?;
Source

pub async fn get_acl<S: Subject + Send + Sync>( &self, subject: &S, ) -> AuthServiceResult<Option<Acl>>

Get the ACL for a subject.

§Arguments
  • subject - The subject to query
§Returns
  • Ok(Some(Acl)) if ACL exists
  • Ok(None) if no ACL found
  • Err(...) if operation fails
§Errors
  • AuthFailureKind::NotFound if subject doesn’t exist
  • AuthFailureKind::Unavailable if storage operation fails
§Examples
ⓘ
let user = User::of("alice");
if let Some(acl) = manager.get_acl(&user).await? {
    println!("Found ACL with {} policies", acl.policies().len());
}
Source

pub async fn list_acl( &self, subject_filter: Option<&str>, resource_filter: Option<&str>, ) -> AuthServiceResult<Vec<Acl>>

List ACLs with optional filtering.

§Arguments
  • subject_filter - Optional subject name filter (substring match)
  • resource_filter - Optional resource name filter (substring match)
§Returns

A vector of matching ACLs. Empty vector if no matches found.

§Errors
  • AuthFailureKind::Unavailable if storage operation fails
§Examples
ⓘ
// List all ACLs
let all_acls = manager.list_acl(None, None).await?;

// Filter by subject
let user_acls = manager.list_acl(Some("user:"), None).await?;

// Filter by resource
let topic_acls = manager.list_acl(None, Some("Topic:test")).await?;

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
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> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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