Merge pull request #38 from jshelley/master

Implemented initial websocket client support - a few changes to interface and implementation will follow soon.

examples/websocket_client/Makefile

@@ -0,0 +1,37 @@
+# 
+# Copyright (c) 2014 Jordan Shelley
+# https://github.com/jshelley
+# License http://opensource.org/licenses/mit-license.php MIT License
+#
+
+#This makefile is used to test the other Makefiles
+
+
+PROG = websocket_client
+SRC = websocket_client.c
+
+TOP = ../..
+CIVETWEB_LIB = libcivetweb.a
+
+CFLAGS = -I$(TOP)/include $(COPT) 
+LIBS = -lpthread
+
+include $(TOP)/resources/Makefile.in-os
+
+ifeq ($(TARGET_OS),LINUX) 
+	LIBS += -ldl
+endif
+
+all: $(PROG)
+
+$(PROG): $(CIVETWEB_LIB) $(SRC)
+	$(CC) -o $@ $(CFLAGS) $(LDFLAGS) $(SRC) $(CIVETWEB_LIB) $(LIBS)
+
+$(CIVETWEB_LIB):
+	$(MAKE) -C $(TOP) clean lib
+	cp $(TOP)/$(CIVETWEB_LIB) .
+
+clean:
+	rm -f $(CIVETWEB_LIB) $(PROG)
+
+.PHONY: all clean

examples/websocket_client/ssl/server.crt

@@ -0,0 +1,13 @@
+-----BEGIN CERTIFICATE-----
+MIICATCCAWoCCQC2BCIqIvgSUTANBgkqhkiG9w0BAQUFADBFMQswCQYDVQQGEwJB
+VTETMBEGA1UECAwKU29tZS1TdGF0ZTEhMB8GA1UECgwYSW50ZXJuZXQgV2lkZ2l0
+cyBQdHkgTHRkMB4XDTE0MDgyMTEyMzAwMVoXDTI0MDgxODEyMzAwMVowRTELMAkG
+A1UEBhMCQVUxEzARBgNVBAgMClNvbWUtU3RhdGUxITAfBgNVBAoMGEludGVybmV0
+IFdpZGdpdHMgUHR5IEx0ZDCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA9k9s
+gH22BCo9neTeB/YnilK7n0sMe0+pjS9KSWhU59Q4w8hqPrW0tuYikIDd0wVggkJF
+BZNg4WPoulTdwXsgNBeG88q2wnNtUosXTS+KQTQBSiQof9Ay9GHQtgxnogI1zIXb
+HOppyyG5zre8a/X6fzDOnFc4iJMBwxTAnjCqObkCAwEAATANBgkqhkiG9w0BAQUF
+AAOBgQBX9V46VUVsB9P9fb8sFuMx2ezFE42ynEeJPrKRrof+dFYbjvR1OUZFSLCy
+aZKwVH7iCnVBJiU12JxO7PR3L6ob3FYPyNHQWYq1/IFUvqBRagehldj5H8iFeEDz
+Wtz2+p1rUyVxcSUqTjobaji0aC8lzPZio0nd1KKM6A92/adHyQ==
+-----END CERTIFICATE-----

examples/websocket_client/ssl/server.csr

@@ -0,0 +1,11 @@
+-----BEGIN CERTIFICATE REQUEST-----
+MIIBhDCB7gIBADBFMQswCQYDVQQGEwJBVTETMBEGA1UECAwKU29tZS1TdGF0ZTEh
+MB8GA1UECgwYSW50ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIGfMA0GCSqGSIb3DQEB
+AQUAA4GNADCBiQKBgQD2T2yAfbYEKj2d5N4H9ieKUrufSwx7T6mNL0pJaFTn1DjD
+yGo+tbS25iKQgN3TBWCCQkUFk2DhY+i6VN3BeyA0F4bzyrbCc21SixdNL4pBNAFK
+JCh/0DL0YdC2DGeiAjXMhdsc6mnLIbnOt7xr9fp/MM6cVziIkwHDFMCeMKo5uQID
+AQABoAAwDQYJKoZIhvcNAQEFBQADgYEA1EOFwyFJ2NAnRNktZCy5yVcLx9C78HoC
+oHPPCOElu0VDIqe6ZecYdaqWbYlhGE0+isbOQn2CwHOeBGN8mIDsNUYzVEpsEfgg
+9OK873LpE5pf4mdjSiRBXkk/h8BxuqkcKi+Qx+qEE7+dH2nK5aKeIHVvbLyfGOch
+9I85q+msBNE=
+-----END CERTIFICATE REQUEST-----

