Access control with OpenZeppelin in Blockchain / Solidity

Introduction

Access control helps decide who can do what in a smart contract. OpenZeppelin makes it easy to add these rules safely.

You want only the owner to change important settings in your contract.

You want to give special permissions to certain users, like admins.

You want to protect functions so only authorized people can call them.

You want to manage roles easily without writing complex code.

You want to keep your contract secure from unauthorized access.

Syntax

Blockchain / Solidity

import "@openzeppelin/contracts/access/AccessControl.sol";

contract MyContract is AccessControl {
    bytes32 public constant ADMIN_ROLE = keccak256("ADMIN_ROLE");

    constructor() {
        _setupRole(DEFAULT_ADMIN_ROLE, msg.sender);
        _setupRole(ADMIN_ROLE, msg.sender);
    }

    function restrictedFunction() public onlyRole(ADMIN_ROLE) {
        // code only admins can run
    }
}

Use onlyRole(role) modifier to restrict function access.

Roles are identified by bytes32 hashes, usually created with keccak256.

Examples

This example creates a MINTER_ROLE and restricts the mint function to users with that role.

Blockchain / Solidity

bytes32 public constant MINTER_ROLE = keccak256("MINTER_ROLE");

function mint() public onlyRole(MINTER_ROLE) {
    // mint tokens
}

This sets the deployer as the default admin who can grant or revoke roles.

Blockchain / Solidity

constructor() {
    _setupRole(DEFAULT_ADMIN_ROLE, msg.sender);
}

Only the default admin can give the ADMIN_ROLE to others.

Blockchain / Solidity

function grantAdmin(address user) public onlyRole(DEFAULT_ADMIN_ROLE) {
    grantRole(ADMIN_ROLE, user);
}

Sample Program

This contract lets only users with the EDITOR_ROLE change the data. The deployer starts with admin and editor roles.

Blockchain / Solidity

pragma solidity ^0.8.20;

import "@openzeppelin/contracts/access/AccessControl.sol";

contract SimpleAccess is AccessControl {
    bytes32 public constant EDITOR_ROLE = keccak256("EDITOR_ROLE");

    string public data;

    constructor() {
        _setupRole(DEFAULT_ADMIN_ROLE, msg.sender);
        _setupRole(EDITOR_ROLE, msg.sender);
    }

    function setData(string memory newData) public onlyRole(EDITOR_ROLE) {
        data = newData;
    }

    function getData() public view returns (string memory) {
        return data;
    }
}

Important Notes

Remember to assign roles carefully to avoid locking out important functions.

OpenZeppelin's AccessControl is safer and easier than writing your own permission checks.

Use DEFAULT_ADMIN_ROLE to manage other roles.

Summary

Access control restricts who can use certain functions in a contract.

OpenZeppelin provides ready-made tools to add roles and permissions.

Use onlyRole modifier to protect functions easily.

Practice

1. What is the main purpose of using onlyRole modifier in OpenZeppelin's Access Control?

easy

A. To restrict function access to accounts with a specific role

B. To automatically assign roles to all users

C. To allow anyone to call the function without restrictions

D. To log all function calls for auditing

Solution

1. Step 1: Understand the purpose of onlyRole

   The onlyRole modifier is used to limit access to functions so only users with a certain role can execute them.

2. Step 2: Analyze the options

   To restrict function access to accounts with a specific role correctly states that it restricts function access to accounts with a specific role. Other options describe unrelated behaviors.

3. Final Answer:

   To restrict function access to accounts with a specific role -> Option A

4. Quick Check:

   Access control = restrict by role [OK]

Hint: Remember: onlyRole means only users with that role can call [OK]

Common Mistakes:

• Thinking onlyRole assigns roles automatically
• Believing onlyRole allows open access
• Confusing onlyRole with event logging

2. Which of the following is the correct way to declare a role constant in OpenZeppelin Access Control?

easy

A. address constant ADMIN_ROLE = 0x123;

B. string public ADMIN_ROLE = "ADMIN_ROLE";

C. uint256 constant ADMIN_ROLE = 1;

D. bytes32 public constant ADMIN_ROLE = keccak256("ADMIN_ROLE");

Solution

1. Step 1: Recall role declaration syntax

   OpenZeppelin uses bytes32 constants with keccak256 hash of a string to define roles.

2. Step 2: Check each option

   bytes32 public constant ADMIN_ROLE = keccak256("ADMIN_ROLE"); matches the correct pattern. Options B, C, and D use wrong types or formats.

3. Final Answer:

   bytes32 public constant ADMIN_ROLE = keccak256("ADMIN_ROLE"); -> Option D

