mirror of
https://github.com/3proxy/3proxy.git
synced 2025-02-23 10:35:40 +08:00
minor man update
This commit is contained in:
parent
92fbb0d2f5
commit
941baaa311
384
man/3proxy.cfg.3
384
man/3proxy.cfg.3
@ -1,7 +1,7 @@
|
|||||||
.TH 3proxy.cfg "8" "January 2019" "3proxy 0.9" "Universal proxy server"
|
.TH 3proxy.cfg "8" "January 2019" "3proxy 0.9" "Universal proxy server"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
.B 3proxy.cfg
|
.B 3proxy.cfg
|
||||||
\- 3proxy configuration file
|
3proxy configuration file
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
Common structure:
|
Common structure:
|
||||||
.br
|
.br
|
||||||
@ -11,7 +11,7 @@ console. Sequence of commands is important. Configuration file as actually a
|
|||||||
script for 3proxy executable.
|
script for 3proxy executable.
|
||||||
Each line of the file is treated as a blank (space or tab) separated
|
Each line of the file is treated as a blank (space or tab) separated
|
||||||
command line. Additional space characters are ignored.
|
command line. Additional space characters are ignored.
|
||||||
Think about 3proxy as "application level router" with console interface.
|
Think about 3proxy as \"application level router\" with console interface.
|
||||||
|
|
||||||
.br
|
.br
|
||||||
Comments:
|
Comments:
|
||||||
@ -22,10 +22,10 @@ ignored. <LF>s are ignored. <CR> is end of command.
|
|||||||
.br
|
.br
|
||||||
Quotation:
|
Quotation:
|
||||||
.br
|
.br
|
||||||
Quotation character is " (double quote). Quotation must be used to quote
|
Quotation character is \" (double quote). Quotation must be used to quote
|
||||||
spaces or another special characters. To use quotation character inside
|
spaces or another special characters. To use quotation character inside
|
||||||
quotation character must be dubbed (BASIC convention). For example to use
|
quotation character must be dubbed (BASIC convention). For example to use
|
||||||
HELLO "WORLD" as an argument you should use it as "HELLO ""WORLD"""\.
|
HELLO \"WORLD\" as an argument you should use it as \"HELLO \"\"WORLD\"\"\".
|
||||||
Good practice is to quote any argument you use.
|
Good practice is to quote any argument you use.
|
||||||
|
|
||||||
.br
|
.br
|
||||||
@ -33,7 +33,7 @@ Good practice is to quote any argument you use.
|
|||||||
.br
|
.br
|
||||||
You can include file by using $FILENAME macro (replace FILENAME with a path
|
You can include file by using $FILENAME macro (replace FILENAME with a path
|
||||||
to file, for example $/usr/local/etc/3proxy/conf.incl or
|
to file, for example $/usr/local/etc/3proxy/conf.incl or
|
||||||
$"c:\\Program Files\\3proxy\\include.cfg" Quotation is
|
$\"c:\\\\Program Files\\\\3proxy\\\\include.cfg\" Quotation is
|
||||||
required in last example because path contains space character.
|
required in last example because path contains space character.
|
||||||
For included file <CR> (end of line characters) is treated as space character
|
For included file <CR> (end of line characters) is treated as space character
|
||||||
(arguments delimiter instead of end of command delimiter).
|
(arguments delimiter instead of end of command delimiter).
|
||||||
@ -44,95 +44,94 @@ Recursion is not allowed.
|
|||||||
|
|
||||||
.br
|
.br
|
||||||
Next commands start gateway services:
|
Next commands start gateway services:
|
||||||
.br
|
|
||||||
|
|
||||||
.br
|
.br
|
||||||
.B proxy
|
.B proxy
|
||||||
[options]
|
[options]
|
||||||
.br
|
.br
|
||||||
.B socks
|
.B socks
|
||||||
[options]
|
[options]
|
||||||
.br
|
.br
|
||||||
.B pop3p
|
.B pop3p
|
||||||
[options]
|
[options]
|
||||||
.br
|
.br
|
||||||
.B ftppr
|
.B ftppr
|
||||||
[options]
|
[options]
|
||||||
.br
|
.br
|
||||||
.B admin
|
.B admin
|
||||||
[options]
|
[options]
|
||||||
.br
|
.br
|
||||||
.B dnspr
|
.B dnspr
|
||||||
[options]
|
[options]
|
||||||
.br
|
.br
|
||||||
.B tcppm
|
.B tcppm
|
||||||
[options]
|
[options]
|
||||||
<SRCPORT> <DSTADDR> <DSTPORT>
|
<SRCPORT> <DSTADDR> <DSTPORT>
|
||||||
.br
|
.br
|
||||||
.B udppm
|
.B udppm
|
||||||
[options]
|
[options]
|
||||||
<SRCPORT> <DSTADDR> <DSTPORT>
|
<SRCPORT> <DSTADDR> <DSTPORT>
|
||||||
.br
|
.br
|
||||||
Descriptions:
|
Descriptions:
|
||||||
.br
|
.br
|
||||||
.B proxy
|
.B proxy
|
||||||
\- HTTP/HTTPS proxy (default port 3128)
|
HTTP/HTTPS proxy (default port 3128)
|
||||||
.br
|
.br
|
||||||
.B socks
|
.B socks
|
||||||
\- SOCKS 4/4.5/5 proxy (default port 1080)
|
SOCKS 4/4.5/5 proxy (default port 1080)
|
||||||
.br
|
.br
|
||||||
.B pop3p
|
.B pop3p
|
||||||
\- POP3 proxy (default port 110)
|
POP3 proxy (default port 110)
|
||||||
.br
|
.br
|
||||||
.B ftppr
|
.B ftppr
|
||||||
\- FTP proxy (default port 21)
|
FTP proxy (default port 21)
|
||||||
.br
|
.br
|
||||||
.B admin
|
.B admin
|
||||||
\- Web interface (default port 80)
|
Web interface (default port 80)
|
||||||
.br
|
.br
|
||||||
.B dnspr
|
.B dnspr
|
||||||
\- caching DNS proxy (default port 53)
|
caching DNS proxy (default port 53)
|
||||||
.br
|
.br
|
||||||
.B tcppm
|
.B tcppm
|
||||||
\- TCP portmapper
|
TCP portmapper
|
||||||
.br
|
.br
|
||||||
.B udppm
|
.B udppm
|
||||||
\- UDP portmapper
|
UDP portmapper
|
||||||
.br
|
|
||||||
|
|
||||||
|
.br
|
||||||
Options:
|
Options:
|
||||||
.br
|
.br
|
||||||
.B -pNUMBER
|
.B -pNUMBER
|
||||||
change default server port to NUMBER
|
change default server port to NUMBER
|
||||||
.br
|
.br
|
||||||
.B -n
|
.B -n
|
||||||
disable NTLM authentication (required if passwords are stored in Unix crypt format.
|
disable NTLM authentication (required if passwords are stored in Unix crypt format).
|
||||||
.br
|
.br
|
||||||
.B -n1
|
.B -n1
|
||||||
enable NTLMv1 authentication.
|
enable NTLMv1 authentication.
|
||||||
.br
|
.br
|
||||||
.B -s
|
.B -s
|
||||||
(for admin) - secure, allow only secure operations (currently only traffic counters
|
(for admin) secure, allow only secure operations, currently only traffic counters
|
||||||
view without ability to reset).
|
view without ability to reset.
|
||||||
.br
|
.br
|
||||||
(for dnspr) - simple, do not use 'resolver' and 3proxy cache, always use external DNS server.
|
(for dnspr) simple, do not use resolver and 3proxy cache, always use external DNS server.
|
||||||
.br
|
.br
|
||||||
(for udppm) - singlepacket, expect only one packet from both client and server
|
(for udppm) singlepacket, expect only one packet from both client and server
|
||||||
.br
|
.br
|
||||||
.B -u
|
.B -u
|
||||||
Never ask for username/password
|
Never ask for username/password
|
||||||
.br
|
.br
|
||||||
.B -u2
|
.B -u2
|
||||||
(socks) require username/password in authentication methods
|
(for socks) require username/password in authentication methods
|
||||||
.br
|
.br
|
||||||
.B -a
|
.B -a
|
||||||
(for proxy) - anonymous proxy (no information about client reported)
|
(for proxy) anonymous proxy (no information about client reported)
|
||||||
.br
|
.br
|
||||||
.B -a1
|
.B -a1
|
||||||
(for proxy) - anonymous proxy (random client information reported)
|
(for proxy) anonymous proxy (random client information reported)
|
||||||
.br
|
.br
|
||||||
.B -a2
|
.B -a2
|
||||||
(for proxy) - generate Via: and X-Forwared-For: instead of Forwarded:
|
(for proxy) generate Via: and X-Forwared-For: instead of Forwarded:
|
||||||
.br
|
.br
|
||||||
.B -6
|
.B -6
|
||||||
Only resolve IPv6 addresses. IPv4 addresses are packed in IPv6 in IPV6_V6ONLY compatible way.
|
Only resolve IPv6 addresses. IPv4 addresses are packed in IPv6 in IPV6_V6ONLY compatible way.
|
||||||
@ -207,8 +206,9 @@ proxy on a client with FTP proxy support. Username format is one of
|
|||||||
.B writable
|
.B writable
|
||||||
.br
|
.br
|
||||||
ReOpens configuration file for write access via Web interface,
|
ReOpens configuration file for write access via Web interface,
|
||||||
and re-reads it. Usually should be first command on config file
|
and rereads it. Usually should be first command on config file
|
||||||
but in combination with "config" it can be used anywhere to open
|
but in combination with config
|
||||||
|
it can be used anywhere to open
|
||||||
alternate config file. Think twice before using it.
|
alternate config file. Think twice before using it.
|
||||||
|
|
||||||
.br
|
.br
|
||||||
@ -222,26 +222,26 @@ alternate config file. Think twice before using it.
|
|||||||
.br
|
.br
|
||||||
sets logfile for all gateways
|
sets logfile for all gateways
|
||||||
.br
|
.br
|
||||||
@ - (for Unix) use syslog, filename is used as ident name
|
@ (for Unix) use syslog, filename is used as ident name
|
||||||
.br
|
.br
|
||||||
& - use ODBC, filename consists of comma-delimited datasource,username,password (username and password are optional)
|
& use ODBC, filename consists of comma-delimited datasource,username,password (username and password are optional)
|
||||||
.br
|
.br
|
||||||
LOGTYPE is one of:
|
LOGTYPE is one of:
|
||||||
.br
|
.br
|
||||||
M - Monthly
|
M Monthly
|
||||||
.br
|
.br
|
||||||
W - Weekly (starting from Sunday)
|
W Weekly (starting from Sunday)
|
||||||
.br
|
.br
|
||||||
D - Daily
|
D Daily
|
||||||
.br
|
.br
|
||||||
H - Hourly
|
H Hourly
|
||||||
.br
|
.br
|
||||||
if logfile is not specified logging goes to stdout. You can specify individual logging options for gateway by using
|
if logfile is not specified logging goes to stdout. You can specify individual logging options for gateway by using -l
|
||||||
-l option in gateway configuration.
|
option in gateway configuration.
|
||||||
.br
|
.br
|
||||||
"log" command supports same format specifications for filename template
|
log command supports same format specifications for filename template
|
||||||
as "logformat" (if filename contains '%' sign it's believed to be template).
|
as \"logformat\" (if filename contains \'%\' sign it\'s believed to be template).
|
||||||
As with "logformat" filename must begin with 'L' or 'G' to specify Local or
|
As with \"logformat\" filename must begin with \'L\' or \'G\' to specify Local or
|
||||||
Grinwitch time zone for all time-based format specificators.
|
Grinwitch time zone for all time-based format specificators.
|
||||||
|
|
||||||
.br
|
.br
|
||||||
@ -257,80 +257,80 @@ Grinwitch time zone for all time-based format specificators.
|
|||||||
or G (absolute Grinwitch time).
|
or G (absolute Grinwitch time).
|
||||||
It can be preceeded with -XXX+Y where XXX is list of characters to be
|
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
|
filtered in user input (any non-printable characters are filtered too
|
||||||
in this case) and Y is replacement character. For example, "-,%+ L" in
|
in this case) and Y is replacement character. For example, \"-,%+ L\" in
|
||||||
the beginning of logformat means comma and percent are replaced
|
the beginning of logformat means comma and percent are replaced
|
||||||
with space and all time based elemnts are in local time zone.
|
with space and all time based elemnts are in local time zone.
|
||||||
.br
|
.br
|
||||||
You can use:
|
You can use:
|
||||||
|
|
||||||
.br
|
.br
|
||||||
%y - Year in 2 digit format
|
%y Year in 2 digit format
|
||||||
.br
|
.br
|
||||||
%Y - Year in 4 digit format
|
%Y Year in 4 digit format
|
||||||
.br
|
.br
|
||||||
%m - Month number
|
%m Month number
|
||||||
.br
|
.br
|
||||||
%o - Month abbriviature
|
%o Month abbriviature
|
||||||
.br
|
.br
|
||||||
%d - Day
|
%d Day
|
||||||
.br
|
.br
|
||||||
%H - Hour
|
%H Hour
|
||||||
.br
|
.br
|
||||||
%M - Minute
|
%M Minute
|
||||||
.br
|
.br
|
||||||
%S - Second
|
%S Second
|
||||||
.br
|
.br
|
||||||
%t - Timstamp (in seconds since 01-Jan-1970)
|
%t Timstamp (in seconds since 01-Jan-1970)
|
||||||
.br
|
.br
|
||||||
%. - milliseconds
|
%. milliseconds
|
||||||
.br
|
.br
|
||||||
%z - timeZone (from Grinvitch)
|
%z timeZone (from Grinvitch)
|
||||||
.br
|
.br
|
||||||
%D - request duration (in milliseconds)
|
%D request duration (in milliseconds)
|
||||||
.br
|
.br
|
||||||
%b - average send rate per request (in Bytes per second) this speed is typically below connection speed shown by download manager.
|
%b average send rate per request (in Bytes per second) this speed is typically below connection speed shown by download manager.
|
||||||
.br
|
.br
|
||||||
%B - average receive rate per request (in Bytes per second) this speed is typically below connection speed shown by download manager.
|
%B average receive rate per request (in Bytes per second) this speed is typically below connection speed shown by download manager.
|
||||||
.br
|
.br
|
||||||
%U - Username
|
%U Username
|
||||||
.br
|
.br
|
||||||
%N - service Name
|
%N service Name
|
||||||
.br
|
.br
|
||||||
%p - service Port
|
%p service Port
|
||||||
.br
|
.br
|
||||||
%E - Error code
|
%E Error code
|
||||||
.br
|
.br
|
||||||
%C - Client IP
|
%C Client IP
|
||||||
.br
|
.br
|
||||||
%c - Client port
|
%c Client port
|
||||||
.br
|
.br
|
||||||
%R - Remote IP
|
%R Remote IP
|
||||||
.br
|
.br
|
||||||
%r - Remote port
|
%r Remote port
|
||||||
.br
|
.br
|
||||||
%i - Internal IP used to accept client connection
|
%i Internal IP used to accept client connection
|
||||||
.br
|
.br
|
||||||
%e - External IP used to establish connection
|
%e External IP used to establish connection
|
||||||
.br
|
.br
|
||||||
%Q - Requested IP
|
%Q Requested IP
|
||||||
.br
|
.br
|
||||||
%q - Requested port
|
%q Requested port
|
||||||
.br
|
.br
|
||||||
%n - requested hostname
|
%n requested hostname
|
||||||
.br
|
.br
|
||||||
%I - bytes In
|
%I bytes In
|
||||||
.br
|
.br
|
||||||
%O - bytes Out
|
%O bytes Out
|
||||||
.br
|
.br
|
||||||
%h - Hops (redirections) count
|
%h Hops (redirections) count
|
||||||
.br
|
.br
|
||||||
%T - service specific Text
|
%T service specific Text
|
||||||
.br
|
.br
|
||||||
%N1-N2T - (N1 and N2 are positive numbers) - log only fields from N1 thorugh N2 of service specific text
|
%N1-N2T (N1 and N2 are positive numbers) log only fields from N1 thorugh N2 of service specific text
|
||||||
.br
|
.br
|
||||||
in case of ODBC logging logformat specifies SQL statement, for exmample:
|
in the case of ODBC logging logformat specifies SQL statement, for exmample:
|
||||||
.br
|
.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')"
|
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\')\"
|
||||||
|
|
||||||
.br
|
.br
|
||||||
.B logdump
|
.B logdump
|
||||||
@ -355,30 +355,29 @@ can use %A as produced archive name and %F as filename.
|
|||||||
.br
|
.br
|
||||||
Sets timeout values, defaults 1, 5, 30, 60, 180, 1800, 15, 60, 15, 5.
|
Sets timeout values, defaults 1, 5, 30, 60, 180, 1800, 15, 60, 15, 5.
|
||||||
.br
|
.br
|
||||||
BYTE_SHORT - short timeout for single byte, is usually used for receiving single byte from stream.
|
BYTE_SHORT short timeout for single byte, is usually used for receiving single byte from stream.
|
||||||
.br
|
.br
|
||||||
BYTE_LONG - long timeout for single byte, is usually used for receiving first byte in frame (for example first byte in socks request).
|
BYTE_LONG long timeout for single byte, is usually used for receiving first byte in frame (for example first byte in socks request).
|
||||||
.br
|
.br
|
||||||
STRING_SHORT - short timeout, for character string within stream (for example to wait between 2 HTTP headers)
|
STRING_SHORT short timeout, for character string within stream (for example to wait between 2 HTTP headers)
|
||||||
.br
|
.br
|
||||||
STRING_LONG - long timeout, for first string in stream (for example to wait for HTTP request).
|
STRING_LONG long timeout, for first string in stream (for example to wait for HTTP request).
|
||||||
.br
|
.br
|
||||||
CONNECTION_SHORT - inactivity timeout for short connections (HTTP, POP3, etc).
|
CONNECTION_SHORT inactivity timeout for short connections (HTTP, POP3, etc).
|
||||||
.br
|
.br
|
||||||
CONNECTION_LONG - inactivity timeout for long connection (SOCKS, portmappers, etc).
|
CONNECTION_LONG inactivity timeout for long connection (SOCKS, portmappers, etc).
|
||||||
.br
|
.br
|
||||||
DNS - timeout for DNS request before requesting next server
|
DNS timeout for DNS request before requesting next server
|
||||||
.br
|
|
||||||
CHAIN - timeout for reading data from chained connection
|
|
||||||
.br
|
.br
|
||||||
|
CHAIN timeout for reading data from chained connection
|
||||||
|
|
||||||
.br
|
.br
|
||||||
.B nserver
|
.B nserver
|
||||||
<ipaddr>[:port][/tcp]
|
<ipaddr>[:port][/tcp]
|
||||||
.br
|
.br
|
||||||
Nameserver to use for name resolutions. If none specified
|
Nameserver to use for name resolutions. If none specified
|
||||||
or name server fails system routines for name resolution will be
|
or name server fails system routines for name resolution will be
|
||||||
used. It's better to specify nserver because gethostbyname() may
|
used. It\'s better to specify nserver because gethostbyname() may
|
||||||
be thread unsafe. Optional port number may be specified.
|
be thread unsafe. Optional port number may be specified.
|
||||||
If optional /tcp is added to IP address, name resolution will be
|
If optional /tcp is added to IP address, name resolution will be
|
||||||
performed over TCP.
|
performed over TCP.
|
||||||
@ -413,7 +412,7 @@ redirected to parent proxy with http, socks4+, connect+ or socks5+.
|
|||||||
.B dialer
|
.B dialer
|
||||||
<progname>
|
<progname>
|
||||||
.br
|
.br
|
||||||
Execute progname if external name can't be resolved.
|
Execute progname if external name can\'t be resolved.
|
||||||
Hint: if you use nscache, dialer may not work, because names will
|
Hint: if you use nscache, dialer may not work, because names will
|
||||||
be resolved through cache. In this case you can use something like
|
be resolved through cache. In this case you can use something like
|
||||||
http://dial.right.now/ from browser to set up connection.
|
http://dial.right.now/ from browser to set up connection.
|
||||||
@ -432,8 +431,8 @@ gateways. Since 0.8 version, IPv6 address may be used.
|
|||||||
<ipaddr>
|
<ipaddr>
|
||||||
.br
|
.br
|
||||||
sets ip address of external interface. This IP address will be source
|
sets ip address of external interface. This IP address will be source
|
||||||
address for all connections made by proxy. Alternatively you can use
|
address for all connections made by proxy. Alternatively you can use -e
|
||||||
-e option to specify individual address for gateway. Since 0.8 version
|
option to specify individual address for gateway. Since 0.8 version
|
||||||
External or -e can be given twice: once with IPv4 and once with IPv6 address.
|
External or -e can be given twice: once with IPv4 and once with IPv6 address.
|
||||||
|
|
||||||
.br
|
.br
|
||||||
@ -454,8 +453,8 @@ to reinstall service.
|
|||||||
.br
|
.br
|
||||||
.B daemon
|
.B daemon
|
||||||
.br
|
.br
|
||||||
Should be specified to close console. Do not use 'daemon' with 'service'.
|
Should be specified to close console. Do not use \'daemon\' with \'service\'.
|
||||||
At least under FreeBSD 'daemon' should preceed any proxy service
|
At least under FreeBSD \'daemon\' should preceed any proxy service
|
||||||
and log commands to avoid sockets problem. Always place it in the beginning
|
and log commands to avoid sockets problem. Always place it in the beginning
|
||||||
of the configuration file.
|
of the configuration file.
|
||||||
|
|
||||||
@ -465,39 +464,39 @@ of the configuration file.
|
|||||||
.br
|
.br
|
||||||
Type of user authorization. Currently supported:
|
Type of user authorization. Currently supported:
|
||||||
.br
|
.br
|
||||||
none - no authentication or authorization required.
|
none - no authentication or authorization required.
|
||||||
.br
|
.br
|
||||||
Note: is auth is none any ip based limitation, redirection, etc will not work.
|
Note: is auth is none any ip based limitation, redirection, etc will not work.
|
||||||
This is default authentication type
|
This is default authentication type
|
||||||
.br
|
.br
|
||||||
iponly - authentication by access control list with username ignored.
|
iponly - authentication by access control list with username ignored.
|
||||||
Appropriate for most cases
|
Appropriate for most cases
|
||||||
.br
|
.br
|
||||||
useronly - authentication by username without checking for any password with
|
useronly - authentication by username without checking for any password with
|
||||||
authorization by ACLs. Useful for e.g. SOCKSv4 proxy and icqpr (icqpr set UIN /
|
authorization by ACLs. Useful for e.g. SOCKSv4 proxy and icqpr (icqpr set UIN /
|
||||||
AOL screen name as a username)
|
AOL screen name as a username)
|
||||||
.br
|
.br
|
||||||
dnsname - authentication by DNS hostnname with authorization by ACLs.
|
dnsname - authentication by DNS hostnname with authorization by ACLs.
|
||||||
DNS hostname is resolved via PTR (reverse) record and validated (resolved
|
DNS hostname is resolved via PTR (reverse) record and validated (resolved
|
||||||
name must resolve to same IP address). It's recommended to use authcache by
|
name must resolve to same IP address). It\'s recommended to use authcache by
|
||||||
ip for this authentication.
|
ip for this authentication.
|
||||||
NB: there is no any password check, name may be spoofed.
|
NB: there is no any password check, name may be spoofed.
|
||||||
.br
|
.br
|
||||||
strong - username/password authentication required. It will work with
|
strong - username/password authentication required. It will work with
|
||||||
SOCKSv5, FTP, POP3 and HTTP proxy.
|
SOCKSv5, FTP, POP3 and HTTP proxy.
|
||||||
.br
|
.br
|
||||||
cache - cached authentication, may be used with 'authcache'.
|
cache - cached authentication, may be used with \'authcache\'.
|
||||||
.br
|
.br
|
||||||
Plugins may add additional authentication types.
|
Plugins may add additional authentication types.
|
||||||
.br
|
|
||||||
|
|
||||||
It's possible to use few authentication types in the same commands. E.g.
|
|
||||||
.br
|
.br
|
||||||
auth iponly strong
|
It\'s possible to use few authentication types in the same commands. E.g.
|
||||||
.br
|
.br
|
||||||
In this case 'strong' authentication will be used only in case resource
|
auth iponly strong
|
||||||
access can not be performed with 'iponly' authentication, that is username is
|
.br
|
||||||
required in ACL. It's usefull to protect access to some resources with
|
In this case \'strong\' authentication will be used only in case resource
|
||||||
|
access can not be performed with \'iponly\' authentication, that is username is
|
||||||
|
required in ACL. It\'s usefull to protect access to some resources with
|
||||||
password allowing passwordless access to another resources, or to use
|
password allowing passwordless access to another resources, or to use
|
||||||
IP-based authentication for dedicated laptops and request username/password for
|
IP-based authentication for dedicated laptops and request username/password for
|
||||||
shared ones.
|
shared ones.
|
||||||
@ -509,17 +508,17 @@ shared ones.
|
|||||||
Cache authentication information to given amount of time (cachetime) in seconds.
|
Cache authentication information to given amount of time (cachetime) in seconds.
|
||||||
Cahtype is one of:
|
Cahtype is one of:
|
||||||
.br
|
.br
|
||||||
ip - after successful authentication all connections during caching time
|
ip - after successful authentication all connections during caching time
|
||||||
from same IP are assigned to the same user, username is not requested.
|
from same IP are assigned to the same user, username is not requested.
|
||||||
.br
|
.br
|
||||||
ip,user username is requested and all connections from the same IP are
|
ip,user username is requested and all connections from the same IP are
|
||||||
assigned to the same user without actual authentication.
|
assigned to the same user without actual authentication.
|
||||||
.br
|
.br
|
||||||
user - same as above, but IP is not checked.
|
user - same as above, but IP is not checked.
|
||||||
.br
|
.br
|
||||||
user,password - both username and password are checked against cached ones.
|
user,password - both username and password are checked against cached ones.
|
||||||
.br
|
.br
|
||||||
Use auth type 'cache' for cached authentication
|
Use auth type \'cache\' for cached authentication
|
||||||
|
|
||||||
.br
|
.br
|
||||||
.B allow
|
.B allow
|
||||||
@ -533,13 +532,13 @@ Use auth type 'cache' for cached authentication
|
|||||||
Access control entries. All lists are comma-separated, no spaces are
|
Access control entries. All lists are comma-separated, no spaces are
|
||||||
allowed. Usernames are case sensitive (if used with authtype nbname
|
allowed. Usernames are case sensitive (if used with authtype nbname
|
||||||
username must be in uppercase). Source and target lists may contain
|
username must be in uppercase). Source and target lists may contain
|
||||||
IP addresses (W.X.Y.Z), ranges A.B.C.D - W.X.Y.Z (since 0.8) or CIDRs
|
IP addresses (W.X.Y.Z), ranges A.B.C.D - W.X.Y.Z (since 0.8) or CIDRs (W.X.Y.Z/L).
|
||||||
(W.X.Y.Z/L). Since 0.6, targetlist may also contain host names,
|
Since 0.6, targetlist may also contain host names,
|
||||||
instead of addresses. It's possible to use wildmask in
|
instead of addresses. It\'s possible to use wildmask in
|
||||||
the begginning and in the the end of hostname, e.g. *badsite.com or
|
the begginning and in the the end of hostname, e.g. *badsite.com or *badcontent*.
|
||||||
*badcontent*. Hostname is only checked if hostname presents in request.
|
Hostname is only checked if hostname presents in request.
|
||||||
Targetportlist may contain ports (X) or port ranges lists (X-Y). For any field
|
Targetportlist may contain ports (X) or port ranges lists (X-Y). For any field *
|
||||||
* sign means "ANY" If access list is empty it's assumed to be
|
sign means ANY. If access list is empty it\'s assumed to be
|
||||||
.br
|
.br
|
||||||
allow *
|
allow *
|
||||||
.br
|
.br
|
||||||
@ -547,61 +546,64 @@ Targetportlist may contain ports (X) or port ranges lists (X-Y). For any field
|
|||||||
.br
|
.br
|
||||||
deny *
|
deny *
|
||||||
.br
|
.br
|
||||||
You may want explicitly add "deny *" to the end of access list to prevent
|
You may want explicitly add deny * to the end of access list to prevent
|
||||||
HTTP proxy from requesting user's password.
|
HTTP proxy from requesting user\'s password.
|
||||||
Access lists are checked after user have requested any resource.
|
Access lists are checked after user have requested any resource.
|
||||||
If you want 3proxy to reject connections from specific addresses
|
If you want 3proxy to reject connections from specific addresses
|
||||||
immediately without any conditions you should either bind proxy
|
immediately without any conditions you should either bind proxy
|
||||||
to appropriate interface only or to use ip filters.
|
to appropriate interface only or to use ip filters.
|
||||||
.br
|
|
||||||
|
|
||||||
Operation is one of:
|
|
||||||
.br
|
.br
|
||||||
CONNECT - establish outgoing TCP connection
|
Operation is one of:
|
||||||
.br
|
.br
|
||||||
BIND - bind TCP port for listening
|
CONNECT establish outgoing TCP connection
|
||||||
.br
|
.br
|
||||||
UDPASSOC - make UDP association
|
BIND bind TCP port for listening
|
||||||
.br
|
.br
|
||||||
ICMPASSOC - make ICMP association (for future use)
|
UDPASSOC make UDP association
|
||||||
.br
|
.br
|
||||||
HTTP_GET - HTTP GET request
|
ICMPASSOC make ICMP association (for future use)
|
||||||
.br
|
.br
|
||||||
HTTP_PUT - HTTP PUT request
|
HTTP_GET HTTP GET request
|
||||||
.br
|
.br
|
||||||
HTTP_POST - HTTP POST request
|
HTTP_PUT HTTP PUT request
|
||||||
.br
|
.br
|
||||||
HTTP_HEAD - HTTP HEAD request
|
HTTP_POST HTTP POST request
|
||||||
.br
|
.br
|
||||||
HTTP_CONNECT - HTTP CONNECT request
|
HTTP_HEAD HTTP HEAD request
|
||||||
.br
|
.br
|
||||||
HTTP_OTHER - over HTTP request
|
HTTP_CONNECT HTTP CONNECT request
|
||||||
.br
|
.br
|
||||||
HTTP - matches any HTTP request except HTTP_CONNECT
|
HTTP_OTHER over HTTP request
|
||||||
.br
|
.br
|
||||||
HTTPS - same as HTTP_CONNECT
|
HTTP matches any HTTP request except HTTP_CONNECT
|
||||||
.br
|
.br
|
||||||
FTP_GET - FTP get request
|
HTTPS same as HTTP_CONNECT
|
||||||
.br
|
.br
|
||||||
FTP_PUT - FTP put request
|
FTP_GET FTP get request
|
||||||
.br
|
.br
|
||||||
FTP_LIST - FTP list request
|
FTP_PUT FTP put request
|
||||||
.br
|
.br
|
||||||
FTP_DATA - FTP data connection. Note: FTP_DATA requires access to dynamic
|
FTP_LIST FTP list request
|
||||||
|
.br
|
||||||
|
FTP_DATA FTP data connection. Note: FTP_DATA requires access to dynamic
|
||||||
non-ptivileged (1024-65535) ports on remote side.
|
non-ptivileged (1024-65535) ports on remote side.
|
||||||
.br
|
.br
|
||||||
FTP - matches any FTP/FTP Data request
|
FTP matches any FTP/FTP Data request
|
||||||
.br
|
.br
|
||||||
ADMIN - access to administration interface
|
ADMIN access to administration interface
|
||||||
|
|
||||||
.br
|
.br
|
||||||
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
|
Weeksdays are week days numbers or periods, 0 or 7 means Sunday, 1 is Monday, 1-5 means Monday through Friday.
|
||||||
|
.br
|
||||||
|
Timeperiodlists is a list of time
|
||||||
periods in HH:MM:SS-HH:MM:SS format. For example, 00:00:00-08:00:00,17:00:00-24:00:00 lists non-working hours.
|
periods in HH:MM:SS-HH:MM:SS format. For example, 00:00:00-08:00:00,17:00:00-24:00:00 lists non-working hours.
|
||||||
|
|
||||||
.br
|
.br
|
||||||
.B parent
|
.B parent
|
||||||
<weight> <type> <ip> <port> <username> <password>
|
<weight> <type> <ip> <port> <username> <password>
|
||||||
.br
|
.br
|
||||||
this command must follow "allow" rule. It extends last allow rule to
|
this command must follow \"allow\" rule. It extends last allow rule to
|
||||||
build proxy chain. Proxies may be grouped. Proxy inside the
|
build proxy chain. Proxies may be grouped. Proxy inside the
|
||||||
group is selected randomly. If few groups are specified one proxy
|
group is selected randomly. If few groups are specified one proxy
|
||||||
is randomly picked from each group and chain of proxies is created
|
is randomly picked from each group and chain of proxies is created
|
||||||
@ -636,46 +638,46 @@ with probability of 0.7) for outgoing web connections.
|
|||||||
.br
|
.br
|
||||||
type is one of:
|
type is one of:
|
||||||
.br
|
.br
|
||||||
tcp - simply redirect connection. TCP is always last in chain.
|
tcp simply redirect connection. TCP is always last in chain.
|
||||||
.br
|
.br
|
||||||
http - redirect to HTTP proxy. HTTP is always last chain.
|
http redirect to HTTP proxy. HTTP is always last chain.
|
||||||
.br
|
.br
|
||||||
pop3 - redirect to POP3 proxy (only local redirection is supported, can not be
|
pop3 redirect to POP3 proxy (only local redirection is supported, can not be
|
||||||
used for chaining)
|
used for chaining)
|
||||||
.br
|
.br
|
||||||
ftp - redirect to FTP proxy (only local redirection is supported, can not be
|
ftp redirect to FTP proxy (only local redirection is supported, can not be
|
||||||
used for chaining)
|
used for chaining)
|
||||||
.br
|
.br
|
||||||
connect - parent is HTTP CONNECT method proxy
|
connect parent is HTTP CONNECT method proxy
|
||||||
.br
|
.br
|
||||||
connect+ - parent is HTTP CONNECT proxy with name resolution
|
connect+ parent is HTTP CONNECT proxy with name resolution
|
||||||
.br
|
.br
|
||||||
socks4 - parent is SOCKSv4 proxy
|
socks4 parent is SOCKSv4 proxy
|
||||||
.br
|
.br
|
||||||
socks4+ - parent is SOCKSv4 proxy with name resolution (SOCKSv4a)
|
socks4+ parent is SOCKSv4 proxy with name resolution (SOCKSv4a)
|
||||||
.br
|
.br
|
||||||
socks5 - parent is SOCKSv5 proxy
|
socks5 parent is SOCKSv5 proxy
|
||||||
.br
|
.br
|
||||||
socks5+ - parent is SOCKSv5 proxy with name resolution
|
socks5+ parent is SOCKSv5 proxy with name resolution
|
||||||
.br
|
.br
|
||||||
socks4b - parent is SOCKS4b (broken SOCKSv4 implementation with shortened
|
socks4b parent is SOCKS4b (broken SOCKSv4 implementation with shortened
|
||||||
server reply. I never saw this kind ofservers byt they say there are).
|
server reply. I never saw this kind ofservers byt they say there are).
|
||||||
Normally you should not use this option. Do not mess this option with
|
Normally you should not use this option. Do not mess this option with
|
||||||
SOCKSv4a (socks4+).
|
SOCKSv4a (socks4+).
|
||||||
.br
|
.br
|
||||||
socks5b - parent is SOCKS5b (broken SOCKSv5 implementation with shortened
|
socks5b parent is SOCKS5b (broken SOCKSv5 implementation with shortened
|
||||||
server reply. I think you will never find it useful). Never use this option
|
server reply. I think you will never find it useful). Never use this option
|
||||||
unless you know exactly you need it.
|
unless you know exactly you need it.
|
||||||
.br
|
.br
|
||||||
admin - redirect request to local 'admin' service (with -s parameter).
|
admin redirect request to local \'admin\' service (with -s parameter).
|
||||||
.br
|
.br
|
||||||
Use "+" proxy only with "fakeresolve" option
|
Use \"+\" proxy only with \"fakeresolve\" option
|
||||||
.br
|
.br
|
||||||
|
|
||||||
IP and port are ip addres and port of parent proxy server.
|
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 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 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,
|
If both IP and port are zero - it\'s a special case of local redirection,
|
||||||
it works only with
|
it works only with
|
||||||
.B socks
|
.B socks
|
||||||
proxy. In case of local redirection request is redirected to different service,
|
proxy. In case of local redirection request is redirected to different service,
|
||||||
@ -690,14 +692,14 @@ locally redurects to
|
|||||||
.B proxy
|
.B proxy
|
||||||
.B admin
|
.B admin
|
||||||
locally redirects to admin -s service.
|
locally redirects to admin -s service.
|
||||||
.br
|
|
||||||
|
|
||||||
|
.br
|
||||||
Main purpose of local redirections is to have requested resource
|
Main purpose of local redirections is to have requested resource
|
||||||
(URL or POP3 username) logged and protocol-specific filters to be applied.
|
(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
|
In case of local redirection ACLs are revied twice: first, by SOCKS proxy up to \'parent\'
|
||||||
'parent' command and then with gateway service connection is
|
command and then with gateway service connection is
|
||||||
redirected (HTTP, FTP or POP3) after 'parent' command. It means,
|
redirected (HTTP, FTP or POP3) after \'parent\' command. It means,
|
||||||
additional 'allow' command is required for redirected requests, for
|
additional \'allow\' command is required for redirected requests, for
|
||||||
example:
|
example:
|
||||||
.br
|
.br
|
||||||
allow * * * 80
|
allow * * * 80
|
||||||
@ -713,11 +715,10 @@ local HTTP proxy parses requests and allows only GET and POST requests.
|
|||||||
.br
|
.br
|
||||||
parent 1000 http 1.2.3.4 0
|
parent 1000 http 1.2.3.4 0
|
||||||
.br
|
.br
|
||||||
Changes external address for given connection to 1.2.3.4
|
Changes external address for given connection to 1.2.3.4 (an equivalent to -e1.2.3.4)
|
||||||
(an equivalent to -e1.2.3.4)
|
|
||||||
.br
|
.br
|
||||||
Optional username and password are used to authenticate on parent
|
Optional username and password are used to authenticate on parent
|
||||||
proxy. Username of '*' means username must be supplied by user.
|
proxy. Username of \'*\' means username must be supplied by user.
|
||||||
|
|
||||||
|
|
||||||
.br
|
.br
|
||||||
@ -752,7 +753,7 @@ nolog
|
|||||||
If force is specified for service, configuration reload will require all current
|
If force is specified for service, configuration reload will require all current
|
||||||
sessions of this service to be re-authenticated. If ACL is changed or user account
|
sessions of this service to be re-authenticated. If ACL is changed or user account
|
||||||
is removed, old connections which do not match current are closed.
|
is removed, old connections which do not match current are closed.
|
||||||
noforce allows to keep previously authenticated connections.
|
noforce allows to keep previously authenticated connections.
|
||||||
|
|
||||||
.br
|
.br
|
||||||
.B bandlimin
|
.B bandlimin
|
||||||
@ -768,13 +769,13 @@ is removed, old connections which do not match current are closed.
|
|||||||
<userlist> <sourcelist> <targetlist> <targetportlist> <operationlist>
|
<userlist> <sourcelist> <targetlist> <targetportlist> <operationlist>
|
||||||
.br
|
.br
|
||||||
bandlim sets bandwith limitation filter to <rate> bps (bits per second)
|
bandlim sets bandwith limitation filter to <rate> bps (bits per second)
|
||||||
(if you want to specife bytes per second - multiply your value to 8).
|
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
|
bandlim rules act in a same manner as allow/deny rules except
|
||||||
one thing: bandwidth limiting is applied to all services, not to some
|
one thing: bandwidth limiting is applied to all services, not to some
|
||||||
specific service.
|
specific service.
|
||||||
bandlimin and nobandlimin applies to incoming traffic
|
bandlimin and nobandlimin applies to incoming traffic
|
||||||
bandlimout and nobandlimout applies to outgoing traffic
|
bandlimout and nobandlimout applies to outgoing traffic
|
||||||
If tou want to ratelimit your clients with ip's 192.168.10.16/30 (4
|
If tou want to ratelimit your clients with IPs 192.168.10.16/30 (4
|
||||||
addresses) to 57600 bps you have to specify 4 rules like
|
addresses) to 57600 bps you have to specify 4 rules like
|
||||||
.br
|
.br
|
||||||
bandlimin 57600 * 192.168.10.16
|
bandlimin 57600 * 192.168.10.16
|
||||||
@ -803,19 +804,19 @@ if you want, for example, to limit all speed ecept access to POP3 you can use
|
|||||||
.B noconnlim
|
.B noconnlim
|
||||||
<userlist> <sourcelist> <targetlist> <targetportlist> <operationlist>
|
<userlist> <sourcelist> <targetlist> <targetportlist> <operationlist>
|
||||||
.br
|
.br
|
||||||
connlim sets connections rate limit per time period for traffic
|
connlim sets connections rate limit per time period for traffic
|
||||||
pattern controlled by ACL. Period is in seconds. If period is 0,
|
pattern controlled by ACL. Period is in seconds. If period is 0,
|
||||||
connlim limits a number of parallel connections.
|
connlim limits a number of parallel connections.
|
||||||
.br
|
.br
|
||||||
connlim 100 60 * 127.0.0.1
|
connlim 100 60 * 127.0.0.1
|
||||||
.br
|
.br
|
||||||
allows 100 connections per minute for 127.0.0.1.
|
allows 100 connections per minute for 127.0.0.1.
|
||||||
.br
|
.br
|
||||||
connlim 20 0 * 127.0.0.1
|
connlim 20 0 * 127.0.0.1
|
||||||
.br
|
.br
|
||||||
allows 20 simulationeous connections for 127.0.0.1.
|
allows 20 simulationeous connections for 127.0.0.1.
|
||||||
.br
|
.br
|
||||||
Like with bandlimin, if individual limit is required per client, separate
|
Like with bandlimin, if individual limit is required per client, separate
|
||||||
rule mustbe added for every client. Like with nobanlimin, noconnlim adds an
|
rule mustbe added for every client. Like with nobanlimin, noconnlim adds an
|
||||||
exception.
|
exception.
|
||||||
|
|
||||||
@ -871,17 +872,17 @@ username[:pwtype:password] ...
|
|||||||
.br
|
.br
|
||||||
pwtype is one of:
|
pwtype is one of:
|
||||||
.br
|
.br
|
||||||
none (empty) - use system authentication
|
none (empty) - use system authentication
|
||||||
.br
|
.br
|
||||||
CL - password is cleartext
|
CL - password is cleartext
|
||||||
.br
|
.br
|
||||||
CR - password is crypt-style password
|
CR - password is crypt-style password
|
||||||
.br
|
.br
|
||||||
NT - password is NT password (in hex)
|
NT - password is NT password (in hex)
|
||||||
.br
|
.br
|
||||||
example:
|
example:
|
||||||
.br
|
.br
|
||||||
users test1:CL:password1 "test2:CR:$1$lFDGlder$pLRb4cU2D7GAT58YQvY49."
|
users test1:CL:password1 \"test2:CR:$1$lFDGlder$pLRb4cU2D7GAT58YQvY49.\"
|
||||||
.br
|
.br
|
||||||
users test3:NT:BD7DFBF29A93F93C63CB84790DA00E63
|
users test3:NT:BD7DFBF29A93F93C63CB84790DA00E63
|
||||||
.br
|
.br
|
||||||
@ -953,14 +954,15 @@ for all threads.
|
|||||||
<value_to_add_to_default_stack_size>
|
<value_to_add_to_default_stack_size>
|
||||||
.br
|
.br
|
||||||
Change default size for threads stack. May be required in some situation,
|
Change default size for threads stack. May be required in some situation,
|
||||||
e.g. with non-default plugins, on on some platforms (some FreeBSD version
|
e.g. with non-default plugins, on on some platforms (some FreeBSD version
|
||||||
may require adjusting stack size due to invalid defined value in system
|
may require adjusting stack size due to invalid defined value in system
|
||||||
header files, this value is also oftent reqruied to be changed for ODBC and
|
header files, this value is also oftent reqruied to be changed for ODBC and
|
||||||
PAM support on Linux. If you experience 3proxy
|
PAM support on Linux. If you experience 3proxy
|
||||||
crash on request processing, try to set some positive value. You may start with
|
crash on request processing, try to set some positive value. You may start with
|
||||||
stacksize 65536
|
stacksize 65536
|
||||||
and then find the minimal value for service to work. If you experience
|
and then find the minimal value for service to work. If you experience
|
||||||
memory shortage, you can try to experiment with negative values.
|
memory shortage, you can try to experiment with negative values.
|
||||||
|
|
||||||
.SH PLUGINS
|
.SH PLUGINS
|
||||||
|
|
||||||
.br
|
.br
|
||||||
@ -988,7 +990,7 @@ Report all bugs to
|
|||||||
.SH SEE ALSO
|
.SH SEE ALSO
|
||||||
3proxy(8), proxy(8), ftppr(8), socks(8), pop3p(8), tcppm(8), udppm(8), syslogd(8),
|
3proxy(8), proxy(8), ftppr(8), socks(8), pop3p(8), tcppm(8), udppm(8), syslogd(8),
|
||||||
.br
|
.br
|
||||||
https://3proxy.org/
|
https://3proxy.org/
|
||||||
.SH TRIVIA
|
.SH TRIVIA
|
||||||
3APA3A is pronounced as \`\`zaraza\'\'.
|
3APA3A is pronounced as \`\`zaraza\'\'.
|
||||||
.SH AUTHORS
|
.SH AUTHORS
|
||||||
|
Loading…
Reference in New Issue
Block a user