鸿蒙源码分析（二十七）

迈不过友情╰ 2022-09-04 11:56 212阅读 0赞

### 文章目录 ###

*  安全密钥库模块hks\_client.c代码分析（下）
 *   *  一、背景知识
     *  二、代码分析
     *  三、总结

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

# 安全密钥库模块hks\_client.c代码分析（下） #

本篇文章主要分析hks\_client.c中的相关内容  
文件路径（security\_huks\\frameworks\\huks\_lite\\source\\hw\_keystore\_sdk\\hks\_client.c）

## 一、背景知识 ##

[代码分析上篇][Link 1]

## 二、代码分析 ##

**非对称性验证**  
函数功能顾名思义，主要原理是先检查相应参数最后调用hks\_access.c当中的函数实现功能。  
参数解释：

*  key：密钥
 *  key\_param：密钥相关参数
 *  hash：哈希数据
 *  signature：签名

//非对称性的验证
    HKS_DLL_API_PUBLIC int32_t hks_asymmetric_verify(const struct hks_blob *key,
        const struct hks_key_param *key_param, const struct hks_blob *hash,
        const struct hks_blob *signature)
    { 
    #ifdef _CUT_AUTHENTICATE_
        return HKS_ERROR_NOT_SUPPORTED;
    #else
        hks_if_true_return_error(((key == NULL) || (key_param == NULL) ||
            (hash == NULL) || (signature == NULL)), HKS_ERROR_NULL_POINTER);
        //先检查函数传入的参数是否有空值
        int32_t status;
    
        if (key->type == HKS_BLOB_TYPE_ALIAS) { 
            status = hks_is_valid_alias(key);
            hks_if_status_error_return(status);
            //当密钥的类型为alias类型时候，检查密钥的可用性然后将检查结果状态值返回
        } else if (key->type == HKS_BLOB_TYPE_KEY) { 
            if (key_param->key_type != HKS_KEY_TYPE_EDDSA_PUBLIC_KEY_ED25519)
                return HKS_ERROR_NOT_SUPPORTED;
            //密钥参数中的密钥类型不为公钥ED25519则函数退出
            if ((key->data == NULL) || (key->size != HKS_PUBLIC_BYTES_ED25519))
                return HKS_ERROR_INVALID_KEY_INFO;
                //检查密钥数据的合法性
        } else { 
            return HKS_ERROR_INVALID_KEY_INFO;
        }
    
        if ((key_param->key_usage & HKS_KEY_USAGE_VERIFY) == 0)
            return HKS_ERROR_NOT_SUPPORTED;
        //检查密钥参数中的usage属性
        if ((hash->data == NULL) || (hash->size <= 0))
            return HKS_ERROR_INVALID_ARGUMENT;
        //哈希域中的数据的size不合法，则函数退出，退出码为HKS_ERROR_INVALID_ARGUMENT
        if ((signature->data == NULL) || (signature->size < HKS_SIGNATURE_MIN_SIZE))
            return HKS_ERROR_INVALID_ARGUMENT;
        return hks_access_verify(key, hash, signature);
        //返回一个通道验证
    #endif
    }

**aead加密筛**  
ree是筛的意思，该函数主要是为了在aead之前实现参数的检查，更好地执行加密。基础功能封装在hks\_access.c的aead加密函数当中，这里只完成相关参数的检查。  
参数解释：

*  key：
 *  key\_param：密钥参数
 *  crypt\_param：加密参数
 *  plain\_text：铭文内容
 *  cipher\_text\_with\_tag：存放带有tag的密文信息

