From 9a54decc49ec04fbe181dd0eba35018ce46027d4 Mon Sep 17 00:00:00 2001 From: Annie_wang Date: Sat, 10 Dec 2022 09:26:19 +0800 Subject: [PATCH] update docs Signed-off-by: Annie_wang --- .../reference/errorcodes/errorcode-huks.md | 53 ++++++++++--------- .../subsystems/subsys-build-module.md | 2 +- 2 files changed, 30 insertions(+), 25 deletions(-) diff --git a/en/application-dev/reference/errorcodes/errorcode-huks.md b/en/application-dev/reference/errorcodes/errorcode-huks.md index 66409a6381..48907ecd87 100644 --- a/en/application-dev/reference/errorcodes/errorcode-huks.md +++ b/en/application-dev/reference/errorcodes/errorcode-huks.md @@ -1,23 +1,22 @@ -# HUKS Error Codes +# HUKS Error Codes ## 12000001 Feature Not Supported **Error Message** -`${messageInfo}` is not supported. +The `${messageInfo}` is not supported. **Possible Causes** - The API is supported, but certain features in the API, such as the algorithm, are not supported. **Solution** -Modify the parameters and use the features supported. +Use the supported features as parameters. ## 12000002 Missing Key Algorithm Parameter **Error Message** -Failed to obtain `${messageInfo}`. It is not set in ParamSet. +Failed to obtain the `${messageInfo}`. It is not set in ParamSet. **Possible Causes** @@ -47,9 +46,12 @@ An invalid parameter is found. **Error Message** -Failed to read the file. +A file error can be any of the following: + +- Insufficient storage space. +- Invalid file size. +- Failed to `${messageInfo}`. -Failed to write the file. **Possible Causes** @@ -57,20 +59,21 @@ The file operation failed. **Solution** -1. Check whether the disk space is used up and whether the file system is abnormal. +1. Check whether sufficient disk space is available and whether the file system is normal. 2. Clear the disk space. ## 12000005 IPC Error **Error Message** -IPC timed out. +An IPC error can be any of the following: -Failed to obtain messages from IPC. +- Failed to get messages from IPC. +- IPC `${messageInfo}`. **Possible Causes** -IPC failed. +The Inter-Process Communication (IPC) failed. **Solution** @@ -80,7 +83,7 @@ Locate and rectify the IPC failure. **Error Message** -Crypto engine error. +Crypto engine error. **Possible Causes** @@ -98,7 +101,7 @@ The algorithm library operation fails. The possible causes include the following **Error Message** -This credential is invalidated permanently. +This credential is invalidated permanently. **Possible Causes** @@ -110,7 +113,7 @@ The possible causes include the following: **Solution** 1. Locate the cause of the authentication failure based on the log. -2. If the authentication fails due to the access control attribute configured, the key cannot be used any more. +2. If the authentication fails due to the configuration of the access control attribute, the key cannot be used any more. ## 12000008 Failed to Access the Key Due to a Failure in Authentication Token Verification @@ -120,18 +123,18 @@ The authentication token verification failed. **Possible Causes** -The authentication token verification failed due to an incorrect challenge value. +The challenge value is incorrect. **Solution** -1. Check whether the challenge for userIAM authentication is correctly assembled. -2. If the challenge value is incorrect, modify the assembly mode, use the bytes generated by HUKS to assembly challenge value, and pass it to userIAM for authentication. +1. Check whether the challenge for user IAM authentication is correctly assembled. +2. If the challenge value is incorrect, modify the assembly mode, use the bytes generated by HUKS to assembly the challenge value, and pass it to user IAM for authentication. ## 12000009 Key Access Timed Out **Error Message** -The Authentication token timed out. +This authentication token timed out. **Possible Causes** @@ -139,7 +142,7 @@ The authentication failed because the authentication token timed out. **Solution** -The difference between the current time and the authentication token generation time must be less than the timeout interval. Otherwise, the access will be rejected. +Initialize the key and perform the authentication again. Ensure that the difference between the current time and the authentication token generation time is less than the timeout interval. ## 12000010 Key Operation Sessions Reaches the Limit @@ -168,18 +171,18 @@ The key corresponding to the key alias does not exist. **Solution** -1. Check whether the key alias is misspelled. +1. Check whether the key alias is correctly spelled. 2. Check whether the key corresponding to the key alias is successfully generated. ## 12000012 External Error **Error Message** -External error `${messageInfo}`. +System external error. **Possible Causes** -An external error, such as a hardware fault or file error occurs. +An external error, such as a hardware fault or file error, occurs. **Solution** @@ -203,7 +206,9 @@ Enroll the credential or change the authentication type bound to the key. **Error Message** -Memory is insufficient. +- Insufficient memory. +- Malloc failed. + **Possible Causes** @@ -217,7 +222,7 @@ Release memory or restart the device. **Error Message** -Failed to call the `${messageInfo}` service to do `${messageInfo}`. +Failed to obtain the `${messageInfo}` information via UserIAM. **Possible Causes** diff --git a/en/device-dev/subsystems/subsys-build-module.md b/en/device-dev/subsystems/subsys-build-module.md index d34ce48f15..039c58593f 100644 --- a/en/device-dev/subsystems/subsys-build-module.md +++ b/en/device-dev/subsystems/subsys-build-module.md @@ -25,7 +25,7 @@ ohos_resources # Other templates # Configuration file -ohos_prebuilt_etc +ohos_prebuild_etc # SA profile ohos_sa_profile -- GitLab