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