*openUBMC 安全切面使能详细设计说明书*

<table>
    <tr>
        <td>所属SIG组:</td>
        <td>hardware</td>
    </tr>
    <tr>
        <td>落入版本:</td>
        <td>26.0</td>
    </tr>
    <tr>
        <td>设计人员:</td>
        <td>lisongwei</td>
    </tr>
    <tr>
        <td>日期:</td>
        <td>2026/01/13</td>
    </tr>
</table>

**Copyright © 2025 openUBMC Community**

您对&quot;本文档&quot;的复制，使用，修改及分发受木兰宽松许可证, 第2版协议(以下简称&quot;MulanPSL2&quot;)的约束。
为了方便用户理解，您可以通过访问<https://license.coscl.org.cn/MulanPSL2>了解MulanPSL2的概要 (但不是替代)。
MulanPSL2的完整协议内容您可以访问如下网址获取：<https://license.coscl.org.cn/MulanPSL2>。

**改版记录**

<table>
    <tr>
        <th>日期</th>
        <th>修订版本</th>
        <th>修订描述</th>
        <th>作者</th>
        <th>审核</th>
    </tr>
    <tr>
        <td>2026/01/13</td>
        <td>1.0</td>
        <td>安全切面使能</td>
        <td>lisongwei</td>
        <td>/</td>
    </tr>
</table>

**List of abbreviations**  **缩略语清单** ：

<table>
    <tr>
        <th>Abbreviations 缩略语</th>
        <th>Full spelling 英文全名</th>
        <th>Chinese explanation 中文解释</th>
    </tr>
    <tr>
        <td>xxx</td>
        <td>xxx</td>
        <td>xxx</td>
    </tr>
    <tr>
        <td>xxx</td>
        <td>xxx</td>
        <td>xxx</td>
    </tr>
</table>

[TOC]

# 1.功能分析
## 1.1 功能背景
<!-- 描述该需求的来源或背景，比如：支撑XXX功能、XXX优化等；以及该需求对用户（含组件）带来什么具体价值，如果没有该需求，对用户（含组件）带来什么损失； -->
为满足安全可信要求，通用硬件需要配置安全切面命令白名单并使能功能，确保不在白名单中的命令能够被拦截。

## 1.2 功能描述
<!-- 描述该需求交付的整体功能，主要实现XXX功能，解决XXX问题，明确方案如何实现 -->
通用硬件子系统配置安全切面命令白名单并使能功能，确保不在白名单中的命令能够被拦截，满足安全可信要求。

## 1.3 功能场景
<!-- 描述该需求的业务使用场景，内容包括：
1) 场景出发条件及对象：什么角色/工具/接口等在什么具体情况下使用该特性，使用对象技能如何？
2) 使用时间及频度
3) 描述该特性主要有哪些场景、子场景及关键任务操作 -->

### 1.3.1 场景触发条件及对象
使用角色：不涉及。使用工具：不涉及。使用技能：不涉及。

### 1.3.2 使用时间及频度
BMC正常运行时。

### 1.3.3 主要场景及子场景
BMC正常运行。

## 1.4 功能列表
<!-- 描述该需求交付的功能列表，内容包括：列出功能详细描述，标题、描述。 -->
| 功能编号 | 功能标题 | 功能描述 |
| ------- | ------- | -------- |
| 1 | 安全切面使能 | 通过配置文件中的配置项，使能通用硬件子系统的安全切面功能，拦截不在白名单中的命令。 |

# 2.功能设计
## 2.1 总体方案分析
<!-- 描述该方案的总体设计（注：相关输出方案可同步刷新到各组件仓） -->
具体涉及修改的代码仓和文件内容如下：
1. manifest仓：
   - secbox.cfg：添加环境变量，使能安全切面功能
   - CommandWhiteList.json：添加通用硬件子系统下各组件实际使用的命令
   - CrossPathWhiteList.json：框架暂未使能该功能，按照默认内容配置
   - PermissionRiskWhiteList.json：框架暂未使能该功能，按照默认内容配置
   - SoftLinkWhiteList.json：框架暂未使能该功能，按照默认内容配置
   - UserWhiteList.json：框架暂未使能该功能，按照默认内容配置
2. 各个组件仓：
   - CommandWhiteList.json：添加本组件实际使用的命令

### 2.1.1 方案详细设计
#### 2.1.1.1 方案概述
<!-- 描述该方案的整体实现，内容包括：涉及的关键点，实现策略等 -->
参考框架提供的安全切面开发指导，配置secbox.cfg文件为使能安全切面。之后根据提供的排查方式排查各组件调用的linux命令，将组件所在子系统使用的命令写入统一写入manifest仓中的CommandWhiteList.json文件。其余几个文件直接使用默认内容即可。

