鸿蒙源码分析（五十二）

hks_storage.c代码分析

本篇博客主要介绍内存中hash加密算法的实现，主要是一些内存的操作。对密钥和文件内存的交互进行实现。 文件路径:security_huks\frameworks\huks_lite\source\hw_keystore_sdk\soft_service\hks_storage.c

代码分析

hks_calc_hash_sha512函数实现hash算法，基于SHA512算法。

//计算hash算法 
static int32_t hks_calc_hash_sha512(uint8_t *hash512, uint16_t size)
{
    uint8_t *buffer = hks_get_buffer();

    if (buffer == NULL)
        return HKS_ERROR_NULL_POINTER;
    //检查是否buffer是否获取失败
    if (size == 0)
        return HKS_ERROR_BUFFER_TOO_SMALL;
    uint8_t *buf = (uint8_t *)HKS_CALLOC(sizeof(uint8_t), size); //按照8位大小申请空间

    if (buf == NULL) //查看是否成功申请空间
        return HKS_ERROR_MALLOC_FAIL;

    if (memcpy_s(buf, size, buffer, size) != EOK) {
        //将buffer中内容复制进buf，buffer的数据内容长度位size，buf的最大大小位size
        hks_free_ptr(buf);
        return HKS_ERROR_BAD_STATE;
    }
    //计算hash算法，基于SHA512算法实现
    crypto_hash_sha512(hash512, buf, size);

    /* clear buffer after use before free. Don't remove! */
    (void)memset_s(buf, size, 0, size);
    //hash执行成功后将buf数组清0
    hks_free_ptr(buf);
    //释放相应空间
    return HKS_STATUS_OK;
}

对数据有效性的检查，

//检查参数是否有效
static int32_t hks_check_data_valid(const uint8_t *buffer)
{
    uint8_t hash512[HKS_HEADER_HASH_SIZE] = {0};
    uint16_t size = hks_get_header_len() - HKS_HEADER_HASH_SIZE;
    //size表示数据域的长度，header的长度减去hash验证码长度
    int32_t status = hks_calc_hash_sha512(hash512, size);
    //
    if (status != HKS_STATUS_OK)
        return status;
    //比较两个字符串内容
    if (memcmp(hash512, (buffer + size), HKS_HEADER_HASH_SIZE) != 0)
    //比较hash512数组内容是否和(buffer中指定位置开始的字符串是否相同
        return HKS_ERROR_INVALID_KEY_FILE;

    return HKS_STATUS_OK;
}

将文件载入进缓冲区。两个参数一个传入文件名字，另一个参数表示传入密钥是否存在。相当于一个逻辑变量。这个逻辑变量实现密钥信息的状态值，用0-1值表示是否存在该密钥信息。 其中大致步骤就是检查参数，然后符合要求的话就申请空间，读取文件等等操作。

//将文件载入进缓冲区。两个参数一个传入文件名字，另一个参数表示传入密钥是否存在。相当于一个逻辑变量
int32_t hks_load_file_to_buffer(const char *file_name, int32_t *is_key_info_exist)
{
    if ((file_name == NULL) || (is_key_info_exist == NULL))
        return HKS_ERROR_NULL_POINTER;

    if (g_storage_image_buffer != NULL) {
        *is_key_info_exist = HKS_BOOL_TRUE;
        return HKS_STATUS_OK;
    }
    //参数的检查
    int32_t status = hks_apply_buffer(sizeof(uint8_t), HKS_BUF_BYTES);
    //申请缓冲区空间
    if (status != HKS_STATUS_OK)
        return status;

    hks_clean_buffer();
    //缓冲区空间的清理。清0
    uint8_t *buffer = hks_get_buffer();

    if (buffer == NULL)
        return HKS_ERROR_NULL_POINTER;

    int32_t len = 0;
    uint32_t offset = hks_get_store_file_offset();
	//计算一个偏置数据，用来计算文件size或者缓冲区size
    if (offset >= HKS_BUF_BYTES) {
        hks_free_buffer();
        return HKS_ERROR_INTERNAL_UNKOWN;
    }

    status = hks_file_read(file_name, offset,
        buffer, (HKS_BUF_BYTES - offset), &len);
    //将文件内容读入缓冲区buffer，将读取长度写进len
    if (status != HKS_STATUS_OK) {
        hks_free_buffer();
        return status;
    }
    //这里的len是文件读取的长度，大于零表示读取成功
    if (len > 0) {
        status = hks_check_data_valid(buffer);
        if (status != HKS_STATUS_OK) {
            hks_free_buffer();
            return status;
        }
        *is_key_info_exist = HKS_BOOL_TRUE;
        //这个变量的值相当于一个逻辑值，0表示逻辑假，1表示逻辑真
    }
    //len=0表示读入文件失败，释放缓冲区空间
    if (len == 0) {
        status = hks_init_buffer();
        if (status != HKS_STATUS_OK) {
            hks_free_buffer();
            return status;
        }
    }
    return status;
}

