向东博客 专注WEB应用 构架之美 --- 构架之美，在于尽态极妍 | 应用之美，在于药到病除|赢在IT，Playin' with IT,Focus on Killer Application,Marketing Meets Technology.

WebSocket数据包协议详解
smark
https://github.com/IKende/

WebSocket数据包协议详解

其实我一直想不明白HTML5包装个应用层办议作为Socket通过基础目的是为了什么,其实直接支持Socket tcp相对来说更加简单灵活.既然标准已经制定而浏览器也支持那对于我们开发者来说只能用的分.最新版本的WebSocket协议于2011-12其标准规范已经明确下来,所以现在可以根据这标准进行相应的开发.详细参考http://datatracker.ietf.org/doc/rfc6455/?include_text=1

WebSocket协议主要分为两部分,第一部分是连接许可验证和验证后的数据交互.连接许可验证比较简单,由Client发送一个类似于HTTP的请求,服务端获取请求后根据请求的KEY生成对应的值并返回.

连接请求内容:
GET / HTTP/1.1
Connection:Upgrade
Host:127.0.0.1:8088
Origin:null
Sec-WebSocket-Extensions:x-webkit-deflate-frame
Sec-WebSocket-Key:puVOuWb7rel6z2AVZBKnfw==
Sec-WebSocket-Version:13
Upgrade:websocket
服务端接收请求后主要是成针对Sec-WebSocket-Key生成对就Sec-WebSocket-Accept 的key,生成Sec-WebSocket-Accept 值比较简单就是Sha1(Sec-WebSocket-Key+258EAFA5-E914-47DA-95CA-C5AB0DC85B11)即可,C#代码如下:
SHA1 sha1 = new SHA1CryptoServiceProvider();
byte[] bytes_sha1_in = Encoding.UTF8.GetBytes(request.SecWebSocketKey+ "258EAFA5-E914-47DA-95CA-C5AB0DC85B11");
byte[] bytes_sha1_out = sha1.ComputeHash(bytes_sha1_in);
string str_sha1_out = Convert.ToBase64String(bytes_sha1_out);
response.SecWebSocketAccept = str_sha1_out;
服务端返回内容:
HTTP/1.1 101 Switching Protocols
Connection:Upgrade
Server:beetle websocket server
Upgrade:WebSocket
Date:Mon, 26 Nov 2012 23:42:44 GMT
Access-Control-Allow-Credentials:true
Access-Control-Allow-Headers:content-type
Sec-WebSocket-Accept:FCKgUr8c7OsDsLFeJTWrJw6WO8Q=
经过服务器的返回处理后连接握手成功,后面就可以进行TCP通讯.WebSocket在握手后发送数据并象下层TCP协议那样由用户自定义,还是需要遵循对应的应用协议规范...这也是在文章之说没有直接基于Socket tcp方便的原因.

数据交互协议:
这图有点难看懂...里面包括几种情况有掩码,数据长度小于126,小于UINT16和小于UINT64等几种情况.后面会慢慢详细说明.整个协议头大概分三部分组成,第一部分是描述消息结束情况和类型,第二部分是描述是否存在掩码长度,第三部分是扩展长度描述和掩码值.

从图中可以看到WebSocket协议数据主要通过头两个字节来描述数据包的情况

第一个字节

最高位用于描述消息是否结束,如果为1则该消息为消息尾部,如果为零则还有后续数据包;后面3位是用于扩展定义的,如果没有扩展约定的情况则必须为0.可以通过以下c#代码方式得到相应值
mDataPackage.IsEof = (data[start] >> 7) > 0;
最低4位用于描述消息类型,消息类型暂定有15种,其中有几种是预留设置.c#代码可以这样得到消息类型:

int type = data[start] & 0xF;
mDataPackage.Type = (PackageType)type;
第二个字节

消息的第二个字节主要用一描述掩码和消息长度,最高位用0或1来描述是否有掩码处理,可以通过以下c#代码方式得到相应值
bool hasMask = (data[start] >>7) > 0;
剩下的后面7位用来描述消息长度,由于7位最多只能描述127所以这个值会代表三种情况,一种是消息内容少于126存储消息长度,如果消息长度少于UINT16的情况此值为126,当消息长度大于UINT16的情况下此值为127;这两种情况的消息长度存储到紧随后面的byte[],分别是UINT16(2位byte)和UINT64(4位byte).可以通过以下c#代码方式得到相应值
mPackageLength = (uint)(data[start] & 0x7F);
start++;
if (mPackageLength == 126)
{
    mPackageLength = BitConverter.ToUInt16(data, start);
    start = start + 2;
}
else if (mPackageLength == 127)
{
    mPackageLength = BitConverter.ToUInt64(data, start);
    start = start + 8;
}
如果存在掩码的情况下获取4位掩码值:
if (hasMask)
{
    mDataPackage.Masking_key = new byte[4];
    Buffer.BlockCopy(data, start, mDataPackage.Masking_key, 0, 4);
          
    start = start + 4;
    count = count - 4;
}
获取消息体

当得到消息体长度后就可以获取对应长度的byte[],有些消息类型是没有长度的如%x8 denotes a connection close.对于Text类型的消息对应的byte[]是相应字符的UTF8编码.获取消息体还有一个需要注意的地方就是掩码,如果存在掩码的情况下接收的byte[]要做如下转换处理:
if (mDataPackage.Masking_key != null)
    {
        int length = mDataPackage.Data.Count;
        for (var i = 0; i < length; i++)
            mDataPackage.Data.Array[i] = (byte)(mDataPackage.Data.Array[i] ^ mDataPackage.Masking_key[i % 4]);
    }

