Struct pallet_rbac::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn tx_create_and_set_roles( origin: OriginFor<T>, pallet: IdOrVec, roles: Vec<Vec<u8>> ) -> DispatchResult

pub fn tx_remove_role_from_user( origin: OriginFor<T>, user: T::AccountId, pallet: IdOrVec, scope_id: ScopeId, role_id: RoleId ) -> DispatchResult

pub fn tx_create_and_set_permissions( origin: OriginFor<T>, pallet: IdOrVec, role_id: RoleId, permissions: Vec<Vec<u8>> ) -> DispatchResult

pub fn tx_assign_role_to_user( origin: OriginFor<T>, user: T::AccountId, pallet: IdOrVec, scope_id: ScopeId, role_id: RoleId ) -> DispatchResult

pub fn revoke_permission_from_role( origin: OriginFor<T>, pallet: IdOrVec, role_id: RoleId, permission_id: PermissionId ) -> DispatchResult

pub fn remove_permission_from_pallet( origin: OriginFor<T>, pallet: IdOrVec, permission_id: PermissionId ) -> DispatchResult

impl<T: Config> Pallet<T>

pub fn scopes<KArg>(k: KArg) -> BoundedVec<ScopeId, T::MaxScopesPerPallet>where KArg: EncodeLike<PalletId>,

impl<T: Config> Pallet<T>

pub fn roles<KArg>(k: KArg) -> Option<BoundedVec<u8, T::RoleMaxLen>>where KArg: EncodeLike<RoleId>,

impl<T: Config> Pallet<T>

pub fn pallet_roles<KArg>(k: KArg) -> BoundedVec<RoleId, T::MaxRolesPerPallet>where KArg: EncodeLike<PalletId>,

impl<T: Config> Pallet<T>

pub fn permissions<KArg1, KArg2>( k1: KArg1, k2: KArg2 ) -> BoundedVec<u8, T::PermissionMaxLen>where KArg1: EncodeLike<PalletId>, KArg2: EncodeLike<PermissionId>,

impl<T: Config> Pallet<T>

pub fn permissions_by_role<KArg1, KArg2>( k1: KArg1, k2: KArg2 ) -> BoundedVec<PermissionId, T::MaxPermissionsPerRole>where KArg1: EncodeLike<PalletId>, KArg2: EncodeLike<RoleId>,

impl<T: Config> Pallet<T>

pub fn roles_by_user<KArg>(key: KArg) -> BoundedVec<RoleId, T::MaxRolesPerUser>where KArg: EncodeLikeTuple<<(NMapKey<Blake2_128Concat, T::AccountId>, NMapKey<Identity, PalletId>, NMapKey<Identity, ScopeId>) as KeyGenerator>::KArg> + TupleToEncodedIter,

impl<T: Config> Pallet<T>

pub fn users_by_scope<KArg>( key: KArg ) -> BoundedVec<T::AccountId, T::MaxUsersPerRole>where KArg: EncodeLikeTuple<<(NMapKey<Identity, PalletId>, NMapKey<Identity, ScopeId>, NMapKey<Identity, RoleId>) as KeyGenerator>::KArg> + TupleToEncodedIter,

Trait Implementations

impl<T: Config> Callable<T> for Pallet<T>

type RuntimeCall = Call<T>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Pallet<T>

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

Formats the value using the given formatter.

impl<T: Config> GetStorageVersion for Pallet<T>

fn current_storage_version() -> StorageVersion

Returns the current storage version as supported by the pallet.

fn on_chain_storage_version() -> StorageVersion

Returns the on-chain storage version of the pallet as stored in the storage.

impl<T: Config> Hooks<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(_n: BlockNumber)

The block is being finalized. Implement to have something happen.

fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight

This will be run when the block is being finalized (before on_finalize). Implement to have something happen using the remaining weight. Will not fire if the remaining weight is 0. Return the weight used, the hook will subtract it from current weight used and pass the result to the next on_idle hook if it exists.

