socks5.1
上传用户:sddyfurun
上传日期:2007-01-04
资源大小:525k
文件大小:9k
源码类别:

代理服务器

开发平台:

Unix_Linux

  1. .TH socks5 1 "7 Oct 1998"
  2. .SH NAME
  3. .HP 9
  4. socks5 - A daemon that implements the SOCKS v5 protocol to execute proxy requests for a client
  5. .SH SYNOPSIS
  6. socks5 fI[options]fP
  7. .SH DESCRIPTION
  8. socks5 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. 
  9. .PP
  10. Following 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.
  11. .PP
  12. The socks5 daemon supports two authentication methods:
  13. .RS 3 
  14. .HP 21
  15. Username/Password -  Refer to socks5.passwd(5) for additional information.
  16. .HP 13
  17. Kerberos 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. 
  18. .RE
  19. .PP
  20. socks5 can run:
  21. .RS 3
  22. standalone -  the default
  23. .TP
  24. preforking -  include the -p option
  25. .HP 14
  26. threaded -    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.
  27. .TP
  28. through inetd - include the -i option
  29. .RE
  30. .PP
  31. You 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. 
  32. .SH OPTIONS
  33. Separate multiple options with white space.
  34. .TP
  35. -b [fIhost:portfP]| --bindintfc [fIhost:portfP]
  36. fIhost:portfP specifies the host and the port number on that host on which socks5 runs, instead of the default port. When you omit fIhostfP, socks5 uses 0.0.0.0 as the fIhostfP value.
  37. .TP
  38. -d fI[val]fP |--debug fI[val]fP
  39. Turn on debug mode and optionally set the debug level to fIvalfP. If you omit fIvalfP, socks5 sends only warning messages. Valid values for fIvalfP are 1, 2, and 3. If you specify other values, socks5 assumes 3. Valid values and their meanings are:
  40. .RS 8
  41. .HP 14
  42. 1
  43. LOG_NOTICE  Reports non-error conditions that may require special handling
  44. .HP 14
  45. 2
  46. LOG_INFO    Reports informational messages
  47. .HP 14
  48. 3
  49. LOG_DEBUG   Reports information useful for debugging
  50. .RE
  51. .TP
  52. -f  |--foreground 
  53. 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.
  54. .TP
  55. -i |--inetd
  56. Run socks5 through inetd.
  57. .TP
  58. -n  fIvalfP |--nchildren fIvalfP
  59. Set the maximum number of child processes that can exist at one time to fIvalfP.
  60. .PP
  61. .RS 5
  62. socks5 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.
  63. .PP
  64. socks5 ignores this value in threaded mode, and it is not useful in oneshot and inetd mode.
  65. .RE
  66. .TP
  67. -o |--oneshot
  68. Service one request in the foreground, turn on debugging, send output to stderr, and exit. The oneshot option is most useful during debugging.
  69. .TP
  70. -p |--prefork
  71. Run socks5 as a preforking process. Also include the --nchildren option to control the number of forked processes.
  72. .TP
  73. -s |--stderr
  74. Log all output to stderr only, instead of the syslog. Logging output to stderr is most useful in debug mode, which generates more output.
  75. .TP
  76. -t | --threaded
  77. Run 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.
  78. .TP
  79. -v |--version
  80. Print a message containing the current socks5 version to stderr.
  81. .PP
  82. .SH ENVIRONMENT
  83. Environment 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. 
  84. To set the variables in the configuration file, use the syntax:
  85. .PP
  86. .RS 5
  87. set fIvariable [value]fP
  88. .RE
  89. .TP
  90. SOCKS5_BINDINTFC fIhost:portfP
  91. fIhost:portfP specifies the host and the port number on that host on which socks5 runs, instead of the default port. When you omit fIhostfP, socks5 uses 0.0.0.0 as the fIhostfP value.
  92. .TP
  93. SOCKS5_CONFFILE fIfilenamefP
  94. fIfilenamefP 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.
  95. .TP
  96. SOCKS5_DEMAND_IDENT
  97. Cause 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.
  98. .TP 
  99. SOCKS5_ENCRYPT
  100. Request that the next socks5 process encrypt the data, if possible. SOCKS5_ENCRYPT is only useful when the socks5 build includes GSS-API authentication.
  101. .TP
  102. SOCKS5_FORCE_ENCRYPT
  103. Force the client to encrypt the data when the authentication method supports encryption.
  104. .TP 
  105. SOCKS5_IDENTFILE fIfilenamefP
  106. fIfilenamefP 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.
  107. .TP
  108. SOCKS5_MAXCHILD fIvalfP
  109. fIvalfP specifies the maximum number of child processes that can exist at one time.
  110. .RS 5
  111. .PP
  112. socks5 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.
  113. .PP
  114. socks5 ignores this value in threaded mode, and it is not useful in oneshot and inetd mode.
  115. .RE
  116. .TP
  117. SOCKS5_NOIDENT
  118. Omit ident requests. Use SOCKS5_NOIDENT to reduce timeouts when you are certain clients are not running identd's.
  119. .TP
  120. SOCKS5_NOINTCHK
  121. Request 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.
  122. .TP
  123. SOCKS5_NONETMASKCHECK
  124. Instruct 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.
  125. .TP
  126. SOCKS5_REVERSEMAP
  127. Always 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.
  128. .TP 
  129. SOCKS5_SERVICENAME
  130. Always 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. 
  131. .TP
  132. SOCKS5_PASSWD [fIpasswordfP]
  133. Specify the password for Username/Password authentication when the socks5 daemon connects to another socks server.
  134. .TP
  135. SOCKS5_PIDFILE fIfilenamefP
  136. Specify 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.
  137. .TP
  138. SOCKS5_PWDFILE fIfilenamefP
  139. Specify the password file. In most systems, the default is /etc/socks5.passwd.
  140. .TP
  141. SOCKS5_TIMEOUT fIminutesfP
  142. fIminutesfP specifies the maximum number of minutes the connection remains idle. After fIminutesfP number of minutes, socks5 disconnects. When you omit SOCKS5_TIMEOUT, socks5 disconnects after the connection is idle for 15 minutes.
  143. .TP
  144. SOCKS5_UDPPORTRANGE fIport1-port2fP
  145. Specify a range of UDP ports. fIport1-port2fP specifies a range of UDP ports that socks5 uses to send UDP packets.
  146. .TP
  147. SOCKS5_USER [fIuser idfP]
  148. Specify the username for Username/Password authentication when the socks5 daemon connects to another socks server.
  149. .PP
  150. .SH REQUEST FOR COMMENTS
  151. .TP
  152. RFC1928
  153. SOCKS protocol Version 5
  154. .TP
  155. RFC1929
  156. Username/Password Authentication for SOCKS V5
  157. .TP
  158. RFC1961
  159. GSS-API Authentication Method for SOCKS Version 5
  160. .PP
  161. .SH SEE ALSO
  162. socks5.conf(5)
  163. .PP
  164. .SH AUTHOR
  165. NWSL SOCKS5 Development Team
  166. .br
  167. Send comments to socks5-comments@socks.nec.com