ss-manager

ss-server controller for multi-user management and traffic statistics

SYNOPSIS

ss-manager [options]

DESCRIPTION

shadowsocks-c is a lightweight and secure socks5 proxy. It is a port of the original shadowsocks created by clowwindy. shadowsocks-c is written in pure C and takes advantage of libuv to achieve both high performance and low resource consumption.

shadowsocks-c consists of five components. ss-manager(1) is a controller for multi-user management and traffic statistics, using UNIX domain socket to talk with ss-server(1). Also, it provides a UNIX domain socket or IP based API for other software. About the details of this API, please refer to the following PROTOCOL section.

OPTIONS

Options include all supported platform variants; restrictions are noted below.

-f <pid_file>

Start shadowsocks as a daemon with specific pid file.

-s <server_host>

Set a server listening hostname or IP address. May be repeated.

-k <password>

Set the password. The server and the client should use the same password.

-t <timeout>

Set the socket timeout in seconds. The default value is 60.

-m <encrypt_method>

Set the cipher. The default is chacha20-ietf-poly1305.

AEAD cipher names from the source (availability depends on the build):

constexpr AeadSpec kSpecs[] = {
    { "aes-128-gcm", AeadKind::aes_128_gcm, 16, 12, 16 },
    { "aes-192-gcm", AeadKind::aes_192_gcm, 24, 12, 16 },
    { "aes-256-gcm", AeadKind::aes_256_gcm, 32, 12, 16 },
    { "chacha20-ietf-poly1305", AeadKind::chacha20_poly1305, 32, 12, 16 },
#ifdef crypto_aead_xchacha20poly1305_ietf_ABYTES
    { "xchacha20-ietf-poly1305", AeadKind::xchacha20_poly1305, 32, 24, 16 },
#endif
};

The unauthenticated stream ciphers (aes-256-cfb, chacha20-ietf, rc4-md5 and the like) are no longer supported.The 2022-blake3-* ciphers implement Shadowsocks 2022 (SIP022). They require a base64-encoded pre-shared key supplied with --key or --password (-k): 16 bytes for 2022-blake3-aes-128-gcm and 32 bytes for the other 2022 ciphers. Generate a 32-byte key with openssl rand -base64 32. Passwords are not stretched into keys for these ciphers.

-c <config_file>

Use a JSON configuration file. The "port_password" field can start multiple ss-server instances.

-i <interface>

Send outbound traffic through the specified network interface where supported by the platform.

-d <addr>

Configure name servers for the internal c-ares DNS resolver. By default it uses the system resolver configuration.

-a <user_name>

Run as a specific user.

-n <number>

Specify the maximum number of open files. Requires a platform with setrlimit support.

-D <path>

Set the working directory of ss-manager.

-6

Resolve hostname to IPv6 address first.

-h

Print help message.

-u

Enable UDP relay.

-U

Enable UDP relay and disable TCP relay.

-v

Enable verbose mode.

-A

Deprecated one-time authentication option. Exits with an error; use AEAD ciphers instead.

--config <config_file>

Read JSON configuration. See the CLI conventions for precedence and default-value behavior. Short alias: -c.

--cipher <encrypt_method>

Select the encryption cipher. See -m for supported cipher names and key requirements. Short alias: -m.

--timeout <timeout>

Same behavior as -t; see that option for details. Short alias: -t.

--user <user_name>

Same behavior as -a; see that option for details. Short alias: -a.

--pid-file <pid_file>

Same behavior as -f; see that option for details. Short alias: -f.

--nofile <number>

Same behavior as -n; see that option for details. Short alias: -n.

--udp

Enable both TCP and UDP relay, overriding the configured mode. Short alias: -u.

--udp-only

Enable UDP relay only, overriding the configured mode. Short alias: -U.

--ipv6-first

Prefer IPv6 DNS results; overrides configuration. This does not restrict connections to IPv6. Short alias: -6.

--verbose

Same behavior as -v; see that option for details. Short alias: -v.

--listen-address <server_host>

Set the listening address. Server and manager addresses may be repeated. Short alias: -s.

--interface <interface>

Same behavior as -i; see that option for details. Short alias: -i.

--nameserver <addr>

Same behavior as -d; see that option for details. Short alias: -d.

--version

Print the program name and version to standard output and exit successfully.

--tcp-only

Enable TCP relay only, overriding the configuration file's mode. The last of --tcp-only, --udp, and --udp-only wins.

--ipv4-first

Prefer IPv4 DNS results, overriding ipv6_first in the configuration file. This is an address preference, not a restriction to IPv4. The last of --ipv4-first and --ipv6-first wins.

--fast-open

Enable TCP Fast Open where supported by the operating system.

--no-delay

Enable TCP_NODELAY.

--reuse-port

Enable port reuse where supported by the operating system.

--acl <acl_config>

Enable ACL (Access Control List) and specify config file.

--manager-address <address>

Set the manager control address: a UNIX domain socket path or an IP address and port.

--executable <path>

Set the executable path of ss-server used by ss-manager.

--mtu <MTU>

Specify the MTU of your network interface.

--plugin <plugin_name>

Enable SIP003 plugin. (Experimental)

--plugin-opts <plugin_options>

Set SIP003 plugin options. (Experimental)

--password <password>

Set the password. The server and the client should use the same password.

--workdir <path>

Set the working directory of ss-manager (alias for -D).

--help

Print help message.

PROTOCOL

ss-manager(1) provides several APIs through UDP protocol:

Send UDP commands in the following format to the manager-address provided to ss-manager(1):

command: [JSON data]

To add a port:

add: {"server_port": 8001, "password":"7cd308cc059"}

To remove a port:

remove: {"server_port": 8001}

To receive the traffic statistics:

ping

The format of the traffic statistics:

stat: {"8001":11370}

There is no way to reset the traffic statistics, unless you remove the port and add it again

EXAMPLE

To use ss-manager(1), First start it and specify necessary information.

Then communicate with ss-manager(1) through UNIX Domain Socket using UDP protocol:

# Start the manager. Arguments for ss-server will be passed to generated
# ss-server process(es) respectively.
ss-manager --manager-address /tmp/manager.sock --executable $(which ss-server) -s example.com -m aes-256-gcm -c /path/to/config.json
 
# Connect to the socket. Using netcat-openbsd as an example.
# You should use scripts or other programs for further management.
nc -Uu /tmp/manager.sock

After that, you may communicate with ss-manager(1) as described above in the PROTOCOL section.

SEE ALSO

ss-local(1), ss-server(1), ss-tunnel(1), ss-redir(1), shadowsocks-libev(8), iptables(8), /etc/shadowsocks-libev/config.json