examples/websocket_client/ssl/server.key

@@ -0,0 +1,15 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIICXQIBAAKBgQD2T2yAfbYEKj2d5N4H9ieKUrufSwx7T6mNL0pJaFTn1DjDyGo+
+tbS25iKQgN3TBWCCQkUFk2DhY+i6VN3BeyA0F4bzyrbCc21SixdNL4pBNAFKJCh/
+0DL0YdC2DGeiAjXMhdsc6mnLIbnOt7xr9fp/MM6cVziIkwHDFMCeMKo5uQIDAQAB
+AoGAYwospr3lomcZv5N3c9wWqhf6OWMD8dFma87IIBxDh7Rd3tuHXQ/TSnffDhvD
+FkbjN31OI5/PJNH3knTtdg78MywPloE4jYsbt4+fEaW7Fzww2nU61N1p+mYk5d/b
+SCTAHhGzF9g9ZMw25CCUFGjDU2z+Ty6my22Euxhk2Qq8tMECQQD9ZYIxWkPhywDW
+pX3v70dqIv7411hEYpuL/ZJl26UCmQsj4HPtXQCraQksVPs74WY5aTtd6MAV9V3M
+UnErHO5/AkEA+NdG2MmfBOBPusDB/WwQaUPiCWGITS9llGTR2JXbvDqmKgL1+UTG
+o27sLNIFCrF1wejpyRGqwjcObFYR0yKrxwJBAOB2uPuK4DL1psp9Uq/mIDbOxVod
+OF1rlCpP9w0vol5Iv+uJ+mc7SUqOAsg4h0yl/+2/YA1yDiXlcq96IDF2sXUCQGAv
+Nh9Nr72+xpK1N0axopZNuu1NWdYb3/PAFKzXIBxdvyS2CEXVo8JAeeHJPFGpzo6p
+bNRfk9WGWnjdu/4UhLkCQQCekR9zpIpzdJiPYCd6XMya+TPCDYlOQL1jlnJIRa2V
+BEOz0rSpzXAGh0PyCB/kMneyVk87LWn8joE6179RoUfv
+-----END RSA PRIVATE KEY-----

examples/websocket_client/ssl/server.key.orig

@@ -0,0 +1,18 @@
+-----BEGIN RSA PRIVATE KEY-----
+Proc-Type: 4,ENCRYPTED
+DEK-Info: DES-EDE3-CBC,89778A6427F05D4A
+
+4aXqO/8oCHVfMLB+a1DfjbXyEddjbd7nB+YVFLPKy68Tam9PRTvC1zRHBet59ll0
+1w7R8tXR6/xH7HRhBeqDHCcuvBhtw3xGxtXWv54WBFhzuq7TvKOAaCFl++cw/JHq
+PCS0rAaYnqF2MAgMi7QBjZKmHFHL43Gy60VfOrB0mmOdxqqXA0NBFC2uEd7Z/MAx
+S2A85bNJJKQaWEeDThP1u0OOlNCq99lkLJ31jiOH7ntdL0/vqcbZ+PUtdPLwAG4L
+1GUHuiC2v5FvDlPiejMk2dvrxCNpcu2e3tQKHpg2KcsTVrpB7EVzRSazln4HywUZ
+EJfBvxqqrS7plImZgj4LXSnln0JPuBb+aHnhKIFvisjYSwqDGJnnp/OaD7YdRhYh
+UCcL011Ge+yUbRipeAmHdtJlSUSdB14KWq+WdIX/KgCRGx06QZm9s1PBLH+fww+I
+EL3A/LFX0a5KUHkCp29akYYv9bUYaQ79Nt7BlaEON+/SW3pJMbGr+nx8aqogr0Yo
+SJ/Zz5TSDBhecRjbCDGkT6DizVZ8cbm2xl8QLBd0H+ZA6uYMgfpAOJGrJx3Nm4Lv
+prEApgFtjSrsQDGYHAcmDMW1UWOVHuNp7BSvwUze9Ftnzr/jlpdzES2rhgMyGhg1
+0Szbsfs3vgw4iM83LFJXza07GQJzF8gRF79dY5JiQX/sOKUprA6Lofk631jE0G8r
+3z59cxblaq9y7EgFsE944Gk7/HIEimBRiqIZzGVJVukD0itynQ+XmYTdbyH1lpvi
+c0ZheZPUoGwUW9RYy+nle5gEDFyZWXcCAuJasQvDBXt//r/bso3ZpA==
+-----END RSA PRIVATE KEY-----