4. Quick Check:

   Role constants use bytes32 + keccak256 [OK]

Hint: Roles are bytes32 constants hashed with keccak256 [OK]

Common Mistakes:

• Using string instead of bytes32 for roles
• Assigning numeric or address types to roles
• Forgetting to use keccak256 hash

3. Given the following Solidity code snippet, what will happen if an account without the ADMIN_ROLE calls secureFunction()?

contract MyContract is AccessControl {
    bytes32 public constant ADMIN_ROLE = keccak256("ADMIN_ROLE");

    constructor() {
        _grantRole(ADMIN_ROLE, msg.sender);
    }

    function secureFunction() public onlyRole(ADMIN_ROLE) {
        // critical logic
    }
}

medium

A. The function executes normally

B. The call reverts with an access control error

C. The function executes but emits a warning

D. The function executes only if the caller is the contract owner

Solution

1. Step 1: Understand the onlyRole modifier behavior

   The onlyRole(ADMIN_ROLE) modifier restricts access to accounts with ADMIN_ROLE. If the caller lacks this role, the call reverts.

2. Step 2: Analyze the scenario

   The constructor grants ADMIN_ROLE only to msg.sender at deployment. Any other account calling secureFunction will trigger a revert due to missing role.

3. Final Answer:

   The call reverts with an access control error -> Option B

4. Quick Check:

   Missing role causes revert [OK]

Hint: Only accounts with role can call; others revert [OK]

Common Mistakes:

• Assuming function runs without role
• Thinking warnings are emitted instead of revert
• Confusing role with ownership

4. Identify the error in this OpenZeppelin Access Control code snippet:

contract MyContract is AccessControl {
    bytes32 public constant ADMIN_ROLE = keccak256("ADMIN_ROLE");

    constructor() {
        _grantRole(ADMIN_ROLE, msg.sender);
    }

    function restricted() public onlyRole(ADMIN_ROLE) {
        // restricted logic
    }

    function grantAdmin(address user) public {
        _grantRole(ADMIN_ROLE, user);
    }
}

medium

A. The grantAdmin function lacks access control and can be called by anyone

B. The _setupRole function is deprecated and should not be used

C. The onlyRole modifier is missing from grantAdmin

D. The ADMIN_ROLE constant is incorrectly declared

Solution

1. Step 1: Review access control on grantAdmin

   The grantAdmin function calls _grantRole but has no modifier restricting who can call it.

2. Step 2: Identify security risk

   Without access control, anyone can call grantAdmin and assign ADMIN_ROLE to themselves or others, breaking security.

3. Final Answer:

   The grantAdmin function lacks access control and can be called by anyone -> Option A

4. Quick Check:

   Grant functions need access control [OK]

Hint: Always protect grantRole functions with onlyRole [OK]

Common Mistakes:

• Ignoring missing access control on grant functions
• Thinking _grantRole is protected like grantRole
• Confusing role declaration syntax

5. You want to create a smart contract where only users with the MINTER_ROLE can mint tokens, and only the contract owner can assign the MINTER_ROLE. Which OpenZeppelin pattern correctly enforces this?

hard

A. Use Ownable and allow only the owner to mint tokens directly without roles

B. Use AccessControl but allow anyone to assign MINTER_ROLE to themselves

C. Use AccessControl with MINTER_ROLE and add onlyRole(DEFAULT_ADMIN_ROLE) modifier to the role assignment function, granting DEFAULT_ADMIN_ROLE to the owner

D. Use AccessControl and assign MINTER_ROLE to everyone by default

Solution

1. Step 1: Understand role assignment control

   To restrict who can assign MINTER_ROLE, use AccessControl's DEFAULT_ADMIN_ROLE for admin rights and protect assignment functions with onlyRole(DEFAULT_ADMIN_ROLE).

2. Step 2: Connect owner with DEFAULT_ADMIN_ROLE

   Grant DEFAULT_ADMIN_ROLE to the contract owner so only they can assign MINTER_ROLE to others.

3. Final Answer:

   Use AccessControl with MINTER_ROLE and add onlyRole(DEFAULT_ADMIN_ROLE) modifier to the role assignment function, granting DEFAULT_ADMIN_ROLE to the owner -> Option C

4. Quick Check:

   Admin role controls role assignment [OK]

Hint: Use DEFAULT_ADMIN_ROLE for owner to control role assignments [OK]

Common Mistakes:

• Allowing anyone to assign roles
• Using Ownable without roles for minting
• Assigning roles to everyone by default