Shadowsocks-NaCl

Shadowsocks-NaCl is a Native Client port of shadowsocks, provides high performance crypto and network relay on web browser which support Native Client.

Note: This port of shadowsocks is for Web App developer ONLY, NOT for the end user.

Build

1. Download and install Native Client SDK.

2. Set environment variable NACL_SDK_ROOT to SDK path (e.g., ~/nacl_sdk/pepper_41).

3. Checkout naclports.

4. Follow the instructions in naclports/README.rst to install naclports.

5. Build and install OpenSSL to Native Client SDK. (e.g., $ NACL_ARCH=pnacl make openssl)

6. Update libsodium in naclports form 0.4.5 to 1.0.3 since ChaCha20 had been add from 0.6.0. You may change the content of naclports/src/ports/libsodium/pkg_info to

   NAME=libsodium
   VERSION=1.0.3
   URL=https://github.com/jedisct1/libsodium/releases/download/1.0.3/libsodium-1.0.3.tar.gz
   LICENSE=ISC
   SHA1=e44ed485842966d4e2d8f58e74a5fd78fbfbe4b0
   

7. Build and install libsodium to Native Client SDK. (e.g., $ NACL_ARCH=pnacl make libsodium)

8. Clone this repository and use $ make to build.

Usage

Note: It is recommend to use Shadowsocks-NaCl JavaScript API to communicate with native client module. You just need include src/shadowsocks.js into your webapp page, initialize it, and invoke commands you need. For more details, see example in test_flight.js and read jsdoc in src/shadowsocks.js.

Also, you can do all things by yourself.

First, put an <embed> tag into webpage to load Native Client module, like:

<embed id="shadowsocks"
       width=0 height=0
       src="/pnacl/Release/shadowsocks.nmf"
       type="application/x-pnacl" />

Then you can use postMessage() API to connect with Native Client module.

Currently, shadowsocks-nacl accepts four types of command.

1. Command: connect. You can use it connect to a remote server.

   document.querySelector("#shadowsocks").postMessage({
       cmd: "connect",
       arg: {
           server: "example.com",  // Value must be a string
           server_port: 8388,      // Value must be a number
           local_port: 1080,       // Value must be a number
           method: "aes-256-cfb",  // Value must be a string and in supported method list
           password: "password"    // Value must be a string
           timeout: 300            // Value in seconds and must be a number
       }
   });

2. Command: disconnect. You can use it to disconnect from a remote server.

   document.querySelector("#shadowsocks").postMessage({
       cmd: "disconnect"
   });

3. Command: sweep. You should run this command repatedly in fixed time to sweep "deadly" connection.

   setInterval(function() {
       document.querySelector("#shadowsocks").postMessage({
           cmd: "sweep"
       });
   }, 120 * 1000);

4. Command: version. Invoke this command can log version to console.

   document.querySelector("#shadowsocks").postMessage({
       cmd: "version"
   });

Test flight

A Chromium App is provided to help testing and debugging.

You can open chrome://extensions/, check Developer Mode, click Load Unpacked Extension, select the root directory of this project.

You will find a new App named Shadowsocks NaCl Test flight in chrome://extensions/, click Inspect views: background page will open a developer tools window and you can try above-mentioned command here.

License

Shadowsocks-NaCl is licensed under GNU General Public License Version 3.

Shadowsocks-NaCl is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Shadowsocks-NaCl is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.