2 * Copyright 2016 iot.bzh
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 * This work is a far adaptation of apache-websocket:
19 * origin: https://github.com/disconnect/apache-websocket
20 * commit: cfaef071223f11ba016bff7e1e4b7c9e5df45b50
21 * Copyright 2010-2012 self.disconnect (APACHE-2)
32 #define BLOCK_DATA_SIZE 4096
34 #define FRAME_GET_FIN(BYTE) (((BYTE) >> 7) & 0x01)
35 #define FRAME_GET_RSV1(BYTE) (((BYTE) >> 6) & 0x01)
36 #define FRAME_GET_RSV2(BYTE) (((BYTE) >> 5) & 0x01)
37 #define FRAME_GET_RSV3(BYTE) (((BYTE) >> 4) & 0x01)
38 #define FRAME_GET_OPCODE(BYTE) ( (BYTE) & 0x0F)
39 #define FRAME_GET_MASK(BYTE) (((BYTE) >> 7) & 0x01)
40 #define FRAME_GET_PAYLOAD_LEN(BYTE) ( (BYTE) & 0x7F)
42 #define FRAME_SET_FIN(BYTE) (((BYTE) & 0x01) << 7)
43 #define FRAME_SET_RSV1(BYTE) (((BYTE) & 0x01) << 6)
44 #define FRAME_SET_RSV2(BYTE) (((BYTE) & 0x01) << 5)
45 #define FRAME_SET_RSV3(BYTE) (((BYTE) & 0x01) << 4)
46 #define FRAME_SET_OPCODE(BYTE) ((BYTE) & 0x0F)
47 #define FRAME_SET_MASK(BYTE) (((BYTE) & 0x01) << 7)
48 #define FRAME_SET_LENGTH(X64, IDX) (unsigned char)(((X64) >> ((IDX)*8)) & 0xFF)
50 #define OPCODE_CONTINUATION 0x0
51 #define OPCODE_TEXT 0x1
52 #define OPCODE_BINARY 0x2
53 #define OPCODE_CLOSE 0x8
54 #define OPCODE_PING 0x9
55 #define OPCODE_PONG 0xA
59 #define STATE_LENGTH 2
68 unsigned char header[14]; /* 2 + 8 + 4 */
69 const struct websock_itf *itf;
73 static ssize_t ws_writev(struct websock *ws, const struct iovec *iov, int iovcnt)
75 return ws->itf->writev(ws->closure, iov, iovcnt);
78 static ssize_t ws_readv(struct websock *ws, const struct iovec *iov, int iovcnt)
80 return ws->itf->readv(ws->closure, iov, iovcnt);
84 static ssize_t ws_write(struct websock *ws, const void *buffer, size_t buffer_size)
87 iov.iov_base = (void *)buffer; /* const cast */
88 iov.iov_len = buffer_size;
89 return ws_writev(ws, &iov, 1);
93 static ssize_t ws_read(struct websock *ws, void *buffer, size_t buffer_size)
96 iov.iov_base = buffer;
97 iov.iov_len = buffer_size;
98 return ws_readv(ws, &iov, 1);
101 static int websock_send_internal(struct websock *ws, unsigned char first, const void *buffer, size_t size)
106 unsigned char header[32];
109 header[pos++] = first;
110 size = (uint64_t) size;
112 header[pos++] = FRAME_SET_MASK(0) | FRAME_SET_LENGTH(size, 0);
115 header[pos++] = FRAME_SET_MASK(0) | 126;
117 header[pos++] = FRAME_SET_MASK(0) | 127;
118 header[pos++] = FRAME_SET_LENGTH(size, 7);
119 header[pos++] = FRAME_SET_LENGTH(size, 6);
120 header[pos++] = FRAME_SET_LENGTH(size, 5);
121 header[pos++] = FRAME_SET_LENGTH(size, 4);
122 header[pos++] = FRAME_SET_LENGTH(size, 3);
123 header[pos++] = FRAME_SET_LENGTH(size, 2);
125 header[pos++] = FRAME_SET_LENGTH(size, 1);
126 header[pos++] = FRAME_SET_LENGTH(size, 0);
129 iov[0].iov_base = header;
130 iov[0].iov_len = pos;
131 iov[1].iov_base = (void *)buffer; /* const cast */
132 iov[1].iov_len = size;
134 rc = ws_writev(ws, iov, 1 + !!size);
136 return rc < 0 ? -1 : 0;
139 static inline int websock_send(struct websock *ws, int last, int rsv1, int rsv2, int rsv3, int opcode, const void *buffer, size_t size)
141 unsigned char first = (unsigned char)(FRAME_SET_FIN(last)
142 | FRAME_SET_RSV1(rsv1)
143 | FRAME_SET_RSV1(rsv2)
144 | FRAME_SET_RSV1(rsv3)
145 | FRAME_SET_OPCODE(opcode));
146 return websock_send_internal(ws, first, buffer, size);
149 int websock_close(struct websock *ws)
151 return websock_send(ws, 1, 0, 0, 0, OPCODE_CLOSE, NULL, 0);
154 int websock_close_code(struct websock *ws, uint16_t code, const void *data, size_t length)
156 unsigned char buffer[125];
158 /* checks the length */
164 /* prepare the buffer */
165 buffer[0] = (unsigned char)((code >> 8) & 0xFF);
166 buffer[1] = (unsigned char)(code & 0xFF);
168 memcpy(&buffer[2], data, length);
170 /* Send server-side closing handshake */
171 return websock_send(ws, 1, 0, 0, 0, OPCODE_CLOSE, buffer, 2 + length);
174 int websock_ping(struct websock *ws, const void *data, size_t length)
176 /* checks the length */
182 return websock_send(ws, 1, 0, 0, 0, OPCODE_PING, data, length);
185 int websock_pong(struct websock *ws, const void *data, size_t length)
187 /* checks the length */
193 return websock_send(ws, 1, 0, 0, 0, OPCODE_PONG, data, length);
196 int websock_text(struct websock *ws, int last, const char *text, size_t length)
198 return websock_send(ws, last, 0, 0, 0, OPCODE_TEXT, text, length);
201 int websock_binary(struct websock *ws, int last, const void *data, size_t length)
203 return websock_send(ws, last, 0, 0, 0, OPCODE_BINARY, data, length);
206 static int read_header(struct websock *ws)
208 if (ws->lenhead < ws->szhead) {
210 ws_read(ws, &ws->header[ws->lenhead], (size_t)(ws->szhead - ws->lenhead));
213 ws->lenhead += (int)rbc;
218 static int check_control_header(struct websock *ws)
221 if (FRAME_GET_RSV1(ws->header[0]) != 0)
223 if (FRAME_GET_RSV2(ws->header[0]) != 0)
225 if (FRAME_GET_RSV3(ws->header[0]) != 0)
227 if (FRAME_GET_PAYLOAD_LEN(ws->header[1]) > 125)
229 if (FRAME_GET_OPCODE(ws->header[0]) == OPCODE_CLOSE)
230 return FRAME_GET_PAYLOAD_LEN(ws->header[1]) != 1;
234 int websock_dispatch(struct websock *ws)
242 ws->state = STATE_START;
245 /* read the header */
248 else if (ws->lenhead < ws->szhead)
251 switch (FRAME_GET_OPCODE(ws->header[0])) {
252 case OPCODE_CONTINUATION:
257 if (!check_control_header(ws))
259 if (FRAME_GET_PAYLOAD_LEN(ws->header[1]))
264 if (!check_control_header(ws))
269 /* update heading size */
270 switch (FRAME_GET_PAYLOAD_LEN(ws->header[1])) {
276 ws->szhead += 4 * FRAME_GET_MASK(ws->header[1]);
278 ws->state = STATE_LENGTH;
281 /* continue to read the header */
284 else if (ws->lenhead < ws->szhead)
288 switch (FRAME_GET_PAYLOAD_LEN(ws->header[1])) {
290 ws->length = (((uint64_t) ws->header[2]) << 56)
291 | (((uint64_t) ws->header[3]) << 48)
292 | (((uint64_t) ws->header[4]) << 40)
293 | (((uint64_t) ws->header[5]) << 32)
294 | (((uint64_t) ws->header[6]) << 24)
295 | (((uint64_t) ws->header[7]) << 16)
296 | (((uint64_t) ws->header[8]) << 8)
297 | (uint64_t) ws->header[9];
300 ws->length = (((uint64_t) ws->header[2]) << 8)
301 | (uint64_t) ws->header[3];
304 ws->length = FRAME_GET_PAYLOAD_LEN(ws->header[1]);
307 if (FRAME_GET_OPCODE(ws->header[0]) == OPCODE_CLOSE && ws->length != 0)
309 if (ws->length > ws->maxlength)
313 if (FRAME_GET_MASK(ws->header[1])) {
314 ((unsigned char *)&ws->mask)[0] = ws->header[ws->szhead - 4];
315 ((unsigned char *)&ws->mask)[1] = ws->header[ws->szhead - 3];
316 ((unsigned char *)&ws->mask)[2] = ws->header[ws->szhead - 2];
317 ((unsigned char *)&ws->mask)[3] = ws->header[ws->szhead - 1];
321 /* all heading fields are known, process */
322 ws->state = STATE_DATA;
323 if (ws->itf->on_extension != NULL) {
324 if (ws->itf->on_extension(ws->closure,
325 FRAME_GET_FIN(ws->header[0]),
326 FRAME_GET_RSV1(ws->header[0]),
327 FRAME_GET_RSV2(ws->header[0]),
328 FRAME_GET_RSV3(ws->header[0]),
329 FRAME_GET_OPCODE(ws->header[0]),
330 (size_t) ws->length)) {
335 /* not an extension case */
336 if (FRAME_GET_RSV1(ws->header[0]) != 0)
338 if (FRAME_GET_RSV2(ws->header[0]) != 0)
340 if (FRAME_GET_RSV3(ws->header[0]) != 0)
344 switch (FRAME_GET_OPCODE(ws->header[0])) {
345 case OPCODE_CONTINUATION:
346 ws->itf->on_continue(ws->closure,
347 FRAME_GET_FIN(ws->header[0]),
348 (size_t) ws->length);
351 ws->itf->on_text(ws->closure,
352 FRAME_GET_FIN(ws->header[0]),
353 (size_t) ws->length);
356 ws->itf->on_binary(ws->closure,
357 FRAME_GET_FIN(ws->header[0]),
358 (size_t) ws->length);
362 code = WEBSOCKET_CODE_NOT_SET;
364 code = (uint16_t)(ws->header[ws->szhead - 2] & 0xff);
365 code = (uint16_t)(code << 8);
366 code = (uint16_t)(code | (uint16_t)(ws->header[ws->szhead - 1] & 0xff));
368 ws->itf->on_close(ws->closure, code, (size_t) ws->length);
371 if (ws->itf->on_ping)
372 ws->itf->on_ping(ws->closure, ws->length);
375 websock_pong(ws, NULL, 0);
377 ws->state = STATE_INIT;
380 if (ws->itf->on_pong)
381 ws->itf->on_pong(ws->closure, ws->length);
384 ws->state = STATE_INIT;
394 ws->state = STATE_INIT;
400 websock_close_code(ws, WEBSOCKET_CODE_MESSAGE_TOO_LARGE, NULL, 0);
404 websock_close_code(ws, WEBSOCKET_CODE_PROTOCOL_ERROR, NULL, 0);
408 ssize_t websock_read(struct websock * ws, void *buffer, size_t size)
414 if (ws->state != STATE_DATA)
417 if (size > ws->length)
418 size = (size_t) ws->length;
420 rc = ws_read(ws, buffer, size);
428 while (size && ((sizeof(uint32_t) - 1) & (uintptr_t) b8)) {
429 m = ((uint8_t *) & mask)[0];
430 ((uint8_t *) & mask)[0] = ((uint8_t *) & mask)[1];
431 ((uint8_t *) & mask)[1] = ((uint8_t *) & mask)[2];
432 ((uint8_t *) & mask)[2] = ((uint8_t *) & mask)[3];
433 ((uint8_t *) & mask)[3] = m;
437 b32 = (uint32_t *) b8;
438 while (size >= sizeof(uint32_t)) {
440 size -= sizeof(uint32_t);
442 b8 = (uint8_t *) b32;
444 m = ((uint8_t *) & mask)[0];
445 ((uint8_t *) & mask)[0] = ((uint8_t *) & mask)[1];
446 ((uint8_t *) & mask)[1] = ((uint8_t *) & mask)[2];
447 ((uint8_t *) & mask)[2] = ((uint8_t *) & mask)[3];
448 ((uint8_t *) & mask)[3] = m;
458 int websock_drop(struct websock *ws)
463 if (ws_read(ws, buffer, sizeof buffer) < 0)
468 struct websock *websock_create_v13(const struct websock_itf *itf, void *closure)
470 struct websock *result = calloc(1, sizeof *result);
473 result->closure = closure;
474 result->maxlength = 65000;
479 void websock_destroy(struct websock *ws)