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_CONSOLE
107              enable web console.
108
109       SS5_DEBUG
110              enable debug output to logfile.
111
112       SS5_PAM_AUTH
113              enable PAM authentication
114
115       SS5_AUTHCACHEAGE
116              enable user authentication caching and  set
117              cache age
118
119       SS5_AUTHOCACHEAGE
120              enable  user  authorization caching and set
121              cache age
122
123       SS5_LDAP_TIMEOUT
124              set timeout for ldap query for profiling
125
126       SS5_LDAP_BASE
127              set BASE method for profiling (see  PROFIL‐
128              ING section in configuration file)
129
130       SS5_LDAP_FILTER
131              set  FILTER  method for profiling (see PRO‐
132              FILING section in configuration file)
133
134       SS5_STICKY_SESSION
135              set session feature  for  balanced  connec‐
136              tions. SS5 mantain affinity session between
137              source client and destination server
138
139       SS5_STICKYAGE
140              set expiration time  for  session  affinity
141              (in seconds)
142
143       SS5_NETBIOS_DOMAIN
144              enable  netbios  domain mapping with direc‐
145              tory store, during authorization process
146
147       SS5_PROCESSLIFE
148              set number of requests ss5 process can serv
149              before closing (only preforked mode)
150

ENVIRONMENT

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

REQUEST FOR COMMENTS

185       RFC1928
186              SOCKS protocol Version 5
187
188       RFC1929
189              Username/Password  Authentication for SOCKS
190              V5
191
192
193       SEE ALSO
194              ss5.conf(5)    ss5.passwd(5)     ss5.pam(5)
195              ss5.ha(5)
196

AUTHOR

198           Matteo Ricchetti
199
200       Send comments to matteo.ricchetti@libero.it
201
202
203
204                                  14 Jul 2003                           ss5(1)