OpenHarmony解读之设备认证：sts协议-服务端响应sts end请求

一、概述

在上文中说到，客户端根据服务端的start响应消息发起了end请求，本文将重点介绍服务端是如何处理和响应end请求的。

二、源码分析

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

1. 首先解析认证ack请求消息，parse_auth_ack_request函数，获取该消息中的关键字段，保存在相应结构体中。

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

2. 然后调用proc_sts_request_message函数处理请求消息，再这个函数里面，根据消息类型选择对应的处理方式，此处应是send_sts_end_response函数。

/*
函数功能：构造sts协议end响应数据
函数参数：
    handle：sts服务端对象
    receive：接收到的消息
    send：待发送的数据缓冲区地址
函数返回值：
    成功：0
    失败：error num
*/
int32_t send_sts_end_response(struct sts_server *handle, struct message *receive, struct message *send)
{
   
    DBG_OUT("Called send sts end response");
    check_ptr_return_val(handle, HC_INPUT_ERROR);//检查参数有效性
    check_ptr_return_val(receive, HC_INPUT_ERROR);
    check_ptr_return_val(send, HC_INPUT_ERROR);
    int32_t ret = HC_OK;
    struct sts_end_response_data *send_data =
        (struct sts_end_response_data *)MALLOC(sizeof(struct sts_end_response_data));//申请sts_end_response_data结构体空间send_data

    if (send_data == NULL) {
   
        LOGE("Malloc struct sts_end_response_data failed");
        send->msg_code = INFORM_MESSAGE;
        return HC_MALLOC_FAILED;
    }
    (void)memset_s(send_data, sizeof(*send_data), 0, sizeof(*send_data));//清空该空间

    if (handle->ack_request == 0) {
   
        struct sts_end_request_data *receive_data = receive->payload;//用sts_end_request_data结构接收消息负载
        ret = send_end_response(handle, receive_data, send_data);//构造end响应消息
        if (ret != HC_OK) {
   //执行失败
            LOGE("Called send_end_response failed, error code is %d", ret);
            FREE(send_data);
            send_data = NULL;
            send->msg_code = INFORM_MESSAGE;
        } else {
   //执行成功
            DBG_OUT("Called send_end_response success");
            send->msg_code = AUTH_ACK_RESPONSE;//设置消息码为AUTH_ACK_RESPONSE
            send->payload = send_data;//赋值待发送的数据
            handle->ack_request = 1;//将start_request标志置1
            (void)memcpy_s(&handle->end_response_data, sizeof(struct sts_end_response_data),
                           send_data, sizeof(struct sts_end_response_data));
        }
    } else {
   //如果start_request不为0，则再次调用send_start_response
        DBG_OUT("Called send sts end response again");
        send->msg_code = AUTH_ACK_RESPONSE;//置响应消息码为AUTH_ACK_RESPONSE
        (void)memcpy_s(send_data, sizeof(struct sts_end_response_data),
                       &handle->end_response_data, sizeof(str