.\" =========================================================================
.\" Copyright (c) 2007 Raffaele De Lorenzo.  All rights reserved.
.\"
.\" ==========================================================================
.\"
.\" csocks.1 by Raffaele De Lorenzo
.\"



.TH CSOCKS.CONF 5 "Version 1.0 - August 6 2007"

.SH NAME 
csocks.conf - Configuration file for csocks library

.SH DESCRIPTION
.I csocks.conf
the CSOCKS configuration file (usually is /usr/local/etc/csocks.conf in FreeBSD and /etc/csocks.conf in Linux). You must indicate for all rules:
.PP
Socks protocol (socks4 or socks5)
.PP 
Destination Address, NetMask
.PP 
Destination Port (you can specify "0" for all ports)
.PP 
Destination Address for socks Server and port
.PP 
Protocol (TCP or UDP)
.PP 
Direction (IN for Active connections and OUT for other)
.PP

socks5 152.33.28.56 255.255.255.0 22 10.253.14.156 1080 TCP OUT

In the csocks.conf you can indicate the username (socks4 and 5) and password (only socks5) used globally. In alternative you can set CSOCKS_USER and CSOCKS_PASSWD environment (in this case the global declarations in csocks.conf are ignored). Remember that inbound connection rule must have a corrispective outbound connection rule, this is necessary for RFC compliant.


.SH ENVIRONMENT
In the "csocks.conf" configuration file you can indicate the username (socks4 and 5) and password (only socks5) used globally. In alternative you can set CSOCKS_USER and CSOCKS_PASSWD environment (in this case the global declarations in csocks.conf are ignored).

.SH EXAMPLE
This is a simple "csocks.conf" file:
.PP
.PP


credential for socks5  (only user for socks4)
#
 CSOCKS_USER charlie
 CSOCKS_PASSWD passwd

# scocks_version host mask port socks_server port_socks_server protocol direction 
# directions: IN for BIND connections, OUT for CONNECT connections
# NB: The BIND connections required 2 rules, one for BIND and one for CONNECT.

# if you specify "0.0.0.0" in place of "host", and "0" in place of "port" ALL host/port are socksyfied
#
#


socks5 10.10.0.20 255.255.255.0 0 10.10.0.21 1080 UDP OUT 

socks5 10.10.0.20 255.255.255.0 0 10.10.0.21 1080 UDP IN

.PP

.SH NOTE
The SOCKS5/GSSAPI and IPv6 aren't implemented in the current version (only NEC SOCKS5 implemented GSSAPI... i don't know any Socks Server that support IPv6).


.SH COPYRIGHT
Raffaele De Lorenzo (raffaele.delorenzo@libero.it)  (http://csocks.altervista.org)

.SH SEE ALSO
csocks(1)



.\" end of file