同时，各个组件新增whitelist目录，将本组件使用的linux命令写入CommandWhiteList.json文件中。构建流程最终会将各组件仓中的CommandWhiteList.json文件与manifest仓中的文件整合成一个最终文件，包含本子系统所有组件使用到的命令。

### 2.1.2 内部依赖分析
<!-- 是否涉及与其他组件接口依赖，如果涉及需要确认当前是否已完成，是否匹配当前需求开发诉求 -->
依赖构建流程的配置汇总动作上库。

### 2.1.3 外部依赖分析
<!-- 是否涉及与平台SDK的依赖关系 -->
不涉及

### 2.1.4 北向接口分析
<!-- 需要分析当前功能是否有以下接口影响，如果有影响，则需要具体的补充影响点。其中注意点如下：
（1）如果有新增IPMI接口，请排查代码中IPMI命令注册的过滤字段，是否完全和IPMI命令的定义一致？
（2）新增一个接口时，需要咨询SIG组是否还有其他的接口受影响 
（3）新增接口需要将对应接口属性名称和属性值列出，属性值若有单位、异常值处理、范围限制或格式规范也需要列出，对于标准接口需要列出标准接口文档中对应的属性名称和属性值相关规定-->
| 特性 | SNMP | CLI | WEB | KVM_VMM | IPMI(RMCP/RMCP+) | HMM | Redfish |
| ---- | ---- | ---- | --- | ------ | ---------------- | --- | ------- |
| 安全切面使能 | NA | NA | NA | NA | NA | NA | NA |

### 2.1.5 兼容性分析
<!-- 当前的功能对现有在网的功能是否有影响，具体的影响点进行分析之后输出影响分析表格 -->
不涉及

### 2.1.6 定制化接口分析
<!-- 如果支持定制化设置，则需要给出定制化时的默认值（空定制化项条件下的设置值），如果涉及到定制化接口变更或新增，注意定制化接口文档需配套修改。注意定制化默认值变更对白牌包的影响 -->
不涉及

### 2.1.7 导入导出分析
<!-- 如果支持导入导出的配置，则需要分析导入导出的schema。 -->
不涉及

### 2.1.8 传感器分析
<!-- 如果需要新增传感器，则需要提前登记和评审新增的传感器要素。新增传感器评审需要上SIG-Interface进行评审 -->
不涉及

### 2.1.9 精准告警事件分析
<!-- 如果需要新增事件，则需要提前登记和评审新增的时间要素 -->
不涉及

### 2.1.10 系统锁定分析
<!-- 对外的接口或者命令是否支持系统锁定 -->
不涉及

### 2.1.11 用例场景分析
<!-- 以表格的形式输出该需求涉及的用例场景 -->

| 用例编号 | 用例名称 | 前置条件 | 操作步骤 | 预期结果 |
| ---- | ---- | ---- | ---- | ---- |
| 1 | 运行冒烟测试 | 1. BMC正常运行 | 1. 登录自动化测试平台，启动冒烟测试，预期有结果a | a. 冒烟测试通过
| 2 | 收集一键式日志，检查general_hardware组件日志内容 | 1. BMC正常运行 | 1. 登录BMC后台，创建以下目录（若已存在则不需要创建）：<br>&emsp;&emsp;/data/var/log/general_hardware<br>&emsp;创建以下打桩日志文件（若已存在则不需要创建）：<br>&emsp;&emsp;/data/var/log/general_hardware/testfile<br>&emsp;预期有结果a<br>2. 登录BMC前台执行日志收集，预期有结果b | a. 打桩日志文件创建成功<br>b. 收集的一键式日志中有打桩日志文件
| 3 | 收集一键式日志，检查storage组件日志内容 | 1. BMC正常运行 | 1. 登录BMC后台，创建以下目录（若已存在则不需要创建）：<br>&emsp;&emsp;/data/var/log/storage/drivelog<br>&emsp;&emsp;/data/var/log/storage/phy<br>&emsp;&emsp;/data/var/log/storage/ctrllog<br>&emsp;创建以下打桩日志文件（若已存在则不需要创建）：<br>&emsp;&emsp;/data/var/log/storage/RAID_Controller_Info.txt<br>&emsp;预期有结果a<br>2. 登录BMC前台执行日志收集，预期有结果b | a. 打桩日志文件创建成功<br>b. 收集的一键式日志中有打桩日志文件
| 4 | 收集一键式日志，检查network_adapter组件日志内容 | 1. BMC正常运行 | 1. 登录BMC后台，创建以下目录（若已存在则不需要创建）：<br>&emsp;&emsp;/data/var/log/bmc/pciecard<br>&emsp;&emsp;/data/var/log/bmc/optical_module<br>&emsp;&emsp;/var/log/compute/NpuIO<br>&emsp;&emsp;/var/log/netcard<br>&emsp;预期有结果a<br>2. 登录BMC前台执行日志收集，预期有结果b | a. 打桩日志文件创建成功<br>b. 收集的一键式日志中有打桩日志文件
| 5 | 检查无拦截命令 | 1. BMC正常运行 | 1. 登录BMC后台，查看/dev/shm/log/AVF目录下内容，预期有结果a | a. 目录下无aop.log文件 |

