From 83ac64b72b8aafb6c12725221b643548898c9244 Mon Sep 17 00:00:00 2001 From: Markus Sattler Date: Thu, 10 Dec 2015 11:16:08 +0100 Subject: [PATCH] add support for AVR this need some more testing but basics are done --- README.md | 15 ++- library.properties | 2 +- src/WebSockets.cpp | 13 ++- src/WebSockets.h | 5 +- src/WebSocketsClient.h | 11 --- src/WebSocketsServer.cpp | 25 ++++- src/WebSocketsServer.h | 12 +-- src/libsha1/libsha1.c | 202 +++++++++++++++++++++++++++++++++++++++ src/libsha1/libsha1.h | 21 ++++ 9 files changed, 273 insertions(+), 33 deletions(-) create mode 100644 src/libsha1/libsha1.c create mode 100644 src/libsha1/libsha1.h diff --git a/README.md b/README.md index 29d652b..14dafa3 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ WebSocket Server and Client for Arduino a WebSocket Server and Client for Arduino based on RFC6455. + ##### Supported features of RFC6455 ##### - text frame - binary frame @@ -16,14 +17,18 @@ a WebSocket Server and Client for Arduino based on RFC6455. ##### Limitations ##### - max input length is limited to the ram size and the ```WEBSOCKETS_MAX_DATA_SIZE``` define - max output length has no limit (the hardware is the limit) - - Client send masked frames always with mask 0x00000000 (open todo) + - Client send masked frames always with mask 0x00000000 ##### Supported Hardware ##### - ESP8266 [Arduino for ESP8266](https://github.com/Links2004/Arduino) - - ATmega328 with Ethernet Shield (planed) - - ATmega328 with enc28j60 (planed) - - ATmega2560 with Ethernet Shield (planed) - - ATmega2560 with enc28j60 (planed) + - ATmega328 with Ethernet Shield (alpha) + - ATmega328 with enc28j60 (alpha) + - ATmega2560 with Ethernet Shield (alpha) + - ATmega2560 with enc28j60 (alpha) + +### wss / SSL ### + supported for: + - wss client on the ESP8266 ### Issues ### Submit issues to: https://github.com/Links2004/arduinoWebSockets/issues diff --git a/library.properties b/library.properties index bbdf97c..92613b3 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=WebSockets -version=1.2 +version=1.3 author=Markus Sattler maintainer=Markus Sattler sentence=WebSockets for Arduino (Server + Client) diff --git a/src/WebSockets.cpp b/src/WebSockets.cpp index 28407f3..0aacaf9 100644 --- a/src/WebSockets.cpp +++ b/src/WebSockets.cpp @@ -38,6 +38,12 @@ extern "C" { #ifdef ESP8266 #include +#else + +extern "C" { +#include "libsha1/libsha1.h" +} + #endif /** @@ -343,8 +349,13 @@ String WebSockets::acceptKey(String clientKey) { #ifdef ESP8266 sha1(clientKey + "258EAFA5-E914-47DA-95CA-C5AB0DC85B11", &sha1HashBin[0]); #else -#error todo implement sha1 for AVR + clientKey =+ "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"; + SHA1_CTX ctx; + SHA1Init(&ctx); + SHA1Update(&ctx, (const unsigned char*)clientKey.c_str(), clientKey.length()); + SHA1Final(&sha1HashBin[0], &ctx); #endif + String key = base64_encode(sha1HashBin, 20); key.trim(); diff --git a/src/WebSockets.h b/src/WebSockets.h index 1b34ffc..32f83bb 100644 --- a/src/WebSockets.h +++ b/src/WebSockets.h @@ -27,7 +27,7 @@ #include -#define DEBUG_WEBSOCKETS(...) Serial1.printf( __VA_ARGS__ ) +//#define DEBUG_WEBSOCKETS(...) Serial1.printf( __VA_ARGS__ ) #ifndef DEBUG_WEBSOCKETS #define DEBUG_WEBSOCKETS(...) @@ -63,17 +63,20 @@ #include #define WEBSOCKETS_NETWORK_CLASS WiFiClient +#define WEBSOCKETS_NETWORK_SERVER_CLASS WiFiServer #elif (WEBSOCKETS_NETWORK_TYPE == NETWORK_W5100) #include #include #define WEBSOCKETS_NETWORK_CLASS EthernetClient +#define WEBSOCKETS_NETWORK_SERVER_CLASS EthernetServer #elif (WEBSOCKETS_NETWORK_TYPE == NETWORK_ENC28J60) #include #define WEBSOCKETS_NETWORK_CLASS UIPClient +#define WEBSOCKETS_NETWORK_SERVER_CLASS UIPServer #else #error "no network type selected!" diff --git a/src/WebSocketsClient.h b/src/WebSocketsClient.h index 7e42cc4..588e951 100644 --- a/src/WebSocketsClient.h +++ b/src/WebSocketsClient.h @@ -26,17 +26,6 @@ #define WEBSOCKETSCLIENT_H_ #include - -#ifdef ESP8266 -#include -#else -#include -#ifndef UIPETHERNET_H -#include -#include -#endif -#endif - #include "WebSockets.h" class WebSocketsClient: private WebSockets { diff --git a/src/WebSocketsServer.cpp b/src/WebSocketsServer.cpp index df147d1..5ec4eca 100644 --- a/src/WebSocketsServer.cpp +++ b/src/WebSocketsServer.cpp @@ -27,7 +27,7 @@ WebSocketsServer::WebSocketsServer(uint16_t port) { _port = port; - _server = new WiFiServer(port); + _server = new WEBSOCKETS_NETWORK_SERVER_CLASS(port); _cbEvent = NULL; @@ -240,6 +240,7 @@ void WebSocketsServer::disconnect(uint8_t num) { } } +#if (WEBSOCKETS_NETWORK_TYPE == NETWORK_ESP8266) /** * get an IP for a client * @param num uint8_t client id @@ -255,6 +256,7 @@ IPAddress WebSocketsServer::remoteIP(uint8_t num) { return IPAddress(); } +#endif //################################################################################# //################################################################################# @@ -363,7 +365,9 @@ bool WebSocketsServer::clientIsConnected(WSclient_t * client) { */ void WebSocketsServer::handleNewClients(void) { WSclient_t * client; +#if (WEBSOCKETS_NETWORK_TYPE == NETWORK_ESP8266) while(_server->hasClient()) { +#endif bool ok = false; // search free list entry for client for(uint8_t i = 0; i < WEBSOCKETS_SERVER_CLIENT_MAX; i++) { @@ -371,10 +375,12 @@ void WebSocketsServer::handleNewClients(void) { // state is not connected or tcp connection is lost if(!clientIsConnected(client)) { - +#if (WEBSOCKETS_NETWORK_TYPE == NETWORK_ESP8266) // store new connection client->tcp = new WEBSOCKETS_NETWORK_CLASS(_server->available()); - +#else + client->tcp = new WEBSOCKETS_NETWORK_CLASS(_server->available()); +#endif if(!client->tcp) { DEBUG_WEBSOCKETS("[WS-Client] creating Network class failed!"); return; @@ -387,9 +393,12 @@ void WebSocketsServer::handleNewClients(void) { // set Timeout for readBytesUntil and readStringUntil client->tcp->setTimeout(WEBSOCKETS_TCP_TIMEOUT); client->status = WSC_HEADER; - +#if (WEBSOCKETS_NETWORK_TYPE == NETWORK_ESP8266) IPAddress ip = client->tcp->remoteIP(); DEBUG_WEBSOCKETS("[WS-Server][%d] new client from %d.%d.%d.%d\n", client->num, ip[0], ip[1], ip[2], ip[3]); +#else + DEBUG_WEBSOCKETS("[WS-Server][%d] new client\n", client->num); +#endif ok = true; break; } @@ -398,15 +407,21 @@ void WebSocketsServer::handleNewClients(void) { if(!ok) { // no free space to handle client WEBSOCKETS_NETWORK_CLASS tcpClient = _server->available(); - IPAddress ip = tcpClient.remoteIP(); +#if (WEBSOCKETS_NETWORK_TYPE == NETWORK_ESP8266) + IPAddress ip = client->tcp->remoteIP(); DEBUG_WEBSOCKETS("[WS-Server] no free space new client from %d.%d.%d.%d\n", ip[0], ip[1], ip[2], ip[3]); +#else + DEBUG_WEBSOCKETS("[WS-Server] no free space new client\n"); +#endif tcpClient.stop(); } #ifdef ESP8266 delay(0); #endif +#if (WEBSOCKETS_NETWORK_TYPE == NETWORK_ESP8266) } +#endif } /** diff --git a/src/WebSocketsServer.h b/src/WebSocketsServer.h index bef170e..ebc76b2 100644 --- a/src/WebSocketsServer.h +++ b/src/WebSocketsServer.h @@ -68,20 +68,14 @@ public: void disconnect(void); void disconnect(uint8_t num); +#if (WEBSOCKETS_NETWORK_TYPE == NETWORK_ESP8266) IPAddress remoteIP(uint8_t num); +#endif protected: uint16_t _port; -#ifdef ESP8266 - WiFiServer * _server; -#else -#ifdef UIPETHERNET_H - UIPServer * _server; -#else - EthernetServer * _server; -#endif -#endif + WEBSOCKETS_NETWORK_SERVER_CLASS * _server; WSclient_t _clients[WEBSOCKETS_SERVER_CLIENT_MAX]; diff --git a/src/libsha1/libsha1.c b/src/libsha1/libsha1.c new file mode 100644 index 0000000..7ff3846 --- /dev/null +++ b/src/libsha1/libsha1.c @@ -0,0 +1,202 @@ +/* from valgrind tests */ + +/* ================ sha1.c ================ */ +/* +SHA-1 in C +By Steve Reid +100% Public Domain + +Test Vectors (from FIPS PUB 180-1) +"abc" + A9993E36 4706816A BA3E2571 7850C26C 9CD0D89D +"abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq" + 84983E44 1C3BD26E BAAE4AA1 F95129E5 E54670F1 +A million repetitions of "a" + 34AA973C D4C4DAA4 F61EEB2B DBAD2731 6534016F +*/ + +/* #define LITTLE_ENDIAN * This should be #define'd already, if true. */ +/* #define SHA1HANDSOFF * Copies data before messing with it. */ + +#ifndef ESP8266 + +#define SHA1HANDSOFF + +#include +#include +#include + +#include "libsha1.h" + + +#define rol(value, bits) (((value) << (bits)) | ((value) >> (32 - (bits)))) + +/* blk0() and blk() perform the initial expand. */ +/* I got the idea of expanding during the round function from SSLeay */ +#if BYTE_ORDER == LITTLE_ENDIAN +#define blk0(i) (block->l[i] = (rol(block->l[i],24)&0xFF00FF00) \ + |(rol(block->l[i],8)&0x00FF00FF)) +#elif BYTE_ORDER == BIG_ENDIAN +#define blk0(i) block->l[i] +#else +#error "Endianness not defined!" +#endif +#define blk(i) (block->l[i&15] = rol(block->l[(i+13)&15]^block->l[(i+8)&15] \ + ^block->l[(i+2)&15]^block->l[i&15],1)) + +/* (R0+R1), R2, R3, R4 are the different operations used in SHA1 */ +#define R0(v,w,x,y,z,i) z+=((w&(x^y))^y)+blk0(i)+0x5A827999+rol(v,5);w=rol(w,30); +#define R1(v,w,x,y,z,i) z+=((w&(x^y))^y)+blk(i)+0x5A827999+rol(v,5);w=rol(w,30); +#define R2(v,w,x,y,z,i) z+=(w^x^y)+blk(i)+0x6ED9EBA1+rol(v,5);w=rol(w,30); +#define R3(v,w,x,y,z,i) z+=(((w|x)&y)|(w&x))+blk(i)+0x8F1BBCDC+rol(v,5);w=rol(w,30); +#define R4(v,w,x,y,z,i) z+=(w^x^y)+blk(i)+0xCA62C1D6+rol(v,5);w=rol(w,30); + + +/* Hash a single 512-bit block. This is the core of the algorithm. */ + +void SHA1Transform(uint32_t state[5], const unsigned char buffer[64]) +{ + uint32_t a, b, c, d, e; + typedef union { + unsigned char c[64]; + uint32_t l[16]; + } CHAR64LONG16; +#ifdef SHA1HANDSOFF + CHAR64LONG16 block[1]; /* use array to appear as a pointer */ + memcpy(block, buffer, 64); +#else + /* The following had better never be used because it causes the + * pointer-to-const buffer to be cast into a pointer to non-const. + * And the result is written through. I threw a "const" in, hoping + * this will cause a diagnostic. + */ + CHAR64LONG16* block = (const CHAR64LONG16*)buffer; +#endif + /* Copy context->state[] to working vars */ + a = state[0]; + b = state[1]; + c = state[2]; + d = state[3]; + e = state[4]; + /* 4 rounds of 20 operations each. Loop unrolled. */ + R0(a,b,c,d,e, 0); R0(e,a,b,c,d, 1); R0(d,e,a,b,c, 2); R0(c,d,e,a,b, 3); + R0(b,c,d,e,a, 4); R0(a,b,c,d,e, 5); R0(e,a,b,c,d, 6); R0(d,e,a,b,c, 7); + R0(c,d,e,a,b, 8); R0(b,c,d,e,a, 9); R0(a,b,c,d,e,10); R0(e,a,b,c,d,11); + R0(d,e,a,b,c,12); R0(c,d,e,a,b,13); R0(b,c,d,e,a,14); R0(a,b,c,d,e,15); + R1(e,a,b,c,d,16); R1(d,e,a,b,c,17); R1(c,d,e,a,b,18); R1(b,c,d,e,a,19); + R2(a,b,c,d,e,20); R2(e,a,b,c,d,21); R2(d,e,a,b,c,22); R2(c,d,e,a,b,23); + R2(b,c,d,e,a,24); R2(a,b,c,d,e,25); R2(e,a,b,c,d,26); R2(d,e,a,b,c,27); + R2(c,d,e,a,b,28); R2(b,c,d,e,a,29); R2(a,b,c,d,e,30); R2(e,a,b,c,d,31); + R2(d,e,a,b,c,32); R2(c,d,e,a,b,33); R2(b,c,d,e,a,34); R2(a,b,c,d,e,35); + R2(e,a,b,c,d,36); R2(d,e,a,b,c,37); R2(c,d,e,a,b,38); R2(b,c,d,e,a,39); + R3(a,b,c,d,e,40); R3(e,a,b,c,d,41); R3(d,e,a,b,c,42); R3(c,d,e,a,b,43); + R3(b,c,d,e,a,44); R3(a,b,c,d,e,45); R3(e,a,b,c,d,46); R3(d,e,a,b,c,47); + R3(c,d,e,a,b,48); R3(b,c,d,e,a,49); R3(a,b,c,d,e,50); R3(e,a,b,c,d,51); + R3(d,e,a,b,c,52); R3(c,d,e,a,b,53); R3(b,c,d,e,a,54); R3(a,b,c,d,e,55); + R3(e,a,b,c,d,56); R3(d,e,a,b,c,57); R3(c,d,e,a,b,58); R3(b,c,d,e,a,59); + R4(a,b,c,d,e,60); R4(e,a,b,c,d,61); R4(d,e,a,b,c,62); R4(c,d,e,a,b,63); + R4(b,c,d,e,a,64); R4(a,b,c,d,e,65); R4(e,a,b,c,d,66); R4(d,e,a,b,c,67); + R4(c,d,e,a,b,68); R4(b,c,d,e,a,69); R4(a,b,c,d,e,70); R4(e,a,b,c,d,71); + R4(d,e,a,b,c,72); R4(c,d,e,a,b,73); R4(b,c,d,e,a,74); R4(a,b,c,d,e,75); + R4(e,a,b,c,d,76); R4(d,e,a,b,c,77); R4(c,d,e,a,b,78); R4(b,c,d,e,a,79); + /* Add the working vars back into context.state[] */ + state[0] += a; + state[1] += b; + state[2] += c; + state[3] += d; + state[4] += e; + /* Wipe variables */ + a = b = c = d = e = 0; +#ifdef SHA1HANDSOFF + memset(block, '\0', sizeof(block)); +#endif +} + + +/* SHA1Init - Initialize new context */ + +void SHA1Init(SHA1_CTX* context) +{ + /* SHA1 initialization constants */ + context->state[0] = 0x67452301; + context->state[1] = 0xEFCDAB89; + context->state[2] = 0x98BADCFE; + context->state[3] = 0x10325476; + context->state[4] = 0xC3D2E1F0; + context->count[0] = context->count[1] = 0; +} + + +/* Run your data through this. */ + +void SHA1Update(SHA1_CTX* context, const unsigned char* data, uint32_t len) +{ + uint32_t i, j; + + j = context->count[0]; + if ((context->count[0] += len << 3) < j) + context->count[1]++; + context->count[1] += (len>>29); + j = (j >> 3) & 63; + if ((j + len) > 63) { + memcpy(&context->buffer[j], data, (i = 64-j)); + SHA1Transform(context->state, context->buffer); + for ( ; i + 63 < len; i += 64) { + SHA1Transform(context->state, &data[i]); + } + j = 0; + } + else i = 0; + memcpy(&context->buffer[j], &data[i], len - i); +} + + +/* Add padding and return the message digest. */ + +void SHA1Final(unsigned char digest[20], SHA1_CTX* context) +{ + unsigned i; + unsigned char finalcount[8]; + unsigned char c; + +#if 0 /* untested "improvement" by DHR */ + /* Convert context->count to a sequence of bytes + * in finalcount. Second element first, but + * big-endian order within element. + * But we do it all backwards. + */ + unsigned char *fcp = &finalcount[8]; + + for (i = 0; i < 2; i++) + { + uint32_t t = context->count[i]; + int j; + + for (j = 0; j < 4; t >>= 8, j++) + *--fcp = (unsigned char) t; + } +#else + for (i = 0; i < 8; i++) { + finalcount[i] = (unsigned char)((context->count[(i >= 4 ? 0 : 1)] + >> ((3-(i & 3)) * 8) ) & 255); /* Endian independent */ + } +#endif + c = 0200; + SHA1Update(context, &c, 1); + while ((context->count[0] & 504) != 448) { + c = 0000; + SHA1Update(context, &c, 1); + } + SHA1Update(context, finalcount, 8); /* Should cause a SHA1Transform() */ + for (i = 0; i < 20; i++) { + digest[i] = (unsigned char) + ((context->state[i>>2] >> ((3-(i & 3)) * 8) ) & 255); + } + /* Wipe variables */ + memset(context, '\0', sizeof(*context)); + memset(&finalcount, '\0', sizeof(finalcount)); +} +/* ================ end of sha1.c ================ */ + + +#endif diff --git a/src/libsha1/libsha1.h b/src/libsha1/libsha1.h new file mode 100644 index 0000000..1f08d0e --- /dev/null +++ b/src/libsha1/libsha1.h @@ -0,0 +1,21 @@ +/* ================ sha1.h ================ */ +/* +SHA-1 in C +By Steve Reid +100% Public Domain +*/ + +#ifndef ESP8266 + +typedef struct { + uint32_t state[5]; + uint32_t count[2]; + unsigned char buffer[64]; +} SHA1_CTX; + +void SHA1Transform(uint32_t state[5], const unsigned char buffer[64]); +void SHA1Init(SHA1_CTX* context); +void SHA1Update(SHA1_CTX* context, const unsigned char* data, uint32_t len); +void SHA1Final(unsigned char digest[20], SHA1_CTX* context); + +#endif \ No newline at end of file