IOT>> shadowsocks-rust>> 返回
项目作者： shadowsocks

项目描述 ：
A Rust port of shadowsocks
高级语言： Rust
项目地址: git://github.com/shadowsocks/shadowsocks-rust.git
创建时间： 2014-10-15T11:02:36Z
项目社区：https://github.com/shadowsocks/shadowsocks-rust
开源协议：MIT License
下载


shadowsocks

License
Build & Test
Build MSRV
Build Releases
Build Nightly Releases
Gurubase

crates.io
Release
shadowsocks-rust
aur shadowsocks-rust-git
NixOS
snap shadowsocks-rust
homebrew shadowsocks-rust
MacPorts shadowsocks-rust

This is a port of shadowsocks.

shadowsocks is a fast tunnel proxy that helps you bypass firewalls.

Library Description
shadowsocks crates.io docs.rs shadowsocks core protocol
shadowsocks-service crates.io docs.rs Services for serving shadowsocks
shadowsocks-rust crates.io Binaries running common shadowsocks services

Related Projects:

Build & Install

Optional Features

  • hickory-dns - Uses hickory-resolver as DNS resolver instead of tokio‘s builtin.

  • local-http - Allow using HTTP protocol for sslocal

    • local-http-native-tls - Support HTTPS with native-tls

    • local-http-rustls - Support HTTPS with rustls

  • local-tunnel - Allow using tunnel protocol for sslocal

  • local-socks4 - Allow using SOCKS4/4a protocol for sslocal

  • local-redir - Allow using redir (transparent proxy) protocol for sslocal

  • local-dns - Allow using dns protocol for sslocal, serves as a DNS server proxying queries to local or remote DNS servers by ACL rules

  • local-fake-dns - FakeDNS, allocating an IP address for each individual Query from a specific IP pool

  • local-tun - TUN interface support for sslocal

  • local-online-config - SIP008 Online Configuration Delivery

  • stream-cipher - Enable deprecated stream ciphers. WARN: stream ciphers are UNSAFE!

  • aead-cipher-extra - Enable non-standard AEAD ciphers

  • aead-cipher-2022 - Enable AEAD-2022 ciphers (SIP022)

  • aead-cipher-2022-extra - Enable AEAD-2022 extra ciphers (non-standard ciphers)

Memory Allocators

This project uses system (libc) memory allocator (Rust’s default). But it also allows you to use other famous allocators by features:

  • jemalloc - Uses jemalloc as global memory allocator
  • mimalloc - Uses mi-malloc as global memory allocator
  • tcmalloc - Uses TCMalloc as global memory allocator. It tries to link system-wide tcmalloc by default, use vendored from source with tcmalloc-vendored.
  • snmalloc - Uses snmalloc as global memory allocator
  • rpmalloc - Uses rpmalloc as global memory allocator

crates.io

Install from crates.io:

  1. # Install from crates.io
  2. cargo install shadowsocks-rust

then you can find sslocal and ssserver in $CARGO_HOME/bin.

Install using Homebrew

For macOS and Linux, you can install it using Homebrew:

  1. brew install shadowsocks-rust

Install using snap

  1. # Install from snapstore
  2. snap install shadowsocks-rust
  4. # List services
  5. snap services shadowsocks-rust
  7. # Enable and start shadowsocks-rust.sslocal-daemon snap service
  8. snap start --enable shadowsocks-rust.sslocal-daemon
  10. # Show generated systemd service status
  11. systemctl status snap.shadowsocks-rust.sslocal-daemon.service
  13. # Override generated systemd service (configure startup options)
  14. systemctl edit snap.shadowsocks-rust.sslocal-daemon.service
  16. ## NOTE: you can pass args to sslocal:
  17. ##  [Service]
  18. ##  ExecStart=
  19. ##  ExecStart=/usr/bin/snap run shadowsocks-rust.sslocal-daemon -b "127.0.0.1:1080" --server-url "ss://...."
  21. # Restart generated systemd service to apply changes
  22. systemctl restart snap.shadowsocks-rust.sslocal-daemon.service
  24. # ... and show service status
  25. systemctl status snap.shadowsocks-rust.sslocal-daemon.service

Default configuration file path probably is /var/snap/shadowsocks-rust/common/etc/shadowsocks-rust/config.json.

Download release

Download static-linked build here.

  • Most of them are built with cross. Build environment details could be found in its README, such as glibc’s version.
  • x86_64-apple-darwin, aarch64-apple-darwin are built in github’s macos-latest image. Information could be found in here.
  • x86_64-pc-windows-msvc is built in github’s windows-latest image. Information could be found in here.

Docker

This project provided Docker images for the linux/i386 and linux/amd64 and linux/arm64/v8 architectures.

:warning: Docker containers do not have access to IPv6 by default: Make sure to disable IPv6 Route in the client or enable IPv6 access to docker containers.

Pull from GitHub Container Registry

Docker will pull the image of the appropriate architecture from our GitHub Packages.

  1. docker pull ghcr.io/shadowsocks/sslocal-rust:latest
  2. docker pull ghcr.io/shadowsocks/ssserver-rust:latest

