Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 d930f737 编写于 作者: A annie_wangli
浏览文件
操作

update docs 

Signed-off-by: Nannie_wangli <annie.wangli@huawei.com>
上级 fc1a5ff7
显示空白变更内容
内联 并排
Showing with 195 addition and 195 deletion
en/application-dev/security/hapsigntool-guidelines.md
浏览文件 @ d930f737
......@@ -3,7 +3,7 @@
## Overview
### Function
To ensure the integrity and secure source of OpenHarmony applications, the applications must be signed during the build process. Only signed applications can be installed, run, and debugged on real devices. [developtools_hapsigner](https://gitee.com/openharmony/developtools_hapsigner) provides the source code of the HAP signing tool - hapsigner. This tool can be used to generate key pairs, certificate signing requests (CSRs), certificates, profile signatures, and HAP signatures.
To ensure the integrity and secure source of OpenHarmony applications, the applications must be signed during the build process. Only signed applications can be installed, run, and debugged on real devices. [developtools_hapsigner](https://gitee.com/openharmony/developtools_hapsigner) provides the source code of the OpenHarmony Ability Package (HAP) signing tool - hapsigner. This tool can be used to generate key pairs, certificate signing requests (CSRs), certificates, profile signatures, and HAP signatures.
### Key Concepts
......@@ -16,14 +16,14 @@ The hapsigner tool is implemented based on the Public Key Infrastructure (PKI).
- CSR
The CSR contains the public key, subject, and private key signature of a certificate. Before applying for a certificate, you need to generate a CSR based on the key pair and submit the CSR to the Certificate Authority (CA).
The CSR contains the public key, subject, and private key signature of a certificate. Before applying for a certificate, you must generate a CSR based on the key pair and submit the CSR to the Certificate Authority (CA).
- Certificate
OpenHarmony uses the RFC5280 standard to build the X509 certificate trust system. The OpenHarmony certificates used for application signatures are classified into the root CA certificate, subordinate CA certificate, and application or profile signing certificate. The application signing certificate indicates the identity of the application developer, which ensures the traceability of the source of the applications. The profile signing certificate is used to verify the signature of the profile, which ensures the integrity of the profile.
OpenHarmony uses the RFC5280 standard to build the X.509 certificate trust system. The OpenHarmony certificates used for application signatures are classified into the root CA certificate, subordinate CA certificate, and application or profile signing certificate. The application signing certificate indicates the identity of the application developer, which ensures the traceability of the source of the applications. The profile signing certificate is used to verify the signature of the profile, which ensures the integrity of the profile.
- HAP
OpenHarmony Ability Package (HAP) is a package used to deploy an ability, which is the basic unit for OpenHarmony application development. An OpenHarmony application consists of one or more abilities.
HAP is a package used to deploy an ability, which is the basic unit for OpenHarmony application development. An OpenHarmony application consists of one or more abilities.
- Profile
......@@ -61,7 +61,7 @@ The hapsigner tool is implemented based on the Public Key Infrastructure (PKI).
### When to Use
The OpenHarmony system has a built-in KeyStore (KS) file named **OpenHarmony.p12**. This file contains the root CA certificate, subordinate CA certificate, and application or profile certificate information. The hapsigner tool signs the OpenHarmony applications based on this KS file.
The OpenHarmony system has a built-in KeyStore (KS) file named **OpenHarmony.p12**. This file contains the root CA certificate, subordinate CA certificate, and application or profile signing certificate information. The hapsigner tool signs the OpenHarmony applications based on this KS file.
The usage of hapsigner varies depending on whether an application signing certificate is available.
......@@ -70,19 +70,18 @@ The usage of hapsigner varies depending on whether an application signing certif
- If an application signing certification is available:
You need to sign the profile, and use the application signing certificate and the local KS file (containing the corresponding key) to sign the application.
### How to Use
### Usage
#### Description
1.Display help information.
1. Display help information.
-help # If no parameter is specified, the command help information is displayed by default.
2.Display the version information.
2. Display the version information.
-version # Display the tool version information.
3.Generate a key pair.
3. Generate a key pair.
generate-keypair: Generate a key pair.
├── -keyAlias # Key alias. It is mandatory.
......@@ -92,7 +91,7 @@ The usage of hapsigner varies depending on whether an application signing certif
├── -keystoreFile # KS file, in JKS or P12 format. It is mandatory.
├── -keystorePwd # KS password. It is optional.
4.Generate a CSR.
4. Generate a CSR.
generate-csr: Generate a CSR.
├── -keyAlias # Key alias. It is mandatory.
......@@ -103,7 +102,7 @@ The usage of hapsigner varies depending on whether an application signing certif
├── -keystorePwd # KS password. It is optional.
├── -outFile # CSR to generate. It is optional. If you do not specify this parameter, the CSR is output to the console.
5.Generate a root CA or subordinate CA certificate.
5. Generate a root CA or subordinate CA certificate.
generate-ca: Generate a root CA or subordinate CA certificate. If the key does not exist, generate a key together with the certificate.
├── -keyAlias # Key alias. It is mandatory.
......@@ -123,7 +122,7 @@ The usage of hapsigner varies depending on whether an application signing certif
├── -issuerKeystorePwd # KS password of the issuer. It is optional.
├── -outFile # File to generate. It is optional. The file is output to the console if this parameter is not specified.
6.Generate an application debug or release certificate.
6. Generate an application debug or release certificate.
generate-app-cert: Generate an application debug or release certificate.
├── -keyAlias # Key alias. It is mandatory.
......@@ -143,7 +142,7 @@ The usage of hapsigner varies depending on whether an application signing certif
├── -subCaCertFile # Subordinate CA certificate, which is mandatory when outForm is certChain.
├── -outFile # Certificate file (certificate or certificate chain) to generate. It is optional. The file is output to the console if this parameter is not specified.
7.Generate a profile debug or release certificate.
7. Generate a profile debug or release certificate.
generate-profile-cert: Generate a profile debug or release certificate.
├── -keyAlias # Key alias. It is mandatory.
......@@ -163,7 +162,7 @@ The usage of hapsigner varies depending on whether an application signing certif
├── -subCaCertFile # Subordinate CA certificate, which is mandatory when outForm is certChain.
├── -outFile # Certificate file (certificate or certificate chain) to generate. It is optional. The file is output to the console if this parameter is not specified.
8.Generate a common certificate, which can be used to generate a custom certificate.
8. Generate a common certificate, which can be used to generate a custom certificate.
generate-cert: Generate a common certificate, which can be used to generate a custom certificate.
├── -keyAlias # Key alias. It is mandatory.
......@@ -191,7 +190,7 @@ The usage of hapsigner varies depending on whether an application signing certif
├── -keystorePwd # KS password. It is optional.
├── -outFile # Certificate file to generate. It is optional. The file is output to the console if this parameter is not specified.
9.Sign a provisioning profile.
9. Sign a provisioning profile.
sign-profile: Sign a provisioning profile.
├── -mode # Signing mode, which can be localSign or remoteSign. It is mandatory.
......@@ -204,15 +203,15 @@ The usage of hapsigner varies depending on whether an application signing certif
├── -keystorePwd # KS password. It is optional.
├── -outFile # Signed provisioning profile to generate, in p7b format. It is mandatory.
10.Verify the provisioning profile signature.
10. Verify the provisioning profile signature.
verify-profile: Verify the provisioning profile signature.
├── -inFile # Signed provisioning profile, in p7b format. It is mandatory.
├── -outFil # Verification result file (including the verification result and profile content), in json format. It is optional. The file is output to the console if this parameter is not specified.
11.Sign a HAP.
11. Sign a HAP.
sign-app: HAP signature.
sign-app: Sign a HAP.
├── -mode # Signing mode, which can be localSign, remoteSign, or remoteResign. It is mandatory.
├── -keyAlias # Key alias. It is mandatory.
├──-keyPwd # Key password. It is optional.
......@@ -226,7 +225,7 @@ The usage of hapsigner varies depending on whether an application signing certif
├── -keystorePwd # KS password. It is optional.
├── -outFile # Signed HAP file to generate. It is mandatory.
12.Verify the HAP signature.
12. Verify the HAP signature.
verify-app: Verify the HAP signature.
├── -inFile # Signed application file, in HAP or bin format. It is mandatory.
......@@ -234,24 +233,25 @@ The usage of hapsigner varies depending on whether an application signing certif
├── -outProfile # Profile of the application. It is mandatory.
### Procedure
### Signing Procedure
The process of signing a HAP is as follows:
1. Generate a key pair for an application signing certificate.
2. Generate an application signing certificate.
3. Sign the profile.
4. Signing the HAP.
4. Sign the HAP.
> **Precautions** <br/>
1. The ECC algorithm is recommended for generating key pairs for application signatures for security purposes. The RSA algorithm is not recommended.<br/>
2. You are advised to place the HAP, profile, **OpenHarmony.p12**, root CA certificate, subordinate CA certificate, and hapsigner in the same directory for easy operation.<br/>
3. The related files are in the following directories:<br/>OpenHarmony KS file: **developtools_hapsigner/autosign/result/OpenHarmony.p12** <br/>Root CA certificate: **developtools_hapsigner/autosign/result/rootCA.cer**<br/>Subordinate CA certificate: **developtools_hapsigner/autosign/result/subCA.cer**<br/>Profile signing certificate: **developtools_hapsigner/autosign/result/OpenHarmonyProfileRelease.pem**
>
> For security purposes, the ECC algorithm is recommended for generating key pairs for application signing signatures. The RSA algorithm is not recommended.<br/>
> You are advised to place the HAP, profile, KS file **OpenHarmony.p12**, root CA certificate, subordinate CA certificate, and hapsigner in the same directory for easy operation.
> The **developtools_hapsigner/autosign/result/** directory has the following files:<br/>-&nbsp;OpenHarmony KS file **OpenHarmony.p12** <br/>-&nbsp;Root CA certificate **rootCA.cer**<br/>-&nbsp;Subordinate CA certificate **subCA.cer**<br/>-&nbsp;Profile signing certificate **OpenHarmonyProfileRelease.pem**
**1. Generate a key pair for the application signing certificate.**
Generate a signature key and save it to the KS.
Generate a signature key pair and save it to the KS.
Example:
```shell
......@@ -262,11 +262,11 @@ java -jar hap-sign-tool.jar generate-keypair -keyAlias "oh-app1-key-v1" -keyAlg
The command parameters are described as follows:
generate-keypair: Generate a key pair for the application signing certificate.
├── -keyAlias # Alias of the key used to generate the application signing certificate. It is stored in the OpenHarmony.p12 file. It is mandatory.
├── -keyAlg # Key algorithm. ECC is recommended. It is mandatory.
├── -keySize # Key length. It is NIST-P-256/NIST-P-384 if ECC is used. It is mandatory.
├── -keyStoreFile # KS file. OpenHarmony.p12 is recommended. It is mandatory.
├── -keyStorePwd # KS password. The default password 123456 for OpenHarmony.p12. It is mandatory.
├── -keyAlias # Alias of the key used to generate the application signing certificate. It is stored in the OpenHarmony.p12 file. This parameter is mandatory.
├── -keyAlg # Key algorithm. It is mandatory. ECC is recommended.
├── -keySize # Key length. It is NIST-P-256/NIST-P-384 if ECC is used. This parameter is mandatory.
├── -keyStoreFile # KS file. OpenHarmony.p12 is recommended. This parameter is mandatory.
├── -keyStorePwd # KS password. It is mandatory. The default password 123456 for OpenHarmony.p12.
├── -keyPwd # Key password. It is optional. If this parameter is not specified, the generated key pair has no password.
......@@ -287,7 +287,7 @@ The command parameters are described as follows:
├── -signAlg # Signature algorithm, which can be SHA256withECDSA or SHA384withECDSA. It is mandatory.
├── -issuer # Issuer of the certificate. Enter the issuer of the subordinate CA certificate. It is mandatory and cannot be changed.
├── -issuerKeyAlias # Key alias of the issuer. Enter the key alias of the subordinate CA certificate. It is mandatory and cannot be changed.
├── -subject # Subject of the certificate. Enter the subject in the same sequence specified in the command. It is mandatory.
├── -subject # Subject of the certificate. Enter the subject in the same sequence specified in the command. This parameter is mandatory.
├── -issuerKeyPwd # Key password of the issuer. Enter the key password of the subordinate CA certificate. It is mandatory and cannot be changed. In this example, it is 123456.
├── -keystoreFile # KS file. Use OpenHarmony.p12. It is mandatory and cannot be changed.
├── -rootCaCertFile # Root certificate. It is mandatory and cannot be changed.
......@@ -331,26 +331,26 @@ Example:
java -jar hap-sign-tool.jar sign-app -keyAlias "oh-app1-key-v1" -signAlg "SHA256withECDSA" -mode "localSign" -appCertFile "app1.pem" -profileFile "app1-profile.p7b" -inFile "app1-unsigned.zip" -keystoreFile "OpenHarmony.p12" -outFile "app1-signed.hap" -keyPwd "123456" -keystorePwd "123456"
```
> ![icon-note.gif](../public_sys-resources/icon-note.gif) **NOTE**<br/>The following parameters used are for the scenario where there is no application signing certificate available. If the application signing certificate is available, the following parameters need to be modified:<br/>
-**keyAlias**: Enter the key alias of the application signing certificate. It is mandatory. <br/>
-**appCertFile**: Enter the application signing certificate. It is mandatory.<br/>
-**keystoreFile**: Enter the KS file of the application signing certificate. It is mandatory. <br/>
> ![icon-note.gif](../public_sys-resources/icon-note.gif) **NOTE**:<br/>The following parameters used are for the scenario where there is no application signing certificate available. If the application signing certificate is available, the following parameters need to be modified:<br/>
-**keyAlias**: Enter the key alias of the application signing certificate. This parameter is mandatory. <br/>
-**appCertFile**: Enter the application signing certificate. This parameter is mandatory.<br/>
-**keystoreFile**: Enter the KS file of the application signing certificate. This parameter is mandatory. <br/>
-**keyPwd**: Enter the key password in the KS file. <br/>
-**keystorePwd**: Enter the KS password in the KS file.<br/>
The command parameters are described as follows:
sign-app: Sign a HAP.
├──-keyAlias # Key alias, which must be the same as the alias of the key pair generated. It is mandatory.
├──-keyAlias # Key alias, which must be the same as the alias of the key pair generated. This parameter is mandatory.
├── -signAlg # Signature algorithm, which can be SHA256withECDSA or SHA384withECDSA. It is mandatory.
├── -mode # Signing mode, which must be localSign. It is mandatory.
├── -appCertFile # Application signing certificate (certificate chain, in application signing certificate, subordinate CA certificate, and root certificate order). Enter the application signing certificate generated. It is mandatory.
├── -profileFile # Signed provisioning profile in p7b format. Enter the profile generated. It is mandatory.
├── -appCertFile # Application signing certificate (certificate chain, in application signing certificate, subordinate CA certificate, and root certificate order). Enter the application signing certificate generated. This parameter is mandatory.
├── -profileFile # Signed provisioning profile in p7b format. Enter the profile generated. This parameter is mandatory.
├── -inFile # Raw application package. It is mandatory.
├── -keystoreFile # KS file, which must be the same as the KS file generated. It is mandatory and cannot be changed.
├── -outFile # Signed file to generate. It is mandatory.
├── -keyPwd # Key password, which must be actual key password.
├── -keystorePwd # KS password, which must be actual KS password.
├── -keyPwd # Key password, which must be the actual key password.
├── -keystorePwd # KS password, which must be the actual KS password.
......@@ -391,17 +391,17 @@ The command parameters are described as follows:
(1) The certificate chain of the profile signing certificate is in incorrect order.
(2). The profile signing certificate is not a certificate chain.
(2) The profile signing certificate is not a certificate chain.
(3). The certificate subject is in incorrect sequence, or the **-issuerKeyAlias** parameter set to generate the application signing certificate is incorrect.
(3) The certificate subject is in incorrect sequence, or the **-issuerKeyAlias** parameter set to generate the application signing certificate is incorrect.
- **Solution**
(1). Check that the certificate chain is in ascending or descending order of seniority.
(1) Check that the certificate chain is in ascending or descending order of seniority.
(2). Check that the certificate is a certificate chain.
(2) Check that the certificate is a certificate chain.
(3). Check that the certificate subject is in the C, O, OU, and CN order.
(3) Check that the certificate subject is in the C, O, OU, and CN order.
**3. An error message is displayed when the tool is used to sign a HAP.**
......@@ -415,4 +415,4 @@ The command parameters are described as follows:
- **Solution**
Use ECC to generate the key pair for an application or profile certificate. Use **SHA256withECDSA** or **SHA384withECDSA** as the HAP signature algorithm.
Use ECC to generate the key pair for an application or profile signing certificate. Use **SHA256withECDSA** or **SHA384withECDSA** as the HAP signature algorithm.
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或