examples/websocket_client/ssl/server.pem

@@ -0,0 +1,28 @@
+-----BEGIN CERTIFICATE-----
+MIICATCCAWoCCQC2BCIqIvgSUTANBgkqhkiG9w0BAQUFADBFMQswCQYDVQQGEwJB
+VTETMBEGA1UECAwKU29tZS1TdGF0ZTEhMB8GA1UECgwYSW50ZXJuZXQgV2lkZ2l0
+cyBQdHkgTHRkMB4XDTE0MDgyMTEyMzAwMVoXDTI0MDgxODEyMzAwMVowRTELMAkG
+A1UEBhMCQVUxEzARBgNVBAgMClNvbWUtU3RhdGUxITAfBgNVBAoMGEludGVybmV0
+IFdpZGdpdHMgUHR5IEx0ZDCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA9k9s
+gH22BCo9neTeB/YnilK7n0sMe0+pjS9KSWhU59Q4w8hqPrW0tuYikIDd0wVggkJF
+BZNg4WPoulTdwXsgNBeG88q2wnNtUosXTS+KQTQBSiQof9Ay9GHQtgxnogI1zIXb
+HOppyyG5zre8a/X6fzDOnFc4iJMBwxTAnjCqObkCAwEAATANBgkqhkiG9w0BAQUF
+AAOBgQBX9V46VUVsB9P9fb8sFuMx2ezFE42ynEeJPrKRrof+dFYbjvR1OUZFSLCy
+aZKwVH7iCnVBJiU12JxO7PR3L6ob3FYPyNHQWYq1/IFUvqBRagehldj5H8iFeEDz
+Wtz2+p1rUyVxcSUqTjobaji0aC8lzPZio0nd1KKM6A92/adHyQ==
+-----END CERTIFICATE-----
+-----BEGIN RSA PRIVATE KEY-----
+MIICXQIBAAKBgQD2T2yAfbYEKj2d5N4H9ieKUrufSwx7T6mNL0pJaFTn1DjDyGo+
+tbS25iKQgN3TBWCCQkUFk2DhY+i6VN3BeyA0F4bzyrbCc21SixdNL4pBNAFKJCh/
+0DL0YdC2DGeiAjXMhdsc6mnLIbnOt7xr9fp/MM6cVziIkwHDFMCeMKo5uQIDAQAB
+AoGAYwospr3lomcZv5N3c9wWqhf6OWMD8dFma87IIBxDh7Rd3tuHXQ/TSnffDhvD
+FkbjN31OI5/PJNH3knTtdg78MywPloE4jYsbt4+fEaW7Fzww2nU61N1p+mYk5d/b
+SCTAHhGzF9g9ZMw25CCUFGjDU2z+Ty6my22Euxhk2Qq8tMECQQD9ZYIxWkPhywDW
+pX3v70dqIv7411hEYpuL/ZJl26UCmQsj4HPtXQCraQksVPs74WY5aTtd6MAV9V3M
+UnErHO5/AkEA+NdG2MmfBOBPusDB/WwQaUPiCWGITS9llGTR2JXbvDqmKgL1+UTG
+o27sLNIFCrF1wejpyRGqwjcObFYR0yKrxwJBAOB2uPuK4DL1psp9Uq/mIDbOxVod
+OF1rlCpP9w0vol5Iv+uJ+mc7SUqOAsg4h0yl/+2/YA1yDiXlcq96IDF2sXUCQGAv
+Nh9Nr72+xpK1N0axopZNuu1NWdYb3/PAFKzXIBxdvyS2CEXVo8JAeeHJPFGpzo6p
+bNRfk9WGWnjdu/4UhLkCQQCekR9zpIpzdJiPYCd6XMya+TPCDYlOQL1jlnJIRa2V
+BEOz0rSpzXAGh0PyCB/kMneyVk87LWn8joE6179RoUfv
+-----END RSA PRIVATE KEY-----

examples/websocket_client/websocket_client.c

