gautamdhameja/substrate-rbac

A Substrate pallet implementing role-based access control and permissions for Substrate extrinsic calls.

Substrate Role-based Access Control Pallet

A Substrate pallet implementing role-based access control and permissions for Substrate extrinsic calls.

The filtering of incoming extrinsics and their sender accounts is done at the transaction queue validation layer, using the SignedExtension trait.

Usage

• Add the module's dependency in the Cargo.toml of your runtime directory. Make sure to enter the correct path or git url of the pallet as per your setup.

[dependencies.substrate_rbac]
package = 'substrate-rbac'
git = 'https://github.com/gautamdhameja/substrate-rbac.git'
default-features = false

• Declare the pallet in your runtime/src/lib.rs.

pub use substrate_rbac;

impl substrate_rbac::Config for Runtime {
    type Event = Event;
    type RbacAdminOrigin = EnsureRoot<AccountId>;
}

construct_runtime!(
    pub enum Runtime where
        Block = Block,
        NodeBlock = opaque::Block,
        UncheckedExtrinsic = UncheckedExtrinsic
    {
        ...
        ...
        ...
        RBAC: substrate_rbac::{Pallet, Call, Storage, Event<T>, Config<T>},
    }
);

• Add the module's Authorize type in the SignedExtra checklist.

pub type SignedExtra = (
    ...
    ...
    balances::TakeFees<Runtime>,
    substrate_rbac::Authorize<Runtime>

• Add a genesis configuration for the module in the src/chain_spec.rs file.

rbac: Some(RBACConfig {
	super_admins: vec![get_account_id_from_seed::<sr25519::Public>("Alice")]
})

• cargo build --release and then cargo run --release -- --dev

Sample

The usage of this pallet are demonstrated in the Substrate permissioning sample.

Disclaimer

This code not audited and reviewed for production use cases. You can expect bugs and security vulnerabilities. Do not use it as-is in real applications.

substrate-rbac's Issues

use of undeclared type or module `frame_system` - error while building on v2.0.0-rc5

Tried adding the frame_system definition to the Cargo file and modified the code to use frame_system. But, those changes led to another error.

error[E0277]: `?` couldn't convert the error to `sp_api_hidden_includes_decl_storage::hidden_include::sp_runtime::DispatchError`
   --> src/lib.rs:105:35
    |
105 |             let who = ensure_signed(origin)?;
    |                                            ^ the trait `std::convert::From<sp_runtime::traits::BadOrigin>` is not implemented for `sp_api_hidden_includes_decl_storage::hidden_include::sp_runtime::DispatchError`