.TH socks5 1 "7 Oct 1998".SH NAME.HP 9socks5 \- A daemon that implements the SOCKS v5 protocol to execute proxy requests for a client.SH SYNOPSISsocks5 \fI[options]\fP.SH DESCRIPTIONsocks5 is a proxy server that implements the SOCKS v5 protocol. As a proxy server, socks5 authenticates, authorizes, 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 socks5 daemon instead of the application host. .PPFollowing authentication, clients request that socks5 perform network activities for the client. The activities might include bind, connect, sendto, ping, or traceroute. The socks5 protocol is independent of application protocols, and can assist with different networking services, including telnet, ftp, finger, whois, gopher, and WWW access..PPThe socks5 daemon supports two authentication methods:.RS 3 .HP 21Username/Password -  Refer to socks5.passwd(5) for additional information..HP 13Kerberos 5 - Requires that you build socks5 with the Kerberos libraries. For additional information about using Kerberos 5 (GSS-API) authentication, please refer to the Kerberos man page. .RE.PPsocks5 can run:.RS 3standalone -  the default.TPpreforking -  include the -p option.HP 14threaded -    if your operating system supports POSIX threads and you configure socks5 with the --with-threads option. Include the -t option to run socks5 in threaded mode. All operating systems impose limits on the number of threads and open file descriptors per process..TPthrough inetd - include the -i option.RE.PPYou can control some aspects of how the socks5 daemon works through the configuration file, environment variables, and options. Refer to the socks5.conf(5) documentation for additional information about the socks5 configuration file. The settings in the configuration file take precedence over the environment variable and option settings. The environment variable settings take precedence over the option settings. .SH OPTIONSSeparate multiple options with white space..TP-b [\fIhost:port\fP]| --bindintfc [\fIhost:port\fP]\fIhost:port\fP specifies the host and the port number on that host on which socks5 runs, instead of the default port. When you omit \fIhost\fP, socks5 uses 0.0.0.0 as the \fIhost\fP value..TP-d \fI[val]\fP |--debug \fI[val]\fPTurn on debug mode and optionally set the debug level to \fIval\fP. If you omit \fIval\fP, socks5 sends only warning messages. Valid values for \fIval\fP are 1, 2, and 3. If you specify other values, socks5 assumes 3. Valid values and their meanings are:.RS 8.HP 141LOG_NOTICE  Reports non-error conditions that may require special handling.HP 142LOG_INFO    Reports informational messages.HP 143LOG_DEBUG   Reports information useful for debugging.RE.TP-f  |--foreground Run in the foreground, and prevent dissociation from the parent shell when running standalone. --foreground is most useful for debugging when you start and stop the daemon frequently..TP-i |--inetdRun socks5 through inetd..TP-n  \fIval\fP |--nchildren \fIval\fPSet the maximum number of child processes that can exist at one time to \fIval\fP..PP.RS 5socks5 presets the maximum number of child processes to 64. Use this option to lower that preset value. You cannot set the maximum number of child processes to a value that exceeds the operating system limit..PPsocks5 ignores this value in threaded mode, and it is not useful in oneshot and inetd mode..RE.TP-o |--oneshotService one request in the foreground, turn on debugging, send output to stderr, and exit. The oneshot option is most useful during debugging..TP-p |--preforkRun socks5 as a preforking process. Also include the --nchildren option to control the number of forked processes..TP-s |--stderrLog all output to stderr only, instead of the syslog. Logging output to stderr is most useful in debug mode, which generates more output..TP-t | --threadedRun socks5 in threaded mode, if your operating system supports POSIX threads and you built socks5 with the --with-threads option. When threaded mode is not available, socks5 prints a warning and reverts to standalone mode..TP-v |--versionPrint a message containing the current socks5 version to stderr..PP.SH ENVIRONMENTEnvironment variables control how socks5 operates. Set them in the environment, or include them in the configuration file. When the environment and the configuration file contain conflicting settings, the configuration files has precedence over the environment. To set the variables in the configuration file, use the syntax:.PP.RS 5set \fIvariable [value]\fP.RE.TPSOCKS5_BINDINTFC \fIhost:port\fP\fIhost:port\fP specifies the host and the port number on that host on which socks5 runs, instead of the default port. When you omit \fIhost\fP, socks5 uses 0.0.0.0 as the \fIhost\fP value..TPSOCKS5_CONFFILE \fIfilename\fP\fIfilename\fP specifies the configuration file. In most systems, the default is /etc/socks5.conf. Set the environment before running socks5. With multiple socks5 daemons, use a different configuration file for each daemon..TPSOCKS5_DEMAND_IDENTCause No authentication to fail when the client fails to respond to an ident request. Use SOCKS5_DEMAND_IDENT to ensure that each connection has an associated username..TP SOCKS5_ENCRYPTRequest that the next socks5 process encrypt the data, if possible. SOCKS5_ENCRYPT is only useful when the socks5 build includes GSS-API authentication..TPSOCKS5_FORCE_ENCRYPTForce the client to encrypt the data when the authentication method supports encryption..TP SOCKS5_IDENTFILE \fIfilename\fP\fIfilename\fP specifies the filename that stores the ident information. In most systems, the default is /tmp/socks5.ident. SOCKS5_IDENTFILE is most useful with multiple socks5 daemons..TPSOCKS5_MAXCHILD \fIval\fP\fIval\fP specifies the maximum number of child processes that can exist at one time..RS 5.PPsocks5 presets the maximum number of child processes to 64. Use this environment variable to lower that preset value. You cannot set the maximum number of child processes to a value that exceeds the operating system limit..PPsocks5 ignores this value in threaded mode, and it is not useful in oneshot and inetd mode..RE.TPSOCKS5_NOIDENTOmit ident requests. Use SOCKS5_NOIDENT to reduce timeouts when you are certain clients are not running identd's..TPSOCKS5_NOINTCHKRequest that the next socks5 process perform the proxy request without integrity checking. SOCKS5_NOINTCHK is only useful when the socks5 build includes GSS-API authentication..TPSOCKS5_NONETMASKCHECKInstruct the daemon to disregard checking the server host's netmask. By default, the daemon checks the netmask and connects directly to hosts on the same subnet before consulting the configuration file..TPSOCKS5_REVERSEMAPAlways attempt to map addresses to hostnames.  By default, socks5 only maps when hostnames or domains are used in the configuration file.  When set, the log file will contain hostnames, but degrades performance..TP SOCKS5_SERVICENAMEAlways map port numbers to service names. By default, socks5 only maps when services are used in the configuration file.  When set, the log file will contain services, but degrades performance. .TPSOCKS5_PASSWD [\fIpassword\fP]Specify the password for Username/Password authentication when the socks5 daemon connects to another socks server..TPSOCKS5_PIDFILE \fIfilename\fPSpecify the filename that stores the socks5 process ID. socks5 stores the PID in /tmp/socks5.pid. You can run socks5 on a port other than the default port by including the --bindintfc command line option or setting the SOCKS5_BINDINTFC environment variable. When you run socks5 on a port other than the default port, socks5 stores the PID in /tmp/socks5.pid-port. Use SOCKS5_PIDFILE to specify an alternate filename..TPSOCKS5_PWDFILE \fIfilename\fPSpecify the password file. In most systems, the default is /etc/socks5.passwd..TPSOCKS5_TIMEOUT \fIminutes\fP\fIminutes\fP specifies the maximum number of minutes the connection remains idle. After \fIminutes\fP number of minutes, socks5 disconnects. When you omit SOCKS5_TIMEOUT, socks5 disconnects after the connection is idle for 15 minutes..TPSOCKS5_UDPPORTRANGE \fIport1-port2\fPSpecify a range of UDP ports. \fIport1-port2\fP specifies a range of UDP ports that socks5 uses to send UDP packets..TPSOCKS5_USER [\fIuser id\fP]Specify the username for Username/Password authentication when the socks5 daemon connects to another socks server..TPSOCKS5_V4SUPPORTBy default, socks5 will only accept SOCKS V5 protocol (rfc 1928) requests.  When set, socks5 will accept SOCKS V4 protocol requests..PP.SH REQUEST FOR COMMENTS.TPRFC1928SOCKS protocol Version 5.TPRFC1929Username/Password Authentication for SOCKS V5.TPRFC1961GSS-API Authentication Method for SOCKS Version 5.PP.SH SEE ALSOsocks5.conf(5).PP.SH AUTHORNWSL SOCKS5 Development Team.brSend comments to socks5-comments@socks.nec.com