Skip to main content

Capability

Struct Capability 

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

A specific permission granted to an agent.

Implementations§

Source§

impl Capability

Source

pub fn builder() -> CapabilityBuilder

Create a new capability builder.

Source

pub fn id(&self) -> CapabilityId

Get the capability ID.

Source

pub fn kind(&self) -> &CapabilityKind

Get the capability kind.

Source

pub fn scope(&self) -> &ResourceScope

Get the resource scope.

Source

pub fn constraints(&self) -> &CapabilityConstraints

Get the constraints.

Source

pub fn constraints_mut(&mut self) -> &mut CapabilityConstraints

Get mutable constraints (for usage tracking).

Source

pub fn grantor(&self) -> &PrincipalId

Get the grantor.

Source

pub fn granted_at(&self) -> i64

Get when this was granted.

Source

pub fn expires_at(&self) -> Option<i64>

Get when this expires.

Source

pub fn is_delegatable(&self) -> bool

Check if this capability is delegatable.

Source

pub fn max_delegation_depth(&self) -> u32

Get maximum delegation depth.

Source

pub fn signature(&self) -> &Sig

Get the signature.

Source

pub fn delegation_depth(&self) -> u32

Get the current delegation depth (0 for root capabilities).

Source

pub fn parent_capability_id(&self) -> Option<CapabilityId>

Get the parent capability ID (for delegated capabilities).

Source

pub fn revoke(&mut self, reason: impl Into<String>)

Revoke this capability with a reason.

Source

pub fn is_revoked(&self) -> bool

Check if this capability has been revoked.

Source

pub fn revoked_at(&self) -> Option<i64>

Get the revocation timestamp if revoked.

Source

pub fn revocation_reason(&self) -> Option<&str>

Get the revocation reason if revoked.

Source

pub fn lifecycle_state(&self, now_ms: i64) -> CapabilityState

Get the lifecycle state at a given time per Section 5.4.

Source

pub fn is_valid_at(&self, timestamp: i64) -> bool

Check if this capability is valid at a given time.

A capability is valid if it is not revoked and not expired.

Source

pub fn matches( &self, action_kind: &CapabilityKind, resource: &ResourceId, ) -> bool

Check if this capability matches an action.

Source

pub fn canonical_bytes(&self) -> Vec<u8>

Compute the canonical bytes for signing/verification.

Source

pub fn hash(&self) -> Hash

Compute the hash of this capability.

Source

pub fn delegate( &self, delegator_key: &SecretKey, scope: Option<ResourceScope>, expiry: Option<Duration>, ) -> Result<Capability>

Delegate this capability to another agent, creating a child capability.

Enforces:

  • INV-CAP-3: child scope must be a subset of parent scope, child expiry must not exceed parent
  • INV-CAP-4: delegation depth must not exceed max_delegation_depth
  • Rule 5.3.3: delegated capabilities must be a subset of the delegator’s

Trait Implementations§

Source§

impl Clone for Capability

Source§

fn clone(&self) -> Capability

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Capability

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Capability

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Capability

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

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

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
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> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,