Enum hdk::prelude::capability::CapGrant

pub enum CapGrant {
    ChainAuthor(HoloHash<Agent>),
    RemoteAgent(ZomeCallCapGrant),
}

Represents a potentially valid access grant to a zome call. Zome call response will be Unauthorized without a valid grant.

The CapGrant is not always a dedicated entry in the chain. Notably AgentPubKey entries in the current chain act like root access to local zome calls.

A CapGrant is valid if it matches the function, agent and secret for a given zome call.

See .is_valid()

Variants

ChainAuthor(HoloHash<Agent>)

Grants the capability of calling every extern to the calling agent, provided the calling agent is the local chain author. This grant is compared to the current Entry::Agent entry on the source chain.

RemoteAgent(ZomeCallCapGrant)

Any agent other than the chain author is attempting to call an extern. The pubkey of the calling agent is secured by the cryptographic handshake at the network layer and the caller must provide a secret that we check for in a private entry in the local chain.

Implementations

impl CapGrant

pub fn is_valid(
    &self,
    check_function: &(ZomeName, FunctionName),
    check_agent: &HoloHash<Agent>,
    check_secret: Option<&CapSecret>
) -> bool

Given a grant, is it valid in isolation? In a world of CRUD, some new entry might update or delete an existing one, but we can check if a grant is valid in a standalone way.

Trait Implementations

impl Clone for CapGrant

pub fn clone(&self) -> CapGrant

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CapGrant

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CapGrant

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

Deserialize this value from the given Serde deserializer.

impl Eq for CapGrant

impl From<HoloHash<Agent>> for CapGrant

pub fn from(agent_hash: HoloHash<Agent>) -> CapGrant

Performs the conversion.

impl From<ZomeCallCapGrant> for CapGrant

pub fn from(zccg: ZomeCallCapGrant) -> CapGrant

Create a new ZomeCall capability grant

impl PartialEq<CapGrant> for CapGrant

pub fn eq(&self, other: &CapGrant) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &CapGrant) -> bool

This method tests for !=.

impl Serialize for CapGrant

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

Serialize this value into the given Serde serializer.

impl StructuralEq for CapGrant

impl StructuralPartialEq for CapGrant