• Winrar >= 5.2.1 (Third party builds on windows)
• Boost >= 1.56.0
• OpenSSL >= 1.0.2
• Google Test >= 1.7.0
• CMake >= 2.8.11
• nasm (openssl build on windows)
• Perl | Active Perl >= 5.20 (openssl build on windows)
• C++11 compiler (Visual Studio 2013, Clang, g++, etc.)

SSF_SECURITY:

• STANDARD: the project will be build with standard security features
• FORCE_TCP_ONLY: the project will be built without security features to facilitate debugging

• Go in project directory

cd PROJECT_PATH

• Copy Boost archive in third_party/boost

cp boost_1_XX_Y.tar.bz2 PROJECT_PATH/third_party/boost

• Copy OpenSSL archive in third_party/openssl

cp openssl-1.0.XY.tar.gz PROJECT_PATH/third_party/openssl

If you are using openssl-1.0.2a, you need to fix the file crypto/x509v3/v3_scts.c. It contains an incorrect #include line. Copy the diff from OpenSSL Github (ignore the 2 first lines) and put it in PROJECT_PATH/third_party/openssl/patches. The build script will then patch the sources.

• Copy GTest archive in third_party/gtest

cp gtest-1.X.Y.zip PROJECT_PATH/third_party/gtest

• Generate project

mkdir PROJECT_PATH/build
cd PROJECT_PATH/build
cmake -G "GENERATOR" -DSSF_SECURITY:STRING="STANDARD|FORCE_TCP_ONLY" ../

• Build project

cd PROJECT_PATH/build
cmake --build `pwd` --config Debug|Release

• Go in project directory

cd PROJECT_PATH

• Copy Boost archive in third_party/boost

cp boost_1_XX_Y.tar.bz2 PROJECT_PATH/third_party/boost

• Copy OpenSSL archive in third_party/openssl

cp openssl-1.0.XY.tar.gz PROJECT_PATH/third_party/openssl

• Copy GTest archive in third_party/gtest

cp gtest-1.X.Y.zip PROJECT_PATH/third_party/gtest

• Generate project

mkdir PROJECT_PATH/build
cd PROJECT_PATH/build
cmake -G "GENERATOR" -DCMAKE_BUILD_TYPE=Release|Debug -DSSF_SECURITY:STRING="STANDARD|FORCE_TCP_ONLY" ../

• Build project

cmake --build PROJECT_PATH/build -- -j

• Go in project directory

cd PROJECT_PATH

• Copy Boost archive in third_party/boost

cp boost_1_XX_Y.tar.bz2 PROJECT_PATH/third_party/boost

• Copy OpenSSL archive in third_party/openssl

cp openssl-1.0.XY.tar.gz PROJECT_PATH/third_party/openssl

• Copy GTest archive in third_party/gtest

cp gtest-1.X.Y.zip PROJECT_PATH/third_party/gtest

• Generate project

mkdir PROJECT_PATH/build
cd PROJECT_PATH/build
cmake -G "GENERATOR" -DCMAKE_BUILD_TYPE=Release|Debug -DSSF_SECURITY:STRING="STANDARD|FORCE_TCP_ONLY" ../

• Build project

cmake --build PROJECT_PATH/build -- -j

./tools/generate_cert.sh /path/to/store/certs

The first argument should be the directory where the CA and certificates will be generated

openssl dhparam 4096 -outform PEM -out dh4096.pem

First of all, create a file named extfile.txt containing the following lines:

[ v3_req_p ]
basicConstraints = CA:FALSE
keyUsage = nonRepudiation, digitalSignature, keyEncipherment

Then, generate a self-signed certificate (the CA) ca.crt and its private key ca.key:

openssl req -x509 -nodes -newkey rsa:4096 -keyout ca.key -out ca.crt -days 3650

Generate a private key private.key and signing request certificate.csr:

openssl req -newkey rsa:4096 -nodes -keyout private.key -out certificate.csr

Sign with the CA (ca.crt, ca.key) the signing request to get the certificate certificate.pem :

openssl x509 -extfile extfile.txt -extensions v3_req_p -req -sha1 -days 3650 -CA ca.crt -CAkey ca.key -CAcreateserial -in certificate.csr -out certificate.pem

With default options, the following files and folders should be in the directory of execution of a client or a server:

• ./certs/dh4096.pem
• ./certs/certificate.crt
• ./certs/private.key
• ./certs/trusted/ca.crt

Where:

• dh4096.pem contains the Diffie-Hellman parameters (see above for how to generate the file)
• certificate.crt and private.key are the certificate and the private key of the ssf server or client
• ca.crt is the concatenated list of certificates trusted by the ssf server or client

However, if you want those files at different paths, it is possible to customize them with the configuration file option -c.

An example is given in the file example section.

This file will contain the bounce servers and ports which will be used to establish the connection. They will be listed as follow :

SERVER1:PORT1
SERVER2:PORT2
SERVER3:PORT3

The chain will be CLIENT -> SERVER1:PORT1 -> SERVER2:PORT2 -> SERVER3:PORT3 -> TARGET

SSF_<Server|Client>[.exe] [-L loc:ip:dest] [-R rem:ip:dest] [-D port] [-F port] [-U loc:ip:dest] [-V rem:ip:dest] [-b bounce_file] [-c config_file] [-p port] [host]

• host : the IP address or the name of the remote server to connect to.
• -p : port is the port on which to listen (for the server) or to connect (for the client). The default value is 8011.
• -L : TCP port forwarding with loc as the local TCP port, ip and dest as destination toward which the forward should be done from the server.
• -R : TCP remote port forwarding with rem as the TCP port to forward from the remote host, ip and dest as destination toward which the forward should be done from the client.
• -D : open a port (port) on the client to connect to a SOCKS server on the server from the client.
• -F : open a port (port) on the server to connect to a SOCKS server on the client from the server.
• -U : UDP port forwarding with loc as the UDP port to forward from the client, ip and dest as destination toward which the forward should be done from the server.
• -V : UDP remote port forwarding with rem as the UDP port to forward from the server, ip and dest as destination toward which the forward should be done from the client.
• -b : bounce_file is the file containing the list of relays to use.
• -c : config_file is the config file containing configuration for SSF (TLS configuration).

127.0.0.1:8002
127.0.0.1:8003

{
    "ssf": {
        "tls": {
            "ca_cert_path": "./certs/trusted/ca.crt",
            "cert_path": "./certs/certificate.crt",
            "key_path": "./certs/private.key",
            "dh_path": "./certs/dh4096.pem",
            "cipher_alg": "DHE-RSA-AES256-GCM-SHA384"
        }
    }
}

• tls.ca_cert_path : relative or absolute path to the CA certificate file
• tls.cert_path : relative or absolute path to the instance certificate file
• tls.key_path : relative or absolute path to the private key file
• tls.dh_path : relative or absolute path to the Diffie-Hellman file
• tls.cipher_alg : cypher algorithm