# ss-local

> A minimal shadowsocks local server implemented by nodejs.

Latest version **1.0.1** (published 2018-09-12) · ISC license · 0 weekly downloads

## Install

```sh
npm install ss-local
pnpm add ss-local
yarn add ss-local
bun add ss-local
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2018-09-12 |
| First published | 2018-08-20 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 11.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Yongsheng Xu |
| Maintainers | chux0519 |
| Keywords | shadowsocks, client, local |

## Links

- npm: https://www.npmjs.com/package/ss-local
- npm.io page: https://npm.io/package/ss-local

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2018-09-12
- 1.0.0 — 2018-08-20

## README

# ss-local

A minimal shadowsocks local server implemented by nodejs.

Because of using [stream.pipeline](https://nodejs.org/dist/latest-v10.x/docs/api/stream.html#stream_stream_pipeline_streams_callback), 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](#ciphers) supported
- minimal code

## quickstart

1. install via npm

    > npm install --save ss-local

2. start local server

    ```javascript
    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](https://shadowsocks.org/en/spec/Stream-Ciphers.html) are supported.

- [x] aes-128-ctr
- [x] aes-192-ctr
- [x] aes-256-ctr
- [x] aes-128-cfb
- [x] aes-192-cfb
- [x] aes-256-cfb
- [x] camellia-128-cfb
- [x] camellia-192-cfb
- [x] camellia-256-cfb
- [ ] chacha20-ietf

---
_Source: https://npm.io/package/ss-local · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._