鸿蒙源码分析（二十一）

超、凢脫俗 2022-09-04 01:46 165阅读 0赞

### 文章目录 ###

*  安全密钥库模块下的hks\_common.h分析
 *   *  一、背景知识
     *  二、hks\_common.h代码分析
     *   *  2.1 变量宏定义
         *  2.2 结构体的定义
         *  2.3 函数声明
     *  三、总结

--------------------

# 安全密钥库模块下的hks\_common.h分析 #

本篇主题：本篇博客主要分析hks\_common.h相关代码  
文件路径（security\_huks\\frameworks\\huks\_lite\\source\\hw\_keystore\_sdk\\common\\hks\_common.h）

## 一、背景知识 ##

背景知识主要为安全加密算法中的aead算法，gcm、ccm认证机制。  
传送门：\[等下一期文章进行更新\]

## 二、hks\_common.h代码分析 ##

### 2.1 变量宏定义 ###

**2.1.1宏定义函数**

#define hks_alg_hmac(hash_alg) \ //mac认证机制
        (HKS_ALG_HMAC_BASE | ((hash_alg) & HKS_ALG_HASH_MASK))
    
    #define hks_alg_hmac_get_hash(hmac_alg) \ //hmac获取哈希值
        (HKS_ALG_CATEGORY_HASH | ((hmac_alg) & HKS_ALG_HASH_MASK))

#define hks_key_type_is_dsa(type) \ (HKS_KEY_TYPE_PUBLIC_KEY_OF_KEYPAIR(type) == \ HKS_KEY_TYPE_DSA_PUBLIC_KEY) //宏定义函数用来判断是一个私钥还是一对密钥

下面都是相关SHA的变量定义，在代码中的实际应用不多，由于类似代码过多这里不一一注释。

#define HKS_MAC_TRUNCATION_OFFSET 8
    /* SHA2-224 */
    #define HKS_ALG_SHA_224 ((uint32_t)0x01000008)
    /* SHA2-256 */
    #define HKS_ALG_SHA_256 ((uint32_t)0x01000009)
    /* SHA2-384 */
    #define HKS_ALG_SHA_384 ((uint32_t)0x0100000a)
    /* SHA2-512 */
    #define HKS_ALG_SHA_512 ((uint32_t)0x0100000b)
    /* SHA2-512/224 */
    #define HKS_ALG_SHA_512_224 ((uint32_t)0x0100000c)
    /* SHA2-512/256 */
    #define HKS_ALG_SHA_512_256 ((uint32_t)0x0100000d)
    /* SHA3-224 */
    #define HKS_ALG_SHA3_224 ((uint32_t)0x01000010)
    /* SHA3-256 */
    #define HKS_ALG_SHA3_256 ((uint32_t)0x01000011)
    /* SHA3-384 */
    #define HKS_ALG_SHA3_384 ((uint32_t)0x01000012)
    /* SHA3-512 */
    #define HKS_ALG_SHA3_512 ((uint32_t)0x01000013)
    /* ECDH KEY AGREEMENT */
    #define HKS_ALG_ECDH_RAW ((uint32_t)0x31000001)

/* the file name of the key storage */
    #define HKS_KEY_STORE_FILE_NAME "hks_keystore" //密钥存储的文件名
    
    /* the number of file clear data type */
    #define HKS_INIT_DATA_TYPE_NUM 3//清除数据类型的数量
    
    /* const define used in Ed25519 algorithm */
    #define CRYPTO_SECRET_KEY_BYTES 64
    #define CRYPTO_PUBLIC_KEY_BYTES 32
    #define CRYPTO_BYTES 64

用来初始化数据类型的共用体，将不同情况的数据进行初始化。

enum hks_init_data_type { //初始化数据类型
        /* all zero */
        HKS_INIT_DATA_TYPE_ALL_ZERO = 0,
        /* all one */
        HKS_INIT_DATA_TYPE_ALL_ONE = 1,
        /* random */
        HKS_INIT_DATA_TYPE_RANDOM = 2,
        HKS_INIT_DATA_TYPE_MAX = HKS_INIT_DATA_TYPE_RANDOM
    };

