websocket server 模型

阅读量

上次我们利用一个 websocket client 的实现对 ws协议 进行了详细的解析（websocket client & ws协议解析），作为一个深度强迫症犯者，那么 websocket server 就必不可少了。

为了保证示例的简洁性，我们仅仅建立了支持单个客户端的 websocket 服务端的模型。而一般的网络编程模型，都是主进程一个事件监听连接，接收连接之后把连接对象抛给IO线程池（一般线程数量等于CPU核数），这个IO线程池每个人都有自己的epoll，来监听连接对象的可读事件，IO线程读取完数据，进行TCP粘包、半包处理，然后封装成task，最后丢给一个工作线程池来处理task，最后处理完task由一个专门的发送线程进行统一发送数据。

环境说明：

websocket server 功能流程

相比 客户端而言，服务端的流程就相对比较简单了，对比之前的一篇 websocket client & ws协议解析，我们主要对以下模块进行说明（有网络编程功底的同学可以先将例子clone下来查看，简单例子，见谅！^-^）

  • TCP协议族 client vs server 核心步骤和流程
  • 服务端生成握手信息的header
  • 解密客户端发送的数据信息
  • 服务端生成数据帧

TCP协议族 client vs server 核心步骤和流程

TCP协议族 client vs server 核心步骤和流程

服务端生成握手信息的header

服务端生成握手 header的步骤基本就是之前 client 生成验证 header的逆向思维（握手）。

1
2
3
4
5
6
HTTP/1.1 101 Switching Protocols
Upgrade: websocket
Sec-WebSocket-Version: 13
Connection: Upgrade
Server: websocket_server
Sec-WebSocket-Accept: 47N20KYf6c6Qe2+UDp2BQfK0hkw=

  • 状态码101 代表协议升级成功后的状态码
  • Connection 和 Upgrade 内容代表协议成功升级为ws
  • Sec-WebSocket-Version 和 Server 内容代表 ws协议版本 以及 服务端服务软件信息
  • Sec-WebSocket-Accept 重点在此，证明服务端接受了客户端的请求，然后客户端对accept值进行验证，任何 为空或者不符合验证规则的都视为服务器拒绝了请求。
    • 服务端生成 Sec-WebSocket-Accept 规则：服务端将客户端传递的key进行去除首尾空白，然后和一段固定的GUID（258EAFA5-E914-47DA-95CA-C5AB0DC85B11）进行连接，连接后的结果使用 SHA-1（160数位）进行哈希操作，对哈希后的字符串进行base64编码，即为 Accept 内容。
    • 客户端验证规则 仿上述规则对 Sec-WebSocket-Key 进行加密，跟服务端返回 Sec-WebSocket-Accept 值进行对比即可。

上述只是基础的 header 字段，当然还会根据具体需求添加一些 cookie 或者 其他衍生字段。

生成握手信息的实现代码片段如下（请着重注意代码注释，注意事项过程）（代码中使用的函数均会存在于完整代码中）

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
/**
 * 服务端生成握手信息
 * @param char *shake_key  客户端传递的握手Sec-WebSocket-Key
 * @param char *send_buf   握手header
 * @return int
 */
static int build_respone_header(char *shake_key, char *send_buf)
{
    const char respone_header[] = "HTTP/1.1 101 Switching Protocols\r\n"
        "Upgrade: websocket\r\n"
        "Sec-WebSocket-Version: 13\r\n"
        "Connection: Upgrade\r\n"
        "Server: websocket_server\r\n"
        "Sec-WebSocket-Accept: %s \r\n\r\n";
    const char guid[] = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"; 
    /*合并前导密钥字符*/
    strcat(shake_key, guid);
    /*使用 SHA-1（160数位）进行哈希操作*/
    char *sha1_data_temp;
    char *sha1_data;
    int n, i;
    sha1_data_temp = sha1_hash(shake_key);
    n = strlen(sha1_data_temp);
    sha1_data = (char *)calloc(1, n / 2 + 1);
    memset(sha1_data, 0, n / 2 + 1);
    for(i = 0; i < n; i += 2) {
        sha1_data[ i / 2 ] = htoi(sha1_data_temp, i, 2);
    }
    
    /*哈希后的字符串进行base64编码*/
    n = base64_encode((const uint8_t *)sha1_data, (char *)shake_key, (n / 2));
    sprintf(send_buf, respone_header, shake_key);
    return n;
}

解密客户端发送的数据信息

