Multi-platform Socket connections

http://akinaru.github.io/socket-multiplatform

Last update 23/05/2015

This project will features socket connection implementation on multiple platforms and frameworks :

Java Browser C++ QT4
HTTP Server socket blocking no ssl
ssl
non-blocking no ssl
ssl
Server websocket blocking no ssl
ssl
non-blocking no ssl
ssl
HTTP Client socket no ssl
ssl
Client websocket no ssl
ssl
UDP server blocking no ssl
ssl
non-blocking no ssl
ssl
UDP Client no ssl
ssl
Java Browser C++ QT4

List of external projects :

How to launch Java HTTP Server socket

HttpServer server = new HttpServer(PORT);

server.start();

How to monitor my clients connected to server ?

Just add a Listener to server object. You have 1 callback that enables you to :

server.addServerEventListener(new IHttpServerEventListener() {

            @Override
            public void onHttpFrameReceived(IHttpFrame httpFrame,HttpStates receptionStates, IHttpStream httpStream) {

                //check if http frame is OK
                if (receptionStates == HttpStates.HTTP_FRAME_OK) {

                    //you can check here http frame type (response or request frame)
                    if (httpFrame.isHttpRequestFrame()) {

                        //we want to send a message to client for http GET request on page with uri /index
                        if (httpFrame.getMethod().equals("GET") && httpFrame.getUri().equals("/index")) {

                            HashMap<String, String> headers = new HashMap<String, String>();

                            String defaultPage = "Hello from custom Java HTTP Server\r\nThis page has been seen "
                                    + PAGE_VIEW_COUNT + " times before.";

                            // return default html page for this HTTP Server
                            httpStream.writeHttpResponseFrame(new HttpResponseFrame(
                                            StatusCodeList.OK, new HttpVersion(1, 1), headers, defaultPage.getBytes()));
                            PAGE_VIEW_COUNT++;
                        }
                    }
                }
            }
        });

Featured exemple display a message in client's browser when uri /index is called. When refreshing page counter will be incremented on displayed page.

IHttpFrame has following useful methods :

HttpStates enum can have following states :

IHttpStream enables you to answered to http client with :

IHttpResponseFrame and IHttpFrame are interface issued from http-endec-java project in http://akinaru.github.io/http-endec-java/

How to launch a SSL secured HTTP server ?

HttpServer server = new HttpServer(PORT);

server.setSsl(true); // set SSL to true (default is false)

Then you set your keystore, trustore, type of these certificates, filepath and passwords : 

server.setSSLParams(String KEYSTORE_DEFAULT_TYPE,
            String KEYSTORE_FILE_PATH,
            String TRUSTORE_FILE_PATH,
            String SSL_PROTOCOL,
            String KEYSTORE_PASSWORD,
            String TRUSTORE_PASSWORD);

Here is the description of all of these parameters :

Eventually add event listener as described above and start HTTP server : 

server.start();

Build/Connect a Java client socket

Build an instance of client socket for later connection to server on HOSTNAME:PORT