@@ -0,0 +1,73 @@
+/*
+* Copyright (c) 2014 Jordan Shelley
+* https://github.com/jshelley
+* License http://opensource.org/licenses/mit-license.php MIT License
+*/
+
+// Simple example program on how to use websocket client embedded C interface.
+#ifdef _WIN32
+#include <Windows.h>
+#else
+#include <unistd.h>
+#endif
+
+#include <string.h>
+#include "civetweb.h"
+
+#define DOCUMENT_ROOT "."
+#define PORT "8888"
+#define SSL_CERT "./ssl/server.pem"
+
+static int websocket_data_handler(struct mg_connection *conn, int flags, char *data, size_t data_len)
+{
+    printf("From server: %s\r\n", data);
+
+    return 1;
+}
+
+int main(int argc, char *argv[])
+{
+
+    const char * options[] = { "document_root", DOCUMENT_ROOT,
+                               "ssl_certificate", SSL_CERT,
+                               "listening_ports", PORT, 0
+                             };
+    struct mg_callbacks callbacks;
+    struct mg_context *ctx;
+
+    memset(&callbacks, 0, sizeof(callbacks));
+    ctx = mg_start(&callbacks, 0, options);
+
+    char ebuf[100];
+    struct mg_connection* newconn = mg_websocket_client_connect("echo.websocket.org", 443, 1,
+                             ebuf, sizeof(ebuf),
+                             "/", "http://websocket.org",websocket_data_handler);
+
+    if(newconn == NULL)
+    {
+        printf("Error: %s", ebuf);
+        return 1;
+    }
+
+    mg_websocket_write(newconn, WEBSOCKET_OPCODE_TEXT, "data1", 5);
+
+    sleep(5);
+
+    mg_websocket_write(newconn, WEBSOCKET_OPCODE_TEXT, "data2", 5);
+
+    sleep(5);
+
+    mg_websocket_write(newconn, WEBSOCKET_OPCODE_TEXT, "data3", 5);
+
+    sleep(5);
+
+    mg_websocket_write(newconn, WEBSOCKET_OPCODE_TEXT, "data4", 5);
+
+    sleep(5);
+
+    mg_close_connection(newconn);
+
+    printf("Bye!\n");
+
+    return 0;
+}

include/civetweb.h

@@ -573,6 +573,25 @@ CIVETWEB_API void mg_cry(struct mg_connection *conn,
 /* utility method to compare two buffers, case incensitive. */
 CIVETWEB_API int mg_strncasecmp(const char *s1, const char *s2, size_t len);
 
+/* Connect to a websocket as a client 
+   Parameters:
+     host: host to connect to, i.e. "echo.websocket.org" or "192.168.1.1" or "localhost"
+     port: server port
+     use_ssl: make a secure connection to server
+     error_buffer, error_buffer_size: error message placeholder.
+     path: server path you are trying to connect to, i.e. if connection to localhost/app, path should be "/app"
+     origin: value of the Origin HTTP header
+     data_func: callback that should be used when data is received from the server
+
+   Return:
+     On success, valid mg_connection object.
+     On error, NULL. */
+     
+typedef int  (*websocket_data_func)(struct mg_connection *, int bits,
+                           char *data, size_t data_len);
+CIVETWEB_API struct mg_connection *mg_websocket_client_connect(const char *host, int port, int use_ssl,
+                                               char *error_buffer, size_t error_buffer_size,
+                                               const char *path, const char *origin, websocket_data_func data_func);
 
 #ifdef __cplusplus
 }

src/civetweb.c

@@ -5144,7 +5144,8 @@ static void read_websocket(struct mg_connection *conn)
 
     /* Loop continuously, reading messages from the socket, invoking the
        callback, and waiting repeatedly until an error occurs. */
