1# 代码签名 2 3## 简介 4 5代码签名部件用于支持OpenHarmony的代码签名机制。OpenHarmony使用代码签名提供运行时应用程序的完整性保护，校验应用来源的合法性。 6 7代码签名部件架构图 8 9 10 11代码签名部件主要提供如下模块功能： 12 13- 可信证书管理：将设备证书和本地签名证书写入内核.fs-verity keyring，支持证书链及其合法路径校验。 14- 代码签名使能：在用户态提供代码签名校验的相关接口和逻辑，供应用安装的时候调用，为应用和代码文件使能代码签名。 15- 本地代码签名：在设备侧运行签名服务给本地代码提供签名接口，为AOT生成的机器码文件生成代码签名。 16- 代码属性设置：支持代码所有者标记及校验，提供配置XPM验签地址区接口。 17- JIT(Just In Time)代码签名：使用代码签名技术来保护编译出的JIT代码的完整性，防止恶意代码被注入到JIT代码中。能力依赖ARMv8.3-A以上版本芯片，支持签名代码大小不超过2G。 18 19## 目录 20 21``` 22/base/security/code_signature 23├── interfaces # 接口层 24│ └── inner_api # 25│ ├── code_sign_attr_utils # 属性设置接口 26│ ├── code_sign_utils # 使能接口 27│ ├── common # 公共基础能力 28│ ├── jit_code_sign # JIT代码签名 29│ └── local_code_sign # 本地签名 30├── services # 服务层 31│ ├── key_enable # 证书初始化 32│ └── local_code_sign # 本地签名服务 33├── test # 测试用例 34│ ├── common # 测试通用能力 35│ ├── fuzztest # fuzz测试用例 36│ └── unittest # 单元测试用例 37└── utils # 公共基础能力 38``` 39 40## 使用 41### 接口说明 42 43| **接口声明** | **接口描述** | 44| --- | --- | 45| int32_t EnforceCodeSignForApp(const EntryMap &entryPath, const std::string &signatureFile); | 对hap使能代码签名 | 46| int32_t EnforceCodeSignForApp(const std::string &path, const EntryMap &entryPathMap, FileType type, uint32_t flag); | 对hap使能代码签名 | 47| int32_t EnforceCodeSignForFile(const std::string &path, const ByteBuffer &signature); | 对文件使能代码签名 | 48| int32_t EnforceCodeSignForFile(const std::string &path); | 对二进制文件使能代码签名 | 49| int32_t EnforceCodeSignForAppWithOwnerId(const std::string ownerId, const std::string &path, const EntryMap &entryPathMap, FileType type, uint32_t flag); | 对hap使能代码签名和OwnerId校验 | 50| int32_t EnforceCodeSignForAppWithPluginId(const std::string ownerId, const std::string pluginId, const std::string &path, const EntryMap &entryPathMap, FileType type, uint32_t flag); | 对hap使能代码签名、OwnerId和PluginId校验 | 51| int ParseOwnerIdFromSignature(const ByteBuffer &sigbuffer, std::string &ownerID); | 从签名中解析OwnerId | 52| int32_t EnableKeyInProfile(const std::string &bundleName, const ByteBuffer &profileBuffer); | 信任开发者证书 | 53| int32_t RemoveKeyInProfile(const std::string &bundleName); | 撤销已信任的开发者证书 | 54| int32_t EnableKey(const CertPathInfo &info); | 信任开发者证书 | 55| int32_t RemoveKey(const CertPathInfo &info); | 撤销已信任的开发者证书 | 56| int32_t InitLocalCertificate(ByteBuffer &cert); | 初始化本地签名证书 | 57| int32_t SignLocalCode(const std::string &filePath, ByteBuffer &signature); | 本地代码签名 | 58| int32_t SignLocalCode(const std::string &ownerID, const std::string &filePath, ByteBuffer &signature); | 带OwnerId的本地代码签名 | 59| int InitXpm(int enableJitFort, uint32_t idType, const char *ownerId, const char *apiTargetVersionStr); | 初始化XPM相关资源（XPM地址范围、JitFort模式、OwnerId配置等）| 60| int SetXpmOwnerId(uint32_t idType, const char *ownerId); | 设置OwnerId | 61| int32_t RegisterTmpBuffer(JitCodeSigner *signer, void *tmpBuffer); | 注册临时Buffer起始地址 | 62| int32_t AppendInstruction(JitCodeSigner *signer, Instr instr); | 对添加到临时Buffer的指令签名 | 63| int32_t AppendData(JitCodeSigner *signer, const void *const data, uint32_t size); | 对添加到临时Buffer的数据签名 | 64| int32_t WillFixUp(JitCodeSigner *signer, uint32_t n = 1); | 声明下n条指令待更新 | 65| int32_t PatchInstruction(JitCodeSigner *signer, int offset, Instr instr); | 更新缓冲区的偏移处指令签名 | 66| int32_t PatchInstruction(JitCodeSigner *signer, void *address, Instr insn); | 更新对应地址指令签名 | 67| int32_t PatchData(JitCodeSigner *signer, int offset, const void *const data, uint32_t size); | 更新缓冲区偏移处数据签名 | 68| int32_t PatchData(JitCodeSigner *signer, void *address, const void *const data, uint32_t size); | 更新对应地址数据签名 | 69| int32_t ResetJitCode(void *jitMemory, int size); | 重置JIT内存 | 70| int32_t CopyToJitCode(JitCodeSigner *signer, void *jitMemory, void *tmpBuffer, int size); | 将JIT代码复制到JIT内存 | 71 72### 签名工具使用指南 73 74**[使用指南](https://gitee.com/openharmony/developtools_hapsigner/blob/master/README_ZH.md)** 75 76## 相关仓 77 78**[developtools\_hapsigner](https://gitee.com/openharmony/developtools_hapsigner/blob/master/README_ZH.md)** 79 80**[kernel_linux_common_modules](https://gitee.com/openharmony/kernel_linux_common_modules)** 81 82**[third\_party\_fsverity-utils](https://gitee.com/openharmony/third_party_fsverity-utils/blob/master/README_zh.md)** 83
