OpenHarmony解读之设备认证：sts协议-客户端发起sts end请求

一、概述

客户端收到来自服务端的响应消息之后，针对消息内容进行相关处理并再次发起sts end请求，目的在于发送可信认证数据，使得服务端可以验证客户端的身份。本文将对这个过程进行详细介绍。

二、源码分析

这一模块的源码位于：/base/security/deviceauth。

1. 首先是parse_auth_start_response函数，解析响应消息，用响应的结构体获取消息的关键字段数据。

/*
函数功能：解析认证start响应消息
函数参数：
    payload：消息负载
    data_type：数据类型
函数返回值：
    成功：返回解析完毕的数据结构
    失败：NULL
*/
void *parse_auth_start_response(const char *payload, enum json_object_data_type data_type)
{
   
   
    struct sts_start_response_data *auth_start_response =
        (struct sts_start_response_data *)MALLOC(sizeof(struct sts_start_response_data));//申请start响应数据结构体空间
    if (auth_start_response == NULL) {
   
   
        return NULL;
    }
    (void)memset_s(auth_start_response, sizeof(*auth_start_response), 0, sizeof(*auth_start_response));//清空该空间
	//如果消息负载为json格式的字符串，则将json格式的数据解析成cjson结构体对象
    json_handle obj = parse_payload(payload, data_type);
    if (obj == NULL) {
   
   
        LOGE("Parse AuthStart Response parse payload failed");//解析失败
        goto error;
    }
    /* authData */
	//获取authData，将原来的十六进制字符串格式转换为byte数组格式
    int32_t result = byte_convert(obj, FIELD_AUTH_DATA, auth_start_response->auth_data.auth_data,
                                  &auth_start_response->auth_data.length, HC_AUTH_DATA_BUFF_LEN);
    if (result != HC_OK) {
   
   //解析失败
        LOGE("Parse AuthStart Response failed, field is null in authData");
        goto error;
    }

    /* challenge */
	//获取challenge，将原来的十六进制字符串格式转换为byte数组格式
    result = byte_convert(obj, FIELD_CHALLENGE, auth_start_response->challenge.challenge,
                          &auth_start_response->challenge.length, CHALLENGE_BUFF_LENGTH);
    if (result != HC_OK) {
   
   //解析失败
        LOGE("Parse AuthStart Response failed, field is null in challenge");
        goto error;
    }

    /* salt */
	//获取salt，将原来的十六进制字符串格式转换为byte数组格式
    result = byte_convert(obj, FIELD_SALT, auth_start_response->salt.salt,
                          (uint32_t *)&auth_start_response->salt.length, HC_SALT_BUFF_LEN);
    if (result != HC_OK) {
   
   //解析失败
        LOGE("Parse AuthStart Response failed, field is null in salt");
        goto error;
    }

    /* epk */
	//获取epk，将原来的十六进制字符串格式转换为byte数组格式
    result = byte_convert(obj, FIELD_EPK, auth_start_response->epk.stpk,
                          &auth_start_response->epk.length, HC_ST_PUBLIC_KEY_LEN);
    if (result != HC_OK) {
   
   //解析失败
        LOGE("Parse AuthStart Response failed, field is null in epk");
        goto error;
    }
    /* version */
    json_pobject obj_ver = get_json_obj(obj, FIELD_VERSION);
    bool ret = parse_version(obj_ver, &auth_start_response->self_version, &auth_start_response->self_support_version);//解析版本号
    if (!ret) {
   
   
        LOGE("Parse AuthStart Response failed, field is null in version");
        goto error;
    }
    free_payload(obj, data_type);//释放内存
    return (void *)auth_start_response;//返回响应消息结构体
error:
    free_payload(obj, data_type);
    FREE(auth_start_response);
    return NULL;
}

2. 然后到消息处理阶段，执行proc_sts_response_message函数，处理sts响应消息。

/*
函数功能：处理sts响应消息
函数参数：
    handle：hichain实例
    nav：导航消息，消息头格式
    receive：接收的消息
    send：待发送消息
函数返回值：
    成功：0
    失败：error num
*/
static int32_t proc_sts_response_message(struct hichain *handle, struct header_analysis *nav,
    struct message *receive, struct message *send)
#if !(defined(_CUT_STS_) || defined(_CUT_STS_CLIENT_))
{
   
   
    DBG_OUT("Object %u proc sts %d response message.", sts_client_sn(handle->sts_client), nav->msg_type);
    int32_t ret;

    if (nav->msg_type == STS_START_MSG) {
   
   //根据消息类型选择不同的处理接口
        ret = send_sts_end_request(handle->sts_client, receive, send);//构造sts end请求数据
    } else if (nav->msg_type == STS_END_MSG) {
   
   
        ret = receive_sts_end_response(handle->sts_client, receive);//处理sts end响应消息
        if (ret == HC_OK) {
   
   
            handle->cb.set_session_key(&handle->identity, &handle->sts_client->service_key);//设置会话密钥service_key
        }
    } else {
   
   
        return HC_UNKNOW_MESSAGE;
    }
    return ret;
}

3. send_sts_end_request函数，构造sts协议的end请求，为该请求准备相关数据。

/*
函数功能：构造sts协议的end请求，为该请求准备相关数据
函数参数：
    sts_client：sts客户端对象
    receive：接收到的消息
    send：待发送消息体
函数返回值：
    成功：0
    失败：error num
*/
int32_t send_sts_end_request(struct sts_client *sts_client, const struct message *receive, struct message *send)
{
   
   
    DBG_OUT("Receive data send_sts_start_response");
    check_ptr_return_val(sts_client, HC_INPUT_ERROR);//检查参数有效性
    check_ptr_return_val(receive, HC_INPUT_ERROR);
    check_ptr_return_val(send, HC_INPUT_ERROR);
    struct sts_start_response_data *receive_data = (struct sts_start_response_data *