### 2.2 结构体的定义 ###

aead加密模式介绍：aead是一种同时具备保密性，完整性和可认证性的加密形式。  
AEAD 产生的原因很简单，单纯的对称加密算法，其解密步骤是无法确认密钥是否正确的。也就是说，加密后的数据可以用任何密钥执行解密运算，得到一组疑似原始数据，而不知道密钥是否是正确的，也不知道解密出来的原始数据是否正确。  
因此，需要在单纯的加密算法之上，加上一层验证手段，来确认解密步骤是否正确。

这里定义几个aead会用到的的结构体。

struct hks_aead_operation { 
        const mbedtls_cipher_info_t *cipher_info; //加密信息
        mbedtls_gcm_context gcm; //gcm密文
        mbedtls_ccm_context ccm;  //ccm加密
        uint32_t core_alg; //核心进程
        uint8_t full_tag_length; //标记位的最大长度
        uint8_t tag_length;//标记位的长度
    };
    struct hks_aead_data { 
        uint8_t *nonce; //当前即时数据
        size_t nonce_length; //即时数据长度
        uint8_t *additional_data; //additional数据
        size_t additional_data_length; //额外附加数据的长度
        uint8_t *ciphertext; //密文
        size_t ciphertext_length; //密文长度
        uint8_t *plaintext; //原文
        size_t plaintext_length; //原文长度
    };

### 2.3 函数声明 ###

下面的代码块主要是对hks\_common.h中出现的函数申明，下面各个函数的详细分析均在下一篇博客hks\_common.c的详细分析中。下面只列举出现的函数不做分析。

int32_t hks_malloc_init_ptr(uint32_t size, uint8_t **ptr);
    int32_t hks_blob_init(struct hks_blob *blob, size_t nmemb, size_t size,
        uint8_t type);
    void hks_blob_destroy(struct hks_blob *blob);
    int32_t hks_is_valid_auth_id(const struct hks_key_param *key_param);
    int32_t hks_is_valid_alias(const struct hks_blob *alias);
    int32_t hks_cpy_key_param(struct hks_key_param *dst,
        const struct hks_key_param *src);
    void hks_key_param_destroy(struct hks_key_param *pram);
    void hks_check_return_code(int32_t s, int32_t *ret);
    int32_t hks_mbedtls_aead_encrypt(const struct hks_blob *key,
        const struct hks_key_param *key_param, struct hks_aead_data *aead_data,
        size_t *ciphertext_output_length);
    
    int32_t hks_aead_unpadded_locate_tag(size_t tag_length,
        const uint8_t *ciphertext, size_t ciphertext_length,
        size_t plaintext_size, const uint8_t **p_tag);
    
    int32_t hks_mbedtls_aead_decrypt(const struct hks_blob *key,
        const struct hks_key_param *key_param,
        struct hks_aead_data *aead_data, size_t *plaintext_output_length);
    
    int32_t hks_mbedtls_key_derivation(struct hks_blob *derived_key,
        const uint32_t alg, const struct hks_blob *kdf_key,
        const struct hks_blob *salt,
        const struct hks_blob *label);
    
    int32_t hks_endian_swap(uint8_t *p_data, int32_t length);
    int32_t hks_gen_random(uint8_t *random, uint32_t len);
    int32_t hks_calc_sha256(const struct hks_blob *hash_src, uint32_t hash_src_num,
        struct hks_blob *hash_result);
    int32_t hks_init_buf_data(uint8_t data_type, uint8_t *buf, uint32_t buf_len);
    int32_t mbedtls_to_hks_error(int ret);
    void hks_xor(const struct hks_blob *src1, const struct hks_blob *src2,
        struct hks_blob *result);
    int32_t hks_reg_get_hardware_udid_callback(
        hks_get_hardware_udid_callback callback);
    int32_t hks_get_hardware_udid(uint8_t *udid, uint32_t udid_len);
    void crypto_hash_sha512(unsigned char *out, const unsigned char *in, const int len);

## 三、总结 ##

以上就是hks\_access.h的内容，简单介绍了该文件中变量的定义和一些结构体的声明定义。感谢阅读和点赞。