Struct AuthActions 

pub struct AuthActions<T: Caller> {
    pub caller: T,
}

Authenticate actions

transact calls into auth services using auth_interface to authenticate senders of top-level actions and uses of runAs. Any service may become an auth service by implementing auth_interface. Any account may select any service to be its authenticator. Be careful; this allows that service to act on the account’s behalf and that service to authorize other accounts and services to act on the account’s behalf. It can also can lock out that account. See AuthSig (C++) for a canonical example of implementing auth_interface.

This interface can’t authenticate non-top-level actions other than runAs actions. Most services shouldn’t call or implement auth_interface; use get_sender() TODO: link.

Services implement auth_interface by defining actions with identical signatures; there is no trait.

Fields

caller: T

Implementations

impl<T: Caller> AuthActions<T>

pub fn checkAuthSys( &self, flags: u32, requester: AccountNumber, action: Action, allowedActions: Vec<ServiceMethod>, claims: Vec<Claim>, ) -> T::ReturnsNothing

Authenticate a top-level action or a runAs action

• flags: One of the Req (request) constants, or’ed with 0 or more of the flag constants
• requester: "" if this is a top-level action, or the sender of the runAs action. This is often different from action.sender.
• action: Action to authenticate
• allowedActions: Argument from runAs
• claims: Claims in transaction (e.g. public keys). Empty if runAs

pub fn canAuthUserSys(&self, user: AccountNumber) -> T::ReturnsNothing

Verify that a particular user is allowed to use a particular auth service. Allows auth services to use user whitelists.

Called by Accounts.

• user: The user being checked

pub fn isAuthSys( &self, sender: AccountNumber, authorizers: Vec<AccountNumber>, authSet: Option<Vec<AccountNumber>>, ) -> T::ReturnType<bool>

Check whether a specified set of authorizer accounts are sufficient to authorize sending a transaction from a specified sender.

• sender: The sender account for the transaction potentially being authorized.
• authorizers: The set of accounts that have already authorized the execution of the transaction.
• authSet: The set of accounts that are already being checked for authorization. If the sender is already in this set, then the function should return false.

Returns:

• true: The authorizers are sufficient to authorize a transaction from the sender.
• false: The authorizers are not sufficient to authorize a transaction from the sender.

pub fn isRejectSys( &self, sender: AccountNumber, rejecters: Vec<AccountNumber>, authSet: Option<Vec<AccountNumber>>, ) -> T::ReturnType<bool>

Check whether a specified set of rejecter accounts are sufficient to reject (cancel) a transaction from a specified sender.

• sender: The sender account for the transaction potentially being rejected.
• rejecters: The set of accounts that have already authorized the rejection of the transaction.
• authSet: The set of accounts that are already being checked for authorization. If the sender is already in this set, then the function should return false.

Returns:

• true: The rejecters are sufficient to reject a transaction from the sender.
• false: The rejecters are not sufficient to reject a transaction from the sender.

Trait Implementations

impl<T: Clone + Caller> Clone for AuthActions<T>

fn clone(&self) -> AuthActions<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Caller> Debug for AuthActions<T>

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

Formats the value using the given formatter.

impl<T: Caller> From<T> for AuthActions<T>

fn from(caller: T) -> Self

Converts to this type from the input type.

impl<T: Caller> ToActionsSchema for AuthActions<T>

fn to_schema( builder: &mut SchemaBuilder, ) -> IndexMap<MethodString, FunctionType>