ClientSocket clientSocket = new ClientSocket(HOSTNAME, PORT);`

Add a client event listener to be notified when incoming http arrives from the server

clientSocket.addClientSocketEventListener(new IHttpClientListener() {

            @Override
            public void onIncomingHttpFrame(HttpFrame frame,
                    HttpStates httpStates, IClientSocket clientSocket) {

                //here test if http frame decoding is fine
                if (httpStates == HttpStates.HTTP_FRAME_OK && frame.isHttpResponseFrame()) {

                    //manage your response from the server or what you want

                }
            }
        });

You can write request to server with write(byte[] data) method :

clientSocket.write("GET /say_hello HTTP/1.1\r\n\r\n".getBytes("UTF-8"));

You can use http-endec library to build http frame request or response to be sent to the server : http://akinaru.github.io/http-endec-java/

The write(byte[] data) method will automatically connect to the server and send your http frame data direclty. A reading thread will be created on the fly and response from the server will be received there and dispatch to your client event listener, you have declared above.

Depending on your server implementation, client connection will be closed immediatly after http frame processing from the server. Reading thread will die shortly when no data remains to be read from the server socket.

Build/Connect a Java SSL client socket

This is the same as above but we add some SSL flavor to this :

Build an instance of client socket for later connection to server on HOSTNAME:PORT

ClientSocket clientSocket = new ClientSocket(HOSTNAME, PORT);

//set SSL encryption
clientSocket.setSsl(true);

Then you set your keystore, trustore, type of these certificates, filepath and passwords : 

clientSocket.setSSLParams(KEYSTORE_DEFAULT_TYPE, TRUSTORE_DEFAULT_TYPE,
        KEYSTORE_FILE_PATH, TRUSTORE_FILE_PATH, SSL_PROTOCOL,
        KEYSTORE_PASSWORD, TRUSTORE_PASSWORD);

Here is the description of all of these parameters :

Later, when you will write http frames to your client socket, all your data will be encrypted according to your SSL settings

Java UDP Server/Client

UDP Server and client are located in udp folder. One exemple features interactions between UDP server and UDP client in JAVA.

The following will start an UDP socket (running as server) on port defined by PORT : 

UdpServer udpServer = new UdpServer(PORT);

//add a server event listener
udpServer.addServerEventListener(new IUdpServerEventListener() {

    @Override
    public void onDataReceived(byte[] data, IUdpServer server,
            InetAddress clientAddress, int clientPort) {

        String dataStr = new String(data);

        System.out
                .println("[UDP SERVER] new data receveived in server : "
                        + dataStr);
    }
});

// UDP server is runnable : just run it into a thread ( naming the thread is recommended for debuggging )
Thread serverThread = new Thread(udpServer,"UDP_SERVER");

// start udp server
serverThread.start();

UDP client socket will broadcast data to this server : 

UdpClient udpClient = new UdpClient(InetAddress.getByName(SERVER_BROADCAST_IP), PORT);

udpClient.addClientEventListener(new IudpEventListener() {

    @Override
    public void onDataReceived(byte[] data) {
        System.out
                .println("[UDP CLIENT] new data receveived in client : "
                        + new String(data));
    }
});

To send a string message use : udpClient.sendMessage(String message); method : 

udpClient.sendMessage("HELLO");

Mecanism of event listener is exactly the same as explained before for client socket in Java or for Java websocket lib (http://akinaru.github.io/websocket-java/).

onDataReceived(byte[] data) for UDP client callback will enable you to get incoming data response from UDP server.

onDataReceived(byte[] data, IUdpServer server,InetAddress clientAddress, int clientPort) for UDP server callback will enable you to get incoming data from the client and to redispatch any response you want to this client thanks toIUdpServerobject that permits you to write abyte[]`` data like this :

server.write("Hello from websocket server".getBytes(),clientAddress, clientPort);

With address and port, UDP server will send your data back to client.

For now, I didn't put in place a timer mecanisme on client side, to close client receiving thread. TODO : timeout for client UDP socket waiting for response

Keystore : public and private server certificates

openssl pkcs12 -export -out server.p12 -inkey server.key -in server.crt

Thus, you will have : String KEYSTORE_DEFAULT_TYPE = "PKCS12"

You have to know your alias (name matching your cert entry), if you dont have it retrieve it with : keytool -v -list -storetype pkcs12 -keystore server.p12

keytool -importkeystore -srckeystore server.p12 -srcstoretype PKCS12 -deststoretype JKS -destkeystore server.jks

Thus, you will have : String KEYSTORE_DEFAULT_TYPE = "JKS"

Trustore : should contain only CA certificates

convert ca cert to jks :

keytool -import -alias ca -file ca.crt -keystore cacerts.jks -storepass 123456

Thus, you will have : String TRUSTORE_DEFAULT_TYPE = "JKS"

QT C++ Non Blocking HTTP server socket

Instantiation and start : 

HttpServer server;

server.listen(QHostAddress(IP),PORT);

You can add socket event listener that notify you of incominh http request/response 

ClientSocketHandler *clientHandler = new ClientSocketHandler();

server.addClientEventListener(clientHandler);

ClientSocketHandler inherit from interface IClientEventListener which contains following methods :

You can send http response or http request back to the client with IHttpClient got from previous callback.

IHttpClient has a sendHttpMessage(std::string message) for sending http message back to client

TroubleShooting

Bad certificate | Unknown CA errors

This could mean you didn't import your not-trusted-CA certificate into your browser.

The remote host closed the connection

Usually happen when your browser closed the connection before the end of SSL handshake. If you already added your CA to your browser dont worry. Both Chrome and Firefox need to MANUALLY add the certificate (in a popup) so putting it in parameter menu don't change anything.

Just load your URL with "https" : https://127.0.0.1:8443 . Browser will prompt you to accept the certificates and it will probably solve your connection error.

CKR_DOMAIN_PARAMS_INVALID error using openjdk

With openjdk-6-jdk and openjdk-7-jdk, I encountered java.security bug described in https://bugs.launchpad.net/ubuntu/+source/openjdk-7/+bug/1006776 triggering a CKR_DOMAIN_PARAMS_INVALID exception error. Solution was to edit java.security parameters in /etc/java-7-openjdk/security/java.security

I replaced that : 

security.provider.9=sun.security.smartcardio.SunPCSC
security.provider.10=sun.security.pkcs11.SunPKCS11 ${java.home}/lib/security/nss.cfg

with that : 

#security.provider.9=sun.security.smartcardio.SunPCSC
security.provider.9=sun.security.ec.SunEC
#security.provider.10=sun.security.pkcs11.SunPKCS11 ${java.home}/lib/security/nss.cfg

Browser tested

This has been tested on following browser :

Debugging SSL connection error

I recommmend using openssl command line tool to debug ssl connection :

openssl s_client -connect 127.0.0.1:8443

You can also use vm argument debugging java ssl implementation : -Djavax.net.debug=ssl

Server-Client key/cert generation

Certs are in libwesocket-test/certs folder, you will find server,client and ca cert build with easy-rsa :

https://github.com/OpenVPN/easy-rsa

With last release of easy-rsa, you can build your own key with the following :

How to close my HTTP server ?

server.closeServer();

COMMAND LINE SYNTAX

The following will open http server on port 4343 (default port value for my exemple)

java -cp ../libs/http-endec-1.0.jar:libsocket-1.0.jar fr.bmartel.network.LaunchServer

You can change port number by specifying yours

java -cp ../libs/http-endec-1.0.jar:libsocket-1.0.jar fr.bmartel.network.LaunchServer 4343

This exemple is launched from /release folder

Java HTTP server : Exemple with Browser HTTP client

This exemple is located in server/server-socket/blocking/no-ssl/java or server/server-socket/blocking/ssl/java

client side

QT C++ non-blocking HTTP server : Exemple with Browser HTTP client

This exemple is located in server/server-socket/non-blocking/no-ssl/cpp or server/server-socket/non-blocking/ssl/cpp

client side

Java HTTP client : Exemple with Java socket server <-> Java socket client

This exemple is located in client/socket-client/no-ssl/java or client/socket-client/ssl/java

Launch your LaunchClient java exec, it will :

client side

Java UDP Server <-> Java UDP client communications

This exemple is located in udp/ for the class : fr.bmartel.network.LaunchUdpSocket => This will launch one UDP server and one UDP client that connect to this server. UDP Server will send back a response to UDP client

Like all other socket connections lib, event listeners are used to catch data :

udp communication

Java

C++ QT

TODO : timeout for client UDP socket waiting for response