解包也属于 client 加密包的逆向思维（“数据帧”）。

解密客户端发送的数据信息 实现代码片段如下（请着重注意代码注释，注意事项过程）（代码中使用的函数均会存在于完整代码中）

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
/**
 * 服务端对客户端发送包进行解密
 * 
 * @param char    *recv_buf     接收包
 * @param char    *recv_text    解包后文字结果
 * 
 * @return int
 */
static int denpackage(char *recv_buf, char *recv_text)
{
    int recv_buf_len = strlen(recv_buf);
    if (recv_buf_len < 2) {
        return -1;
    }
    /*第一位fin*/
    int fin = (recv_buf[0] & 0x80) == 0x80;
    if (!fin) {
        return -1;
    }
    /*是否包含掩码*/
    int mask = (recv_buf[1] & 0x80) == 0x80;
    char mask_key[4];
    memset(mask_key, 0, 4);
    if (!mask) {
        return -1;
    }
    /*数据长度*/
    unsigned long n, payload_len = recv_buf[1] & 0x7F;
    char *payload_data;
    char temp[8] = {"\0"};
    int i;
    if (payload_len == 126) {
        memcpy(mask_key, recv_buf + 4, 4);
        payload_len = (recv_buf[2] & 0xFF) << 8 | (recv_buf[3] & 0xFF);
        payload_data = (char *)malloc(payload_len);
        memset(payload_data, 0, payload_len);
        memcpy(payload_data, recv_buf + 8, payload_len);
    } else if (payload_len == 127) {
        
        memcpy(mask_key, recv_buf + 10, 4);
        for (i = 0; i < 8; i ++) {
            temp[i] = recv_buf[9 - i];
        }
        memcpy(&n, temp, 8);
        payload_data = (char *)malloc(n);
        memset(payload_data, 0, n);
        memcpy(payload_data, recv_buf + 14, n);
        payload_len = n;
    
    } else {
    
        memcpy(mask_key, recv_buf + 2, 4);
        payload_data = (char *)malloc(payload_len);
        memset(payload_data, 0, payload_len);
        memcpy(payload_data, recv_buf + 6, payload_len);
    }
    for (i = 0; i < payload_len; i ++) {
        recv_text[i] = (char) (payload_data[i] ^ mask_key[i % 4]);
    }
    printf("recv_text: %s \n\n", recv_text);
    return 0;
}

服务端生成数据帧

打包过程与 client 基本类似，区别在于 通常client发server的数据都要 isMask(掩码) 处理, 反之server到client却不用（“数据帧”）。

服务端生成数据帧 实现代码片段如下（请着重注意代码注释，注意事项过程）（代码中使用的函数均会存在于完整代码中）

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
/**
 * 服务端生成数据帧
 * 
 * @param char    *recv_text    发送text字符
 * @param char    *send_buf     数据帧内容
 * 
 * @return int
 */
static int enpackage(char *recv_text, char *send_buf)
{
    int len = strlen(recv_text);
    /*我们这里以text为例子*/
    *send_buf++ = 0x81;
    if (len < 126) {
        *send_buf++ = len;
        memcpy(send_buf, recv_text, len);
    } else if (len < 0xFFFF) {
        
        *send_buf++ = 126;
        *send_buf++ = (len >> 8 & 0xFF);
        *send_buf++ = (len & 0xFF);
        memcpy(send_buf, recv_text, len);
    } else {
    
        return -1;
    
    }
    return 0;
}

本文作者： wettper
本文链接： http://www.web-lovers.com/c-websocket-server.html
版权声明： 本博客所有文章除特别声明外，均采用 CC BY-NC-SA 3.0 许可协议。转载请注明出处！

赏

谢谢你请我吃糖果

支付宝
微信

扫一扫，分享到微信

微信分享二维码

tag:

    缺失模块。
    1、请确保node版本大于6.2
    2、在博客根目录（注意不是yilia根目录）执行以下命令：
    npm i hexo-generator-json-content --save

    3、在根目录_config.yml里添加配置： 

      jsonContent:
    meta: false
    pages: false
    posts:
      title: true
      date: true
      path: true
      text: false
      raw: false
      content: false
      slug: false
      updated: false
      comments: false
      link: false
      permalink: false
      excerpt: false
      categories: false
      tags: true

wettper <br /><br /> 现 离职状态 程序猿 <br /><br /> 叫醒我的不止阳光，还有梦想！<br /><br /> 喵喵、念念、健身、吉他！