1ss5(1)                      General Commands Manual                     ss5(1)
2
3
4

NAME

6       ss5  - A daemon that implements the SOCKS v4 and v5 protocol to execute
7                proxy requests for a client
8

SYNOPSIS

10       ss5 [options]
11

DESCRIPTION

13       ss5 is a socks server that implements the SOCKS v4 and v5 protocol.  As
14       a  proxy  server,  ss5  authenticates,  profiles  and processes network
15       requests for clients. It establishes connections to  application  hosts
16       for  client  applications.  When the client attempts to access the net‐
17       work, the client connects to the ss5 daemon instead of the  application
18       host.
19
20       Following  authentication,  clients  request  that  ss5 perform network
21       activities for the client. The activities might include:
22
23           CONNECT
24
25           BIND
26
27           UDP ASSOCIATE
28
29       The ss5 protocol is  independent  of  application  protocols,  and  can
30       assist  with different networking services, including telnet, ftp, fin‐
31       ger, whois, gopher, and WWW access.
32
33       The ss5 daemon supports one authentication method:
34
35          Username/Password -  Refer to ss5.passwd(5) or ss5.pam(5) for  addi‐
36                               tional information.
37
38
39
40          The ss5 daemon supports two profiling methods:
41
42             File -  Refer to ss5.conf(5) for additional information.
43
44                                  Ldap  -  Refer to ss5.conf(5) for additional
45                                  information.
46
47
48
49          ss5 can run:
50
51             standalone -  the default
52
53             prefork processes -  include the  -n  option  (not  supported  in
54             threaded mode)
55
56             threaded    -   if  your operating system supports POSIX threads.
57                           Include the -t option to run ss5 in threaded mode.
58

OPTIONS

60       Separate multiple options with white space.
61
62       -b [host:port]|
63              host:port specifies the host and the port number on that host on
64              which ss5 runs, instead of the default port. When you omit host,
65              ss5 uses 0.0.0.0 as the host value.
66
67
68
69       -n  val
70              Run multiple instances of ss5. -n  option  control
71              the number of instances.
72
73
74       -t     Run ss5 in threaded mode, if your operating
75              system supports POSIX threads.
76
77       -u  val
78              Run ss5 with the specified user name.
79
80       -v     Print a message containing the current  ss5
81              version.
82
83       -s     Use syslog instead of ss5.log log file.
84
85       -c     Run syntax check for config file
86
87       -m     Disable logging
88

VARIABLES

90       To  set  the  variables in the configuration file,
91       use the syntax:
92
93            set variable [value]
94
95       SS5_DNSORDER
96              order domain name answers for  implementing
97              failover.
98
99       SS5_STIMEOUT val
100              val  specifies  the  idle  time in seconds,
101              before closing a connection.
102
103       SS5_VERBOSE
104              enable verbose output to logfile.
105
106       SS5_DEBUG
107              enable debug output to logfile.
108
109       SS5_PAM_AUTH
110              enable PAM authentication
111
112       SS5_AUTHCACHEAGE
113              enable user authentication caching and  set
114              cache age
115
116       SS5_AUTHOCACHEAGE
117              enable  user  authorization caching and set
118              cache age
119
120       SS5_LDAP_TIMEOUT
121              set timeout for ldap query for profiling
122
123       SS5_LDAP_BASE
124              set BASE method for profiling (see  PROFIL‐
125              ING section in configuration file)
126
127       SS5_LDAP_FILTER
128              set  FILTER  method for profiling (see PRO‐
129              FILING section in configuration file)
130
131       SS5_STICKY_SESSION
132              set session feature  for  balanced  connec‐
133              tions. SS5 mantain affinity session between
134              source client and destination server
135
136       SS5_STICKYAGE
137              set expiration time  for  session  affinity
138              (in seconds)
139
140       SS5_NETBIOS_DOMAIN
141              enable  netbios  domain mapping with direc‐
142              tory store, during authorization process
143
144       SS5_PROCESSLIFE
145              set number of requests ss5 process can serv
146              before closing (only preforked mode)
147

ENVIRONMENT

149       SS5_SOCKS_USER
150              sets  the  effective  user  ID  of  the ss5
151              process
152
153       SS5_SOCKS_PORT
154              sets listen port
155
156       SS5_SOCKS_ADDR
157              sets listen address
158
159       SS5_CONFIG_FILE
160              sets absolute pathname of ss5 config file
161
162       SS5_PASSWORD_FILE
163              sets absolute pathname of ss5 password file
164
165       SS5_PROPAGATE_KEY
166              sets key value for configuration replica
167
168       SS5_ROLE_SLAVE
169              sets role to slave to accept  replica  from
170              master (default value is ALONE)
171
172       SS5_LOG_FILE
173              sets absolute pathname of ss5 log file
174
175       SS5_PROFILE_PATH
176              sets absolute path of ss5 profile files
177
178       SS5_LIB_PATH
179              sets absolute path of ss5 modules
180

REQUEST FOR COMMENTS

182       RFC1928
183              SOCKS protocol Version 5
184
185       RFC1929
186              Username/Password  Authentication for SOCKS
187              V5
188
189
190       SEE ALSO
191              ss5.conf(5)    ss5.passwd(5)     ss5.pam(5)
192              ss5.peers(5)
193

AUTHOR

195           Matteo Ricchetti
196
197       Send comments to matteo.ricchetti@libero.it
198
199
200
201                                  14 Jul 2003                           ss5(1)