Lines Matching refs:key
23 * @brief Describes the OpenHarmony Universal KeyStore (HUKS) capabilities, including key management and
62 * @brief Generates a key.
64 * @param keyAlias Indicates the pointer to the alias of the key to generate.
65 * The alias must be unique in the process of the service. Otherwise, the key will be overwritten.
66 * @param paramSetIn Indicates the pointer to the parameter set for generating the key.
67 * @param paramSetOut Indicates the pointer to a temporary key generated. If the generated key is
75 * {@link OH_Huks_ErrCode#OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT} 12000003 - If the key argument
77 * {@link OH_Huks_ErrCode#OH_HUKS_ERR_CODE_ITEM_NOT_EXIST} 12000011 - If the base key file is not exit.
79 * get key argument.
94 * @brief Imports a key in plaintext.
96 * @param keyAlias Indicates the pointer to the alias of the key to import.
97 * The alias must be unique in the process of the service. Otherwise, the key will be overwritten.
98 * @param paramSet Indicates the pointer to the parameters of the key to import.
99 * @param key Indicates the pointer to the key to import. The key must be in the format required by the HUKS.
103 * key is invalid.
107 * {@link OH_Huks_ErrCode#OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT} 12000003 - If the key argument
110 * get key argument.
119 const struct OH_Huks_ParamSet *paramSet, const struct OH_Huks_Blob *key);
122 * @brief Imports a wrapped key.
124 * @param keyAlias Indicates the pointer to the alias of the key to import.
125 * The alias must be unique in the process of the service. Otherwise, the key will be overwritten.
126 * @param wrappingKeyAlias Indicates the pointer to the alias of the wrapping key,
127 * which is obtained through key agreement and used to decrypt the key to import.
128 * @param paramSet Indicates the pointer to the parameters of the wrapped key to import.
129 * @param wrappedKeyData Indicates the pointer to the wrapped key to import.
130 * The key must be in the format required by the HUKS. For details, see {@link OH_Huks_AlgSuite}.
137 * {@link OH_Huks_ErrCode#OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT} 12000003 - If the key argument
140 * get key argument.
154 * @brief Exports a public key.
156 * @param keyAlias Indicates the pointer to the alias of the public key to export.
157 * The alias must be the same as the alias for the key generated.
158 * @param paramSet Indicates the pointer to the parameters required for exporting the public key.
159 * @param key Indicates the pointer to the public key exported.
162 * paramSet or key is invalid.
164 * {@link OH_Huks_ErrCode#OH_HUKS_ERR_CODE_ITEM_NOT_EXIST} 12000011 - If the key file is not exit.
165 * {@link OH_Huks_ErrCode#OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT} 12000003 - If the key argument
168 * get key argument.
176 const struct OH_Huks_ParamSet *paramSet, struct OH_Huks_Blob *key);
179 * @brief Deletes a key.
181 * @param keyAlias Indicates the pointer to the alias of the key to delete.
182 * The alias must be the same as the alias for the key generated.
183 * @param paramSet Indicates the pointer to the parameters required for deleting the key.
188 * {@link OH_Huks_ErrCode#OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT} 12000003 - If the key argument
190 * {@link OH_Huks_ErrCode#OH_HUKS_ERR_CODE_ITEM_NOT_EXIST} 12000011 - If the key file is not exit.
192 * get key argument.
202 * @brief Obtains the attributes of a key.
204 * @param keyAlias Indicates the pointer to the alias of the target key.
212 * {@link OH_Huks_ErrCode#OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT} 12000003 - If the key argument
214 * {@link OH_Huks_ErrCode#OH_HUKS_ERR_CODE_ITEM_NOT_EXIST} 12000011 - If the key file is not exit.
216 * get key argument.
227 * @brief Checks whether a key exists.
229 * @param keyAlias Indicates the pointer to the alias of the target key.
230 * @param paramSet Indicates the pointer to the attribute tag required for checking the key.
235 * {@link OH_Huks_ErrCode#OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT} 12000003 - If the key argument
237 * {@link OH_Huks_ErrCode#OH_HUKS_ERR_CODE_ITEM_NOT_EXIST} 12000011 - If the key file is not exit.
239 * get key argument.
249 * @brief Obtain the key certificate chain. This API can be called only by system applications.
252 * @param keyAlias Indicates the pointer to the alias of the target key.
253 * @param paramSet Indicates the pointer to the parameters required for obtaining the key certificate.
254 * @param certChain Indicates the pointer to the key certificate chain obtained.
259 * {@link OH_Huks_ErrCode#OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT} 12000003 - If the key argument
261 * {@link OH_Huks_ErrCode#OH_HUKS_ERR_CODE_ITEM_NOT_EXIST} 12000011 - If the key file is not exit.
263 * get key argument.
277 * @brief Obtain the key certificate chain.
279 * @param keyAlias Indicates the pointer to the alias of the target key.
280 * @param paramSet Indicates the pointer to the parameters required for obtaining the key certificate.
281 * @param certChain Indicates the pointer to the key certificate chain obtained.
286 * {@link OH_Huks_ErrCode#OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT} 12000003 - If the key argument
288 * {@link OH_Huks_ErrCode#OH_HUKS_ERR_CODE_ITEM_NOT_EXIST} 12000011 - If the key file is not exit.
290 * get key argument.
305 * @brief Initializes the key session interface and obtains a handle (mandatory) and challenge value (optional).
307 * @param keyAlias Indicates the pointer to the alias of the target key.
309 * @param handle Indicates the pointer to the handle of the key session obtained.
317 * {@link OH_Huks_ErrCode#OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT} 12000003 - If the key argument
319 * {@link OH_Huks_ErrCode#OH_HUKS_ERR_CODE_ITEM_NOT_EXIST} 12000011 - If the key file is not exit.
321 * get key argument.
337 * @brief Adds data by segment for the key operation, performs the related key operation,
340 * @param handle Indicates the pointer to the key session handle, which is generated by {@link OH_Huks_InitSession}.
341 * @param paramSet Indicates the pointer to the parameters required for the key operation.
349 * {@link OH_Huks_ErrCode#OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT} 12000003 - If the key argument
351 * {@link OH_Huks_ErrCode#OH_HUKS_ERR_CODE_ITEM_NOT_EXIST} 12000011 - If the key file is not exit,
354 * get key argument.
376 * @brief Ends the key session.
378 * @param handle Indicates the pointer to the key session handle, which is generated by {@link OH_Huks_InitSession}.
379 * @param paramSet Indicates the pointer to the parameters required for the key operation.
386 * {@link OH_Huks_ErrCode#OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT} 12000003 - If the key argument
388 * {@link OH_Huks_ErrCode#OH_HUKS_ERR_CODE_ITEM_NOT_EXIST} 12000011 - If the key file is not exit,
391 * get key argument.
413 * @brief Aborts a key session.
415 * @param handle Indicates the pointer to the key session handle, which is generated by {@link OH_Huks_InitSession}.
416 * @param paramSet Indicates the pointer to the parameters required for aborting the key session.
422 * {@link OH_Huks_ErrCode#OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT} 12000003 - If the key argument
426 * get key argument.