diff --git a/.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md b/.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md new file mode 100644 index 0000000000000000000000000000000000000000..95b7f1751e572747b8b0d5fcd9847de5f59548ff --- /dev/null +++ b/.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md @@ -0,0 +1,70 @@ +* **IssueNo**: +* **Description**: +* **Sig**: SIG_DataManagement +* **Feature or Bugfix**: +* **Binary Source**:No/Yes +* **TDD**:Pass/Fail/NA +* **XTS**:Pass/Fail/NA +* **Pretest**:Pass/Fail/NA + +**稳定性排查:** + +| 自检项 | 自检结果 | +| ------------------------------------------------------------ | -------- | +| 禁止在锁内,向其他进程发送IPC | | +| 禁止将捕获**栈变量引用**的lambda函数**异步到其他线程执行** | | +| 禁止传递this指针至其他模块或线程(特别是eventhandler任务) +| 禁止存储string的c_str()方法获取到的指针 | | +|成员变量进行赋值或创建需要排查并发|| +|谨慎在未经拷贝的情况下使用外部传入的string、C字符串 +|map\vector\list\set等stl模板类使用时需要排查并发 +|谨慎考虑加锁范围,尽可能的小范围加锁 +|在IPC通信中谨慎使用同步通信方式 +|禁止将外部传入的裸指针在内部直接构造智能指针 +|禁止多个独立创建的智能指针管理同一地址 +|禁止在析构函数中抛异步任务 +|禁止js对象在非js线程(例如在IPC线程)创建、使用或销毁 +|禁止在对外接口中未经判空直接使用外部传入的指针 +|监听回调要确保,回调触发和取消注册并发时无生命周期问题 +|遍历容器进行删除或插入时注意迭代器失效问题 + +**日志打印排查:** + +| 自检项 | 自检结果 | +| ------------------------------------------------------------ | -------- | +| 禁止打印内存地址,如:%p | | +| 禁止打印密钥、文件路径、数据库名称、udidhash、设备名称、账号id等敏感信息 | | +| 禁止不作匿名化直接打印udid/networkid/uuid/ip/mac等敏感信息 | | +| 非必要不要在循环内打印日志,防止日志超限| | + +**安全编码自检:** + +| 自检项 | 自检结果 | +| -------------------------------------------------------------- | -------- | +| 【内存管理】内存申请前必须对内存大小进行合法性校验 | | +| 【内存管理】内存申请后必须判空,判断内存申请是否成功 | | +| 【内存管理】分配和释放内存(or fd等资源)的函数需要成对出现 | | +| 【内存管理】申请内存后异常退出前需要及时进行内存释放 | | +| 【内存管理】禁止使用realloc、alloca函数 | | +| 【内存管理】strdup使用需要注意内存释放 | | +| 【内存管理】正则表达式构造后需释放资源,regcomp/regexec与regfree必须成对使用 | | +| 【内存管理】realpath使用时如果resolved_path为NULL需要注意内存释放 | | +| 【外部输入校验】外部传入的路径要做规范化校验,对路径中的.、..、../等特殊字符严格校验 | | +| 【外部输入校验】按TLV格式解析时需校验解析长度值是否小于等于缓冲区实际值,并校验是否符合业务数据范围 | | +| 【外部输入校验】解析数据后拷贝时需校验源buffer实际缓冲区大小,避免越界读写 | | +| 【外部输入校验】使用外部输入作为循环变量时,需要校验循环变量上限是否合理,防止出现超大循环 | | +| 【外部输入校验】禁止直接使用使用外部输入作为数组下标,防止出现内存越界 | | +| 【敏感信息】堆、栈中保存密钥、口令(包括加密后的变量)变量使用完后必须显式覆盖或清空 | | +| 【加密算法】禁止使用私有加密算法或不安全加密算法 | | +| 【变量初始化】指针变量、表示资源描述符的变量、bool变量必须赋初值 | | +| 【指针】IPC流程中ReadCString、ReadRawData、readParcelable等结果必须判空; | | +| 【整数运算】整数之间运算时必须严格检查,确保不会出现溢出、反转、除0 | | +| 【整数运算】禁止对有符号整数进行位操作符运算 | | +| 【循环变量】循环次数如果受外部数据控制,需要检验其合法性 | | +| 【循环变量】循环变量和中止条件的数据类型定义保持一致 | | +| 【安全函数】安全函数必须检查返回值,并进行正确处理 | | +| 【安全函数】安全函数目标缓冲区大小入参与目标缓冲区实际大小必须一致 | | +| 【安全函数】禁止封装或者自定义安全函数 | | +| 【常见问题】修改单个函数时,如果涉及新增异常返回分支,必须排查是否需要释放锁、内存、fd等资源 | | +| 【常见问题】函数返回值需与函数签名相同,参数定义需在同一范畴(不能定义bool,返回int32_t),或同一枚举类型 | | +| 【常见问题】格式化打印类型需匹配,例如:int32_t %d; uint32_t %u; long %ld; unsigned long %lu; long long PRId64;
unsigned long long PRIu64; | |