Build on the local machine（Optional）

If you want to build the Docker image yourself, you need to use the BuildX.

  1. docker buildx build -t shadowsocks/ssserver-rust:latest -t shadowsocks/ssserver-rust:v1.15.2 --target ssserver .
  2. docker buildx build -t shadowsocks/sslocal-rust:latest -t shadowsocks/sslocal-rust:v1.15.2 --target sslocal .

Run the container

You need to mount the configuration file into the container and create an external port map for the container to connect to it.

  1. docker run --name sslocal-rust \
  2.   --restart always \
  3.   -p 1080:1080/tcp \
  4.   -v /path/to/config.json:/etc/shadowsocks-rust/config.json \
  5.   -dit ghcr.io/shadowsocks/sslocal-rust:latest
  7. docker run --name ssserver-rust \
  8.   --restart always \
  9.   -p 8388:8388/tcp \
  10.   -p 8388:8388/udp \
  11.   -v /path/to/config.json:/etc/shadowsocks-rust/config.json \
  12.   -dit ghcr.io/shadowsocks/ssserver-rust:latest

Deploy to Kubernetes

This project provided yaml manifests for deploying to Kubernetes.

You can leverage k8s Service to expose traffic outside, like LoadBalancer or NodePort which gains more fine-grained compared with fixed host or port.

For a more interesting use case, you can use a Ingress(Istio, nginx, etc.) which routes the matched traffic to shadowsocks along with the real web service.

Using kubectl

kubectl apply -f https://github.com/shadowsocks/shadowsocks-rust/raw/master/k8s/shadowsocks-rust.yaml

You can change the config via editing the ConfigMap named shadowsocks-rust.

For more fine-grained control, use helm.

Using helm

helm install my-release k8s/chart -f my-values.yaml

Below is the common default values you can change:

  1. # This is the shadowsocks config which will be mount to /etc/shadowocks-rust.
  2. # You can put arbitrary yaml here, and it will be translated to json before mounting.
  3. servers:
  4. - server: "::"
  5.   server_port: 8388
  6.   service_port: 80 # the k8s service port, default to server_port
  7.   password: mypassword
  8.   method: aes-256-gcm
  9.   fast_open: true
  10.   mode: tcp_and_udp
  11.   # plugin: v2ray-plugin
  12.   # plugin_opts: server;tls;host=github.com
  14. # Whether to download v2ray and xray plugin.
  15. downloadPlugins: false
  17. # Name of the ConfigMap with config.json configuration for shadowsocks-rust.
  18. configMapName: ""
  20. service:
  21.   # Change to LoadBalancer if you are behind a cloud provider like aws, gce, or tke.
  22.   type: ClusterIP
  24. # Bind shadowsocks port port to host, i.e., we can use host:port to access shawdowsocks server.
  25. hostPort: false
  27. replicaCount: 1
  29. image:
  30.   repository: ghcr.io/shadowsocks/ssserver-rust
  31.   pullPolicy: IfNotPresent
  32.   # Overrides the image tag whose default is the chart appVersion.
  33.   tag: "latest"

Build from source

Use cargo to build. NOTE: RAM >= 2GiB

  1. cargo build --release

Then sslocal and ssserver will appear in ./target/(debug|release)/, it works similarly as the two binaries in the official ShadowSocks’ implementation.

  1. make install TARGET=release

Then sslocal, ssserver, ssmanager and ssurl will be installed to /usr/local/bin (variable PREFIX).

For Windows users, if you have encountered any problem in building, check and discuss in #102.

target-cpu optimization

If you are building for your current CPU platform (for example, build and run on your personal computer), it is recommended to set target-cpu=native feature to let rustc generate and optimize code for the CPU running the compiler.

  1. export RUSTFLAGS="-C target-cpu=native"

Build standalone binaries

Requirements:

  • Docker
  1. ./build/build-release

Then sslocal, ssserver, ssmanager, ssservice and ssurl will be packaged in

  • ./build/shadowsocks-${VERSION}-stable.x86_64-unknown-linux-musl.tar.xz
  • ./build/shadowsocks-${VERSION}-stable.x86_64-pc-windows-gnu.zip

Read Cargo.toml for more details.

For Linux with low GLIBC versions, set CROSS_CONFIG to CentOS based image:

  1. export CROSS_CONFIG=Cross-centos.toml

Getting Started

Generate a safe and secured password for a specific encryption method (aes-128-gcm in the example) with:

  1. ssservice genkey -m "aes-128-gcm"

Create a ShadowSocks’ configuration file. Example

  1. {
  2.     "server": "my_server_ip",
  3.     "server_port": 8388,
  4.     "password": "rwQc8qPXVsRpGx3uW+Y3Lj4Y42yF9Bs0xg1pmx8/+bo=",
  5.     "method": "aes-256-gcm",
  6.     // ONLY FOR `sslocal`
  7.     // Delete these lines if you are running `ssserver` or `ssmanager`
  8.     "local_address": "127.0.0.1",
  9.     "local_port": 1080
  10. }

