[系统运维]鸿蒙通信softbus_lite组件分析

概述

softbus_lite组件是在受限设备上提供数据传输服务，除此之外，还提供设备发现，设备认证，通信安全功能。

运行机理

内部结构

softbus_lite由coap服务器，消息队列处理线程，设备认证服务器，会话管理服务器四部分组成。其中coap服务器是UDP服务器，端口为5684，用于设备发现。消息队列用于内部消息传递，目前仅用在创建设备认证服务器和会话管理服务器上，不对外提供服务。设备认证服务器是TCP服务器，其端口不固定，用于设备认证，密钥协商。会话管理服务器是TCP服务器，其端口不固定，用于数据传输。
softbus_lite内部结构图

softbus_lite支持网口和Wifi两种通信方式。

PublishService函数

PublishService函数的功能是创建coap服务器，消息队列处理线程，设备认证服务器，会话管理服务器，声明一个功能模块。只有调用了PublishService函数，softbus_lite才能向外提供服务。
PublishService函数处理流程如下。

由于CoapInitDiscovery函数已打开消息队列处理线程，而CoapWriteMsgQueue(UPDATE_IP_EVENT)函数向消息队列发送了消息，将触发消息队列处理流程，将调用g_wifiCallback(para)，这时g_wifiCallback为WifiEventTrigger，para为1，所以处理流程如下。

主要函数说明：

coap服务器

coap服务器用于响应设备发现，检查接收报文是否合法，向外部设备提供自身的设备名称，设备ID，版本，模式，认证端口，IP地址，能力值等信息。其处理流程如下。

主要函数说明：

设备认证服务器

设备认证服务器用于设备认证，建立认证会话密钥，向外提供会话端口。其处理流程如下。

由于AuthInterfaceOnDataReceived函数主要处理流程在base/security/deviceauth目录下，这里不再展开。
OnModuleMessageReceived函数处理流程如下：

可见，如果客户端发送报文体中CODE域值为CODE_VERIFY_IP（即为1）时，服务器会将自身的会话端口返回给客户端。

从上可以看出，认证服务器主要工作有两个：

1. 认证连接维护：接收客户端认证连接，记录到g_fdMap；
2. 响应认证数据：解析客户端的认证数据，解析，并作相应处理；

主要函数说明：

会话管理服务器

会话管理服务器用于数据传输。进行数据传输之前需要如下条件：1）客户端与服务器做设备认证，建立认证会话密钥；2）服务器需要调用CreateSessionServer函数，来设置用于响应某个session的处理函数。
会话管理服务器处理流程如下。

主要函数说明：

对外接口

设备发现接口

源码foundation/communication/softbus_lite/interfaces/kits/discovery/discovery_service.h定义了设备发现的对外函数接口和数据结构。
函数接口如下

数据结构如下

typedef enum {
    /** Automatic medium selection */
    AUTO = 0,
    /** Bluetooth */
    BLE = 1,
    /** Wi-Fi */
    COAP = 2,
    /** USB */
    USB = 3,
} ExchangeMedium;
typedef enum {
    /** Low */
    LOW = 0,
   /** Medium */
    MID = 1,
   /** High */
    HIGH = 2,
   /** Super-high */
    SUPER_HIGH = 3,
} ExchangeFreq;
typedef struct PublishInfo {
  /** Service publishing ID */
    int publishId;
  /** Service publishing mode, which can be {@link DISCOVER_MODE_PASSIVE} or {@link DISCOVER_MODE_ACTIVE } */
    int mode;
  /** Service publishing medium */
    ExchangeMedium medium;
  /** Service publishing frequency */
    ExchangeFreq freq;
  /** Service publishing capabilities. For details, see {@link g_capabilityMap}. */
    const char *capability;
  /** Capability data for service publishing */
    unsigned char *capabilityData;
  /** Maximum length of the capability data for service publishing (2 bytes) */
    unsigned int dataLen;
} PublishInfo;

