大家好，又见面了，我是你们的朋友全栈君。

一、stun协议格式

1、STUN报文头

stun协议笔记一（stun格式简介）「建议收藏」

1）最高的2位必须置零，这可以在当STUN和其他协议复用的时候，用来区分STUN包和其他数据包。

2）STUN Message Type 字段定义了消息的类型（请求/成功响应/失败响应/指示）和消息的主方法。
虽然我们有4个消息类别，但在STUN中只有两种类型的事务，即请求/响应类型和指示类型。响应类型分为成功和出错两种，用来帮助快速处理STUN信息。Message Type字段又可以进一步分解为如下结构：

stun协议笔记一（stun格式简介）「建议收藏」

其中显示的位为从最高有效位M11到最低有效位M0，M11到M0表示方法的12位编码。C1和C0两位表示类的编码。

因此：MessageType=MessageClass | MessageMethod

例如对于binding方法来说，

MessageClass定义：0b00表示request，0b01表示indication，0b10表示success response，0b11表示error response

Message Method定义为0x001

所以binding的MessageType的定义如下枚举值：

stun协议笔记一（stun格式简介）「建议收藏」

每一个method都有可能对应不同的传输类别。方法和类是正交的，因此对于每种方法，对该方法的请求，成功响应，错误响应和指示都是可能的。拓展定义新方法的时候注意要指定该方法允许哪些类型的消息。

根据RFC5766定义，音视频通讯经常使用的Stun Methods定义如下：

stun协议笔记一（stun格式简介）「建议收藏」

3）Message Length 字段存储了信息的长度，以字节为单位，不包括20字节的STUN头部。由于所有的STUN属性都是都是4字节对齐（填充）的，因此这个字段最后两位应该恒等于零，这也是辨别STUN包的一个方法之一。

4）Magic Cookie 字段包含固定值0x2112A442，这是为了前向兼容RFC3489，因为在classic STUN中，这一区域是事务ID的一部分。另外选择固定数值也是为了服务器判断客户端是否能识别特定的属性。还有一个作用就是在协议多路复用时候也可以将其作为判断标志之一

5）Transaction ID 字段是个96位的标识符，用来区分不同的STUN传输事务。对于request/response传输，事务ID由客户端选择，服务器收到后以同样的事务ID返回response；对于indication则由发送方自行选择。事务ID的主要功能是把request和response联系起来，同时也在防止攻击方面有一定作用。服务端也把事务ID当作一个Key来识别不同的STUN客户端，因此必须格式化且随机在0~2^(96-1)之间。重发同样的request请求时可以重用相同的事务ID，但是客户端进行新的传输时，必须选择一个新的事务ID。

2、STUN报文属性（attributes）

在STUN报文头部之后，通常跟着0个或者多个属性，每个属性必须是TLV编码的（Type-Length-Value）。其中Type字段和Length字段都是16位，Value字段为为32位表示，如下：

stun协议笔记一（stun格式简介）「建议收藏」

attributes的Type定义如下：

stun协议笔记一（stun格式简介）「建议收藏」

webrtc的代码定义：

stun协议笔记一（stun格式简介）「建议收藏」

wireshark抓包示例：

stun协议笔记一（stun格式简介）「建议收藏」

下面简要介绍几个常见属性的定义：

1）MAPPED-ADDRESS

MAPPED-ADDRESS用来表示NAT客户端的反射地址。

stun协议笔记一（stun格式简介）「建议收藏」

Family为IP类型，即IPV4(0x01)或IPV6(0x02)，Port为端口，Address为32位或128位的IP地址。注意Family前面的高8位必须全部置零，而且接收端必须要将其忽略掉。

stun协议笔记一（stun格式简介）「建议收藏」

2）XOR-MAPPED-ADDRESS

和MAPPED-ADDRESS基本相同，不同点是反射地址部分经过了一次异或（XOR）处理。

stun协议笔记一（stun格式简介）「建议收藏」

对于X-Port字段，是将NAT的映射端口以小端形式与magic cookie的高16位进行异或，再将结果转换成大端形式而得到的，X-Address也是类似。

stun协议笔记一（stun格式简介）「建议收藏」

之所以要经过这么一次转换，是因为在实践中发现很多NAT会修改payload中自身公网IP的32位数据，从而导致NAT打洞失败。

3）ERROR-CODE

该属性用于error response报文中。包含了300-699表示的错误代码，以及一个UTF-8格式的文字出错信息（Reason Phrase）。

stun协议笔记一（stun格式简介）「建议收藏」

其中返回码定义：

stun协议笔记一（stun格式简介）「建议收藏」

300：尝试代替(Try Alternate)，客户端应该使用该请求联系一个代替的服务器。这个错误响应仅在请求包括一个 USERNAME属性和一个有效的MESSAGE-INTEGRITY属性时发送；否则它不会被发送，而是发送错误代码为400的错误响应；
400：错误请求(Bad Request)，请求变形了，客户端在修改先前的尝试前不应该重试该请求。
401：未授权(Unauthorized)，请求未包括正确的资格来继续。客户端应该采用一个合适的资格来重试该请求。
420：未知属性(Unknown Attribute)，服务器收到一个STUN包包含一个强制理解的属性但是它不会理解。服务器必须将不认识的属性放在错误响应的UNKNOWN-ATTRIBUTE属性中。
438：过期Nonce(Stale Nonce)，客户端使用的Nonce不再有效，应该使用响应中提供的Nonce来重试。
500：服务器错误(Server Error)，服务器遇到临时错误，客户端应该再次尝试。

stun协议笔记一（stun格式简介）「建议收藏」