| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693 |
- <HTML><HEAD><TITLE>Manpage of 3proxy.conf</TITLE>
- </HEAD><BODY>
- <H1>3proxy.conf</H1>
- Section: Universal proxy server
(5)<BR>Updated: December 2004<BR><A HREF="#index">Index</A>
- <A HREF="../index.html">Return to Main Contents</A><HR>
- <A NAME="lbAB"> </A>
- <H2>NAME</H2>
- <B>3proxy.conf</B>
- - 3proxy configuration file
- <A NAME="lbAC"> </A>
- <H2>DESCRIPTION</H2>
- Common structure:
- Configuration file is a text file 3proxy reads configuration from. Each line
- of the file is command and is executed immediately, as it was given from
- console. Each line of the file is treated as a blank (space or tab) separated
- command line. Additional space characters are ignored.
- Think about 3proxy as "application level router" with console interface.
- Comments:
- Any string beginning with space character or '#' character is comment. It's
- ignored. <LF>s are ignored. <CR> is end of command.
- Quotation:
- Quotation character is spaces or another special characters. To use quotation character inside
- quotation character must be dubbed (BASIC convention). For example to use
- HELLO Good practice is to quote any argument you use.
- File inclusion:
- You can include file by using $FILENAME macro (replace FILENAME with a path
- to file, for example $/usr/local/etc/3proxy/conf.incl or
- <BR> $"c:\Program Files\3proxy\include.cfg" Quotation is
- required in last example because path contains space character.
- For included file <CR> (end of line characters) is treated as space character
- (arguments delimiter instead of end of command delimiter).
- Thus, include files are only useful to store long signle-line commands
- (like userlist, network lists, etc).
- To use dollar sign somewhere in argument it must be quoted.
- Recursion is not allowed.
- Commands:
- <B>proxy</B>
- [options]
- <BR>
- <B>socks</B>
- [options]
- <BR>
- <B>pop3p</B>
- [options]
- <BR>
- <B>ftppr</B>
- [options]
- <BR>
- <B>admin</B>
- [options]
- <BR>
- <B>dnspr</B>
- [options]
- <BR>
- <B>tcppm</B>
- [options]
- <SRCPORT> <DSTADDR> <DSTPORT>
- <BR>
- <B>udppm</B>
- [options]
- <SRCPORT> <DSTADDR> <DSTPORT>
- starts gateway services
- <B>proxy</B>
- - HTTP/HTTPS proxy (default port 3128)
- <BR>
- <B>socks</B>
- - SOCKS 4/4.5/5 proxy (default port 1080)
- <BR>
- <B>pop3p</B>
- - POP3 proxy (default port 110)
- <BR>
- <B>ftppr</B>
- - FTP proxy (default port 21)
- <BR>
- <B>admin</B>
- - Web interface (default port 80)
- <BR>
- <B>dnspr</B>
- - caching DNS proxy (default port 53)
- <BR>
- <B>tcppm</B>
- - TCP portmapper
- <BR>
- <B>udppm</B>
- - UDP portmapper
- Options:
- <BR>
- <B>-pNUMBER</B>
- change default server port to NUMBER
- <BR>
- <B>-n</B>
- disable NTLM authentication (required if passwords are stored in Unix crypt format.
- <BR>
- Also, all options mentioned for
- <B><A HREF="../man8/proxy.8.html">proxy</A></B>(8)
- <B><A HREF="../man8/socks.8.html">socks</A></B>(8)
- <B><A HREF="../man8/pop3p.8.html">pop3p</A></B>(8)
- <B><A HREF="../man8/tcppm.8.html">tcppm</A></B>(8)
- <B><A HREF="../man8/udppm.8.html">udppm</A></B>(8)
- <B><A HREF="../man8/ftppr.8.html">ftppr</A></B>(8)
- are also supported.
- Portmapping services listen at SRCPORT and connect to DSTADDR:DSTPORT
- HTTP and SOCKS proxies are standard.
- POP3 proxy must be configured as POP3 server and requires username in the form of:
- <A HREF="mailto:pop3username@pop3server">pop3username@pop3server</A>. If POP3 proxy access must be authenticated, you can
- specify username as proxy_username:proxy_password:<A HREF="mailto:POP3_username@pop3server">POP3_username@pop3server</A>
- DNS proxy is only capable to resolve hostnames (no MX, PTR, SRV, etc) and
- requires nserver/nscache to be configured.
- FTP proxy can be used as FTP server in any FTP client or configured as FTP
- proxy on a client with FTP proxy support. Username format is one of
- <BR> <A HREF="mailto:FTPuser@FTPServer">FTPuser@FTPServer</A>
- <BR> FTPuser:<A HREF="mailto:FTPpassword@FTPserver">FTPpassword@FTPserver</A>
- <BR> proxyuser:proxypassword:FTPuser:<A HREF="mailto:FTPpassword@FTPserver">FTPpassword@FTPserver</A>
- <BR>
- Please note, if you use FTP client interface for FTP proxy
- do not add FTPpassword and FTPServer to username, because
- FTP client does it for you. That is, if you use 3proxy with
- authentication use
- proxyuser:proxypassword:FTPuser
- as FTP username, otherwise do not change original FTP user name<TT> </TT><BR>
- <B>config</B>
- <path>
- <BR>
- Path to configuration file to use on 3proxy restart or to save configuration.
- <B>writable</B>
- <BR>
- ReOpens configuration file for write access via Web interface,
- and re-reads it. Usually should be first command on config file
- but in combination with "config" it can be used anywhere to open
- alternate config file. Think twice before using it.
- <B>end</B>
- <BR>
- End of configuration
- <B>log</B>
- [[@|&]logfile] [<LOGTYPE>]
- <BR>
- sets logfile for all gateways
- <BR> @ - (for Unix) use syslog, filename is used as ident name
- <BR> & - use ODBC, filename consists of comma-delimited datasource,username,password (username and password are optional)
- <BR> LOGTYPE is one of:
- <BR> M - Monthly
- <BR> W - Weekly (starting from Sunday)
- <BR> D - Daily
- <BR> H - Hourly
- if logfile is not specified logging goes to stdout. You can specify individual logging options for gateway by using
- -l option in gateway configuration.
- <B>rotate</B>
- <n>
- how many archived log files to keep
- <B>logformat</B>
- <format>
- Format for log record. First symbol in format must be L (local time)
- or G (absolute Grinwitch time).
- It can be preceeded with -XXX+Y where XXX is list of characters to be
- filtered in user input (any non-printable characters are filtered too
- in this case) and Y is replacement character. For example, "-,%+ L" in
- the beginning of logformat means comma and percent are replaced
- with space and all time based elemnts are in local time zone.
- You can use:
- <BR> %y - Year in 2 digit format
- <BR> %Y - Year in 4 digit format
- <BR> %m - Month number
- <BR> %o - Month abbriviature
- <BR> %d - Day
- <BR> %H - Hour
- <BR> %M - Minute
- <BR> %S - Second
- <BR> %t - Timstamp (in seconds since 01-Jan-1970)
- <BR> %. - milliseconds
- <BR> %z - timeZone (from Grinvitch)
- <BR> %D - request duration (in milliseconds)
- <BR> %b - average send rate per request (in Bytes per second) this speed is typically below connection speed shown by download manager.
- <BR> %B - average receive rate per request (in Bytes per second) this speed is typically below connection speed shown by download manager.
- <BR> %U - Username
- <BR> %N - service Name
- <BR> %p - service Port
- <BR> %E - Error code
- <BR> %C - Client IP
- <BR> %c - Client port
- <BR> %R - Remote IP
- <BR> %r - Remote port
- <BR> %n - requested hostname
- <BR> %I - bytes In
- <BR> %O - bytes Out
- <BR> %h - Hops (redirections) count
- <BR> %T - service specific Text
- <BR> %N1-N2T - (N1 and N2 are positive numbers) - log only fields from N1 thorugh N2 of service specific text
- in case of ODBC logging logformat specifies SQL statement, for exmample:
- <BR> logformat "-'+_Linsert into log (l_date, l_user, l_service, l_in, l_out, l_descr) values ('%d-%m-%Y %H:%M:%S', '%U', '%N', %I, %O, '%T')"
- <B>archiver</B>
- <ext> <commandline>
- <BR>
- Archiver to use for log files. <ext> is file extension produced by
- archiver. Filename will be last argument to archiver, optionally you
- can use %A as produced archive name and %F as filename.
- <B>timeouts</B>
- <BYTE_SHORT> <BYTE_LONG> <STRING_SHORT> <STRING_LONG> <CONNECTION_SHORT> <CONNECTION_LONG> <DNS> <CHAIN>
- Sets timeout values
- <BR> BYTE_SHORT - short timeout for single byte, is usually used for receiving single byte from stream.
- <BR> BYTE_LONG - long timeout for single byte, is usually used for receiving first byte in frame (for example first byte in socks request).
- <BR> STRING_SHORT - short timeout, for character string within stream (for example to wait between 2 HTTP headers)
- <BR> STRING_LONG - long timeout, for first string in stream (for example to wait for HTTP request).
- <BR> CONNECTION_SHORT - inactivity timeout for short connections (HTTP, POP3, etc).
- <BR> CONNECTION_LONG - inactivity timeout for long connection (SOCKS, portmappers, etc).
- <BR> DNS - timeout for DNS request before requesting next server
- <BR> CHAIN - timeout for reading data from chained connection
- <B>nserver</B>
- <BR> <ipaddr>
- <BR>
- Nameserver to use for name resolutions. If none spcified system
- or name server fails system routines for name resolution will be
- used. It's better to specify nserver because gethostbyname() may
- be thread unsafe.
- <B>nscache</B>
- <cachesize>
- <BR>
- Cache <cachesize> records for name resolution. Cachesize usually
- should be large enougth (for example 65536).
- <B>nsrecord</B>
- <hostname> <hostaddr>
- <B></B>
- Adds static record to nscache. nscache must be enabled. If 0.0.0.0
- is used as a hostaddr host will never resolve, it can be used to
- blacklist something or together with
- <B>dialer</B>
- command to set up UDL for dialing.
- <B>dialer</B>
- <progname>
- <BR>
- Execute progname if external name can't be resolved.
- Hint: if you use nscache, dialer may not work, because names will
- be resolved through cache. In this case you can use something like
- <A HREF="http://dial.right.now/">http://dial.right.now/</A> from browser to set up connection.
- <B>internal</B>
- <ipaddr>
- <BR>
- sets ip address of internal interface. This IP address will be used
- to bind gateways. Alternatively you can use -i option for individual
- gateways
- <B>external</B>
- <ipaddr>
- <BR>
- sets ip address of external interface. This IP address will be source
- address for all connections made by proxy. Alternatively you can use
- -e option to specify individual address for gateway.
- <BR>
- <B>maxconn</B>
- <number>
- <BR>
- sets maximum number of simulationeous connections to each services
- started after this command. Default is 100.
- <B>service</B>
- <BR>
- (depricated) Should be specified to launch as Windows 95/98/NT/2000/XP service,
- no effect for Unix. Is not reqired since 0.6, but you must re-install 3proxy
- service with --remove and --install.
- <B>daemon</B>
- <BR>
- Should be specified to close console (not required for 'service').
- At least under FreeBSD 'daemon' should preceed any proxy service
- and log commands to avoid sockets problem. Always place it in the beginning
- of the configuration file.
- <B>auth</B>
- <BR>
- Type of user authorization. Currently supported:
- <BR> none - no authorization required. Note: is auth is none any ip based limitation, redirection, etc will not work.
- <BR> iponly - authorization by source/destination IP and ports. Appropriate for most cases
- <BR> nbname - iponly + authorization by NetBIOS name. Messanger
- service should be started on user's machine. Note, that
- Windows 95/98 hosts do not have messanger service by default,
- WinPopup program need to be started.
- NB: there is no any password check, name may be spoofed.
- Think about it as about ident for Windows.
- <BR> Q: Will ident authorization be implemented?
- <BR> A: Yes, as soon as it will be required by someone.
- <BR> strong - username/password authentication required. It will work with SOCKSv5, FTP, POP3 and HTTP proxy.
- <B>allow</B>
- <userlist> <sourcelist> <targetlist> <targetportlist> <operationlist>
- <weekdayslist> <timeperiodslist>
- <BR>
- <B>deny</B>
- <userlist> <sourcelist> <targetlist> <targetportlist> <operationlist>
- <weekdayslist> <timeperiodslist>
- <BR>
- Access control entries. All lists are comma-separated, no spaces are
- allowed. Usernames are case sensitive (if used with authtype nbname
- username must be in uppercase). Source and target lists may contain
- IP addresses (W.X.Y.Z) or CIDRs (W.X.Y.Z/L). Targetportlist may
- contain ports (X) or port lists (X-Y).<TT> </TT>For any field * sign means "ANY"<BR>
- If access list is empty it's assumed to be
- <BR> allow *
- If access list is not empty last item in access list is assumed to be
- <BR> deny *
- You may want explicitly add "deny *" into the end of access list to prevent
- HTTP proxy from requesting user's password.
- Access lists are checked after user have requested any resource.
- If you want 3proxy to reject connections from specific addresses
- immediately without any conditions you should either bind proxy
- to appropriate interface only or to use ip filters.
- Operation is one of:
- <BR> CONNECT<TT> </TT>- establish outgoing TCP connection<BR>
- <BR> BIND - bind TCP port for listening
- <BR> UDPASSOC - make UDP association
- <BR> ICMPASSOC - make ICMP association (for future use)
- <BR> HTTP_GET - HTTP GET request
- <BR> HTTP_PUT - HTTP PUT request
- <BR> HTTP_POST - HTTP POST request
- <BR> HTTP_HEAD - HTTP HEAD request
- <BR> HTTP_CONNECT - HTTP CONNECT request
- <BR> HTTP_OTHER - over HTTP request
- <BR> HTTP - matches any HTTP request except HTTP_CONNECT
- <BR> HTTPS - same as HTTP_CONNECT
- <BR> FTP_GET - FTP get request
- <BR> FTP_PUT - FTP put request
- <BR> FTP_LIST - FTP list request
- <BR> FTP - matches any FTP request
- Weeksdays are week days numbers or periods (0 or 7 means Sunday, 1 is Monday,
- 1-5 means Monday through Friday). Timeperiodlists is a list of time
- periods in HH:MM:SS-HH:MM:SS format. For example,
- <BR> 00:00:00-08:00:00,17:00:00-24:00:00
- lists non-working hours.
- <TT> </TT><BR>
- <B>parent</B>
- <weight> <type> <ip> <port> <username> <password>
- <BR>
- this command may follow "allow" rule. It extends last allow rule to
- build proxy chain. Proxy may be grouped. Proxy inside the
- group is selected randomely. If few groups are specified one proxy
- is randomely picked from each group and chain of proxies is created
- (that is second proxy connected through first one and so on).
- Weight is used to group proxies. Weigt is a number between 1 and 1000.
- Weights are summed and proxies are grouped together untill weight of
- group is 1000. That is:
- <BR> allow *
- <BR> parent 500 socks5 192.168.10.1 1080
- <BR> parent 500 connect 192.168.10.1 3128
- makes 3proxy to randomely choose between 2 proxies for all outgoing
- connections
- <BR> allow * * * 80
- <BR> parent 1000 socks5 192.168.10.1 1080
- <BR> parent 1000 connect 192.168.20.1 3128
- <BR> parent 300 socks4 192.168.30.1 1080
- <BR> parent 700 socks5 192.168.40.1 1080
- creates chain of 3 proxies: 192.168.10.1, 192.168.20.1 and third
- is (192.168.30.1 with probability of 0.3 or 192.168.40.1
- with probability of 0.7) for outgoing web connections.
- type is one of:
- <BR> tcp - simply redirect connection. TCP is always last in chain.
- <BR> http - redirect to HTTP proxy. HTTP is always last chain.
- <BR> pop3 - redirect to POP3 proxy (only local redirection is supported, can not be
- used for chaining)
- <BR> ftp - redirect to FTP proxy (only local redirection is supported, can not be
- used for chaining)
- <BR> connect - parent is HTTP CONNECT method proxy
- <BR> socks4 - parent is SOCKSv4 proxy
- <BR> socks5 - parent is SOCKSv5 proxy
- IP and port are ip addres and port of parent proxy server.
- If IP is zero, ip is taken from original request, only port is changed.
- If port is zero, it's taken from original request, only IP is changed.
- If both IP and port are zero - it's a special case of local redirection,
- it works only with
- socks
- proxy. In case of local redirection request is redirected to different service,
- <B>ftppr</B>
- <B>pop3p</B>
- <B>proxy .</B>
- Main purpose of local redirections is to have requested resource
- (URL or POP3 username) logged and protocol-specific filters to be applied.
- In case of local redirection ACLs are revied twice: first, by SOCKS proxy up to
- redirected (HTTP, FTP or POP3) after 'parent' command. It means,
- additional 'allow' command is required for redirected requests, for
- example:
- <BR> allow * * * 80
- <BR> parent 1000 http 0.0.0.0 0
- <BR> allow * * * 80 HTTP_GET,HTTP_POST
- <BR> socks
- redirects all SOCKS requests with target port 80 to local HTTP proxy,
- local HTTP proxy parses requests and allows only GET and POST requests.
- Optional username and password are used to authenticate on parent
- proxy. Username of '*' means username must be supplied by user.
- <B>bandlimin</B>
- <rate> <userlist> <sourcelist> <targetlist> <targetportlist> <operationlist>
- <BR>
- <B>nobandlimin</B>
- <userlist> <sourcelist> <targetlist> <targetportlist> <operationlist>
- <BR>
- bandlim sets bandwith limitation filter to <rate> bps (bits per second)
- (if you want to specife bytes per second - multiply your value to 8).
- bandlim rules act in a same manner as allow/deny rules except
- one thing: bandwidth limiting is applied to all services, not to some
- specific service.
- bandlimin and nobandlimin applies to incoming traffic
- bandlimout and nobandlimout applies to outgoing traffic
- If tou want to ratelimit your clients with ip's 192.168.10.16/30 (4
- addresses) to 57600 bps you have to specify 4 rules like
- <BR> bandlimin 57600 * 192.168.10.16
- <BR> bandlimin 57600 * 192.168.10.17
- <BR> bandlimin 57600 * 192.168.10.18
- <BR> bandlimin 57600 * 192.168.10.19
- and every of you clients will have 56K channel.<TT> </TT>if you specify<BR>
- <BR> bandlimin 57600 * 192.168.10.16/30
- you will have 56K channel shared between all clients.
- if you want, for example, to limit all speed ecept access to POP3 you can use
- <BR> nobandlimin * * * 110
- before the rest of bandlim rules.
- <B>counter</B>
- <filename> <reporttype> <repotname>
- <BR>
- <B>countin</B>
- <number> <type> <limit> <userlist> <sourcelist> <targetlist> <targetportlist> <operationlist>
- <BR>
- <B>nocountin</B>
- <userlist> <sourcelist> <targetlist> <targetportlist> <operationlist>
- <BR>
- counter, countin, nocountin commands are used to set traffic limit
- in MB for period of time (day, week or month). Filename is a path
- to a special file where traffic information is permanently stored.
- number is sequential number of record in this file. If number is 0
- no traffic information on this counter is saved in file (that is
- if proxy restarted all information is loosed) overwise it should be
- unique sequential number.
- Type specifies a type of counter. Type is one of:
- <BR> D - counter is resetted daily
- <BR> W - counter is resetted weekly
- <BR> M - counter is resetted monthely
- reporttype/repotname may be used to generate traffic reports.
- Reporttype is one of D,W,M,H(hourly) and repotname specifies filename
- template for reports. Report is text file with counter values in
- format:
- <BR> <COUNTERNUMBER> <TRAF*4GB> <TRAF>
- The rest of parameters is identical to bandlim/nobandlim.
- <B>users</B>
- username[:pwtype:password] ...
- <BR>
- pwtype is one of:
- <BR> none (empty) - use system authentication
- <BR> CL - password is cleartext
- <BR> CR - password is crypt-style password
- <BR> NT - password is NT password (in hex)
- example:
- <BR> users test1:CL:password1 "test2:CR:$1$lFDGlder$pLRb4cU2D7GAT58YQvY49."
- <BR> users test3:NT:BD7DFBF29A93F93C63CB84790DA00E63
- <BR>
- (note: double quotes are requiered because password contains $ sign).<TT> </TT><BR>
- <B>flush</B>
- <BR>
- empty active access list. Access list must be flushed avery time you creating
- new access list for new service. For example:
- <BR> allow *
- <BR> pop3p
- <BR> flush
- <BR> allow * 192.168.1.0/24
- <BR> socks
- sets different ACLs for
- <B>pop3p</B>
- and
- <B>socks</B>
- <B>system</B>
- <BR>
- execute system command
- <B>pidfile</B>
- <filename>
- <BR>
- write pid of current process to file. It can be used to manipulate
- 3proxy with signals under Unix. Currently next signals are available:
- <B>setuid</B>
- <uid>
- <BR>
- calls setuid(uid), uid must be numeric. Unix only.
- <B>setgid</B>
- <gid>
- <BR>
- calls setgid(gid), gid must be numeric. Unix only.
- <B>chroot</B>
- <path>
- <BR>
- calls chroot(path). Unix only.
- <A NAME="lbAD"> </A>
- <H2>SEE ALSO</H2>
- <A HREF="../man8/3proxy.8.html">3proxy</A>(8), <A HREF="../man8/proxy.8.html">proxy</A>(8), <A HREF="../man8/ftppr.8.html">ftppr</A>(8), <A HREF="../man8/socks.8.html">socks</A>(8), <A HREF="../man8/pop3p.8.html">pop3p</A>(8), <A HREF="../man8/tcppm.8.html">tcppm</A>(8), <A HREF="../man8/udppm.8.html">udppm</A>(8), <A HREF="../man8/syslogd.8.html">syslogd</A>(8),
- <BR>
- <A HREF="http://3proxy.ru/">http://3proxy.ru/</A>
- <A NAME="lbAE"> </A>
- <H2>TRIVIA</H2>
- 3APA3A is pronounced as ``zaraza''.
- <A NAME="lbAF"> </A>
- <H2>AUTHORS</H2>
- 3proxy is designed by 3APA3A
- (<I><A HREF="mailto:3APA3A@security.nnov.ru">3APA3A@security.nnov.ru</A></I>),
- Vladimir Dubrovin
- (<I><A HREF="mailto:vlad@sandy.ru">vlad@sandy.ru</A></I>)
- <P>
- <HR>
- <A NAME="index"> </A><H2>Index</H2>
- <DL>
- <DT><A HREF="#lbAB">NAME</A><DD>
- <DT><A HREF="#lbAC">DESCRIPTION</A><DD>
- <DT><A HREF="#lbAD">SEE ALSO</A><DD>
- <DT><A HREF="#lbAE">TRIVIA</A><DD>
- <DT><A HREF="#lbAF">AUTHORS</A><DD>
- </DL>
- <HR>
- This document was created by
- using the manual pages.<BR>
- Time: GMT, December 11, 2004
- </BODY>
- </HTML>
|