reorganized project to make room for server code. updated build process to include server

Author: jeremyhahn

.cproject

@@ -50,9 +50,9 @@
 						</toolChain>
 					</folderInfo>
 					<sourceEntries>
-						<entry excluding="websocket|src" flags="VALUE_WORKSPACE_PATH|RESOLVED" kind="sourcePath" name=""/>
-						<entry excluding="websocket" flags="VALUE_WORKSPACE_PATH|RESOLVED" kind="sourcePath" name="src"/>
-						<entry flags="VALUE_WORKSPACE_PATH|RESOLVED" kind="sourcePath" name="src/websocket"/>
+						<entry excluding="cwebsocket|src" flags="VALUE_WORKSPACE_PATH|RESOLVED" kind="sourcePath" name=""/>
+						<entry excluding="cwebsocket" flags="VALUE_WORKSPACE_PATH|RESOLVED" kind="sourcePath" name="src"/>
+						<entry flags="VALUE_WORKSPACE_PATH|RESOLVED" kind="sourcePath" name="src/cwebsocket"/>
 					</sourceEntries>
 				</configuration>
 			</storageModule>
@@ -99,9 +99,9 @@
 						</toolChain>
 					</folderInfo>
 					<sourceEntries>
-						<entry excluding="websocket|src" flags="VALUE_WORKSPACE_PATH|RESOLVED" kind="sourcePath" name=""/>
-						<entry excluding="websocket" flags="VALUE_WORKSPACE_PATH|RESOLVED" kind="sourcePath" name="src"/>
-						<entry flags="VALUE_WORKSPACE_PATH|RESOLVED" kind="sourcePath" name="src/websocket"/>
+						<entry excluding="cwebsocket|src" flags="VALUE_WORKSPACE_PATH|RESOLVED" kind="sourcePath" name=""/>
+						<entry excluding="cwebsocket" flags="VALUE_WORKSPACE_PATH|RESOLVED" kind="sourcePath" name="src"/>
+						<entry flags="VALUE_WORKSPACE_PATH|RESOLVED" kind="sourcePath" name="src/cwebsocket"/>
 					</sourceEntries>
 				</configuration>
 			</storageModule>

Makefile.am

@@ -1,7 +1,8 @@
 AUTOMAKE_OPTIONS = foreign
 
-bin_PROGRAMS = websocket-client
-websocket_client_SOURCES = src/websocket/utf8.h src/websocket/utf8.c src/websocket/cwebsocket_client.h src/websocket/cwebsocket_client.c src/client.c
+bin_PROGRAMS = websocket-client websocket-server
+websocket_client_SOURCES = src/cwebsocket/utf8.h src/cwebsocket/common.h src/cwebsocket/common.c src/cwebsocket/utf8.c src/cwebsocket/client.h src/cwebsocket/client.c src/websocket-client.c
+websocket_server_SOURCES = src/cwebsocket/utf8.h src/cwebsocket/common.h src/cwebsocket/common.c src/cwebsocket/utf8.c src/cwebsocket/server.h src/cwebsocket/server.c src/websocket-server.c
 
 #LDFLAGS = -L/usr/local/lib -lcrypto
 
@@ -22,4 +23,4 @@ if USESSL
 endif
 
 clean:
-	rm -rf autoscan.log config.h.in config.h config.cache configure install-sh aclocal.m4 autom4te.cache/ config.log config.status Debug/ depcomp .deps/ m4/ Makefile Makefile.in missing stamp-h1 *.o src/*.o *~ client server
+	rm -rf autoscan.log config.h.in config.h config.cache configure install-sh aclocal.m4 autom4te.cache/ config.log config.status Debug/ depcomp .deps/ m4/ Makefile Makefile.in missing stamp-h1 *.o src/*.o *~ websocket-client websocket-server

README.md

@@ -4,10 +4,9 @@
 
 ###### Fast, lightweight websocket server/client.
 
-The goal of cwebsocket is to provide a simple, lightweight, high performance websocket solution that's
-efficient enough to run well on low power embedded systems.
+The goal of cwebsocket is to provide a simple, lightweight, high performance websocket client/server optimized for low power embedded systems.
 
-cwebsocket is currently in a development state. You may encounter bugs. Report them for a timely fix.
+cwebsocket is currently in a development state. You may encounter bugs. Report them in the issues section for a timely fix.
 
 Successful tests have been conducted on the following architectures:
 
@@ -43,7 +42,7 @@ Without SSL:
 The websocket client is able to connect and exchange data with any RFC 6455 compliant server.
 
 ```C
-#include "cwebsocket.h"
+#include "cwebsocket/client.h"
 
 cwebsocket_client websocket;
 
@@ -54,7 +53,6 @@ void onopen(cwebsocket_client *websocket) {
 void onmessage(cwebsocket_client *websocket, cwebsocket_message *message) {
 	syslog(LOG_DEBUG, "onmessage: socket_fd=%i, opcode=%#04x, payload_len=%zu, payload=%s\n",
 			websocket->socket, message->opcode, message->payload_len, message->payload);
-
 }
 
 void onclose(cwebsocket_client *websocket, const char *message) {
@@ -104,3 +102,10 @@ int main(int argc, char **argv) {
 	./websocket-client ws://echo.websocket.org
 	./websocket-client wss://echo.websocket.org
 
+### TODO
+
+1. More testing on various embedded devices
+2. Implement pluggable sub-protocols (socketio, WAMP, custom)
+3. Implement pluggable extensions on the client per RFC (section 9)
+4. Get a basic websocket server developed
+

configure.ac

@@ -4,7 +4,7 @@
 AC_PREREQ([2.69])
 AC_INIT([cwebsocket], [0.01], [root@localhost])
 AM_INIT_AUTOMAKE([1.9 foreign])
-AC_CONFIG_SRCDIR([src/client.c])
+AC_CONFIG_SRCDIR([src/websocket-client.c])
 AC_CONFIG_HEADERS([config.h])
 
 if test -z $CFLAGS; then

src/websocket/cwebsocket_client.c renamed to src/cwebsocket/client.c

@@ -22,7 +22,7 @@
  *  THE SOFTWARE.
  */
 