对内存中数据的清理（置为0）

//清理内存的密钥信息
int32_t hks_storage_clean_key_info(void)
{
    int32_t status = hks_apply_buffer(sizeof(uint8_t), HKS_BUF_BYTES);
    //先申请一个空间
    if (status != HKS_STATUS_OK)
        return status;
    //申请失败的处理
    hks_clean_buffer();
    uint8_t *buffer = hks_get_buffer();
    //获取缓冲区
    if (buffer == NULL)
        return HKS_ERROR_NULL_POINTER;
    //初始化缓冲区内容为0
    status = hks_init_buffer();
    if (status != HKS_STATUS_OK) {
        hks_free_buffer();
        return status;
    }
    //刷新header的hash内容
    status = hks_refresh_header_hash();
    if (status != HKS_STATUS_OK) {
        hks_free_buffer();
        return status;
    }
    //将缓冲区内容读进file，实现内容迁移方便清理buffer内容
    status = hks_sync_buf_to_file();
    if (status != HKS_STATUS_OK) {
        hks_free_buffer();
        return status;
    }
    return status;
}

用来获取密钥的数量，将结果写进key_num.主要目的是为了后面和本地保存的数量做对比，看是否保存合法。

//用来获取密钥的数量，将结果写进key_num
static int32_t hks_storage_get_key_count(uint32_t *key_num)
{
    uint8_t *buffer = hks_get_buffer();

    if (buffer == NULL)
        return HKS_ERROR_NULL_POINTER;

    uint8_t key_count = 0;
    uint32_t key_count_pos = sizeof(uint16_t);

    hks_blob_read_uint8(&key_count, (buffer + key_count_pos));
    *key_num = key_count;
    return HKS_STATUS_OK;
}

计算loop数目

//计算loop数目
static uint8_t hks_get_slot_count_loop(void)
{
    uint8_t *buffer = hks_get_buffer();

    if (buffer == NULL)
        return 0;

    uint32_t slot_count_pos = sizeof(uint16_t) + sizeof(uint8_t);
    uint8_t slot_count = 0;
    //读取密钥信息
    hks_blob_read_uint8(&slot_count, (buffer + slot_count_pos));

    uint8_t max_num = HKS_LOCAL_STORAGE_KEY_MAX_NUM;
    //选择slot_count和max_num的数目较少的那个
    uint8_t slot_count_loop = (slot_count size;  //随机值的size
    aead_data.additional_data = aad->data;
    aead_data.additional_data_length = aad->size;  //附加值的size和大小
    aead_data.ciphertext = cipher_text->data;  //密文信息输入
    aead_data.ciphertext_length = cipher_text->size;  //密文的size
    aead_data.plaintext = key->data;
    aead_data.plaintext_length = key->size;
    //对该部分数据进行赋值
    status = hks_mbedtls_aead_encrypt(&kek, &key_param, &aead_data,
        &cipher_text_length);
    //aead加密
    if (status != HKS_STATUS_OK) {
        hks_blob_destroy(cipher_text);
        //加密失败的话直接distroy密文
        goto exit;
    }
    //
    if (cipher_text_length size = (uint32_t)cipher_text_length;
        //密文length的判断
    else
        status = HKS_ERROR_DATA_CORRUPT;

exit:
    hks_blob_destroy(&kek);
    //密钥结构体内存的清理
    return status;
}

以上为函数代码的解释部分，感谢阅读和点赞