https://github.com/Jigsaw-Code/outline-shadowsocksconfig

Serialize Shadowsocks configuration data to and from SIP002 and legacy URI formats.
https://github.com/Jigsaw-Code/outline-shadowsocksconfig

Last synced: 5 days ago
JSON representation

Serialize Shadowsocks configuration data to and from SIP002 and legacy URI formats.

• Host: GitHub
• URL: https://github.com/Jigsaw-Code/outline-shadowsocksconfig
• Owner: Jigsaw-Code
• License: apache-2.0
• Created: 2018-03-06T23:43:13.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-09-22T04:45:08.000Z (about 1 year ago)
• Last Synced: 2024-08-01T21:56:39.133Z (3 months ago)
• Language: TypeScript
• Size: 185 KB
• Stars: 145
• Watchers: 23
• Forks: 51
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ShadowsocksConfig

[![Build Status](https://travis-ci.org/Jigsaw-Code/outline-shadowsocksconfig.svg?branch=master)](https://travis-ci.org/Jigsaw-Code/outline-shadowsocksconfig)

TypeScript library to store Shadowsocks configuration data

as well as (de)serialize it to/from SIP002 and legacy base64 URIs.

Node.js- and browser-friendly.

## References

- https://shadowsocks.org/en/config/quick-guide.html

- https://shadowsocks.org/en/spec/SIP002-URI-Scheme.html

## Fields, validation, and sanitization

Some fields are validated, normalized, and/or sanitized, but not all:

- `host`

  - May be an IPv4, IPv6, or hostname.

  - Unicode hostnames are converted to punycode.

  - Hostnames must begin with a character in the set `[A-z0-9]`.

- `port`

  - Must be an integer from 0 to 65535.

- `method`

  - One of the values specified in `shadowsocks_config.ts#METHODS`.

- `tag` \*

  - Only URI encoded/decoded.

- `password` \*

- `extra` \*

  - Any additional configuration (e.g. `timeout`, SIP003 `plugin`, etc.) may be stored here.

\* **No sanitization is performed for these fields.**

**Client code is responsible for sanitizing these values when received from untrusted input.**

## Usage

Please see [test/unit/shadowsocks_config.spec.ts](test/unit/shadowsocks_config.spec.ts)

for example usage.

## Development

First [install yarn](https://yarnpkg.com/en/docs/install-ci).

Then, install dependencies using yarn:

```

yarn

```

Then, build with the included script:

```

yarn run build

```

### Unit Tests

```

yarn run test

```

### Linting (tslint and commit formatting)

```

yarn run precommit

```