-#include "cwebsocket_client.h"
+#include "client.h"
 
 void cwebsocket_init() {
 	const rlim_t kStackSize = STACK_SIZE_MIN * 1024 * 1024;
@@ -43,27 +43,6 @@ void cwebsocket_init() {
 	syslog(LOG_DEBUG, "stack limit min=%ld, max=%ld\n", rl.rlim_cur, rl.rlim_max);
 }
 
-char* cwebsocket_base64_encode(const unsigned char *input, int length) {
-
-	BIO *bmem, *b64;
-	BUF_MEM *bptr;
-
-	b64 = BIO_new(BIO_f_base64());
-	bmem = BIO_new(BIO_s_mem());
-	b64 = BIO_push(b64, bmem);
-	BIO_write(b64, input, length);
-	BIO_flush(b64);
-	BIO_get_mem_ptr(b64, &bptr);
-
-	char *buff = (char *)malloc(bptr->length);
-	memcpy(buff, bptr->data, bptr->length-1);
-	buff[bptr->length-1] = '\0';
-
-	BIO_free_all(b64);
-
-	return buff;
-}
-
 void cwebsocket_parse_uri(cwebsocket_client *websocket, const char *uri,
 		char *hostname, char *port, char *resource, char *querystring) {
 
@@ -130,11 +109,6 @@ void cwebsocket_parse_uri(cwebsocket_client *websocket, const char *uri,
 	}
 }
 
-void cwebsocket_print_frame(cwebsocket_frame *frame) {
-	syslog(LOG_DEBUG, "cwebsocket_print_frame: fin=%i, rsv1=%i, rsv2=%i, rsv3=%i, opcode=%#04x, mask=%i, payload_len=%i\n",
-			frame->fin, frame->rsv1, frame->rsv2, frame->rsv3, frame->opcode, frame->mask, frame->payload_len);
-}
-
 int cwebsocket_connect(cwebsocket_client *websocket) {
 
 	if(websocket->state & WEBSOCKET_STATE_CONNECTED) {

src/websocket/cwebsocket_client.h renamed to src/cwebsocket/client.h

@@ -25,29 +25,14 @@
 #ifndef WEBSOCKET_CLIENT_H
 #define WEBSOCKET_CLIENT_H
 
-#include <stdlib.h>
-#include <stdio.h>
-#include <stdint.h>
 #include <time.h>
-#include <string.h>
-#include <syslog.h>
-#include <errno.h>
 #include <fcntl.h>
-#include <unistd.h>
 #include <ctype.h>
 #include <netdb.h>
 #include <netinet/in.h>
-#include <arpa/inet.h>
-#include <sys/types.h>
-#include <sys/socket.h>
 #include <sys/time.h>
-#include <openssl/sha.h>
-#include <openssl/hmac.h>
-#include <openssl/evp.h>
-#include <openssl/bio.h>
-#include <openssl/buffer.h>
 #include <sys/resource.h>
-#include "utf8.h"
+#include "common.h"
 
 #ifdef USESSL
 	#include <openssl/rand.h>
@@ -59,18 +44,6 @@
 	#include <pthread.h>
 #endif
 
-#ifndef HANDSHAKE_BUFFER_MAX
-	#define HANDSHAKE_BUFFER_MAX 256
-#endif
-
-#ifndef DATA_BUFFER_MAX
-	#define DATA_BUFFER_MAX 65536
-#endif
-
-#ifndef STACK_SIZE_MIN
-	#define STACK_SIZE_MIN 2
-#endif
-
 #define WEBSOCKET_STATE_CONNECTING   (1 << 0)
 #define WEBSOCKET_STATE_CONNECTED    (1 << 1)
 #define WEBSOCKET_STATE_OPEN         (1 << 2)
@@ -80,37 +53,6 @@
 #define WEBSOCKET_FLAG_SSL           (1 << 0)
 #define WEBSOCKET_FLAG_AUTORECONNECT (1 << 1)
 
-typedef enum {
-	TRUE,
-	FALSE
-} bool;
-
-typedef enum {
-	CONTINUATION = 0x00,
-	TEXT_FRAME = 0x01,
-	BINARY_FRAME = 0x02,
-	CLOSE = 0x08,
-	PING = 0x09,
-	PONG = 0x0A,
-} opcode;
-
-typedef struct {
-	uint32_t opcode;
-	uint64_t payload_len;
-	char *payload;
-} cwebsocket_message;
-
-typedef struct {
-	bool fin;
-	bool rsv1;
-	bool rsv2;
-	bool rsv3;
-	opcode opcode;
-	bool mask;
-	int payload_len;
-	uint32_t masking_key[4];
-} cwebsocket_frame;
-
 typedef struct _cwebsocket {
 	int socket;
 	int retry;
@@ -145,10 +87,8 @@ ssize_t cwebsocket_write_data(cwebsocket_client *websocket, const char *data, in
 void cwebsocket_run(cwebsocket_client *websocket);
 void cwebsocket_close(cwebsocket_client *websocket, const char *message);
 void cwebsocket_listen(cwebsocket_client *websocket);
-void cwebsocket_print_frame(cwebsocket_frame *frame);
 
 // "private"
-char* cwebsocket_base64_encode(const unsigned char *input, int length);
 void cwebsocket_parse_uri(cwebsocket_client *websocket, const char *uri, char *hostname, char *port, char *resource, char *querystring);
 int cwebsocket_handshake_handler(cwebsocket_client *websocket, const char *handshake_response, char *seckey);
 int cwebsocket_read_handshake(cwebsocket_client *websocket, char *seckey);

src/cwebsocket/common.c

@@ -0,0 +1,51 @@
+/**
+ *  The MIT License (MIT)
+ *
+ *  Copyright (c) 2014 Jeremy Hahn
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in
+ *  all copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ *  THE SOFTWARE.
+ */
+
+#include "common.h"
+
+char* cwebsocket_base64_encode(const unsigned char *input, int length) {
+
+	BIO *bmem, *b64;
+	BUF_MEM *bptr;
+
+	b64 = BIO_new(BIO_f_base64());
+	bmem = BIO_new(BIO_s_mem());
+	b64 = BIO_push(b64, bmem);
+	BIO_write(b64, input, length);
+	BIO_flush(b64);
+	BIO_get_mem_ptr(b64, &bptr);
+
+	char *buff = (char *)malloc(bptr->length);
+	memcpy(buff, bptr->data, bptr->length-1);
+	buff[bptr->length-1] = '\0';
+
+	BIO_free_all(b64);
+
+	return buff;
+}
+
+void cwebsocket_print_frame(cwebsocket_frame *frame) {
+	syslog(LOG_DEBUG, "cwebsocket_print_frame: fin=%i, rsv1=%i, rsv2=%i, rsv3=%i, opcode=%#04x, mask=%i, payload_len=%i\n",
+			frame->fin, frame->rsv1, frame->rsv2, frame->rsv3, frame->opcode, frame->mask, frame->payload_len);
+}

src/cwebsocket/common.h

@@ -0,0 +1,91 @@
+/**
+ *  The MIT License (MIT)
+ *
+ *  Copyright (c) 2014 Jeremy Hahn
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in
+ *  all copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ *  THE SOFTWARE.
+ */
+
+#ifndef CWEBSOCKET_H_
+#define CWEBSOCKET_H_
+
+#include <stdlib.h>
+#include <stdio.h>
+#include <stdint.h>
+#include <syslog.h>
+#include <string.h>
+#include <errno.h>
+#include <unistd.h>
+#include <sys/types.h>
+#include <sys/socket.h>
+#include <arpa/inet.h>
+#include <openssl/sha.h>
+#include <openssl/hmac.h>
+#include <openssl/evp.h>
+#include <openssl/bio.h>
+#include <openssl/buffer.h>
+#include "utf8.h"
+
+#ifndef HANDSHAKE_BUFFER_MAX
+	#define HANDSHAKE_BUFFER_MAX 256  // bytes
+#endif
+
+#ifndef DATA_BUFFER_MAX
+	#define DATA_BUFFER_MAX 65536     // bytes
+#endif
+
+#ifndef STACK_SIZE_MIN
+	#define STACK_SIZE_MIN 2          // MB
+#endif
+
+typedef enum {
+	TRUE,
+	FALSE
+} bool;
+
+typedef enum {
+	CONTINUATION = 0x00,
+	TEXT_FRAME = 0x01,
+	BINARY_FRAME = 0x02,
+	CLOSE = 0x08,
+	PING = 0x09,
+	PONG = 0x0A,
+} opcode;
+
+typedef struct {
+	uint32_t opcode;
+	uint64_t payload_len;
+	char *payload;
+} cwebsocket_message;
+
+typedef struct {
+	bool fin;
+	bool rsv1;
+	bool rsv2;
+	bool rsv3;
+	opcode opcode;
+	bool mask;
+	int payload_len;
+	uint32_t masking_key[4];
+} cwebsocket_frame;
+
+char* cwebsocket_base64_encode(const unsigned char *input, int length);
+void cwebsocket_print_frame(cwebsocket_frame *frame);
+
+#endif