### 2.1.12 装备能力差异分析
<!-- 当前功能是否在装备版本和Release版本中存在能力差异，若有差异需要进行说明 -->
不涉及

### 2.1.13 持久化分析
<!-- 当前的功能是否涉及持久化，尤其是持久化类型变更或某个属性新增了取值，是否兼容老版本 -->
不涉及

## 2.2 非功能质量属性设计
### 2.2.1 扩展性分析
<!-- 考虑后续新增类似功能可以很好地扩展 -->
本方案开发的功能具有良好扩展性，本方案新增注册属性均使用已有属性转换得到，同时注册对象的代码基于现有代码增量开发，未对当前代码框架产生影响。后续功能开发可继续基于当前框架开发。

### 2.2.2 重用性分析
<!-- 是否为通用处理方式、接口，如果是得考虑重用性 -->
本方案开发的代码为组件内部处理逻辑，不涉及重用性。

### 2.2.3 可测试性分析
<!-- 此需求如何验证，是否可直接验证，or通过XXX功能覆盖验证，or需要单独怎加测试接口验证 -->
本方案开发的代码可以通过运行其他测试项查看结果，从而确定本修改对组件功能无影响。

### 2.2.4 资料分析
<!-- 是否涉及资料修改 -->
不涉及

### 2.2.5 资源使用分析
<!-- 新增线程、内存分配、模型属性名长度是否合理，CPU占用率是否会激增，Flash中新增文件是否合理（频繁读写Flash会大幅缩短emmc寿命）；是否涉及消息队列，如果涉及请检查是否存在某些场景下消息队列会满导致消息丢失，例如大量消息发送到队列且处理消息需要耗费较长时间的场景。 -->
不涉及

### 2.2.6 可靠性分析
不涉及

### 2.2.7 安全性分析
| 安全合规项 | 是否涉及 | 现有的防护措施 |
| --- | --- | --- |
| 访问控制（通道、文件权限、用户权限、查询权限、配置权限、接口权限） | 不涉及 |  |
| 敏感数据 | 不涉及 |  |
| 日志（操作日志、维护日志、安全日志、运行日志） | 不涉及 |  |
| 文档 | 不涉及 |  |
| 加密及算法 | 不涉及 |  |
| 新增关键资源（密钥、证书、关键配置）备份、恢复 | 不涉及 |  |
| 新增对外接口入参校验 | 不涉及 |  |
| 新增开源及三方软件引入 | 不涉及 |  |
# 3.功能实现
<!-- 通过表格、流程图、简明文字描述提供，力求容易看懂、容易实现，详细描述细节。 -->
## 3.1 安全切面使能
### 3.1.1 功能实现设计
参考框架提供的安全切面开发指导，配置secbox.cfg文件为使能安全切面。之后根据提供的排查方式排查各组件调用的linux命令，将组件所在子系统使用的命令写入统一写入manifest仓中的CommandWhiteList.json文件。其余几个文件直接使用默认内容即可。

同时，各个组件新增whitelist目录，将本组件使用的linux命令写入CommandWhiteList.json文件中。构建流程最终会将各组件仓中的CommandWhiteList.json文件与manifest仓中的文件整合成一个最终文件，包含本子系统所有组件使用到的命令。

### 3.1.2 开发者测试
<!--
增加模块接口：以活动图/流程图等形式明确模块内处理流程，针对模块处理流程中的分支进行覆盖
修改模块接口处理流程：覆盖修改影响流程分支
-->
#### 3.1.2.1 单元测试
<!-- UT，主要是功能单元测试，测试对象是功能单元接口。UT测试设计要从黑盒（功能）角度设计，从输入(I)、处理（B）、预期输出（O）的角度进行用例分析设计，测试覆盖率仅作为反馈，用于分析哪些功能场景没有覆盖到，从而指导测试设计优化并补充测试用例 -->
不涉及
#### 3.1.2.2 集成测试
<!-- IT，主要是组件/模块内的集成测试，测试对象是模块/组件接口。IT测试设计将模块/组件当作黑盒测试，IT测试用例中禁止对组件/模块内部代码打桩，如果确实有少量场景难以构造，可以考虑在测试框架中统一打桩并提供接口供测试用例调用构造场景。
说明：API测试属于IT，其测试对象是微服务接口。
PCST，是指PC上的服务集成测试，测试对象是功能需求。PCST测试设计，要覆盖正常功能、异常功能和交叉功能，采用灰盒 -->
不涉及