/** * @file WebSockets.cpp * @date 20.05.2015 * @author Markus Sattler * * Copyright (c) 2015 Markus Sattler. All rights reserved. * This file is part of the WebSockets for Arduino. * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA * */ #include "WebSockets.h" extern "C" { #include "libb64/cencode.h" } #include /** * * @param client WSclient_t * ptr to the client struct * @param code uint16_t see RFC * @param reason * @param reasonLen */ void WebSockets::clientDisconnect(WSclient_t * client, uint16_t code, char * reason, size_t reasonLen) { if(client->status == WSC_CONNECTED && code) { if(reason) { sendFrame(client, WSop_close, (uint8_t *) reason, reasonLen); } else { uint8_t buffer[2]; buffer[0] = ((code >> 8) & 0xFF); buffer[1] = (code & 0xFF); sendFrame(client, WSop_close, &buffer[0], 2); } } clientDisconnect(client); } /** * * @param client WSclient_t * ptr to the client struct * @param opcode WSopcode_t * @param payload uint8_t * * @param length size_t */ void WebSockets::sendFrame(WSclient_t * client, WSopcode_t opcode, uint8_t * payload, size_t length) { uint8_t buffer[16] = { 0 }; uint8_t i = 0; //create header buffer[i] = bit(7); // set Fin buffer[i++] |= opcode; // set opcode if(length < 126) { buffer[i++] = length; } else if(length < 0xFFFF) { buffer[i++] = 126; buffer[i++] = ((length >> 8) & 0xFF); buffer[i++] = (length & 0xFF); } else { // normaly we never get here (to less memory) buffer[i++] = 127; buffer[i++] = 0x00; buffer[i++] = 0x00; buffer[i++] = 0x00; buffer[i++] = 0x00; buffer[i++] = ((length >> 24) & 0xFF); buffer[i++] = ((length >> 16) & 0xFF); buffer[i++] = ((length >> 8) & 0xFF); buffer[i++] = (length & 0xFF); } // send header client->tcp.write(&buffer[0], i); if(payload && length > 0) { // send payload client->tcp.write(&payload[0], length); } } /** * handle the WebSocket stream * @param client WSclient_t * ptr to the client struct */ void WebSockets::handleWebsocket(WSclient_t * client) { uint8_t buffer[8] = { 0 }; bool fin; bool rsv1; bool rsv2; bool rsv3; WSopcode_t opCode; bool mask; size_t payloadLen; uint8_t maskKey[4]; uint8_t * payload = NULL; DEBUG_WEBSOCKETS("[WS-Server][%d][handleWebsocket] ------- read massage frame -------\n", client->num); if(!readWait(client, buffer, 2)) { //timeout clientDisconnect(client, 1002); return; } // split first 2 bytes in the data fin = ((buffer[0] >> 7) & 0x01); rsv1 = ((buffer[0] >> 6) & 0x01); rsv2 = ((buffer[0] >> 5) & 0x01); rsv3 = ((buffer[0] >> 4) & 0x01); opCode = (WSopcode_t) (buffer[0] & 0x0F); mask = ((buffer[1] >> 7) & 0x01); payloadLen = (WSopcode_t) (buffer[1] & 0x7F); if(payloadLen == 126) { if(!readWait(client, buffer, 2)) { //timeout clientDisconnect(client, 1002); return; } payloadLen = buffer[0] << 8 | buffer[1]; } else if(payloadLen == 127) { // read 64bit inteager as length if(!readWait(client, buffer, 8)) { //timeout clientDisconnect(client, 1002); return; } if(buffer[0] != 0 || buffer[1] != 0 || buffer[2] != 0 || buffer[3] != 0) { // really to big! payloadLen = 0xFFFFFFFF; } else { payloadLen = buffer[4] << 24 | buffer[5] << 16 | buffer[6] << 8 | buffer[7]; } } DEBUG_WEBSOCKETS("[WS-Server][%d][handleWebsocket] fin: %u rsv1: %u rsv2: %u rsv3 %u opCode: %u\n", client->num, fin, rsv1, rsv2, rsv3, opCode); DEBUG_WEBSOCKETS("[WS-Server][%d][handleWebsocket] mask: %u payloadLen: %u\n", client->num, mask, payloadLen); if(payloadLen > WEBSOCKETS_MAX_DATA_SIZE) { DEBUG_WEBSOCKETS("[WS-Server][%d][handleWebsocket] payload to big! (%u)\n", client->num, payloadLen); clientDisconnect(client, 1009); return; } if(mask) { client->tcp.read(maskKey, 4); } if(payloadLen > 0) { // if text data we need one more payload = (uint8_t *) malloc(payloadLen + 1); if(!payload) { DEBUG_WEBSOCKETS("[WS-Server][%d][handleWebsocket] to less memory to handle payload %d!\n", client->num, payloadLen); clientDisconnect(client, 1011); return; } if(!readWait(client, payload, payloadLen)) { DEBUG_WEBSOCKETS("[WS-Server][%d][handleWebsocket] missing data!\n", client->num); free(payload); clientDisconnect(client, 1002); return; } payload[payloadLen] = 0x00; if(mask) { //decode XOR for(size_t i = 0; i < payloadLen; i++) { payload[i] = (payload[i] ^ maskKey[i % 4]); } } } switch(opCode) { case WSop_text: DEBUG_WEBSOCKETS("[WS-Server][%d][handleWebsocket] text: %s\n", client->num, payload); // no break here! case WSop_binary: messageRecived(client, opCode, payload, payloadLen); break; case WSop_ping: // send pong back sendFrame(client, WSop_pong, payload, payloadLen); break; case WSop_pong: DEBUG_WEBSOCKETS("[WS-Server][%d][handleWebsocket] get pong from Client (%s)\n", client->num, payload); break; case WSop_close: { uint16_t reasonCode = 1000; if(payloadLen >= 2) { reasonCode = payload[0] << 8 | payload[1]; } DEBUG_WEBSOCKETS("[WS-Server][%d][handleWebsocket] client ask for close. Code: %d", client->num, reasonCode); if(payloadLen > 2) { DEBUG_WEBSOCKETS("(%s)\n", (payload+2)); } else { DEBUG_WEBSOCKETS("\n"); } clientDisconnect(client, 1000); } break; case WSop_continuation: // continuation is not supported clientDisconnect(client, 1003); break; default: clientDisconnect(client, 1002); break; } if(payload) { free(payload); } } /** * generate the key for Sec-WebSocket-Accept * @param clientKey String * @return String Accept Key */ String WebSockets::acceptKey(String clientKey) { uint8_t sha1HashBin[20] = { 0 }; sha1(clientKey + "258EAFA5-E914-47DA-95CA-C5AB0DC85B11", &sha1HashBin[0]); String key = base64_encode(sha1HashBin, 20); key.trim(); return key; } /** * base64_encode * @param data uint8_t * * @param length size_t * @return base64 encoded String */ String WebSockets::base64_encode(uint8_t * data, size_t length) { char * buffer = (char *) malloc((length*1.4)+1); if(buffer) { base64_encodestate _state; base64_init_encodestate(&_state); int len = base64_encode_block((const char *) &data[0], length, &buffer[0], &_state); len = base64_encode_blockend((buffer + len), &_state); String base64 = String(buffer); free(buffer); return base64; } return "-FAIL-"; } /** * read x byte from tcp or get timeout * @param client WSclient_t * * @param out uint8_t * data buffer * @param n size_t byte count * @return true if ok */ bool WebSockets::readWait(WSclient_t * client, uint8_t *out, size_t n) { unsigned long t = millis(); size_t len; while(n > 0) { if(!client->tcp.connected()) { DEBUG_WEBSOCKETS("[readWait] Receive not connected - 1!\n"); return false; } while(!client->tcp.available()) { if(!client->tcp.connected()) { DEBUG_WEBSOCKETS("[readWait] Receive not connected - 2!\n"); return false; } if((millis() - t) > WEBSOCKETS_TCP_TIMEOUT) { DEBUG_WEBSOCKETS("[readWait] Receive TIMEOUT!\n"); return false; } delay(0); } len = client->tcp.read((uint8_t*) out, n); if(len) { t = millis(); out += len; n -= len; //DEBUG_WEBSOCKETS("Receive %d left %d!\n", len, n); } else { //DEBUG_WEBSOCKETS("Receive %d left %d!\n", len, n); } delay(0); } return true; }