-    assert(conn->content_len == 0);
+    /* TODO: Investigate if this next line is needed
+    assert(conn->content_len == 0); */
     for (;;) {
         header_len = 0;
         assert(conn->data_len >= conn->request_len);
@@ -6444,6 +6445,75 @@ struct mg_connection *mg_download(const char *host, int port, int use_ssl,
     return conn;
 }
 
+static void* websocket_client_thread(void *data)
+{
+    struct mg_connection* conn = (struct mg_connection*)data;
+    read_websocket(conn);
+
+    DEBUG_TRACE("Websocket client thread exited\n");
+
+    return NULL;
+}
+
+struct mg_connection *mg_websocket_client_connect(const char *host, int port, int use_ssl,
+                                               char *error_buffer, size_t error_buffer_size,
+                                               const char *path, const char *origin, websocket_data_func data_func)
+{
+    static const char *magic = "x3JJHMbDL1EzLkh9GBhXDw==";
+    static const char *handshake_req;
+
+    if(origin != NULL)
+    {
+        handshake_req = "GET %s HTTP/1.1\r\n"
+                            "Host: %s\r\n"
+                            "Upgrade: websocket\r\n"
+                            "Connection: Upgrade\r\n"
+                            "Sec-WebSocket-Key: %s\r\n"
+                            "Sec-WebSocket-Version: 13\r\n"
+                            "Origin: %s\r\n"
+                             "\r\n";
+    }
+    else
+    {
+        handshake_req = "GET %s HTTP/1.1\r\n"
+                            "Host: %s\r\n"
+                            "Upgrade: websocket\r\n"
+                            "Connection: Upgrade\r\n"
+                            "Sec-WebSocket-Key: %s\r\n"
+                            "Sec-WebSocket-Version: 13\r\n"
+                             "\r\n";
+    }
+
+    /* Establish the client connection and request upgrade */
+    struct mg_connection* conn = mg_download(host, port, use_ssl,
+                             error_buffer, error_buffer_size,
+                             handshake_req, path, host, magic, origin);
+
+    /* Connection object will be null if something goes wrong */
+    if(conn == NULL || (strcmp(conn->request_info.uri, "101") != 0))
+    {
+        DEBUG_TRACE("Websocket client connect error: %s\r\n", error_buffer);
+        if(conn != NULL) { mg_free(conn); conn = NULL; }
+        return conn;
+    }
+
+    /* For client connections, mg_context is fake. Set the callback for websocket 
+     data manually here so that read_websocket will automatically call it */
+    conn->ctx->callbacks.websocket_data = data_func;
+
+    /* Start a thread to read the websocket client connection
+    This thread will automatically stop when mg_disconnect is 
+    called on the client connection */
+    if(mg_start_thread(websocket_client_thread, (void*)conn) != 0)
+    {
+        mg_free((void*)conn);
+        conn = NULL;
+        DEBUG_TRACE("Websocket client connect thread could not be started\r\n");
+    }
+
+    return conn;
+}
+
 static void process_new_connection(struct mg_connection *conn)
 {
     struct mg_request_info *ri = &conn->request_info;

test/unit_test.c

@@ -525,6 +525,57 @@ static void test_mg_download(int use_ssl) {
     mg_stop(ctx);
 }
 
+static int websocket_data_handler(struct mg_connection *conn, int flags, char *data, size_t data_len)
+{
+    return 1;
+}
+
+static void test_mg_websocket_client_connect(int use_ssl) {
+    struct mg_connection* conn;
+    char ebuf[100];
+    int port = HTTP_PORT;
+
+    if(use_ssl) { port = HTTPS_PORT; }
+
+    //Try to connect to our own server
+    //TODO: These do not work right now
+
+    //Invalid port test
+    /*conn = mg_client_websocket_connect("localhost", 0, use_ssl,
+                             ebuf, sizeof(ebuf),
+                             "/", "http://localhost",websocket_data_handler);
+    ASSERT(conn == NULL);
+
+    //Should succeed, the default civetweb sever should complete the handshake
+    conn = mg_client_websocket_connect("localhost", port, use_ssl,
+                             ebuf, sizeof(ebuf),
+                             "/", "http://localhost",websocket_data_handler);
+    ASSERT(conn != NULL);*/
+
+
+    //Try an external server test
+    port = 80;
+    if(use_ssl) { port = 443; }
+
+    //Not a websocket server path
+    conn = mg_websocket_client_connect("websocket.org", port, use_ssl,
+                             ebuf, sizeof(ebuf),
+                             "/", "http://websocket.org",websocket_data_handler);
+    ASSERT(conn == NULL);
+
+    //Invalid port test
+    conn = mg_websocket_client_connect("echo.websocket.org", 0, use_ssl,
+                             ebuf, sizeof(ebuf),
+                             "/", "http://websocket.org",websocket_data_handler);
+    ASSERT(conn == NULL);
+
+    //Should succeed, echo.websocket.org echos the data back
+    conn = mg_websocket_client_connect("echo.websocket.org", port, use_ssl,
+                             ebuf, sizeof(ebuf),
+                             "/", "http://websocket.org",websocket_data_handler);
+    ASSERT(conn != NULL);
+}
+
 static int alloc_printf(char **buf, size_t size, char *fmt, ...) {
     va_list ap;
     va_start(ap, fmt);
@@ -1015,6 +1066,12 @@ int __cdecl main(void) {
 #ifndef NO_SSL
     test_mg_download(1);
 #endif
+
+    test_mg_websocket_client_connect(0);
+#ifndef NO_SSL
+    test_mg_websocket_client_connect(1);
+#endif
+
     test_mg_upload();
     test_request_replies();
     test_api_calls();