README
上传用户:sddyfurun
上传日期:2007-01-04
资源大小:525k
文件大小:11k
源码类别:

代理服务器

开发平台:

Unix_Linux

  1. Welcome to NWSL's (previously CSTC) socksv5!
  2. socksv5 allows UNIX hosts behind a firewall to gain full access to the
  3. Internet without requiring direct IP reachability. socksv5 requires a SOCKS
  4. daemon running on a host that can communicate directly with hosts behind the
  5. firewall and with hosts on the Internet. socksv5 is based on the original
  6. SOCKS, written by David Koblas <koblas@netcom.com>, and the IETF AFT working
  7. group.
  8. NEC developed the socks5 system using GNU's ANSI-C compiler. You must use an
  9. ANSI-C compiler to build your socks5 system. If you experience problems
  10. building socks5 with your native compiler, we recommend using GNU's ANSI-C
  11. compiler. You can download GNU's ANCI-C compiler, tar, and zip from:
  12.             ftp://prep.ai.mit.edu/pub/gnu/
  13. To support some socks5 protocol features, requires available libraries and
  14. programs on your system. Some of these requirements include:
  15.     - To build socks5 with GSS-API authentication requires a Kerberos5-based
  16.       GSS-API library.
  17.     - To build socks5 with IDENT, you need an ident library.
  18.     - To build socks5 with monitoring, you need the SOCKS5WatchAG library.
  19.     - To support the ping and traceroute proxies, you must have these
  20.       programs in your PATH.
  21. socks5 Daemon
  22. =============
  23. The socks5 daemon can run:
  24. - standalone
  25. - pre-forking, by adding the -p flag
  26. - threaded, by adding the -t flag if you configured with the
  27.   --with-threads options and the operating system supports
  28.   POSIX threads
  29. - through inetd, by adding the -i flag
  30. socks runs in threaded mode if the operating system supports POSIX threads.
  31. Because the optimum mode is highly operating system and hardware dependent,
  32. it is impossible to state the best mode.
  33. NEC has tested threading on Solaris and IRIX UNIX systems. Be aware that all
  34. operating systems impose limits on the number of threads and the number of
  35. open file descriptors per process.
  36. The maximum number of child processes limits standalone and pre-forking
  37. modes. The default number of child processes is 64. The socks5 daemon
  38. includes a -n(--nchildren) option to change the default. The number of socks5
  39. child processes can not exceed the system limit.
  40. To turn on debug mode, include the -d flag or configure with the
  41. --with-debug option. Only use debug mode when you must debug the server.
  42. During debugging, you may want to include the -o flag to force the server
  43. to accept only one request and to prevent it from forking.
  44. Use the -f flag to keep standalone versions in the foreground. 
  45. Kerberos users: You may experience problems building the shared library if
  46. your Kerberos libraries are not sharable. After successfully including the
  47. Kerberos libraries, extraneous characters may appear in your output. The
  48. extra characters are a result of how your shared linker replaces read and
  49. write calls. Try using runsocks without integrity or confidentiality
  50. checking. To omit integrity and confidentiality, set SOCKS5_NOINTCHK in
  51. your environment before using runsocks.
  52. RealAudio requires no special setup.
  53. Configuration Parameters
  54. ========================
  55. Please read INSTALL for configure and compile instructions. socks5 includes
  56. several package-specific options that you can include with the ./configure
  57. command. Some of the most commonly used options include: 
  58. --with-krb5[=path]
  59. Sets socks5 to build with Kerberos support and optionally sets the location
  60. of the Kerberos library. If you omit the path, socks5 checks for krlogin
  61. lines in /etc/inetd.conf 
  62. --with-ident[=path]
  63. Sets socks5 to support ident mode and optionally sets the location of the
  64. ident header file and library.
  65. --with-debug
  66. Turns on debug and compile time warnings, for gcc, and turns off
  67. optimization
  68. --with-static
  69. Turns on static compilation of most binaries
  70. --with-threads
  71. Turns on thread support if the operating system supports it
  72. --with-libconffile=filename
  73. Sets the client configuration file. If you omit this option, socks5 uses
  74. /etc/libsocks5.conf in most cases. Under FreeBSD's UNIX port, the configuration
  75. file resides in /usr/local/etc/libsocks5.conf.
  76. --with-srvconffile=filename
  77. Sets the server configuration file. If you omit this option, socks5 uses
  78. /etc/socks5.conf in most cases. Under FreeBSD's UNIX port, the configuration 
  79. file resides in /usr/local/etc/socks5.conf.
  80. --with-srvpidfile=filename
  81. Sets the server pid file, where the socks5 daemon stores its process id. If
  82. you omit this option, the daemon stores its pid in /tmp/socks5.pid.
  83. --with-srvpwdfile=filename
  84. Sets the server Username/Password authentication file. If you omit this
  85. option, socks5 uses /etc/socks5.passwd in most cases. Under FreeBSD's UNIX 
  86. port, the password file resides in /usr/local/etc/socks5.passwd.
  87. --with-srvidtfile=filename
  88. Sets the server ident file. If you omit this option, socks5 stores the ident 
  89. file in /tmp/socks5.ident.
  90. --with-default-port=number
  91. Sets the default socks port number. socks5 uses port 1080 if you omit this
  92. option.
  93. --with-default-server=hostname
  94. Sets the default socks server. If you omit this option, socks uses the local
  95. host.
  96. --with-default-version=number
  97. Sets the default socks version. If you omit this option, socks uses direct
  98. connect.
  99. --with-syslog-facility=facility
  100. Sets the default syslog facility. socks5 uses LOG_DAEMON when you omit this
  101. option.
  102. --with-monitor[=path]
  103. Specifies to build NEC's SOCKS5WatchAG support and optionally specifies the
  104. location for SOCKS5WatchAG's include files and library.
  105. --with-passwd
  106. Instructs socks5 to use the system password file in socks5 Username/Password
  107. exchanges instead of the socks5 username and password file. For security
  108. reasons, we do NOT recommend this option.
  109. socks5 Configuration Files
  110. ==========================
  111. The socks5 daemon requires a configuration file, socks5.conf. socks5 clients
  112. optionally read the client configuration file, libsocks.conf. If you omit
  113. the libsocks5.conf file, set the SOCKS5_SERVER environment variable.
  114. socks5.conf supports these entries:
  115. auth lines        - identify the types of authentication the socks5
  116.                             daemon can use. The server requires auth lines 
  117.                             to perform authentication.
  118. interface lines   - identify to the server which network interfaces
  119.                             the server should use for outbound connections.
  120.                             We strongly recommend using interface entries in a
  121.                             multi-homed server configuration file. It is
  122.                             more efficient to use a default interface entry with
  123.                             the destination address and port fields set to
  124.                             any, "-". interface lines are not useful for 
  125.                             single-homed servers.
  126. proxy lines       - identify to the server how it should establish a
  127.                             proxy connection, directly or through another 
  128.                             socks server. You MUST include proxy entries to
  129.                             make server-to-server (VPN) connections.
  130. permit/deny lines - identify to the server the connection requests 
  131.                             that it should authorize. The order of
  132.                             permit/deny lines is critical because the server
  133.                             checks permit/deny entries in sequential order.
  134.                             When it locates a match, it stops checking. When
  135.                             the server fails to locate a match, it denies
  136.                             authorization. You MUST have at least one permit
  137.                             entry in your socks5.conf file.
  138. The socks5 daemon supports both socks4 and socks5 clients and communicates
  139. with SOCKS4 servers. Be aware of the differences between socks5 and SOCKS4
  140. servers.
  141. socks5 Clients
  142. ==============
  143. The socks5 package includes client applications intended to demonstrate the
  144. socksification process. Developers using the socks5 package submitted the 
  145. applications to NEC. NEC did NOT write the applications. Although they work,
  146. they do contain bugs. NEC has no intention of fixing or maintaining these
  147. applications. We will try to include newer versions of these applications in
  148. future releases. This distribution includes these socks5 clients: ftp,
  149. telnet, archie, finger, whois, rping, and rtraceroute.
  150. If your operating systems supports shared libraries, the socks5 package
  151. builds the socks shared library. The shared library allows non-socks5 clients
  152. to run with the runsocks shell script included in the shlib directory.
  153. runsocks re-orders the dynamic library, linking the new shared library
  154. before libc, resulting in some socksified commands, including connect and
  155. bind. runsocks works under FreeBSD 2, SunOS 4, Solaris 2, Irix 5, and OSF1.
  156. runsocks dynamically socksifies existing applications, without recompiling.
  157. To use runsocks:
  158.     - Your operating system must support the socks5 shared library
  159.     - Your operating system must support the dynamic shared library 
  160.       loading path
  161.     - You must build applications with the dynamic shared C and
  162.       socket libraries
  163. NEC tested the current version of runsocks on Solaris, SunOS, OSF1, IRIX,
  164. and Linux.
  165. Platforms
  166. =========
  167. socks5 relies on the operating system. We try to support as many operating
  168. systems as possible. However, it is impossible to support all UNIX
  169. platforms. We release the source and encourage others to support additional
  170. UNIX platforms.
  171. Operating systems do contain bugs. We cannot fix those bugs and encourage
  172. you to submit these problems to your operating system developers for bug
  173. fixes. For example, Linux 2.0 has bugs in the shared library loader that
  174. cause a segmentation fault message following runsocks.
  175. socks5 Error Messages
  176. =====================
  177. Developers are the intended audience for most logging messages. We recommend
  178. that you refer to the source code to fully understand the messages. Error
  179. messages in the log file do not mean the server malfunctioned. For example,
  180. some HTTP proxies generate S5IORecv ...  messages.
  181. Mailing Lists
  182. =============
  183. NEC maintains a mailing list, socks5@syl.dl.nec.com, to discuss problems
  184. and suggestions. To subscribe, send mail to:
  185. majordomo@socks.nec.com
  186. In your mail message, omit the Subject. Include a one-line body containing:
  187. subscribe socks5
  188. socks5 Bugs
  189. ===========
  190. We encourage all socks5 users to report problems and provide patches for
  191. problems you encounter with socks5. 
  192. PLEASE NOTE: When submitting bug reports, it is most helpful for you to
  193. include debug output. Debug output greatly assists us in isolating problems.
  194. To turn on debug mode for clients, set the client environment variable
  195. SOCKS5_DEBUG. To turn on debug mode when you start the socks5 daemon,
  196. include the -d flag.
  197. To submit problem reports, or send mail not distributed to a mailing list,
  198. send mail to:
  199.         socks5-bugs@syl.dl.nec.com
  200. socks5 Information
  201. ==================
  202. We welcome your comments to: socks5-comments@socks.nec.com
  203. For more information on how to build and use the socks5, please visit our 
  204. socks web site at:
  205. http://www.socks.nec.com/