typedef enum {
   /** Unsupported medium */
    PUBLISH_FAIL_REASON_NOT_SUPPORT_MEDIUM = 1,
   /** Invalid parameter */
    PUBLISH_FAIL_REASON_PARAMETER_INVALID = 2,
   /** Unknown reason */
    PUBLISH_FAIL_REASON_UNKNOWN = 0xFF
} PublishFailReason;
typedef struct IPublishCallback {
    /** Callback for successful publishing */
    void (*onPublishSuccess)(int publishId);
    /** Callback for failed publishing */
    void (*onPublishFail)(int publishId, PublishFailReason reason);
} IPublishCallback;

typedef enum {
    /** Device ID. The value contains a maximum of 64 characters. */
    COMM_DEVICE_KEY_DEVID = 0,
    /** Device type. Currently, only <b>ddmpCapability</b> is supported. */
    COMM_DEVICE_KEY_DEVTYPE = 1,
    /** Device name. The value contains a maximum of 63 characters. */
    COMM_DEVICE_KEY_DEVNAME = 2,
    /** Reserved */
    COMM_DEVICE_KEY_MAX
} CommonDeviceKey;
typedef struct CommonDeviceInfo {
    /** Device information type. For details, see {@link CommonDeviceKey}. */
    CommonDeviceKey key;
    /** Content to set */
    const char *value;
} CommonDeviceInfo;

数据传输接口

源码foundation/communication/softbus_lite/interfaces/kits/transport/sesion.h定义了数据传输的对外函数接口和数据结构。
函数接口如下

数据结构如下

struct ISessionListener {
    /**@brief Called when a session is opened.
     * This function can be used to verify the session or initialize resources related to the session.
     * @param sessionId Indicates the session ID.
     * @return Returns <b>0</b> if the session connection is accepted; returns a non-zero value
     * otherwise (you do not need to call {@link CloseSession} to close the session).
     * @since 1.0
     * @version 1.0
     */
    int (*onSessionOpened)(int sessionId);
    /**
     * @brief Called when a session is closed.
     * This function can be used to release resources related to the session.
     * You do not need to call {@link CloseSession}.
     * @param sessionId Indicates the session ID.
     * @since 1.0
     * @version 1.0
     */
    void (*onSessionClosed)(int sessionId);
    /**
     * @brief Called when data is received.
     * This function is used to notify that data is received.
     * @param sessionId Indicates the session ID.
     * @param data Indicates the pointer to the data received.
     * @param dataLen Indicates the length of the data received.
     * @since 1.0
     * @version 1.0
     */
    void (*onBytesReceived)(int sessionId, const void *data, unsigned int dataLen);
};

使用示例

标准使用方法

测试方法

由于对密钥交换，认证会话密钥的生成流程不清楚，要测试softbus_lite的数据传输功能，需要屏蔽与加解密相关的操作，也需要coap server将认证端口直接暴露出来。

数据传输报文(未加密)格式如下

数据传输报文(认证密钥加密)格式如下

数据传输报文(会话密钥加密)格式如下

测试1，设备发现。目标：获得认证端口与会话端口。
步骤如下。

1. 服务端调用PublishService发布一个服务"softbus-server"
2. 客户端向服务器5684端口发送coap发现请求
3. 客户端收到服务器的返回报文后，确认该报文中含有服务器的设备信息，认证端口和会话端口

测试2，回声服务器（回声服务器是将收到的报文原封不动的发送回去）。目标：验证数据传输通路正确；
步骤如下。

1. 服务端调用PublishService发布一个服务"softbus-server"
2. 服务端调用CreateSessionServer创建一个会话服务器"echo-server"
3. 客户端向服务器5684端口发送coap发现请求
4. 客户端收到服务器的返回报文后，确认该报文中含有服务器的设备信息，认证端口和会话端口
5. 客户端连接服务器会话端口
6. 客户端向服务器会话端口发送报文后，服务器回复后，确认该报文中是否含有服务器的设备信息
7. 客户端向服务器会话端口发送报文后，服务器回复后，确认该报文报文体与发送报文体一样