//加密筛法
    static int32_t hks_aead_encrypt_ree(const struct hks_blob *key,
        const struct hks_key_param *key_param,
        const struct hks_crypt_param *crypt_param,
        const struct hks_blob *plain_text,
        struct hks_blob *cipher_text_with_tag)
    { 
        hks_if_true_return_error(((key_param->key_type != HKS_KEY_TYPE_AES) ||
            (key_param->key_mode != HKS_ALG_GCM) ||
            (key_param->key_pad != HKS_PADDING_NONE) ||
            ((key_param->key_usage & HKS_KEY_USAGE_ENCRYPT) == 0)), HKS_ERROR_NOT_SUPPORTED);
        //密钥参数key_param的type、mode、pad、usage属性的检查
        hks_if_true_return_error(((key_param->key_len != HKS_MAX_KEY_LEN_128) &&
            (key_param->key_len != HKS_MAX_KEY_LEN_192) &&
            (key_param->key_len != HKS_MAX_KEY_LEN_256)), HKS_ERROR_NOT_SUPPORTED);
        //参数长度的检查
        hks_if_true_return_error(((key->type != HKS_BLOB_TYPE_KEY) || (key->data == NULL) ||
            (key->size != (key_param->key_len / HKS_BITS_PER_BYTES))), HKS_ERROR_INVALID_KEY_INFO);
        //
        hks_if_true_return_error(((crypt_param->nonce.data == NULL) ||
            (crypt_param->nonce.size < HKS_AES_GCM_MIN_IV_LENGTH) ||
            (crypt_param->aad.data == NULL) ||
            (crypt_param->aad.size == 0) ||
            (plain_text->data == NULL) || (plain_text->size == 0)), HKS_ERROR_INVALID_ARGUMENT);
    
        hks_if_true_return_error(((cipher_text_with_tag == NULL) ||
            (cipher_text_with_tag->data == NULL) ||
            (cipher_text_with_tag->size < (plain_text->size + HKS_SALT_MAX_SIZE))),
            HKS_ERROR_INVALID_ARGUMENT);
        //密文标记位为空或者标记位数据域为空或者标记域的size大小小雨明文长度加16，函数就返回对应的错误码
        return hks_access_aead_encrypt(key, key_param, crypt_param, plain_text, cipher_text_with_tag);
        //传入参数实现加密
    }

**aead加密**  
功能位aead，基础功能还是基于hks\_access.c来实现。这里只是对该功能执行封装，实现客户端的加密。  
参数功能同上，不在赘述。

//aead加密
    HKS_DLL_API_PUBLIC int32_t hks_aead_encrypt(const struct hks_blob *key,
        const struct hks_key_param *key_param,
        const struct hks_crypt_param *crypt_param,
        const struct hks_blob *plain_text,
        struct hks_blob *cipher_text_with_tag)
    { 
        hks_if_true_return_error(((key == NULL) || (key_param == NULL) ||
            (crypt_param == NULL || (plain_text == NULL) ||
            (cipher_text_with_tag == NULL))), HKS_ERROR_NULL_POINTER);
        //检查参数
        return hks_aead_encrypt_ree(key, key_param, crypt_param, plain_text, cipher_text_with_tag);
        //调用aead加密筛，用来检查相关数据域和参数实现
    }

**解密筛和解密的封装原理类似**  
**密钥派生**

//密钥派生
    HKS_DLL_API_PUBLIC int32_t hks_key_derivation(struct hks_blob *derived_key,
        const struct hks_key_param *key_param, const struct hks_blob *kdf_key,
        const struct hks_blob *salt, const struct hks_blob *label)
    { 
        hks_if_true_return_error(((derived_key == NULL) ||
            (key_param == NULL) || (kdf_key == NULL) ||
            (salt == NULL) || (label == NULL)),
            HKS_ERROR_NULL_POINTER);
        //只要有传入参数为空，就返回对应的错误码
        return hks_access_key_derivation(derived_key, kdf_key, salt, label,
            key_param);
        //
    }

**生成随机数**  
参数解释：

*  random：将带有数据的random结构体写进全局变量消息盒子返回状态值

//用来生成随机数
    HKS_DLL_API_PUBLIC int32_t hks_generate_random(struct hks_blob *random)
    { 
        hks_if_true_return_error(((random == NULL) || (random->data == NULL)),
            HKS_ERROR_NULL_POINTER);
            //检查random是否为空，以及数据域是否为空
        hks_if_true_return_error((random->size > HKS_RANDOM_MAX_LEN),
            HKS_ERROR_INVALID_ARGUMENT);
            //检查数组大小
        return hks_access_get_random(random);
        //将random写进msg_box
    }