来自：http://www.cnblogs.com/smark/archive/2012/11/26/2789812.html


webSocket 服务器端的简单实现
上周研究了一下HTML5.
发现很多令人激动的功能。
路漫漫其修远兮，吾将上下而求索！

1. 内置数据库
2. 支持WebSocket
3. 支持多线程
4. 支持本地存储

但是，仍然处于草案中的 WebSocket 竟然找不到合适的服务器，刚好工作比较闲，用来三天时间自己写了一个。
功能有点简单！设计上也有很大缺陷。只能简单的发送信息，和推送信息。
而且现在的协议还不成熟，不久就有一个版本出现！昨天看到才是V16，今天出V17了。

简单介绍一下 WebSocket 它是实现了浏览器与服务器的全双工信息传输。Websocket协议基于Http 的 Upgrade 头和101的响应进行协议切换。经过简单的握手协议，建立一个长连接，按照协议的规则进行数据的传输。具体介绍可以参考google.

1.握手协议
版本0--3中：
握手通过请求头Sec-WebSocket-Key1 和 Sec-WebSocket-Key2 的值和 8 字节的请求实体，进行MD5加密，将加密结果，构造出一个16字节作为请求实体的内容返回。如下实例：
------------------请求--------------------------------------------


GET /demo HTTP/1.1
Host: example.com
Connection: Upgrade
Sec-WebSocket-Key2: 12998 5 Y3 1  .P00
Sec-WebSocket-Protocol: sample
Upgrade: WebSocket
Sec-WebSocket-Key1: 4 @1  46546xW%0l 1 5
Origin: http://example.com
(\r\n)
^n:ds[4U


------------------响应--------------------------------------------

HTTP/1.1 101 WebSocket Protocol Handshake
Upgrade: WebSocket
Connection: Upgrade
Sec-WebSocket-Origin: http://example.com
Sec-WebSocket-Location: ws://example.com/demo
Sec-WebSocket-Protocol: sample
(\r\n)
8jKS'y:G*Co,Wxa-


------------------------------

把第一个Key中的数字除以第一个Key的空白字符的数量，而第二个Key也是如此，这样得到两个整数，把每个整数写的四个字节里去，串为8个字节，然后和请求实体里面的8个字节串为16字节，将这16个字节进行MD5加密（如实例中的结果：8jKS'y:G*Co,Wxa-），得到一个16字节的数据作为响应实体的内容，返回给客户端，这样握手成功。


代码实现：

int len = 8; // in.available();
byte[] key3 = new byte[len];
if (in.read(key3) != len)
  throw new RuntimeException();
log.debug(HelpUtil.formatBytes(key3));
String key1 = requestHeaders.get("Sec-WebSocket-Key1");
String key2 = requestHeaders.get("Sec-WebSocket-Key2");
int k1 = HelpUtil.parseWebsokcetKey(key1);
int k2 = HelpUtil.parseWebsokcetKey(key2);

byte[] sixteenByte = new byte[16];
System.arraycopy(HelpUtil.intTo4Byte(k1), 0, sixteenByte, 0, 4);
System.arraycopy(HelpUtil.intTo4Byte(k2), 0, sixteenByte, 4, 4);
System.arraycopy(key3, 0, sixteenByte, 8, 8);
byte[] md5 = MessageDigest.getInstance("MD5").digest(sixteenByte);





在版本4之后，握手协议修改了：
------------------请求--------------------------------------------

GET /chat HTTP/1.1
Host: server.example.com
Upgrade: websocket
Connection: Upgrade
Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==
Sec-WebSocket-Origin: http://example.com
Sec-WebSocket-Protocol: chat, superchat
(\r\n)



------------------响应--------------------------------------------

HTTP/1.1 101 Switching Protocols
Upgrade: websocket
Connection: Upgrade
Sec-WebSocket-Accept: me89jWimTRKTWwrS3aRrL53YZSo=
Sec-WebSocket-Nonce: AQIDBAUGBwgJCgsMDQ4PEC==
Sec-WebSocket-Protocol: chat



使用请求头的值 Sec-WebSocket-Key，该值是BASE-64编码（base64-encoded）的，我们不需要转码，加上一个魔幻字符串： "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"，（结果：[dGhlIHNhbXBsZSBub25jZQ==258EAFA5-E914-47DA-95CA-C5AB0DC85B11]）使用 SHA-1 加密，之后进行 BASE-64编码，将结果做为 Sec-WebSocket-Accept 头的值，返回给客户端。
如果服务器端有 Sec-WebSocket-Nonce 头，表示要在Sec-WebSocket-Key 的值，和魔幻字符串之间加入该 Sec-WebSocket-Nonce 头的值，即“dGhlIHNhbXBsZSBub25jZQ==AQIDBAUGBwgJCgsMDQ4PEC==258EAFA5-E914-47DA-95CA-C5AB0DC85B11”，进行 SHA-1 加密，之后和前面的相同。完成握手协议。

更多查看：http://www.myexception.cn/web/475595.html

Qt websocket协议的实现：
http://www.cnblogs.com/danju/p/3691643.html

作者：jackxiang@向东博客 专注WEB应用 构架之美 --- 构架之美，在于尽态极妍 | 应用之美，在于药到病除
地址：https://jackxiang.com/post/7427/
版权所有。转载时必须以链接形式注明作者和原始出处及本声明！