fn on_initialize(_n: BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a module allows you to perform long-running tasks that make (by default) validators generate transactions that feed results of those long-running computations back on chain.

fn integrity_test()

Run integrity test.

impl<T: Config> IntegrityTest for Pallet<T>

fn integrity_test()

Run integrity test.

impl<T: Config> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T>

fn offchain_worker(n: <T as Config>::BlockNumber)

This function is being called after every block import (when fully synced).

impl<T: Config> OnFinalize<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(n: <T as Config>::BlockNumber)

The block is being finalized. Implement to have something happen.

impl<T: Config> OnGenesis for Pallet<T>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<T as Config>::BlockNumber> for Pallet<T>

fn on_idle(n: <T as Config>::BlockNumber, remaining_weight: Weight) -> Weight

The block is being finalized. Implement to have something happen in case there is leftover weight. Check the passed remaining_weight to make sure it is high enough to allow for your pallet’s extra computation.

impl<T: Config> OnInitialize<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(n: <T as Config>::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

impl<T: Config> OnRuntimeUpgrade for Pallet<T>

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

impl<T: Config> PalletInfoAccess for Pallet<T>

fn index() -> usize

Index of the pallet as configured in the runtime.

fn name() -> &'static str

Name of the pallet as configured in the runtime.

fn module_name() -> &'static str

Name of the Rust module containing the pallet.

fn crate_version() -> CrateVersion

Version of the crate containing the pallet.

impl<T: Config> PalletsInfoAccess for Pallet<T>

fn count() -> usize

The number of pallets’ information that this type represents.

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

impl<T> PartialEq<Pallet<T>> for Pallet<T>

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Config> RoleBasedAccessControl<<T as Config>::AccountId> for Pallet<T>

fn create_scope(pallet: IdOrVec, scope_id: ScopeId) -> DispatchResult

Scope creation

Creates a scope within a external pallet using the pallet index.

Parameters:

• pallet_id: The unique pallet identifier.
• scope_id: The newly generated scope identifier.

fn remove_scope(pallet: IdOrVec, scope_id: ScopeId) -> DispatchResult

Scope removal

Removes a scope within a external pallet using the pallet index. Executing this function will delete all registered role users.

Parameters:

• pallet_id: The unique pallet identifier.
• scope_id: The scope identifier to remove.

fn remove_pallet_storage(pallet: IdOrVec) -> DispatchResult

External pallet storage removal

Removes all storage associated to a external pallet.

Executing this function will delete all role lists and permissions linked to that pallet.

Parameters:

• pallet_id: The unique pallet identifier.

fn create_and_set_roles( pallet: IdOrVec, roles: Vec<Vec<u8>> ) -> Result<BoundedVec<RoleId, T::MaxRolesPerPallet>, DispatchError>

Role creation and coupling with pallet.

Creates the specified roles if needed and adds them to the pallet. Recommended first step to enable RBAC on a external pallet.

Parameters:

• pallet_id: The unique pallet identifier.
• roles: A list of roles to create, encoded in bytes.

fn create_role(role: Vec<u8>) -> Result<RoleId, DispatchError>

Role creation.

Creates a role and returns its identifier, if its already created, the function will return the preexisting one.

Parameters:

• role: A role to create, encoded in bytes.

fn set_role_to_pallet(pallet: IdOrVec, role_id: RoleId) -> DispatchResult

Role coupling with pallet.

Assigns a previously created role to a pallet.

Parameters:

• pallet_id: The unique pallet identifier.
• role_id: The unique role identifier.

fn set_multiple_pallet_roles( pallet: IdOrVec, roles: Vec<RoleId> ) -> DispatchResult

Multiple role coupling with pallet.

Assigns multiple, previously created roles to a pallet.

Parameters:

• pallet_id: The unique pallet identifier.
• roles: A list of unique role identifiers.

fn assign_role_to_user( user: T::AccountId, pallet: IdOrVec, scope_id: &ScopeId, role_id: RoleId ) -> DispatchResult

Role assignation to a user

Assigns a role to a user in a scope context.

Parameters:

• user: The account which the role will be granted.
• pallet_id: The unique pallet identifier.
• scope_id: The scope in which the role will be granted.
• role_id: The role identifier to grant for the user.

fn remove_role_from_user( user: T::AccountId, pallet: IdOrVec, scope_id: &ScopeId, role_id: RoleId ) -> DispatchResult

Role removal from the user.

Removes the specified role from a user in a scope context. the user will no longer be able to enforce the removed role and its permissions.

Parameters:

• user: The account which the role will be removed.
• pallet_id: The unique pallet identifier.
• scope_id: The scope in which the role will be removed.
• role_id: The role identifier to remove from the user.

fn create_and_set_permissions( pallet: IdOrVec, role_id: RoleId, permissions: Vec<Vec<u8>> ) -> Result<BoundedVec<PermissionId, Self::MaxPermissionsPerRole>, DispatchError>

Permission creation and coupling with a role.

Creates the specified permissions if needed and assigns them to a role.

Parameters:

• pallet_id: The unique pallet identifier.
• role_id: The role identifier to which the permissions will be linked to.
• permissions: A list of permissions to create and link, encoded in bytes.

fn create_permission( pallet: IdOrVec, permission: Vec<u8> ) -> Result<PermissionId, DispatchError>

Permission creation

Creates the specified permission in the specified pallet..

Parameters:

• pallet_id: The unique pallet identifier.
• permission: The permission to insert, encoded in bytes.

fn set_permission_to_role( pallet: IdOrVec, role_id: RoleId, permission_id: PermissionId ) -> DispatchResult

Permission linking to role.

Assigns a previously created permission to a role.

Parameters:

• pallet_id: The unique pallet identifier.
• role_id: The role identifier to which the permission will be added.
• permission_id: The permission to assign to the role.

fn set_multiple_permissions_to_role( pallet: IdOrVec, role_id: RoleId, permissions: Vec<PermissionId> ) -> DispatchResult

Multiple permissions assignation to a role

Assigns multiple, previously created permissions to a role in a pallet context.

Parameters:

• pallet_id: The unique pallet identifier.
• role_id: The role identifier to which the permissions will be added.
• permissions: A list of permission identifiers to assign to the role.

fn do_revoke_permission_from_role( pallet: IdOrVec, role_id: RoleId, permission_id: PermissionId ) -> DispatchResult

Permission revocation from role

Remove a permission linked to a role (in a pallet context).

Parameters:

• pallet_id: The unique pallet identifier.
• role_id: The role identifier to which the permissions will be removed from.
• permission_id: The permission to deassign.

fn do_remove_permission_from_pallet( pallet: IdOrVec, permission: PermissionId ) -> DispatchResult

Permission removal from pallet

Use with caution. The permission will be deleted from all the roles and pallet.

Parameters:

• pallet_id: The unique pallet identifier.
• permission_id: The permission to remove completely.

fn is_authorized( user: T::AccountId, pallet: IdOrVec, scope_id: &ScopeId, permission_id: &PermissionId ) -> DispatchResult

Authorization function

Checks if the user has a role that includes the specified permission.

Parameters:

• user: The account to validate.
• pallet_id: The unique pallet identifier.
• scope_id: The scope context in which the permission will be validated.
• permission_id: The permission the user must have.

fn has_role( user: T::AccountId, pallet: IdOrVec, scope_id: &ScopeId, role_ids: Vec<RoleId> ) -> DispatchResult

User role validation function

Checks if the user has at least one of the specified roles.

Parameters:

• user: The account to validate.
• pallet_id: The unique pallet identifier.
• scope_id: The scope context in which the permission will be validated.
• role_ids: A list of roles to validate.

fn does_user_have_any_role_in_scope( account: T::AccountId, pallet: IdOrVec, scope_id: &ScopeId ) -> bool

User any-role validation function

Checks if the user has at least one role in the given scope.

Parameters:

• user: The account to validate.
• pallet_id: The unique pallet identifier.
• scope_id: The scope context in which the role will be validated.

fn scope_exists(pallet: IdOrVec, scope_id: &ScopeId) -> DispatchResult

Scope validation

Checks if the scope exists in that pallet.

Parameters:

• pallet_id: The unique pallet identifier.
• scope_id: The scope to validate.

fn permission_exists( pallet: IdOrVec, permission_id: &PermissionId ) -> DispatchResult

Permission validation.

Checks if the permission exists in a pallet context.

Parameters:

• pallet_id: The unique pallet identifier.
• permission_id: The permission to validate.

fn is_role_linked_to_pallet(pallet: IdOrVec, role_id: &RoleId) -> DispatchResult

Role validation

Checks if the role is linked to the pallet.

Parameters:

• pallet_id: The unique pallet identifier.
• role_id: The role to validate

fn is_permission_linked_to_role( pallet: IdOrVec, role_id: &RoleId, permission_id: &PermissionId ) -> DispatchResult

Permission linking validation

Checks if the permission is linked to the role in the pallet context.

Parameters:

• pallet_id: The unique pallet identifier.
• role_id: The role which should have the permission.
• permission_id: The permission which the role should have.

fn get_roles_that_have_permission( pallet_id: PalletId, permission_id: &PermissionId ) -> Vec<RoleId>

Get roles that have a permission

Returns all the roles within the pallet that have a permission

Parameters:

• pallet_id: The unique pallet identifier.
• permission_id: The permission which the roles should have.

fn get_role_users_len( pallet: IdOrVec, scope_id: &ScopeId, role_id: &RoleId ) -> usize

Role list length

Returns the number of user that have the specified role in a scope context.

Parameters:

• pallet_id: The unique pallet identifier.
• scope_id: The scope in which the users will be retrieved.
• role_id: The role in which the number of users will be counted.

fn to_id(v: Vec<u8>) -> [u8; 32]

fn get_roles_by_user( user: T::AccountId, pallet: IdOrVec, scope_id: &ScopeId ) -> Vec<RoleId>

type MaxRolesPerPallet = <T as Config>::MaxRolesPerPallet

type MaxPermissionsPerRole = <T as Config>::MaxPermissionsPerRole

type PermissionMaxLen = <T as Config>::PermissionMaxLen

type RoleMaxLen = <T as Config>::RoleMaxLen

impl<T: Config> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config> WhitelistedStorageKeys for Pallet<T>

fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>

Returns a Vec<TrackedStorageKey> indicating the storage keys that should be whitelisted during benchmarking. This means that those keys will be excluded from the benchmarking performance calculation.

impl<T> Eq for Pallet<T>