NAME
- ss5 - A daemon that implements the SOCKS v4 and v5 protocol to
execute proxy requests for a client
SYNOPSIS
ss5 [options]
DESCRIPTION
ss5 is a socks server that implements the SOCKS
v4 and v5 protocol. As a proxy server, ss5 authenticates, profiles
and processes network requests for clients. It establishes
connections to application hosts for client applications. When the
client attempts to access the network, the client connects to the
ss5 daemon instead of the application host.
Following authentication, clients request that ss5 perform
network activities for the client. The activities might include:
-
CONNECT
BIND
UDP ASSOCIATE
The ss5 protocol is independent of application protocols, and
can assist with different networking services, including telnet,
ftp, finger, whois, gopher, and WWW access.
The ss5 daemon supports one authentication method:
-
- Username/Password - Refer to ss5.passwd(5)
or ss5.pam(5)
for additional information.
- The ss5 daemon supports two profiling methods:
-
- File - Refer to ss5.conf(5)
for additional information.
Ldap - Refer to ss5.conf(5)
for additional information.
- ss5 can run:
-
standalone - the default
- prefork processes - include the -n option (not supported in
threaded mode)
- threaded - if your operating system supports POSIX threads.
Include the -t option to run ss5 in threaded
mode.
OPTIONS
Separate multiple options with white space.
- -b [host:port]|
- host:port specifies the host and the port number on that
host on which ss5 runs, instead of the default port. When you omit
host, ss5 uses 0.0.0.0 as the host value.
- -n val
- Run multiple instances of ss5. -n option control the number of
instances.
- -t
- Run ss5 in threaded mode, if your operating system supports
POSIX threads.
- -u val
- Run ss5 with the specified user name.
- -v
- Print a message containing the current ss5 version.
- -s
- Use syslog instead of ss5.log log file.
- -c
- Run syntax check for config file
- -m
- Disable logging
VARIABLES
To set the variables in the configuration file,
use the syntax:
- set variable [value]
- SS5_DNSORDER
- order domain name answers for implementing failover.
- SS5_STIMEOUT val
- val specifies the idle time in seconds, before closing a
connection.
- SS5_VERBOSE
- enable verbose output to logfile.
- SS5_DEBUG
- enable debug output to logfile.
- SS5_PAM_AUTH
- enable PAM authentication
- SS5_AUTHCACHEAGE
- enable user authentication caching and set cache age
- SS5_AUTHOCACHEAGE
- enable user authorization caching and set cache age
- SS5_LDAP_TIMEOUT
- set timeout for ldap query for profiling
- SS5_LDAP_BASE
- set BASE method for profiling (see PROFILING section in
configuration file)
- SS5_LDAP_FILTER
- set FILTER method for profiling (see PROFILING section in
configuration file)
- SS5_STICKY_SESSION
- set session feature for balanced connections. SS5 mantain
affinity session between source client and destination server
- SS5_STICKYAGE
- set expiration time for session affinity (in seconds)
- SS5_NETBIOS_DOMAIN
- enable netbios domain mapping with directory store, during
authorization process
- SS5_PROCESSLIFE
- set number of requests ss5 process can serv before closing
(only preforked mode)
ENVIRONMENT
- SS5_SOCKS_USER
- sets the effective user ID of the ss5 process
- SS5_SOCKS_PORT
- sets listen port
- SS5_SOCKS_ADDR
- sets listen address
- SS5_CONFIG_FILE
- sets absolute pathname of ss5 config file
- SS5_PASSWORD_FILE
- sets absolute pathname of ss5 password file
- SS5_PROPAGATE_KEY
- sets key value for configuration replica
- SS5_ROLE_SLAVE
- sets role to slave to accept replica from master (default value
is ALONE)
- SS5_LOG_FILE
- sets absolute pathname of ss5 log file
- SS5_PROFILE_PATH
- sets absolute path of ss5 profile files
- SS5_LIB_PATH
- sets absolute path of ss5 modules
REQUEST FOR COMMENTS
- RFC1928
- SOCKS protocol Version 5
- RFC1929
- Username/Password Authentication for SOCKS V5
-
SEE ALSO
ss5.conf(5)
ss5.passwd(5)
ss5.pam(5)
ss5.peers(5)
AUTHOR
Matteo Ricchetti
-
- Send comments to