Struct UcanBuilder 

pub struct UcanBuilder<'a, K>
where
    K: KeyMaterial,
{ /* private fields */ }

A builder API for UCAN tokens

Implementations

impl<'a, K> UcanBuilder<'a, K>

where K: KeyMaterial,

pub fn issued_by(self, issuer: &'a K) -> Self

The UCAN must be signed with the private key of the issuer to be valid.

pub fn for_audience(self, audience: &str) -> Self

This is the identity this UCAN transfers rights to.

It could e.g. be the DID of a service you’re posting this UCAN as a JWT to, or it could be the DID of something that’ll use this UCAN as a proof to continue the UCAN chain as an issuer.

pub fn with_lifetime(self, seconds: u64) -> Self

The number of seconds into the future (relative to when build() is invoked) to set the expiration. This is ignored if an explicit expiration is set.

pub fn with_expiration(self, timestamp: u64) -> Self

Set the POSIX timestamp (in seconds) for when the UCAN should expire. Setting this value overrides a configured lifetime value.

pub fn not_before(self, timestamp: u64) -> Self

Set the POSIX timestamp (in seconds) of when the UCAN becomes active.

pub fn with_fact<T: Serialize + DeserializeOwned>( self, key: &str, fact: T, ) -> Self

Add a fact or proof of knowledge to this UCAN.

pub fn with_nonce(self) -> Self

Will ensure that the built UCAN includes a number used once.

pub fn witnessed_by(self, authority: &Ucan, hasher: Option<Code>) -> Self

Includes a UCAN in the list of proofs for the UCAN to be built. Note that the proof’s audience must match this UCAN’s issuer or else the proof chain will be invalidated! The proof is encoded into a [Cid], hashed via the UcanBuilder::default_hasher() algorithm, unless one is provided.

pub fn claiming_capability<C>(self, capability: C) -> Self

where C: Into<Capability>,

Claim a capability by inheritance (from an authorizing proof) or implicitly by ownership of the resource by this UCAN’s issuer

pub fn claiming_capabilities<C>(self, capabilities: &[C]) -> Self

where C: Into<Capability> + Clone,

Claim capabilities by inheritance (from an authorizing proof) or implicitly by ownership of the resource by this UCAN’s issuer

pub fn delegating_from(self, authority: &Ucan, hasher: Option<Code>) -> Self

Delegate all capabilities from a given proof to the audience of the UCAN you’re building. The proof is encoded into a [Cid], hashed via the UcanBuilder::default_hasher() algorithm, unless one is provided.

pub fn default_hasher() -> Code

Returns the default hasher (Code::Blake3_256) used for [Cid] encodings.

pub fn build(self) -> Result<Signable<'a, K>>

Trait Implementations

impl<'a, K> Clone for UcanBuilder<'a, K>

where K: KeyMaterial + Clone,

fn clone(&self) -> UcanBuilder<'a, K>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, K> Default for UcanBuilder<'a, K>

where K: KeyMaterial,

fn default() -> Self

Create an empty builder. Before finalising the builder, you need to at least call:

• issued_by
• to_audience and one of
• with_lifetime or with_expiration.

To finalise the builder, call its build or build_parts method.