Detailed explanation of the configuration file could be found in shadowsocks’ documentation. (Link to original project, not maintained anymore !)

:warning: For snap installations, configuration file is most probably located in /var/snap/shadowsocks-rust/common/etc/shadowsocks-rust/config.json (see https://github.com/shadowsocks/shadowsocks-rust/issues/621 / https://github.com/shadowsocks/shadowsocks-rust/issues/1146)

In shadowsocks-rust, we also have an extended configuration file format, which is able to define more than one server. You can also disable individual servers.

  1. {
  2.     "servers": [
  3.         {
  4.             "server": "127.0.0.1",
  5.             "server_port": 8388,
  6.             "password": "rwQc8qPXVsRpGx3uW+Y3Lj4Y42yF9Bs0xg1pmx8/+bo=",
  7.             "method": "aes-256-gcm",
  8.             "timeout": 7200
  9.         },
  10.         {
  11.             "server": "127.0.0.1",
  12.             "server_port": 8389,
  13.             "password": "/dliNXn5V4jg6vBW4MnC1I8Jljg9x7vSihmk6UZpRBM=",
  14.             "method": "chacha20-ietf-poly1305"
  15.         },
  16.         {
  17.             "disabled": true,
  18.             "server": "eg.disable.me",
  19.             "server_port": 8390,
  20.             "password": "mGvbWWay8ueP9IHnV5F1uWGN2BRToiVCAWJmWOTLU24=",
  21.             "method": "chacha20-ietf-poly1305"
  22.         }
  23.     ],
  24.     // ONLY FOR `sslocal`
  25.     // Delete these lines if you are running `ssserver` or `ssmanager`
  26.     "local_port": 1080,
  27.     "local_address": "127.0.0.1"
  28. }

sslocal automatically selects the best server with the lowest latency and the highest availability.

Start Shadowsocks client and server with:

  1. sslocal -c config.json
  2. ssserver -c config.json

If you Build it with Cargo:

  1. cargo run --bin sslocal -- -c config.json
  2. cargo run --bin ssserver -- -c config.json

List all available arguments with -h.

Usage

Start local client with configuration file

  1. # Read local client configuration from file
  2. sslocal -c /path/to/shadowsocks.json

Socks5 Local client

  1. # Pass all parameters via command line
  2. sslocal -b "127.0.0.1:1080" -s "[::1]:8388" -m "aes-256-gcm" -k "hello-kitty" --plugin "v2ray-plugin" --plugin-opts "server;tls;host=github.com"
  4. # Pass server with SIP002 URL
  5. sslocal -b "127.0.0.1:1080" --server-url "ss://YWVzLTI1Ni1nY206cGFzc3dvcmQ@127.0.0.1:8388/?plugin=v2ray-plugin%3Bserver%3Btls%3Bhost%3Dgithub.com"

HTTP Local client

  1. sslocal -b "127.0.0.1:3128" --protocol http -s "[::1]:8388" -m "aes-256-gcm" -k "hello-kitty"

All parameters are the same as Socks5 client, except --protocol http.

Tunnel Local client

  1. # Set 127.0.0.1:8080 as the target for forwarding to
  2. sslocal --protocol tunnel -b "127.0.0.1:3128" -f "127.0.0.1:8080" -s "[::1]:8388" -m "aes-256-gcm" -k "hello-kitty"
  • --protocol tunnel enables local client Tunnel mode
  • -f "127.0.0.1:8080 sets the tunnel target address

Transparent Proxy Local client

NOTE: It currently only supports

  • Linux (with iptables targets REDIRECT and TPROXY)
  • BSDs (with pf), such as OS X 10.10+, FreeBSD, …
  1. sslocal -b "127.0.0.1:60080" --protocol redir -s "[::1]:8388" -m "aes-256-gcm" -k "hello-kitty" --tcp-redir "redirect" --udp-redir "tproxy"

Redirects connections with iptables configurations to the port that sslocal is listening on.

  • --protocol redir enables local client Redir mode
  • (optional) --tcp-redir sets TCP mode to REDIRECT (Linux)
  • (optional) --udp-redir sets UDP mode to TPROXY (Linux)

Tun interface client

NOTE: It currently only supports

  • Linux, Android
  • macOS, iOS
  • Windows

Linux

Create a Tun interface with name tun0

  1. ip tuntap add mode tun tun0
  2. ifconfig tun0 inet 10.255.0.1 netmask 255.255.255.0 up

Start sslocal with --protocol tun and binds to tun0

  1. sslocal --protocol tun -s "[::1]:8388" -m "aes-256-gcm" -k "hello-kitty" --outbound-bind-interface lo0 --tun-interface-name tun0

macOS

  1. sslocal --protocol tun -s "[::1]:8388" -m "aes-256-gcm" -k "hello-kitty" --outbound-bind-interface lo0 --tun-interface-address 10.255.0.1/24

It will create a Tun interface with address 10.255.0.1 and netmask 255.255.255.0.

Windows

Download wintun.dll from Wintun, and place it in the folder with shadowsocks’ runnable binaries, or in the system PATH.

  1. sslocal --protocol tun -s "[::1]:8388" -m "aes-256-gcm" -k "hello-kitty" --outbound-bind-interface "Ethernet 0" --tun-interface-name "shadowsocks"

Local client for Windows Service

Compile it by enabling --features "winservice" (not included in the default build):

  1. cargo build --release --bin "sswinservice" --features "winservice"

Install it as a Windows Service (PowerShell):

  1. New-Service -Name "shadowsocks-local-service" `
  2.             -DisplayName "Shadowsocks Local Service" `
  3.             -BinaryPathName "<Path\to>\sswinservice.exe local -c <Path\to>\local_config.json"

There are other ways to install sswinservice as a Windows Service, for example, the sc command.

As you may have noticed that the -BinaryPathName contains not only just the sswinservice.exe, but local -c local_config.json. These command line parameters will be used as the default parameter when the Windows Service starts. You can also start the service with customized parameters.

Learn more from Microsoft’s Document.

The sswinservice‘s parameter works exactly the same as ssservice. It supports local, server and manager subcommands.

Server

  1. # Read server configuration from file
  2. ssserver -c /path/to/shadowsocks.json
  4. # Pass all parameters via command line
  5. ssserver -s "[::]:8388" -m "aes-256-gcm" -k "hello-kitty" --plugin "v2ray-plugin" --plugin-opts "server;tls;host=github.com"

Server Manager

Supported Manage Multiple Users API:

  • add - Starts a server instance
  • remove - Deletes an existing server instance
  • list - Lists all current running servers
  • ping - Lists all servers’ statistic data

NOTE: stat command is not supported. Because servers are running in the same process with the manager itself.

  1. # Start it just with --manager-address command line parameter
  2. ssmanager --manager-address "127.0.0.1:6100"
  4. # For *nix system, manager can bind to unix socket address
  5. ssmanager --manager-address "/tmp/shadowsocks-manager.sock"
  7. # You can also provide a configuration file
  8. #
  9. # `manager_address` key must be provided in the configuration file
  10. ssmanager -c /path/to/shadowsocks.json
  12. # Create one server by UDP
  13. echo 'add: {"server_port":8388,"password":"hello-kitty"}' | nc -u '127.0.0.1' '6100'
  15. # Close one server by unix socket
  16. echo 'remove: {"server_port":8388}' | nc -Uu '/tmp/shadowsocks-manager.sock'

For manager UI, check more details in the shadowsocks-manager project.

Example configuration:

  1. {
  2.     // Required option
  3.     // Address that ssmanager is listening on
  4.     "manager_address": "127.0.0.1",
  5.     "manager_port": 6100,
  7.     // Or bind to a Unix Domain Socket
  8.     "manager_address": "/tmp/shadowsocks-manager.sock",
  10.     "servers": [
  11.         // These servers will be started automatically when ssmanager is started
  12.     ],
  14.     // Outbound socket binds to this IP address
  15.     // For choosing different network interface on the same machine
  16.     "local_address": "xxx.xxx.xxx.xxx",
  18.     // Other options that may be passed directly to new servers
  19. }

Configuration

  1. {
  2.     // LOCAL: Listen address. This is exactly the same as `locals[0]`
  3.     // SERVER: Bind address for remote sockets, mostly used for choosing interface
  4.     //         Don't set it if you don't know what's this for.
  5.     "local_address": "127.0.0.1",
  6.     "local_port": 1080,
  8.     // Extended multiple local configuration
  9.     "locals": [
  10.         {
  11.             // Basic configuration, a SOCKS5 local server
  12.             "local_address": "127.0.0.1",
  13.             "local_port": 1080,
  14.             // OPTIONAL. Setting the `mode` for this specific local server instance.
  15.             // If not set, it will derive from the outer `mode`
  16.             "mode": "tcp_and_udp",
  17.             // OPTIONAL. Authentication configuration file
  18.             // Configuration file document could be found in the next section.
  19.             "socks5_auth_config_path": "/path/to/auth.json",
  20.             // OPTIONAL. Instance specific ACL
  21.             "acl": "/path/to/acl/file.acl",
  22.             // OPTIONAL. macOS launchd activate socket
  23.             "launchd_tcp_socket_name": "TCPListener",
  24.             "launchd_udp_socket_name": "UDPListener"
  25.         },
  26.         {
  27.             // SOCKS5, SOCKS4/4a local server
  28.             "protocol": "socks",
  29.             // Listen address
  30.             "local_address": "127.0.0.1",
  31.             "local_port": 1081,
  32.             // OPTIONAL. Enables UDP relay
  33.             "mode": "tcp_and_udp",
  34.             // OPTIONAL. Customizing the UDP's binding address. Depending on `mode`, if
  35.             // - TCP is enabled, then SOCKS5's UDP Association command will return this address
  36.             // - UDP is enabled, then SOCKS5's UDP server will listen to this address.
  37.             "local_udp_address": "127.0.0.1",
  38.             "local_udp_port": 2081,
  39.             // OPTIONAL. macOS launchd activate socket
  40.             "launchd_tcp_socket_name": "TCPListener",
  41.             "launchd_udp_socket_name": "UDPListener"
  42.         },
  43.         {
  44.             // Tunnel local server (feature = "local-tunnel")
  45.             "protocol": "tunnel",
  46.             // Listen address
  47.             "local_address": "127.0.0.1",
  48.             "local_port": 5353,
  49.             // Forward address, the target of this tunnel
  50.             // In this example, this will build a `127.0.0.1:5353` -> `8.8.8.8:53` tunnel
  51.             "forward_address": "8.8.8.8",
  52.             "forward_port": 53,
  53.             // OPTIONAL. Customizing whether to start TCP and UDP tunnel
  54.             "mode": "tcp_only",
  55.             // OPTIONAL. macOS launchd activate socket
  56.             "launchd_tcp_socket_name": "TCPListener",
  57.             "launchd_udp_socket_name": "UDPListener"
  58.         },
  59.         {
  60.             // HTTP local server (feature = "local-http")
  61.             "protocol": "http",
  62.             // Listen address
  63.             "local_address": "127.0.0.1",
  64.             "local_port": 3128,
  65.             // OPTIONAL. macOS launchd activate socket
  66.             "launchd_tcp_socket_name": "TCPListener"
  67.         },
  68.         {
  69.             // DNS local server (feature = "local-dns")
  70.             // This DNS works like China-DNS, it will send requests to `local_dns` and `remote_dns` and choose by ACL rules
  71.             "protocol": "dns",
  72.             // Listen address
  73.             "local_address": "127.0.0.1",
  74.             "local_port": 53,
  75.             // OPTIONAL. DNS local server uses `tcp_and_udp` mode by default
  76.             "mode": "udp_only",
  77.             // Local DNS address, DNS queries will be sent directly to this address
  78.             "local_dns_address": "114.114.114.114",
  79.             // OPTIONAL. Local DNS's port, 53 by default
  80.             "local_dns_port": 53,
  81.             // Remote DNS address, DNS queries will be sent through ssserver to this address
  82.             "remote_dns_address": "8.8.8.8",
  83.             // OPTIONAL. Remote DNS's port, 53 by default
  84.             "remote_dns_port": 53,
  85.             // OPTIONAL. dns client cache size for fetching dns queries.
  86.             "client_cache_size": 5,
  87.             // OPTIONAL. macOS launchd activate socket
  88.             "launchd_tcp_socket_name": "TCPListener",
  89.             "launchd_udp_socket_name": "UDPListener"
  90.         },
  91.         {
  92.             // Tun local server (feature = "local-tun")
  93.             "protocol": "tun",
  94.             // Tun interface name
  95.             "tun_interface_name": "tun0",
  96.             // Tun interface address
  97.             //
  98.             // It has to be a host address in CIDR form
  99.             "tun_interface_address": "10.255.0.1/24"
  100.         },
  101.         {
  102.             // Transparent Proxy (redir) local server (feature = "local-redir")
  103.             "protocol": "redir",
  104.             // OPTIONAL: TCP type, may be different between platforms
  105.             // Linux/Android: redirect (default), tproxy
  106.             // FreeBSD/OpenBSD: pf (default), ipfw
  107.             // NetBSD/macOS/Solaris: pf (default), ipfw
  108.             "tcp_redir": "tproxy",
  109.             // OPTIONAL: UDP type, may be different between platforms
  110.             // Linux/Android: tproxy (default)
  111.             // FreeBSD/OpenBSD: pf (default)
  112.             "udp_redir": "tproxy"
  113.         },
  114.         {
  115.             // FakeDNS local server (feature = "local-fake-dns")
  116.             // FakeDNS is a DNS server that allocates an IPv4 / IPv6 address in a specific pool for each queries.
  117.             // Subsequence requests from the other local interfaces that the target addresses includes those allocated IP addresses,
  118.             // will be substituted back to their original domain name addresses.
  119.             // This feature is useful mostly for transparent proxy, which will allow the proxied domain names to be resolved remotely.
  120.             "protocol": "fake-dns",
  121.             // Listen address
  122.             "local_address": "127.0.0.1",
  123.             "local_port": 10053,
  124.             // IPv4 address pool (for A records)
  125.             "fake_dns_ipv4_network": "10.255.0.0/16",
  126.             // IPv6 address pool (for AAAA records)
  127.             "fake_dns_ipv6_network": "fdf2:e786:ab40:9d2f::/64",
  128.             // Persistent storage for all allocated DNS records
  129.             "fake_dns_database_path": "/var/shadowsocks/fakedns.db",
  130.             // OPTIONAL: Record expire duration in seconds, 10s by default
  131.             "fake_dns_record_expire_duration": 10
  132.         }
  133.     ],
  135.     // Server configuration
  136.     // listen on :: for dual stack support, no need add [] around.
  137.     "server": "::",
  138.     // Change to use your custom port number
  139.     "server_port": 8388,
  140.     "method": "aes-256-gcm",
  141.     "password": "your-password",
  142.     "plugin": "v2ray-plugin",
  143.     "plugin_opts": "mode=quic;host=github.com",
  144.     "plugin_args": [
  145.         // Each line is an argument passed to "plugin"
  146.         "--verbose"
  147.     ],
  148.     "plugin_mode": "tcp_and_udp", // SIP003u, default is "tcp_only"
  149.     // Server: TCP socket timeout in seconds.
  150.     // Client: TCP connection timeout in seconds.
  151.     // Omit this field if you don't have specific needs.
  152.     "timeout": 7200,
  154.     // Extended multiple server configuration
  155.     // LOCAL: Choosing the best server to connect dynamically
  156.     // SERVER: Creating multiple servers in one process
  157.     "servers": [
  158.         {
  159.             // Fields are the same as the single server's configuration
  161.             // Individual servers can be disabled
  162.             // "disabled": true,
  163.             "address": "0.0.0.0",
  164.             "port": 8389,
  165.             "method": "aes-256-gcm",
  166.             "password": "your-password",
  167.             "plugin": "...",
  168.             "plugin_opts": "...",
  169.             "plugin_args": [],
  170.             "plugin_mode": "...",
  171.             "timeout": 7200,
  173.             // Customized weight for local server's balancer
  174.             //
  175.             // Weight must be in [0, 1], default is 1.0.
  176.             // The higher weight, the server may rank higher.
  177.             "tcp_weight": 1.0,
  178.             "udp_weight": 1.0,
  180.             // OPTIONAL. Instance specific ACL
  181.             "acl": "/path/to/acl/file.acl",
  182.         },
  183.         {
  184.             // Same key as basic format "server" and "server_port"
  185.             "server": "0.0.0.0",
  186.             "server_port": 8388,
  187.             "method": "chacha20-ietf-poly1305",
  188.             // Read the actual password from environment variable PASSWORD_FROM_ENV
  189.             "password": "${PASSWORD_FROM_ENV}"
  190.         },
  191.         {
  192.             // AEAD-2022
  193.             "server": "::",
  194.             "server_port": 8390,
  195.             "method": "2022-blake3-aes-256-gcm",
  196.             "password": "3SYJ/f8nmVuzKvKglykRQDSgg10e/ADilkdRWrrY9HU=",
  197.             // For Server (OPTIONAL)
  198.             // Support multiple users with Extensible Identity Header
  199.             // https://github.com/Shadowsocks-NET/shadowsocks-specs/blob/main/2022-2-shadowsocks-2022-extensible-identity-headers.md
  200.             "users": [
  201.                 {
  202.                     "name": "username",
  203.                     // User's password must have the same length as server's password
  204.                     "password": "4w0GKJ9U3Ox7CIXGU4A3LDQAqP6qrp/tUi/ilpOR9p4="
  205.                 }
  206.             ],
  207.             // For Client (OPTIONAL)
  208.             // If EIH enabled, then "password" should have the following format: iPSK:iPSK:iPSK:uPSK
  209.             // - iPSK is one of the middle relay servers' PSK, for the last `ssserver`, it must be server's PSK ("password")
  210.             // - uPSK is the user's PSK ("password")
  211.             // Example:
  212.             // "password": "3SYJ/f8nmVuzKvKglykRQDSgg10e/ADilkdRWrrY9HU=:4w0GKJ9U3Ox7CIXGU4A3LDQAqP6qrp/tUi/ilpOR9p4="
  213.         },
  214.         {
  215.             "...": "Any other fields",
  217.             // Some optional fields for this specific server
  219.             // Outbound socket options
  220.             // Linux Only (SO_MARK)
  221.             "outbound_fwmark": 255,
  222.             // FreeBSD only (SO_USER_COOKIE)
  223.             "outbound_user_cookie": 255,
  224.             // `SO_BINDTODEVICE` (Linux), `IP_BOUND_IF` (BSD), `IP_UNICAST_IF` (Windows) socket option for outbound sockets
  225.             "outbound_bind_interface": "eth1",
  226.             // Outbound socket bind() to this IP (choose a specific interface)
  227.             "outbound_bind_addr": "11.22.33.44",
  228.             // Outbound UDP socket allows IP fragmentation (default false)
  229.             "outbound_udp_allow_fragmentation": false,
  230.         }
  231.     ],
  233.     // Global configurations for UDP associations
  234.     "udp_timeout": 300, // Timeout for UDP associations (in seconds), 5 minutes by default
  235.     "udp_max_associations": 512, // Maximum UDP associations to be kept in one server, unlimited by default
  237.     // Options for Manager
  238.     "manager_address": "127.0.0.1", // Could be a path to UNIX socket, /tmp/shadowsocks-manager.sock
  239.     "manager_port": 5300, // Not needed for UNIX socket
  241.     // DNS server's address for resolving domain names
  242.     // For *NIX and Windows, it uses system's configuration by default
  243.     //
  244.     // Value could be IP address of DNS server, for example, "8.8.8.8".
  245.     // DNS client will automatically request port 53 with both TCP and UDP protocol.
  246.     //
  247.     // - system, uses system provided API (`getaddrinfo` on *NIX)
  248.     //
  249.     // It also allows some pre-defined well-known public DNS servers:
  250.     // - google (TCP, UDP)
  251.     // - cloudflare (TCP, UDP)
  252.     // - cloudflare_tls (TLS), enable by feature "dns-over-tls"
  253.     // - cloudflare_https (HTTPS), enable by feature "dns-over-https"
  254.     // - quad9 (TCP, UDP)
  255.     // - quad9_tls (TLS), enable by feature "dns-over-tls"
  256.     //
  257.     // The field is only effective if feature "hickory-dns" is enabled.
  258.     "dns": "google",
  259.     // Configure `cache_size` for "hickory-dns" ResolverOpts. Set to "0" to disable DNS cache.
  260.     "dns_cache_size": 0,
  262.     // Mode, could be one of the
  263.     // - tcp_only
  264.     // - tcp_and_udp
  265.     // - udp_only
  266.     "mode": "tcp_only",
  268.     // TCP_NODELAY
  269.     "no_delay": false,
  271.     // Enables `SO_KEEPALIVE` and set `TCP_KEEPIDLE`, `TCP_KEEPINTVL` to the specified seconds
  272.     "keep_alive": 15,
  274.     // Soft and Hard limit of file descriptors on *NIX systems
  275.     "nofile": 10240,
  277.     // Try to resolve domain name to IPv6 (AAAA) addresses first
  278.     "ipv6_first": false,
  279.     // Set IPV6_V6ONLY for all IPv6 listener sockets
  280.     // Only valid for locals and servers listening on `::`
  281.     "ipv6_only": false,
  283.     // Outbound socket options
  284.     // Linux Only (SO_MARK)
  285.     "outbound_fwmark": 255,
  286.     // FreeBSD only (SO_USER_COOKIE)
  287.     "outbound_user_cookie": 255,
  288.     // `SO_BINDTODEVICE` (Linux), `IP_BOUND_IF` (BSD), `IP_UNICAST_IF` (Windows) socket option for outbound sockets
  289.     "outbound_bind_interface": "eth1",
  290.     // Outbound socket bind() to this IP (choose a specific interface)
  291.     "outbound_bind_addr": "11.22.33.44",
  292.     // Outbound UDP socket allows IP fragmentation (default false)
  293.     "outbound_udp_allow_fragmentation": false,
  295.     // Balancer customization
  296.     "balancer": {
  297.         // MAX Round-Trip-Time (RTT) of servers
  298.         // The timeout seconds of each individual checks
  299.         "max_server_rtt": 5,
  300.         // Interval seconds between each check
  301.         "check_interval": 10,
  302.         // Interval seconds between each check for the best server
  303.         // Optional. Specify to enable shorter checking interval for the best server only.
  304.         "check_best_interval": 5
  305.     },
  307.     // SIP008 Online Configuration Delivery
  308.     // https://shadowsocks.org/doc/sip008.html
  309.     "online_config": {
  310.         "config_url": "https://path-to-online-sip008-configuration",
  311.         // Optional. Seconds between each update to config_url. Default to 3600s
  312.         "update_interval": 3600,
  313.         // Optional. Whitelist of plugins (RECOMMENDED for all users)
  314.         // SECURITY: To avoid executing untrusted commands loaded from config_url
  315.         "allowed_plugins": [
  316.             "v2ray-plugin"
  317.         ]
  318.     },
  320.     // Service configurations
  321.     // Logger configuration
  322.     "log": {
  323.         // Equivalent to `-v` command line option
  324.         "level": 1,
  325.         "format": {
  326.             // Euiqvalent to `--log-without-time`
  327.             "without_time": false,
  328.         },
  329.         // Equivalent to `--log-config`
  330.         // More detail could be found in https://crates.io/crates/log4rs
  331.         "config_path": "/path/to/log4rs/config.yaml"
  332.     },
  333.     // Runtime configuration
  334.     "runtime": {
  335.         // single_thread or multi_thread
  336.         "mode": "multi_thread",
  337.         // Worker threads that are used in multi-thread runtime
  338.         "worker_count": 10
  339.     }
  340. }

SOCKS5 Authentication Configuration

The configuration file is set by socks5_auth_config_path in locals.

  1. {
  2.     // Password/Username Authentication (RFC1929)
  3.     "password": {
  4.         "users": [
  5.             {
  6.                 "user_name": "USERNAME in UTF-8",
  7.                 "password": "PASSWORD in UTF-8"
  8.             }
  9.         ]
  10.     }
  11. }

Environment Variables

  • SS_SERVER_PASSWORD: A default password for servers that created from command line argument (--server-addr)
  • SS_SYSTEM_DNS_RESOLVER_FORCE_BUILTIN: "system" DNS resolver force use system’s builtin (getaddrinfo in *NIX)

Supported Ciphers

AEAD 2022 Ciphers

  • 2022-blake3-aes-128-gcm, 2022-blake3-aes-256-gcm
  • 2022-blake3-chacha20-poly1305, 2022-blake3-chacha8-poly1305

These Ciphers require "password" to be a Base64 string of key that have exactly the same length of Cipher’s Key Size. It is recommended to use ssservice genkey -m "METHOD_NAME" to generate a secured and safe key.

AEAD Ciphers

  • chacha20-ietf-poly1305
  • aes-128-gcm, aes-256-gcm

Stream Ciphers

  • plain or none (No encryption, only used for debugging or with plugins that ensure transport security)
Deprecated



- table
- aes-128-cfb, aes-128-cfb1, aes-128-cfb8, aes-128-cfb128
- aes-192-cfb, aes-192-cfb1, aes-192-cfb8, aes-192-cfb128
- aes-256-cfb, aes-256-cfb1, aes-256-cfb8, aes-256-cfb128
- aes-128-ctr
- aes-192-ctr
- aes-256-ctr
- camellia-128-cfb, camellia-128-cfb1, camellia-128-cfb8, camellia-128-cfb128
- camellia-192-cfb, camellia-192-cfb1, camellia-192-cfb8, camellia-192-cfb128
- camellia-256-cfb, camellia-256-cfb1, camellia-256-cfb8, camellia-256-cfb128
- rc4-md5
- chacha20-ietf


ACL

sslocal, ssserver, and ssmanager support ACL file with syntax like shadowsocks-libev. Some examples could be found in here.

Available sections

  • For local servers (sslocal, ssredir, …)
    • Modes:
      • [bypass_all] - ACL runs in BlackList mode. Bypasses all addresses that didn’t match any rules.
      • [proxy_all] - ACL runs in WhiteList mode. Proxies all addresses that didn’t match any rules.
    • Rules:
      • [bypass_list] - Rules for connecting directly
      • [proxy_list] - Rules for connecting through proxies
  • For remote servers (ssserver)
    • Modes:
      • [reject_all] - ACL runs in BlackList mode. Rejects all clients that didn’t match any rules.
      • [accept_all] - ACL runs in WhiteList mode. Accepts all clients that didn’t match any rules.
    • Rules:
      • [white_list] - Rules for accepted clients
      • [black_list] - Rules for rejected clients
      • [outbound_block_list] - Rules for blocking outbound addresses.

Example

  1. # SERVERS
  2. # For ssserver, accepts requests from all clients by default
  3. [accept_all]
  5. # Blocks these clients
  6. [black_list]
  7. 1.2.3.4
  8. 127.0.0.1/8
  10. # Disallow these outbound addresses
  11. [outbound_block_list]
  12. 127.0.0.1/8
  13. ::1
  14. # Using regular expression
  15. ^[a-z]{5}\.baidu\.com
  16. # Match exactly
  17. |baidu.com
  18. # Match with subdomains
  19. ||google.com
  20. # An internationalized domain name should be converted to punycode
  21. # |☃-⌘.com - WRONG
  22. |xn----dqo34k.com
  23. # ||джpумлатест.bрфa - WRONG
  24. ||xn--p-8sbkgc5ag7bhce.xn--ba-lmcq
  26. # CLIENTS
  27. # For sslocal, ..., bypasses all targets by default
  28. [bypass_all]
  30. # Proxy these addresses
  31. [proxy_list]
  32. ||google.com
  33. 8.8.8.8

Useful Tools

  1. ssurl is for encoding and decoding ShadowSocks URLs (SIP002). Example:

    1. ss://YWVzLTI1Ni1jZmI6cGFzc3dvcmQ@127.0.0.1:8388/?plugin=obfs-local%3Bobfs%3Dhttp%3Bobfs-host%3Dwww.baidu.com

Notes

It supports the following features:

  • SOCKS5 CONNECT command
  • SOCKS5 UDP ASSOCIATE command (partial)
  • SOCKS4/4a CONNECT command
  • Various crypto algorithms
  • Load balancing (multiple servers) and server delay checking
  • SIP004 AEAD ciphers
  • SIP003 Plugins
  • SIP003u Plugin with UDP support
  • SIP002 Extension ss URLs
  • SIP022 AEAD 2022 ciphers
  • HTTP Proxy Supports (RFC 7230 and CONNECT)
  • Defend against replay attacks, shadowsocks/shadowsocks-org#44
  • Manager APIs, supporting Manage Multiple Users
  • ACL (Access Control List)
  • Support HTTP/HTTPS Proxy protocol

TODO

  • Documentation
  • Extend configuration format
  • Improved logging format (waiting for the new official log crate)
  • Support more ciphers without depending on libcrypto (waiting for an acceptable Rust crypto lib implementation)
  • Windows support.
  • Build with stable rustc (blocking by crypto2).
  • Support HTTP Proxy protocol
  • AEAD ciphers. (proposed in SIP004, still under discussion)
  • Choose server based on delay #152

License

The MIT License (MIT)

Copyright (c) 2014 Y. T. CHUNG

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the “Software”), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

Stargazers over time

Stargazers over time