Links2004/arduinoWebSockets
1
0
Fork 1
mirror of https://github.com/Links2004/arduinoWebSockets.git synced 2025-07-14 15:56:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

allow to moves all Header strings to Flash (~300 Byte) #152

Browse Source
This commit is contained in:
Links
2017-02-22 15:30:58 +01:00
parent e93a323e56
commit 34a2d282e4
4 changed files with 95 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/WebSockets.h
View File

@ -47,6 +47,8 @@
#define WEBSOCKETS_MAX_DATA_SIZE (15*1024) #define WEBSOCKETS_MAX_DATA_SIZE (15*1024)
#define WEBSOCKETS_USE_BIG_MEM #define WEBSOCKETS_USE_BIG_MEM
#define GET_FREE_HEAP ESP.getFreeHeap() #define GET_FREE_HEAP ESP.getFreeHeap()
// moves all Header strings to Flash (~300 Byte)
//#define WEBSOCKETS_SAVE_RAM
#else #else
#ifdef STM32_DEVICE #ifdef STM32_DEVICE
#define WEBSOCKETS_MAX_DATA_SIZE (15*1024) #define WEBSOCKETS_MAX_DATA_SIZE (15*1024)
@ -55,6 +57,8 @@
#else #else
//atmega328p has only 2KB ram! //atmega328p has only 2KB ram!
#define WEBSOCKETS_MAX_DATA_SIZE (1024) #define WEBSOCKETS_MAX_DATA_SIZE (1024)
// moves all Header strings to Flash
#define WEBSOCKETS_SAVE_RAM
#endif #endif
#endif #endif
@ -134,6 +138,12 @@
#error "no network type selected!" #error "no network type selected!"
#endif #endif
// moves all Header strings to Flash (~300 Byte)
#ifdef WEBSOCKETS_SAVE_RAM
#define WEBSOCKETS_STRING(var) F(var)
#else
#define WEBSOCKETS_STRING(var) var
#endif
typedef enum { typedef enum {
WSC_NOT_CONNECTED, WSC_NOT_CONNECTED,

103
src/WebSocketsClient.cpp
View File

@ -404,12 +404,15 @@ void WebSocketsClient::handleClientData(void) {
} }
#endif #endif
/** /**
* send the WebSocket header to Server * send the WebSocket header to Server
* @param client WSclient_t * ptr to the client struct * @param client WSclient_t * ptr to the client struct
*/ */
void WebSocketsClient::sendHeader(WSclient_t * client) { void WebSocketsClient::sendHeader(WSclient_t * client) {
static const char * NEW_LINE = "\r\n";
DEBUG_WEBSOCKETS("[WS-Client][sendHeader] sending header...\n"); DEBUG_WEBSOCKETS("[WS-Client][sendHeader] sending header...\n");
uint8_t randomKey[16] = { 0 }; uint8_t randomKey[16] = { 0 };
@ -424,45 +427,59 @@ void WebSocketsClient::sendHeader(WSclient_t * client) {
unsigned long start = micros(); unsigned long start = micros();
#endif #endif
String transport;
String handshake; String handshake;
if(!client->isSocketIO || (client->isSocketIO && client->cSessionId.length() > 0)) { bool ws_header = true;
if(client->isSocketIO) { String url = client->cUrl;
transport = "&transport=websocket&sid=" + client->cSessionId;
}
handshake = "GET " + client->cUrl + transport + " HTTP/1.1\r\n"
"Host: " + _host + ":" + _port + "\r\n"
"Connection: Upgrade\r\n"
"Upgrade: websocket\r\n"
"Sec-WebSocket-Version: 13\r\n"
"Sec-WebSocket-Key: " + client->cKey + "\r\n";
if(client->cProtocol.length() > 0) { if(client->isSocketIO) {
handshake += "Sec-WebSocket-Protocol: " + client->cProtocol + "\r\n"; if(client->cSessionId.length() == 0) {
} url += WEBSOCKETS_STRING("&transport=polling");
ws_header = false;
if(client->cExtensions.length() > 0) { } else {
handshake += "Sec-WebSocket-Extensions: " + client->cExtensions + "\r\n"; url += WEBSOCKETS_STRING("&transport=websocket&sid=");
} url += client->cSessionId;
}
} else {
handshake = "GET " + client->cUrl + "&transport=polling HTTP/1.1\r\n"
"Host: " + _host + ":" + _port + "\r\n"
"Connection: keep-alive\r\n";
} }
handshake += "Origin: file://\r\n" handshake = WEBSOCKETS_STRING("GET ");
"User-Agent: arduino-WebSocket-Client\r\n"; handshake += url + WEBSOCKETS_STRING(" HTTP/1.1\r\n"
"Host: ");
handshake += _host + ":" + _port + NEW_LINE;
if(client->base64Authorization.length() > 0) { if(ws_header) {
handshake += "Authorization: Basic " + client->base64Authorization + "\r\n"; handshake += WEBSOCKETS_STRING("Connection: Upgrade\r\n"
} "Upgrade: websocket\r\n"
"Sec-WebSocket-Version: 13\r\n"
"Sec-WebSocket-Key: ");
handshake += client->cKey + NEW_LINE;
if(client->plainAuthorization.length() > 0) { if(client->cProtocol.length() > 0) {
handshake += "Authorization: " + client->plainAuthorization + "\r\n"; handshake += WEBSOCKETS_STRING("Sec-WebSocket-Protocol: ");
} handshake +=client->cProtocol + NEW_LINE;
}
handshake += "\r\n"; if(client->cExtensions.length() > 0) {
handshake += WEBSOCKETS_STRING("Sec-WebSocket-Extensions: ");
handshake +=client->cExtensions + NEW_LINE;
}
} else {
handshake += WEBSOCKETS_STRING("Connection: keep-alive\r\n");
}
handshake += WEBSOCKETS_STRING("Origin: file://\r\n"
"User-Agent: arduino-WebSocket-Client\r\n");
if(client->base64Authorization.length() > 0) {
handshake += WEBSOCKETS_STRING("Authorization: Basic ");
handshake += client->base64Authorization + NEW_LINE;
}
if(client->plainAuthorization.length() > 0) {
handshake += WEBSOCKETS_STRING("Authorization: ");
handshake += client->plainAuthorization + NEW_LINE;
}
handshake += NEW_LINE;
DEBUG_WEBSOCKETS("[WS-Client][sendHeader] handshake %s", (uint8_t*)handshake.c_str()); DEBUG_WEBSOCKETS("[WS-Client][sendHeader] handshake %s", (uint8_t*)handshake.c_str());
client->tcp->write((uint8_t*)handshake.c_str(), handshake.length()); client->tcp->write((uint8_t*)handshake.c_str(), handshake.length());
@ -486,32 +503,32 @@ void WebSocketsClient::handleHeader(WSclient_t * client, String * headerLine) {
if(headerLine->length() > 0) { if(headerLine->length() > 0) {
DEBUG_WEBSOCKETS("[WS-Client][handleHeader] RX: %s\n", headerLine->c_str()); DEBUG_WEBSOCKETS("[WS-Client][handleHeader] RX: %s\n", headerLine->c_str());
if(headerLine->startsWith("HTTP/1.")) { if(headerLine->startsWith(WEBSOCKETS_STRING("HTTP/1."))) {
// "HTTP/1.1 101 Switching Protocols" // "HTTP/1.1 101 Switching Protocols"
client->cCode = headerLine->substring(9, headerLine->indexOf(' ', 9)).toInt(); client->cCode = headerLine->substring(9, headerLine->indexOf(' ', 9)).toInt();
} else if(headerLine->indexOf(':')) { } else if(headerLine->indexOf(':')) {
String headerName = headerLine->substring(0, headerLine->indexOf(':')); String headerName = headerLine->substring(0, headerLine->indexOf(':'));
String headerValue = headerLine->substring(headerLine->indexOf(':') + 2); String headerValue = headerLine->substring(headerLine->indexOf(':') + 2);
if(headerName.equalsIgnoreCase("Connection")) { if(headerName.equalsIgnoreCase(WEBSOCKETS_STRING("Connection"))) {
if(headerValue.equalsIgnoreCase("upgrade")) { if(headerValue.equalsIgnoreCase(WEBSOCKETS_STRING("upgrade"))) {
client->cIsUpgrade = true; client->cIsUpgrade = true;
} }
} else if(headerName.equalsIgnoreCase("Upgrade")) { } else if(headerName.equalsIgnoreCase(WEBSOCKETS_STRING("Upgrade"))) {
if(headerValue.equalsIgnoreCase("websocket")) { if(headerValue.equalsIgnoreCase(WEBSOCKETS_STRING("websocket"))) {
client->cIsWebsocket = true; client->cIsWebsocket = true;
} }
} else if(headerName.equalsIgnoreCase("Sec-WebSocket-Accept")) { } else if(headerName.equalsIgnoreCase(WEBSOCKETS_STRING("Sec-WebSocket-Accept"))) {
client->cAccept = headerValue; client->cAccept = headerValue;
client->cAccept.trim(); // see rfc6455 client->cAccept.trim(); // see rfc6455
} else if(headerName.equalsIgnoreCase("Sec-WebSocket-Protocol")) { } else if(headerName.equalsIgnoreCase(WEBSOCKETS_STRING("Sec-WebSocket-Protocol"))) {
client->cProtocol = headerValue; client->cProtocol = headerValue;
} else if(headerName.equalsIgnoreCase("Sec-WebSocket-Extensions")) { } else if(headerName.equalsIgnoreCase(WEBSOCKETS_STRING("Sec-WebSocket-Extensions"))) {
client->cExtensions = headerValue; client->cExtensions = headerValue;
} else if(headerName.equalsIgnoreCase("Sec-WebSocket-Version")) { } else if(headerName.equalsIgnoreCase(WEBSOCKETS_STRING("Sec-WebSocket-Version"))) {
client->cVersion = headerValue.toInt(); client->cVersion = headerValue.toInt();
} else if(headerName.equalsIgnoreCase("Set-Cookie")) { } else if(headerName.equalsIgnoreCase(WEBSOCKETS_STRING("Set-Cookie"))) {
if (headerValue.indexOf("HttpOnly") > -1) { if (headerValue.indexOf(WEBSOCKETS_STRING("HttpOnly")) > -1) {
client->cSessionId = headerValue.substring(headerValue.indexOf('=') + 1, headerValue.indexOf(";")); client->cSessionId = headerValue.substring(headerValue.indexOf('=') + 1, headerValue.indexOf(";"));
} else { } else {
client->cSessionId = headerValue.substring(headerValue.indexOf('=') + 1); client->cSessionId = headerValue.substring(headerValue.indexOf('=') + 1);

47
src/WebSocketsServer.cpp
View File

@ -667,6 +667,7 @@ bool WebSocketsServer::hasMandatoryHeader(String headerName) {
return false; return false;
} }
/** /**
* handles http header reading for WebSocket upgrade * handles http header reading for WebSocket upgrade
* @param client WSclient_t * ///< pointer to the client struct * @param client WSclient_t * ///< pointer to the client struct
@ -674,6 +675,8 @@ bool WebSocketsServer::hasMandatoryHeader(String headerName) {
*/ */
void WebSocketsServer::handleHeader(WSclient_t * client, String * headerLine) { void WebSocketsServer::handleHeader(WSclient_t * client, String * headerLine) {
static const char * NEW_LINE = "\r\n";
headerLine->trim(); // remove \r headerLine->trim(); // remove \r
if(headerLine->length() > 0) { if(headerLine->length() > 0) {
@ -693,25 +696,25 @@ void WebSocketsServer::handleHeader(WSclient_t * client, String * headerLine) {
String headerName = headerLine->substring(0, headerLine->indexOf(':')); String headerName = headerLine->substring(0, headerLine->indexOf(':'));
String headerValue = headerLine->substring(headerLine->indexOf(':') + 2); String headerValue = headerLine->substring(headerLine->indexOf(':') + 2);
if(headerName.equalsIgnoreCase("Connection")) { if(headerName.equalsIgnoreCase(WEBSOCKETS_STRING("Connection"))) {
headerValue.toLowerCase(); headerValue.toLowerCase();
if(headerValue.indexOf("upgrade") >= 0) { if(headerValue.indexOf(WEBSOCKETS_STRING("upgrade")) >= 0) {
client->cIsUpgrade = true; client->cIsUpgrade = true;
} }
} else if(headerName.equalsIgnoreCase("Upgrade")) { } else if(headerName.equalsIgnoreCase(WEBSOCKETS_STRING("Upgrade"))) {
if(headerValue.equalsIgnoreCase("websocket")) { if(headerValue.equalsIgnoreCase(WEBSOCKETS_STRING("websocket"))) {
client->cIsWebsocket = true; client->cIsWebsocket = true;
} }
} else if(headerName.equalsIgnoreCase("Sec-WebSocket-Version")) { } else if(headerName.equalsIgnoreCase(WEBSOCKETS_STRING("Sec-WebSocket-Version"))) {
client->cVersion = headerValue.toInt(); client->cVersion = headerValue.toInt();
} else if(headerName.equalsIgnoreCase("Sec-WebSocket-Key")) { } else if(headerName.equalsIgnoreCase(WEBSOCKETS_STRING("Sec-WebSocket-Key"))) {
client->cKey = headerValue; client->cKey = headerValue;
client->cKey.trim(); // see rfc6455 client->cKey.trim(); // see rfc6455
} else if(headerName.equalsIgnoreCase("Sec-WebSocket-Protocol")) { } else if(headerName.equalsIgnoreCase(WEBSOCKETS_STRING("Sec-WebSocket-Protocol"))) {
client->cProtocol = headerValue; client->cProtocol = headerValue;
} else if(headerName.equalsIgnoreCase("Sec-WebSocket-Extensions")) { } else if(headerName.equalsIgnoreCase(WEBSOCKETS_STRING("Sec-WebSocket-Extensions"))) {
client->cExtensions = headerValue; client->cExtensions = headerValue;
} else if(headerName.equalsIgnoreCase("Authorization")) { } else if(headerName.equalsIgnoreCase(WEBSOCKETS_STRING("Authorization"))) {
client->base64Authorization = headerValue; client->base64Authorization = headerValue;
} else { } else {
client->cHttpHeadersValid &= execHttpHeaderValidation(headerName, headerValue); client->cHttpHeadersValid &= execHttpHeaderValidation(headerName, headerValue);
@ -764,7 +767,7 @@ void WebSocketsServer::handleHeader(WSclient_t * client, String * headerLine) {
if(_base64Authorization.length() > 0) { if(_base64Authorization.length() > 0) {
if(client->base64Authorization.length() > 0) { if(client->base64Authorization.length() > 0) {
String auth = "Basic "; String auth = WEBSOCKETS_STRING("Basic ");
auth += _base64Authorization; auth += _base64Authorization;
if(auth != client->base64Authorization) { if(auth != client->base64Authorization) {
DEBUG_WEBSOCKETS("[WS-Server][%d][handleHeader] HTTP Authorization failed!\n", client->num); DEBUG_WEBSOCKETS("[WS-Server][%d][handleHeader] HTTP Authorization failed!\n", client->num);
@ -787,32 +790,30 @@ void WebSocketsServer::handleHeader(WSclient_t * client, String * headerLine) {
client->status = WSC_CONNECTED; client->status = WSC_CONNECTED;
client->tcp->write("HTTP/1.1 101 Switching Protocols\r\n" String handshake = WEBSOCKETS_STRING("HTTP/1.1 101 Switching Protocols\r\n"
"Server: arduino-WebSocketsServer\r\n" "Server: arduino-WebSocketsServer\r\n"
"Upgrade: websocket\r\n" "Upgrade: websocket\r\n"
"Connection: Upgrade\r\n" "Connection: Upgrade\r\n"
"Sec-WebSocket-Version: 13\r\n" "Sec-WebSocket-Version: 13\r\n"
"Sec-WebSocket-Accept: "); "Sec-WebSocket-Accept: ");
client->tcp->write((uint8_t*)sKey.c_str(), sKey.length()); handshake += sKey + NEW_LINE;
if(_origin.length() > 0) { if(_origin.length() > 0) {
String origin = "\r\nAccess-Control-Allow-Origin: "; handshake += WEBSOCKETS_STRING("Access-Control-Allow-Origin: ");
origin += _origin; handshake +=_origin + NEW_LINE;
origin += "\r\n";
client->tcp->write((uint8_t*)origin.c_str(), origin.length());
} }
if(client->cProtocol.length() > 0) { if(client->cProtocol.length() > 0) {
String protocol = "\r\nSec-WebSocket-Protocol: "; handshake += WEBSOCKETS_STRING("Sec-WebSocket-Protocol: ");
protocol += _protocol; handshake +=_protocol + NEW_LINE;
protocol += "\r\n";
client->tcp->write((uint8_t*)protocol.c_str(), protocol.length());
} else {
client->tcp->write("\r\n");
} }
// header end // header end
client->tcp->write("\r\n"); handshake += NEW_LINE;
DEBUG_WEBSOCKETS("[WS-Server][%d][handleHeader] handshake %s", client->num, (uint8_t*)handshake.c_str());
client->tcp->write((uint8_t*)handshake.c_str(), handshake.length());
headerDone(client); headerDone(client);

3
src/WebSocketsServer.h
View File

@ -149,8 +149,7 @@ protected:
* @param client WSclient_t * ptr to the client struct * @param client WSclient_t * ptr to the client struct
*/ */
virtual void handleAuthorizationFailed(WSclient_t *client) { virtual void handleAuthorizationFailed(WSclient_t *client) {
client->tcp->write("HTTP/1.1 401 Unauthorized\r\n"
client->tcp->write("HTTP/1.1 401 Unauthorized\r\n"
"Server: arduino-WebSocket-Server\r\n" "Server: arduino-WebSocket-Server\r\n"
"Content-Type: text/plain\r\n" "Content-Type: text/plain\r\n"
"Content-Length: 45\r\n" "Content-Length: 45\r\n"