**hash过程**

//单向哈希函数
    HKS_DLL_API_PUBLIC int32_t hks_hash(const uint32_t alg,
        const struct hks_blob *src_data, struct hks_blob *hash)
    { 
    #ifdef _CUT_AUTHENTICATE_
        return HKS_ERROR_NOT_SUPPORTED;
    #else
        hks_if_true_return_error(((src_data == NULL) || (hash == NULL)),
            HKS_ERROR_NULL_POINTER);
        //检查传入数据是否为空
        return hks_access_hash(alg, src_data, hash);
        //将src_data和hash写进全局变量
    #endif
    }

**大数幂运算取模**  
x = a^e mod n  
参数功能参考上面表达式

//该运算表示x = a^e mod n
    HKS_DLL_API_PUBLIC int32_t hks_bn_exp_mod(struct hks_blob *x,
        const struct hks_blob *a, const struct hks_blob *e,
        const struct hks_blob *n)
    { 
        hks_if_true_return_error(((x == NULL) || (a == NULL) || (e == NULL) ||
            (n == NULL)), HKS_ERROR_NULL_POINTER);
        return hks_access_bn_exp_mod(x, a, e, n); //计算大数幂运算取模
    }

**回调函数获取硬件描述符**  
参数：回调函数

//获取硬件设备的唯一标识符（基于回调函数）
    HKS_DLL_API_PUBLIC int32_t hks_register_get_hardware_udid_callback(
        hks_get_hardware_udid_callback callback)
    { 
    #ifdef _CUT_AUTHENTICATE_
        return HKS_SUCCESS;
    #else
        return hks_service_register_get_hardware_udid_callback(callback);
    #endif
    }

**日志的寄存**  
将log中的数据写进关于日志的全局变量

//寄存器日志接口
    HKS_DLL_API_PUBLIC int32_t hks_register_log_interface(
        const struct hks_log_f_group *log)
    { 
        if (log == NULL)
            return HKS_ERROR_NULL_POINTER;
    
        hks_register_log(log);
        //将log中数据写进日志数组
        return HKS_STATUS_OK;
    }

**一些基础功能的封装**

//获取公钥参数列表
    HKS_DLL_API_PUBLIC int32_t hks_get_pub_key_alias_list(
        struct hks_blob *key_alias_list, uint32_t *list_count)
    { 
    #ifdef _CUT_AUTHENTICATE_
        return HKS_ERROR_NOT_SUPPORTED;
    #else
        if ((key_alias_list == NULL) || (list_count == NULL))
            return HKS_ERROR_NULL_POINTER;
    
        return hks_access_get_pub_key_alias_list(key_alias_list, list_count);
    #endif
    }
    //调用通道函数实现初始化
    HKS_DLL_API_PUBLIC int32_t hks_init(void)
    { 
    #ifdef _CUT_AUTHENTICATE_
        log_debug("call hks init success.");
        return HKS_SUCCESS;
    #else
        return hks_access_init();
    #endif
    }
    //调用通道函数实现摧毁
    HKS_DLL_API_PUBLIC void hks_destroy(void)
    { 
    #ifdef _CUT_AUTHENTICATE_
        return;
    #else
        hks_access_destroy();
    #endif
    }
    //调用通道函数实现刷新
    HKS_DLL_API_PUBLIC int32_t hks_refresh_key_info(void)
    { 
    #ifdef _CUT_AUTHENTICATE_
        return HKS_SUCCESS;
    #else
        return hks_access_refresh_key_info();
    #endif
    }

## 三、总结 ##

以上就是hks\_ client.c的最后一部分内容，分析了一些相关函数的定义和参数的解释。感谢阅读点赞。

[Link 1]: https://forum.trustie.net/forums/3665/detail