From a6637ee2268e95669c6226d657ee1a56d71bfa82 Mon Sep 17 00:00:00 2001 From: Jesse Date: Fri, 16 Sep 2022 02:46:42 +0000 Subject: [PATCH] update README_ZH.md Signed-off-by: Jesse --- README_ZH.md | 66 ++++++++++++++++++++++++++-------------------------- 1 file changed, 33 insertions(+), 33 deletions(-) diff --git a/README_ZH.md b/README_ZH.md index 85de2b83..d9687827 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -1,21 +1,21 @@ # Hap包签名工具 -* 简介 -* 目录 -* 约束 -* 编译构建 -* 说明 - * 签名相关文件用法说明 - * 使用说明 - * 接口说明 -* 相关仓 - -#### 简介 +* [简介](#section1) +* [目录](#section2) +* [约束](#section3) +* [编译构建](#section4) +* [说明](#section5) + * [签名相关文件用法说明](#section6) + * [使用说明](#section7) + * [接口说明](#section8) +* [相关仓](#section9) + +## 简介 为了保证OpenHarmony应用的完整性和来源可靠，在应用构建时需要对应用进行签名。经过签名的应用才能在真机设备上安装、运行、和调试。本仓提供了签名工具的源码，包含密钥对生成、CSR文件生成、证书生成、Profile文件签名、Hap包签名等功能。 -#### 目录 +## 目录 developtools_hapsigner @@ -28,24 +28,24 @@ -#### 约束 -Hap包签名工具基于Java语言开发，需要在Java8以上Java环境运行 +## 约束 +Hap包签名工具基于Java语言开发，需要在Java8以上Java环境运行。 （附：一键签名等脚本文件基于Python语言开发，使用需配置环境python3.x） -#### 编译构建 +## 编译构建 - 1. 该工具基于Gradle 7.1编译构建，请确认环境已安装配置Gradle环境，并且版本正确 + 1. 该工具基于Gradle 7.1编译构建，请确认环境已安装配置Gradle环境，并且版本正确； gradle -v - 2. 下载代码，命令行打开文件目录至developtools_hapsigner/hapsigntool，执行命令进行编译打包 + 2. 下载代码，命令行打开文件目录至developtools_hapsigner/hapsigntool，执行命令进行编译打包； gradle build 或者 gradle jar - 3. 编译后得到二进制文件，目录为: ./hap_sign_tool/build/libs/hap-sign-tool.jar + 3. 编译后得到二进制文件，文件路径为: ./hap_sign_tool/build/libs/hap-sign-tool.jar **** -#### 说明 -##### 签名相关文件用法说明 +## 说明 +### 签名相关文件用法说明 开发者通过IDE进行应用签名时，可在SDK中会获得如下签名相关文件： @@ -64,9 +64,9 @@ Profile模板文件：UnsgnedReleasedProfileTemplate.json、UnsgnedDebugProfileT **应用签名场景：** ![signapp.png](figures/signapp_zh.png) -##### 使用说明 +### 使用说明 -以下说明中使用jar包为编译构建中生成的二进制文件 +以下说明中使用jar包为编译构建中生成的二进制文件。 1.命令行签名 命令行签名分为profile文件签名和hap包签名。 @@ -129,20 +129,20 @@ java -jar hap-sign-tool.jar sign-app -keyAlias "oh-app1-key-v1" -signAlg "SHA256 - signHap.config 使用指导： -1. 准备依赖环境python3.5以上 -2. 准备签名工具jar包：hap-sign-tool.jar（参照上文编译生成的产物） -3. 准备待签名的应用hap包和Provision profile模板文件 -4. 使用文本编辑器编辑createAppCertAndProfile.config,signHap.config修改配置文件中的配置信息：common.keyPwd 和 common.issuerKeyPwd 参数值改成自己定义的口令信息 -5. Linux运行create_appcert_sign_profile.sh、Windows运行create_appcert_sign_profile.bat生成签名所需文件 -6. Linux运行sign_hap.sh、Windows运行sign_hap.bat对hap包进行签名 +1. 准备依赖环境python3.5以上； +2. 准备签名工具jar包：hap-sign-tool.jar（参照上文编译生成的产物）； +3. 准备待签名的应用hap包和Provision profile模板文件； +4. 使用文本编辑器编辑createAppCertAndProfile.config,signHap.config修改配置文件中的配置信息：common.keyPwd 和 common.issuerKeyPwd 参数值改成自己定义的口令信息； +5. Linux运行create_appcert_sign_profile.sh、Windows运行create_appcert_sign_profile.bat生成签名所需文件； +6. Linux运行sign_hap.sh、Windows运行sign_hap.bat对hap包进行签名。 - > 说明：如需自定义生成密钥库文件，根CA，中间CA证书，profile签名证书，可执行以下步骤 - 1.使用文本编辑器编辑createRootAndSubCert.config修改配置文件中的配置信息：common.keyPwd 和 common.issuerKeyPwd 参数值改成自己定义的口令信息 - 2.Linux运行 create_root.sh、Windows运行create_root.bat生成所需密钥库文件，根CA，中间CA证书，profile签名证书 + > 说明：如需自定义生成密钥库文件，根CA，中间CA证书，profile签名证书，可执行以下步骤。 + 1.使用文本编辑器编辑createRootAndSubCert.config修改配置文件中的配置信息：common.keyPwd 和 common.issuerKeyPwd 参数值改成自己定义的口令信息； + 2.Linux运行 create_root.sh、Windows运行create_root.bat生成所需密钥库文件，根CA，中间CA证书，profile签名证书。 **** -##### 接口说明 +### 接口说明 1.生成密钥对 generate-keypair : 生成密钥对 @@ -297,5 +297,5 @@ java -jar hap-sign-tool.jar sign-app -keyAlias "oh-app1-key-v1" -signAlg "SHA256 -#### 相关仓 +## 相关仓 不涉及 \ No newline at end of file -- Gitee