Skip to main content

Gate

Struct Gate 

Source
pub struct Gate;
Expand description

Authorization Gate facade.

Provides a central point for authorization checks.

§Example

use ferro_rs::authorization::Gate;

// Define a simple gate
Gate::define("admin", |user, _| user.is_admin().into());

// Check in controller
if Gate::allows("admin", None) {
    // User is admin
}

// Authorize (returns Result)
Gate::authorize("admin", None)?;

Implementations§

Source§

impl Gate

Source

pub fn init()

Initialize the gate registry.

This is called automatically by the framework during bootstrap.

Source

pub fn define<F>(ability: &str, callback: F)
where F: Fn(&dyn Authenticatable, Option<&dyn Any>) -> AuthResponse + Send + Sync + 'static,

Define a simple ability.

§Example
Gate::define("view-dashboard", |user, _| {
    user.as_any().downcast_ref::<User>()
        .map(|u| (u.is_admin || u.has_role("manager")).into())
        .unwrap_or_else(AuthResponse::deny_silent)
});
Source

pub fn before<F>(callback: F)
where F: Fn(&dyn Authenticatable, &str) -> Option<bool> + Send + Sync + 'static,

Register a before hook.

Before hooks run before any ability check. Return Some(true) to allow, Some(false) to deny, or None to continue to the ability check.

§Example
// Allow super admins to bypass all checks
Gate::before(|user, _ability| {
    if let Some(u) = user.as_any().downcast_ref::<User>() {
        if u.is_super_admin {
            return Some(true);
        }
    }
    None
});
Source

pub fn allows(ability: &str, resource: Option<&dyn Any>) -> bool

Check if the current user is allowed to perform an ability.

Returns true if allowed, false if denied or not authenticated.

Source

pub fn denies(ability: &str, resource: Option<&dyn Any>) -> bool

Check if the current user is denied an ability.

Source

pub fn authorize( ability: &str, resource: Option<&dyn Any>, ) -> Result<(), AuthorizationError>

Authorize the current user for an ability.

Returns Ok(()) if allowed, or Err(AuthorizationError) if denied.

§Example
pub async fn admin_dashboard() -> Result<Response, AuthorizationError> {
    Gate::authorize("view-dashboard", None)?;
    // Render dashboard...
}
Source

pub fn allows_for<U: Authenticatable>( user: &U, ability: &str, resource: Option<&dyn Any>, ) -> bool

Check ability for a specific user.

Source

pub fn authorize_for<U: Authenticatable>( user: &U, ability: &str, resource: Option<&dyn Any>, ) -> Result<(), AuthorizationError>

Authorize for a specific user.

Source

pub fn check_for<U: Authenticatable>( user: &U, ability: &str, resource: Option<&dyn Any>, ) -> AuthResponse

Check ability for a specific user (generic wrapper).

Source

pub fn inspect( user: &dyn Authenticatable, ability: &str, resource: Option<&dyn Any>, ) -> AuthResponse

Check ability for a dynamic Authenticatable reference.

Use this when you have a trait object (&dyn Authenticatable or Arc<dyn Authenticatable>).

Source

pub fn has_policy_for<M: 'static>() -> bool

Check if a policy is registered for a model type.

Source§

impl Gate

Extension methods for checking authorization with the current user.

These are async methods that fetch the user before checking.

Source

pub async fn user_allows(ability: &str, resource: Option<&dyn Any>) -> bool

Check if the current authenticated user is allowed (async).

This fetches the user from the database before checking.

Source

pub async fn user_authorize( ability: &str, resource: Option<&dyn Any>, ) -> Result<(), AuthorizationError>

Authorize the current authenticated user (async).

This fetches the user from the database before checking.

Auto Trait Implementations§

§

impl Freeze for Gate

§

impl RefUnwindSafe for Gate

§

impl Send for Gate

§

impl Sync for Gate

§

impl Unpin for Gate

§

impl UnsafeUnpin for Gate

§

impl UnwindSafe for Gate

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

Source§

fn len(&self) -> usize

The number of items that this chain link consists of.
Source§

fn append_to(self, v: &mut Vec<T>)

Append the elements in this link to the chain.
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> 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
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: 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: 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, 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.
Source§

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

Source§

fn vzip(self) -> V

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