智能合约与以太坊 / 系统课时

限制管理员可调用的函数

限制管理员可调用的函数

Solidity 合约中的公开写入函数可能被任意地址尝试调用。本课将部署者设置为管理员,使用 msg.sender 和 modifier 保护状态修改函数,并通过 Foundry 测试验证:管理员可以修改状态,未授权账户调用会回滚,原有状态保持不变。

学习目标

  • 理解 msg.sender、管理员地址与函数调用权限之间的关系。
  • 使用 modifier 编写可复用的管理员权限检查,并保护状态修改函数。
  • 使用 Foundry 模拟不同调用账户,验证授权成功、未授权回滚及状态不变。

明确管理员身份与权限边界

假设一个链上计数器允许所有人查询当前数值,但只有管理员能够修改。合约需要保存一个可信的管理员地址,并在每次执行受保护函数前核对调用者身份。

Solidity 提供 msg.sender 表示当前调用的直接发起者。对于外部账户直接发起的交易,它通常是该外部账户地址;如果合约 A 调用合约 B,那么在合约 B 中,msg.sender 是合约 A 的地址,而不是最初发起交易的用户。

本例采用部署者作为初始管理员,部署时把 msg.sender 写入 admin,之后检查调用者是否与该地址相同。

操作 普通账户 管理员
查询 value() 允许 允许
查询 admin() 允许 允许
调用 setValue(42) 拒绝并回滚 允许

权限判断必须在链上执行。即使前端隐藏了管理员按钮,其他用户仍然能够直接构造交易或调用合约接口,不能把界面可见性当作安全边界。

管理员权限检查与状态修改的条件分支流程

使用 modifier 保护写入函数

在 Solidity 0.8.24 及兼容的后续 0.8.x 版本中,可以使用函数修饰器 modifier 抽取重复的权限检查逻辑。修饰器中的 _; 表示被修饰函数的函数体将在此处执行。

使用已安装 Foundry 的开发环境,运行 forge init admin-access-demo 创建项目,再进入 admin-access-demo 目录。默认项目已包含 src、test 目录及 forge-std 测试依赖。将以下完整合约保存为 src/AdminCounter.sol。

solidity
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.24;

contract AdminCounter {
    error Unauthorized();

    // 部署时固定管理员,避免普通调用者更改身份。
    address public immutable admin;
    uint256 public value;

    constructor() {
        admin = msg.sender;
    }

    modifier onlyAdmin() {
        // 未通过检查时回滚,受保护函数体不会执行。
        if (msg.sender != admin) {
            revert Unauthorized();
        }
        _;
    }

    // 只有管理员可以修改链上状态。
    function setValue(uint256 newValue) external onlyAdmin {
        value = newValue;
    }
}

这个合约有四个需要区分的部分。

  1. constructor() 仅在部署时执行一次,将部署者地址保存为 admin。
  2. immutable 表示管理员地址只能在声明初始化或构造阶段赋值,部署后不能再通过普通函数修改。
  3. onlyAdmin 在进入 setValue 函数体前检查调用者身份,不符合条件时通过 revert Unauthorized() 终止执行。
  4. value 和 admin 使用 public,编译器会生成对应的读取函数;它们不会因为 setValue 受到保护而禁止查询。

这里使用自定义错误 Unauthorized(),而不是在每次调用时携带字符串形式的错误描述,可以减少错误数据体积。客户端也能够通过错误选择器识别未授权失败。

如果未来增加 resetValue() 或其他管理函数,只需要在相应的函数声明后加上 onlyAdmin,不必复制整段检查逻辑。

通过 Foundry 验证授权与回滚

合约编译成功并不能证明权限正确。测试必须分别覆盖管理员调用和非管理员调用,还要检查拒绝调用之后的状态是否发生变化。

在 Foundry 项目的 test 目录中新建 AdminCounter.t.sol,使用以下完整测试代码。

solidity
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.24;

import {Test} from "forge-std/Test.sol";
import {AdminCounter} from "../src/AdminCounter.sol";

contract AdminCounterTest is Test {
    AdminCounter private counter;

    function setUp() public {
        // 测试合约部署被测合约,因此自身成为管理员。
        counter = new AdminCounter();
    }

    function test_AdminCanSetValue() public {
        assertEq(counter.admin(), address(this));

        counter.setValue(42);

        assertEq(counter.value(), 42);
    }

    function test_NonAdminCannotSetValue() public {
        address outsider = address(0xBEEF);

        assertEq(counter.value(), 0);

        // 下一次被测合约调用模拟来自未授权账户。
        vm.expectRevert(AdminCounter.Unauthorized.selector);
        vm.prank(outsider);
        counter.setValue(99);

        // 回滚之后仍然是初始值,而不是99。
        assertEq(counter.value(), 0);
    }
}

setUp() 会在每个测试执行前重新部署合约,所以两项测试各自使用独立的初始状态。测试合约本身是部署者,因此 address(this) 等于被测合约记录的管理员地址。

vm.prank(outsider) 用于模拟下一次合约调用的 msg.sender。vm.expectRevert(AdminCounter.Unauthorized.selector) 则要求后续调用必须因为指定自定义错误而回滚,否则测试失败。

测试文件保存后,在项目根目录执行:

bash
forge test --match-contract AdminCounterTest

预期输出(节选,编译信息及耗时会随环境变化):

text
[PASS] test_AdminCanSetValue()
[PASS] test_NonAdminCannotSetValue()
Suite result: ok. 2 passed; 0 failed; 0 skipped

两个测试均通过意味着已经验证以下行为:

  • 授权调用 setValue(42) 后,读取 value() 得到 42。
  • 未授权调用 setValue(99) 触发预期的 Unauthorized() 错误。
  • 非授权调用结束后,value() 仍为 0,说明被拒绝的操作没有写入状态。

这里验证的是直接拒绝未授权调用的情况。如果一个复杂函数在执行部分状态修改后才发生 revert,EVM 同样会撤销当前被回滚执行范围内的状态变更。不过,权限检查仍应尽量安排在可能产生副作用的操作之前。

识别权限检查中的常见错误

实际开发时,管理员限制容易在身份来源、检查位置和受保护函数覆盖范围上出现问题。

错误做法 具体风险 正确做法
使用 tx.origin 判断管理员 经由恶意中间合约调用时,可能错误信任原始交易发起者 使用 msg.sender 检查当前直接调用者
只在前端限制管理员按钮 攻击者可以绕过前端直接调用合约 在每个受保护的链上入口执行权限检查
只检查一个写入函数 其他未保护函数可能仍能修改相同状态 逐个检查所有可以修改敏感状态的入口
把部署者固定为管理员却未考虑工厂部署 通过工厂部署时,管理员可能是工厂合约地址 明确部署路径及预期管理员身份,必要时设计显式初始化参数

还需要区分管理员权限与业务规则。onlyAdmin 只负责回答调用者是否具有权限,不负责判断输入数值是否合理。例如业务规定 value 最大不能超过 1000,就应另行增加数值检查,而不能认为管理员输入天然安全。

在本例中,还可以做一个简单的权限边界检查:将 setValue 的 onlyAdmin 暂时删除,重新运行测试。未授权测试应当失败,因为普通账户调用不再触发 Unauthorized()。恢复修饰器并再次运行,两项测试应重新通过。

最终可验收的权限行为是:任意账户都能读取公开状态,但只有部署时确定的管理员地址能够通过 setValue 修改它。合约上线前还应核对实际部署者地址,并根据资产价值与业务要求考虑成熟的权限管理组件、管理员交接及多签控制。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

限制管理员可调用的函数

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通