Armin Felder / WebSocketClient

fork of WebSocketClient with some fixes

Fork of WebSocketClient by mbed_example

Websocket.cpp@10:a2686b9d28d5, 2018-01-28 (annotated)

Committer:
arminfelder
Date:
Sun Jan 28 14:45:05 2018 +0000
Revision:
10:a2686b9d28d5
Parent:
9:efa2c147bee1 
send handshake at once, to prevent compatibility issues, with some WebsocketServer implementations as for example QT5 QWebSocketServer

Who changed what in which revision?

UserRevisionLine numberNew contents of line
samux 3:9589afa4712e 1 #include "Websocket.h"
samux 3:9589afa4712e 2
samux 7:4567996414a5 3 #define MAX_TRY_WRITE 20
samux 7:4567996414a5 4 #define MAX_TRY_READ 10
samux 3:9589afa4712e 5
samux 3:9589afa4712e 6 //Debug is disabled by default
samux 3:9589afa4712e 7 #if 0
samux 3:9589afa4712e 8 #define DBG(x, ...) std::printf("[WebSocket : DBG]"x"\r\n", ##__VA_ARGS__);
samux 3:9589afa4712e 9 #define WARN(x, ...) std::printf("[WebSocket : WARN]"x"\r\n", ##__VA_ARGS__);
samux 3:9589afa4712e 10 #define ERR(x, ...) std::printf("[WebSocket : ERR]"x"\r\n", ##__VA_ARGS__);
samux 3:9589afa4712e 11 #else
samux 3:9589afa4712e 12 #define DBG(x, ...)
samux 3:9589afa4712e 13 #define WARN(x, ...)
samux 3:9589afa4712e 14 #define ERR(x, ...)
samux 3:9589afa4712e 15 #endif
samux 3:9589afa4712e 16
arminfelder 10:a2686b9d28d5 17 #define INFO(x, ...) std::printf("[WebSocket : INFO]"x"\r\n", ##__VA_ARGS__);
samux 3:9589afa4712e 18
mbed_official 9:efa2c147bee1 19 Websocket::Websocket(char * url, NetworkInterface * iface) {
samux 3:9589afa4712e 20 fillFields(url);
mbed_official 9:efa2c147bee1 21 socket.open(iface);
mbed_official 9:efa2c147bee1 22 socket.set_timeout(400);
samux 3:9589afa4712e 23 }
samux 3:9589afa4712e 24
samux 3:9589afa4712e 25 void Websocket::fillFields(char * url) {
donatien 6:86e89a0369b9 26 int ret = parseURL(url, scheme, sizeof(scheme), host, sizeof(host), &port, path, sizeof(path));
donatien 6:86e89a0369b9 27 if(ret)
donatien 6:86e89a0369b9 28 {
donatien 6:86e89a0369b9 29 ERR("URL parsing failed; please use: \"ws://ip-or-domain[:port]/path\"");
donatien 6:86e89a0369b9 30 return;
donatien 6:86e89a0369b9 31 }
samux 3:9589afa4712e 32
donatien 6:86e89a0369b9 33 if(port == 0) //TODO do handle WSS->443
donatien 6:86e89a0369b9 34 {
donatien 6:86e89a0369b9 35 port = 80;
donatien 6:86e89a0369b9 36 }
donatien 6:86e89a0369b9 37
donatien 6:86e89a0369b9 38 if(strcmp(scheme, "ws"))
donatien 6:86e89a0369b9 39 {
donatien 6:86e89a0369b9 40 ERR("Wrong scheme, please use \"ws\" instead");
donatien 6:86e89a0369b9 41 }
donatien 6:86e89a0369b9 42 }
samux 3:9589afa4712e 43
donatien 6:86e89a0369b9 44 int Websocket::parseURL(const char* url, char* scheme, size_t maxSchemeLen, char* host, size_t maxHostLen, uint16_t* port, char* path, size_t maxPathLen) //Parse URL
donatien 6:86e89a0369b9 45 {
donatien 6:86e89a0369b9 46 char* schemePtr = (char*) url;
donatien 6:86e89a0369b9 47 char* hostPtr = (char*) strstr(url, "://");
donatien 6:86e89a0369b9 48 if(hostPtr == NULL)
donatien 6:86e89a0369b9 49 {
donatien 6:86e89a0369b9 50 WARN("Could not find host");
donatien 6:86e89a0369b9 51 return -1; //URL is invalid
donatien 6:86e89a0369b9 52 }
donatien 6:86e89a0369b9 53
donatien 6:86e89a0369b9 54 if( maxSchemeLen < hostPtr - schemePtr + 1 ) //including NULL-terminating char
donatien 6:86e89a0369b9 55 {
donatien 6:86e89a0369b9 56 WARN("Scheme str is too small (%d >= %d)", maxSchemeLen, hostPtr - schemePtr + 1);
donatien 6:86e89a0369b9 57 return -1;
donatien 6:86e89a0369b9 58 }
donatien 6:86e89a0369b9 59 memcpy(scheme, schemePtr, hostPtr - schemePtr);
donatien 6:86e89a0369b9 60 scheme[hostPtr - schemePtr] = '\0';
donatien 6:86e89a0369b9 61
donatien 6:86e89a0369b9 62 hostPtr+=3;
donatien 6:86e89a0369b9 63
donatien 6:86e89a0369b9 64 size_t hostLen = 0;
samux 3:9589afa4712e 65
donatien 6:86e89a0369b9 66 char* portPtr = strchr(hostPtr, ':');
donatien 6:86e89a0369b9 67 if( portPtr != NULL )
donatien 6:86e89a0369b9 68 {
donatien 6:86e89a0369b9 69 hostLen = portPtr - hostPtr;
donatien 6:86e89a0369b9 70 portPtr++;
donatien 6:86e89a0369b9 71 if( sscanf(portPtr, "%hu", port) != 1)
donatien 6:86e89a0369b9 72 {
donatien 6:86e89a0369b9 73 WARN("Could not find port");
donatien 6:86e89a0369b9 74 return -1;
donatien 6:86e89a0369b9 75 }
donatien 6:86e89a0369b9 76 }
donatien 6:86e89a0369b9 77 else
donatien 6:86e89a0369b9 78 {
donatien 6:86e89a0369b9 79 *port=0;
donatien 6:86e89a0369b9 80 }
donatien 6:86e89a0369b9 81 char* pathPtr = strchr(hostPtr, '/');
mbed_official 9:efa2c147bee1 82 if(pathPtr == NULL)
mbed_official 9:efa2c147bee1 83 {
mbed_official 9:efa2c147bee1 84 WARN("Path not specified. Please add /[path] to the end of the websocket address");
mbed_official 9:efa2c147bee1 85 return -1;
mbed_official 9:efa2c147bee1 86 }
donatien 6:86e89a0369b9 87 if( hostLen == 0 )
donatien 6:86e89a0369b9 88 {
donatien 6:86e89a0369b9 89 hostLen = pathPtr - hostPtr;
donatien 6:86e89a0369b9 90 }
samux 3:9589afa4712e 91
donatien 6:86e89a0369b9 92 if( maxHostLen < hostLen + 1 ) //including NULL-terminating char
donatien 6:86e89a0369b9 93 {
donatien 6:86e89a0369b9 94 WARN("Host str is too small (%d >= %d)", maxHostLen, hostLen + 1);
donatien 6:86e89a0369b9 95 return -1;
donatien 6:86e89a0369b9 96 }
donatien 6:86e89a0369b9 97 memcpy(host, hostPtr, hostLen);
donatien 6:86e89a0369b9 98 host[hostLen] = '\0';
samux 3:9589afa4712e 99
donatien 6:86e89a0369b9 100 size_t pathLen;
donatien 6:86e89a0369b9 101 char* fragmentPtr = strchr(hostPtr, '#');
donatien 6:86e89a0369b9 102 if(fragmentPtr != NULL)
donatien 6:86e89a0369b9 103 {
donatien 6:86e89a0369b9 104 pathLen = fragmentPtr - pathPtr;
donatien 6:86e89a0369b9 105 }
donatien 6:86e89a0369b9 106 else
donatien 6:86e89a0369b9 107 {
donatien 6:86e89a0369b9 108 pathLen = strlen(pathPtr);
donatien 6:86e89a0369b9 109 }
donatien 6:86e89a0369b9 110
donatien 6:86e89a0369b9 111 if( maxPathLen < pathLen + 1 ) //including NULL-terminating char
donatien 6:86e89a0369b9 112 {
donatien 6:86e89a0369b9 113 WARN("Path str is too small (%d >= %d)", maxPathLen, pathLen + 1);
donatien 6:86e89a0369b9 114 return -1;
donatien 6:86e89a0369b9 115 }
donatien 6:86e89a0369b9 116 memcpy(path, pathPtr, pathLen);
donatien 6:86e89a0369b9 117 path[pathLen] = '\0';
donatien 6:86e89a0369b9 118
donatien 6:86e89a0369b9 119 return 0;
samux 3:9589afa4712e 120 }
samux 3:9589afa4712e 121
samux 3:9589afa4712e 122
samux 3:9589afa4712e 123 bool Websocket::connect() {
samux 3:9589afa4712e 124 char cmd[200];
arminfelder 10:a2686b9d28d5 125 int cmdPos = 0;
donatien 6:86e89a0369b9 126 while (socket.connect(host, port) < 0) {
donatien 6:86e89a0369b9 127 ERR("Unable to connect to (%s) on port (%d)", host, port);
samux 3:9589afa4712e 128 wait(0.2);
donatien 6:86e89a0369b9 129 return false;
samux 3:9589afa4712e 130 }
samux 3:9589afa4712e 131
samux 3:9589afa4712e 132 // sent http header to upgrade to the ws protocol
arminfelder 10:a2686b9d28d5 133 cmdPos += sprintf(cmd+cmdPos, "GET %s HTTP/1.1\r\n", path);
donatien 6:86e89a0369b9 134
arminfelder 10:a2686b9d28d5 135 cmdPos += sprintf(cmd+cmdPos, "Host: %s:%d\r\n", host, port);
samux 3:9589afa4712e 136
arminfelder 10:a2686b9d28d5 137 cmdPos += sprintf(cmd+cmdPos, "Upgrade: WebSocket\r\n");
samux 3:9589afa4712e 138
arminfelder 10:a2686b9d28d5 139 cmdPos += sprintf(cmd+cmdPos, "Connection: Upgrade\r\n");
samux 3:9589afa4712e 140
arminfelder 10:a2686b9d28d5 141 cmdPos += sprintf(cmd+cmdPos, "Sec-WebSocket-Key: L159VM0TWUzyDxwJEIEzjw==\r\n");
arminfelder 10:a2686b9d28d5 142
arminfelder 10:a2686b9d28d5 143 sprintf(cmd+cmdPos, "Sec-WebSocket-Version: 13\r\n\r\n");
samux 3:9589afa4712e 144 int ret = write(cmd, strlen(cmd));
arminfelder 10:a2686b9d28d5 145 if (ret != (int)strlen(cmd)) {
samux 3:9589afa4712e 146 close();
samux 3:9589afa4712e 147 ERR("Could not send request");
samux 3:9589afa4712e 148 return false;
samux 3:9589afa4712e 149 }
samux 3:9589afa4712e 150
samux 3:9589afa4712e 151 ret = read(cmd, 200, 100);
samux 3:9589afa4712e 152 if (ret < 0) {
samux 3:9589afa4712e 153 close();
samux 3:9589afa4712e 154 ERR("Could not receive answer\r\n");
samux 3:9589afa4712e 155 return false;
samux 3:9589afa4712e 156 }
samux 3:9589afa4712e 157
samux 3:9589afa4712e 158 cmd[ret] = '\0';
samux 3:9589afa4712e 159 DBG("recv: %s\r\n", cmd);
samux 3:9589afa4712e 160
samux 3:9589afa4712e 161 if ( strstr(cmd, "DdLWT/1JcX+nQFHebYP+rqEx5xI=") == NULL ) {
samux 3:9589afa4712e 162 ERR("Wrong answer from server, got \"%s\" instead\r\n", cmd);
samux 3:9589afa4712e 163 do {
samux 3:9589afa4712e 164 ret = read(cmd, 200, 100);
samux 3:9589afa4712e 165 if (ret < 0) {
samux 3:9589afa4712e 166 ERR("Could not receive answer\r\n");
samux 3:9589afa4712e 167 return false;
samux 3:9589afa4712e 168 }
samux 3:9589afa4712e 169 cmd[ret] = '\0';
samux 3:9589afa4712e 170 } while (ret > 0);
samux 3:9589afa4712e 171 close();
samux 3:9589afa4712e 172 return false;
samux 3:9589afa4712e 173 }
samux 3:9589afa4712e 174
donatien 6:86e89a0369b9 175 INFO("\r\nhost: %s\r\npath: %s\r\nport: %d\r\n\r\n", host, path, port);
samux 3:9589afa4712e 176 return true;
samux 3:9589afa4712e 177 }
samux 3:9589afa4712e 178
samux 4:466f90b7849a 179 int Websocket::sendLength(uint32_t len, char * msg) {
samux 3:9589afa4712e 180
samux 3:9589afa4712e 181 if (len < 126) {
samux 4:466f90b7849a 182 msg[0] = len | (1<<7);
samux 3:9589afa4712e 183 return 1;
samux 3:9589afa4712e 184 } else if (len < 65535) {
samux 4:466f90b7849a 185 msg[0] = 126 | (1<<7);
samux 4:466f90b7849a 186 msg[1] = (len >> 8) & 0xff;
samux 4:466f90b7849a 187 msg[2] = len & 0xff;
samux 3:9589afa4712e 188 return 3;
samux 3:9589afa4712e 189 } else {
samux 4:466f90b7849a 190 msg[0] = 127 | (1<<7);
samux 3:9589afa4712e 191 for (int i = 0; i < 8; i++) {
samux 4:466f90b7849a 192 msg[i+1] = (len >> i*8) & 0xff;
samux 3:9589afa4712e 193 }
samux 3:9589afa4712e 194 return 9;
samux 3:9589afa4712e 195 }
samux 3:9589afa4712e 196 }
samux 3:9589afa4712e 197
samux 3:9589afa4712e 198 int Websocket::readChar(char * pC, bool block) {
samux 3:9589afa4712e 199 return read(pC, 1, 1);
samux 3:9589afa4712e 200 }
samux 3:9589afa4712e 201
samux 4:466f90b7849a 202 int Websocket::sendOpcode(uint8_t opcode, char * msg) {
samux 4:466f90b7849a 203 msg[0] = 0x80 | (opcode & 0x0f);
samux 4:466f90b7849a 204 return 1;
samux 3:9589afa4712e 205 }
samux 3:9589afa4712e 206
samux 4:466f90b7849a 207 int Websocket::sendMask(char * msg) {
samux 3:9589afa4712e 208 for (int i = 0; i < 4; i++) {
samux 4:466f90b7849a 209 msg[i] = 0;
samux 3:9589afa4712e 210 }
samux 3:9589afa4712e 211 return 4;
samux 3:9589afa4712e 212 }
samux 3:9589afa4712e 213
samux 3:9589afa4712e 214 int Websocket::send(char * str) {
samux 4:466f90b7849a 215 char msg[strlen(str) + 15];
samux 4:466f90b7849a 216 int idx = 0;
samux 4:466f90b7849a 217 idx = sendOpcode(0x01, msg);
samux 4:466f90b7849a 218 idx += sendLength(strlen(str), msg + idx);
samux 4:466f90b7849a 219 idx += sendMask(msg + idx);
samux 4:466f90b7849a 220 memcpy(msg+idx, str, strlen(str));
samux 4:466f90b7849a 221 int res = write(msg, idx + strlen(str));
samux 3:9589afa4712e 222 return res;
samux 3:9589afa4712e 223 }
samux 3:9589afa4712e 224
samux 3:9589afa4712e 225
samux 3:9589afa4712e 226 bool Websocket::read(char * message) {
samux 3:9589afa4712e 227 int i = 0;
samux 3:9589afa4712e 228 uint32_t len_msg;
samux 3:9589afa4712e 229 char opcode = 0;
samux 3:9589afa4712e 230 char c;
samux 3:9589afa4712e 231 char mask[4] = {0, 0, 0, 0};
samux 3:9589afa4712e 232 bool is_masked = false;
samux 3:9589afa4712e 233 Timer tmr;
samux 3:9589afa4712e 234
samux 3:9589afa4712e 235 // read the opcode
samux 3:9589afa4712e 236 tmr.start();
samux 3:9589afa4712e 237 while (true) {
samux 3:9589afa4712e 238 if (tmr.read() > 3) {
samux 3:9589afa4712e 239 DBG("timeout ws\r\n");
samux 3:9589afa4712e 240 return false;
samux 3:9589afa4712e 241 }
mbed_official 9:efa2c147bee1 242
mbed_official 9:efa2c147bee1 243 socket.set_timeout(1);
mbed_official 9:efa2c147bee1 244 if (socket.recv(&opcode, 1) != 1) {
mbed_official 9:efa2c147bee1 245 socket.set_timeout(2000);
donatien 5:bb09d7a6c92f 246 return false;
donatien 5:bb09d7a6c92f 247 }
samux 3:9589afa4712e 248
mbed_official 9:efa2c147bee1 249 socket.set_timeout(2000);
samux 3:9589afa4712e 250
samux 3:9589afa4712e 251 if (opcode == 0x81)
samux 3:9589afa4712e 252 break;
samux 3:9589afa4712e 253 }
samux 3:9589afa4712e 254 DBG("opcode: 0x%X\r\n", opcode);
samux 3:9589afa4712e 255
samux 3:9589afa4712e 256 readChar(&c);
samux 3:9589afa4712e 257 len_msg = c & 0x7f;
samux 3:9589afa4712e 258 is_masked = c & 0x80;
samux 3:9589afa4712e 259 if (len_msg == 126) {
samux 3:9589afa4712e 260 readChar(&c);
samux 3:9589afa4712e 261 len_msg = c << 8;
samux 3:9589afa4712e 262 readChar(&c);
samux 3:9589afa4712e 263 len_msg += c;
samux 3:9589afa4712e 264 } else if (len_msg == 127) {
samux 3:9589afa4712e 265 len_msg = 0;
samux 3:9589afa4712e 266 for (int i = 0; i < 8; i++) {
samux 3:9589afa4712e 267 readChar(&c);
samux 3:9589afa4712e 268 len_msg += (c << (7-i)*8);
samux 3:9589afa4712e 269 }
samux 3:9589afa4712e 270 }
samux 3:9589afa4712e 271
samux 3:9589afa4712e 272 if (len_msg == 0) {
samux 3:9589afa4712e 273 return false;
samux 3:9589afa4712e 274 }
samux 3:9589afa4712e 275 DBG("length: %d\r\n", len_msg);
samux 3:9589afa4712e 276
samux 3:9589afa4712e 277 if (is_masked) {
mbed_official 9:efa2c147bee1 278 for (i = 0; i < 4; i++) {
mbed_official 9:efa2c147bee1 279 readChar(&c);
mbed_official 9:efa2c147bee1 280 mask[i] = c;
mbed_official 9:efa2c147bee1 281 }
samux 3:9589afa4712e 282 }
samux 3:9589afa4712e 283
samux 3:9589afa4712e 284 int nb = read(message, len_msg, len_msg);
samux 3:9589afa4712e 285 if (nb != len_msg)
samux 3:9589afa4712e 286 return false;
samux 3:9589afa4712e 287
samux 3:9589afa4712e 288 for (i = 0; i < len_msg; i++) {
samux 3:9589afa4712e 289 message[i] = message[i] ^ mask[i % 4];
samux 3:9589afa4712e 290 }
samux 3:9589afa4712e 291
samux 3:9589afa4712e 292 message[len_msg] = '\0';
samux 3:9589afa4712e 293
samux 3:9589afa4712e 294 return true;
samux 3:9589afa4712e 295 }
samux 3:9589afa4712e 296
samux 3:9589afa4712e 297 bool Websocket::close() {
samux 3:9589afa4712e 298
samux 3:9589afa4712e 299 int ret = socket.close();
samux 3:9589afa4712e 300 if (ret < 0) {
samux 3:9589afa4712e 301 ERR("Could not disconnect");
samux 3:9589afa4712e 302 return false;
samux 3:9589afa4712e 303 }
samux 3:9589afa4712e 304 return true;
samux 3:9589afa4712e 305 }
samux 3:9589afa4712e 306
donatien 6:86e89a0369b9 307 char* Websocket::getPath() {
samux 3:9589afa4712e 308 return path;
samux 3:9589afa4712e 309 }
samux 3:9589afa4712e 310
samux 3:9589afa4712e 311 int Websocket::write(char * str, int len) {
samux 3:9589afa4712e 312 int res = 0, idx = 0;
samux 3:9589afa4712e 313
samux 3:9589afa4712e 314 for (int j = 0; j < MAX_TRY_WRITE; j++) {
samux 3:9589afa4712e 315
mbed_official 9:efa2c147bee1 316 if ((res = socket.send(str + idx, len - idx)) < 0)
samux 3:9589afa4712e 317 continue;
samux 3:9589afa4712e 318
samux 3:9589afa4712e 319 idx += res;
samux 3:9589afa4712e 320
samux 3:9589afa4712e 321 if (idx == len)
samux 3:9589afa4712e 322 return len;
samux 3:9589afa4712e 323 }
samux 3:9589afa4712e 324
samux 3:9589afa4712e 325 return (idx == 0) ? -1 : idx;
samux 3:9589afa4712e 326 }
samux 3:9589afa4712e 327
samux 3:9589afa4712e 328 int Websocket::read(char * str, int len, int min_len) {
samux 3:9589afa4712e 329 int res = 0, idx = 0;
samux 3:9589afa4712e 330
samux 3:9589afa4712e 331 for (int j = 0; j < MAX_TRY_WRITE; j++) {
samux 3:9589afa4712e 332
mbed_official 9:efa2c147bee1 333 if ((res = socket.recv(str + idx, len - idx)) < 0)
mbed_official 9:efa2c147bee1 334 continue;
samux 3:9589afa4712e 335
samux 3:9589afa4712e 336 idx += res;
samux 3:9589afa4712e 337
samux 3:9589afa4712e 338 if (idx == len || (min_len != -1 && idx > min_len))
samux 3:9589afa4712e 339 return idx;
samux 3:9589afa4712e 340 }
samux 3:9589afa4712e 341
samux 3:9589afa4712e 342 return (idx == 0) ? -1 : idx;
samux 3:9589afa4712e 343 }