1.0.1 • Published 6 years ago

ss-local v1.0.1

Weekly downloads
2
License
ISC
Repository
-
Last release
6 years ago

ss-local

A minimal shadowsocks local server implemented by nodejs.

Because of using stream.pipeline, node version must be greater than 10.

ps: This is an unstable poc project, might be rewrite after some time.

feature

  • TCP support (only)
  • mutiple cipher supported
  • minimal code

quickstart

  1. install via npm

    npm install --save ss-local

  2. start local server

    const createServer = require('ss-local')
    
    const server = createServer({
      host: '127.0.0.1',
      port: 8388,
      password: 'password',
      method: 'aes-256-cfb'
    })
    
    server.listen(1088, () => { console.log('serve at 1088') })
  3. test via curl

    curl 7.54.0 (x86_64-apple-darwin17.0) libcurl/7.54.0 LibreSSL/2.0.20 zlib/1.2.11 nghttp2/1.24.0

    curl https://github.com/ --socks5 127.0.0.1:1088

ciphers

Most ciphers recommended here are supported.

  • aes-128-ctr
  • aes-192-ctr
  • aes-256-ctr
  • aes-128-cfb
  • aes-192-cfb
  • aes-256-cfb
  • camellia-128-cfb
  • camellia-192-cfb
  • camellia-256-cfb
  • chacha20-ietf