mqtt协议分析_mqtt serialize

mqtt协议分析

一.mqtt报文

mqtt报文包括，固定报头，可变报头，有效载荷（消息体）。

1.固定报头

mqtt control packet type：

flagsspecific to each mqtt control packet type:

dup:客户端与服务器消息重发时，此标志被置1
qos:消息质量等级，最多一次 (QoS0)，至少一次 (QoS1)，有且仅有一次 (QoS2)
retain:是否保持此条消息，1为保持

2.可变报头
不同类型消息其参数不一样，现在以connect 类型为例。

这里解释下连接标志与保活计时器
user name flag: 值为1，连接mqtt需要用户名，存在于有效载荷里
password flag:值为1，连接mqtt需要密码，存在于有效载荷里
所以，如果连接mqtt service需要用户名和密码，这两位需要置1。

will retain，will qos，will flag:控制客户端与服务器异常断开，发送will消息给客户端，如果will flag被置1，will retain 与will qos设置将会被生效，并且在有效载荷填写相关字段内容。

保活计时器：客户端设定一段时间给服务器发送一个ping包，用于探测二者是否还处于正常连接状态。

3.有效载荷
存放着客户端与服务器之间需要传输的数据，不同消息类型，其携带的数据也不一样。
CONNECT:
该有效载荷包含了一个或多个 UTF-8 编码字符串。 它们包括标识客户端的唯一标识符、 Will
主题和消息、 要使用的用户名和密码。 其中只有第一项是必选的， 其余的取决于可变消息头
部中的标志置位情况
SUBSCRIBE:
该有效载荷包含一系列要订阅的主题名，以及每个主题的 QoS 级别。这些字符串都是 UTF
编码的。
PUBLISH:
该有效载荷只包含应用特定的数据。

二.wireshark 抓包分析mqtt协议

设备开机，连接mqtt服务器，订阅发布消息，并且定时ping服务器的完整log如下图。

connect报文：

报文内容解析（补充，与上图不是一个mqtt包）：

subscribe报文：

报文内容解析（补充，与上图不是一个mqtt包）：

publish报文：

msg len 属于固定报头，mqtt报文剩余长度

三.mqtt 源码实现

本文已CONNECT类型为例，其他都是类似的，封装报文，发送数据包;

	//封装报文
    if ((len = MQTTSerialize_connect(c->buf, c->buf_size, options)) <= 0)
        goto exit;
    //发送报文
    if ((rc = sendPacket(c, len, &connect_timer)) != SUCCESS)  // send the connect packet
        goto exit; // there was a problem
1
2
3
4
5
6

int MQTTSerialize_connect(unsigned char* buf, int buflen, MQTTPacket_connectData* options)
{
	unsigned char *ptr = buf;
	MQTTHeader header = {0};
	MQTTConnectFlags flags = {0};
	int len = 0;
	int rc = -1;

	FUNC_ENTRY;
	if (MQTTPacket_len(len = MQTTSerialize_connectLength(options)) > buflen)
	{
		rc = MQTTPACKET_BUFFER_TOO_SHORT;
		goto exit;
	}

	header.byte = 0;
	header.bits.type = CONNECT;//mqtt包类型
	writeChar(&ptr, header.byte); /* write header */

	ptr += MQTTPacket_encode(ptr, len); /* write remaining length */

	if (options->MQTTVersion == 4)//mqtt协议版本
	{
		writeCString(&ptr, "MQTT");
		writeChar(&ptr, (char) 4);
	}
	else
	{
		writeCString(&ptr, "MQIsdp");
		writeChar(&ptr, (char) 3);//mqtt协议名称
	}

	//mqtt connect连接标志
	flags.all = 0;
	flags.bits.cleansession = options->cleansession;
	flags.bits.will = (options->willFlag) ? 1 : 0;
	if (flags.bits.will)
	{
		flags.bits.willQoS = options->will.qos;
		flags.bits.willRetain = options->will.retained;
	}

	if (options->username.cstring || options->username.lenstring.data)
		flags.bits.username = 1;
	if (options->password.cstring || options->password.lenstring.data)
		flags.bits.password = 1;

	writeChar(&ptr, flags.all);
	writeInt(&ptr, options->keepAliveInterval);  //保活计时器

	//有效载荷
	writeMQTTString(&ptr, options->clientID);
	if (options->willFlag)
	{
		writeMQTTString(&ptr, options->will.topicName);
		writeMQTTString(&ptr, options->will.message);
	}
	if (flags.bits.username)
		writeMQTTString(&ptr, options->username);
	if (flags.bits.password)
		writeMQTTString(&ptr, options->password);

	rc = ptr - buf;

	exit: FUNC_EXIT_RC(rc);
	return rc;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

本文部分内容参考mqtt-v3.1协议规范，可自行去查看详细内容。