3proxy.cfg.3 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964
  1. .TH 3proxy.cfg "3" "January 2016" "3proxy 0.8" "Universal proxy server"
  2. .SH NAME
  3. .B 3proxy.cfg
  4. \- 3proxy configuration file
  5. .SH DESCRIPTION
  6. Common structure:
  7. .br
  8. Configuration file is a text file 3proxy reads configuration from. Each line
  9. of the file is a command executed immediately, as it was given from
  10. console. Sequence of commands is important. Configuration file as actually a
  11. script for 3proxy executable.
  12. Each line of the file is treated as a blank (space or tab) separated
  13. command line. Additional space characters are ignored.
  14. Think about 3proxy as "application level router" with console interface.
  15. .br
  16. Comments:
  17. .br
  18. Any string beginning with space character or \'#\' character is comment. It\'s
  19. ignored. <LF>s are ignored. <CR> is end of command.
  20. .br
  21. Quotation:
  22. .br
  23. Quotation character is " (double quote). Quotation must be used to quote
  24. spaces or another special characters. To use quotation character inside
  25. quotation character must be dubbed (BASIC convention). For example to use
  26. HELLO "WORLD" as an argument you should use it as "HELLO ""WORLD"""\.
  27. Good practice is to quote any argument you use.
  28. .br
  29. File inclusion:
  30. .br
  31. You can include file by using $FILENAME macro (replace FILENAME with a path
  32. to file, for example $/usr/local/etc/3proxy/conf.incl or
  33. $"c:\\Program Files\\3proxy\\include.cfg" Quotation is
  34. required in last example because path contains space character.
  35. For included file <CR> (end of line characters) is treated as space character
  36. (arguments delimiter instead of end of command delimiter).
  37. Thus, include files are only useful to store long signle-line commands
  38. (like userlist, network lists, etc).
  39. To use dollar sign somewhere in argument it must be quoted.
  40. Recursion is not allowed.
  41. .br
  42. Next commands start gateway services:
  43. .br
  44. .br
  45. .B proxy
  46. [options]
  47. .br
  48. .B socks
  49. [options]
  50. .br
  51. .B pop3p
  52. [options]
  53. .br
  54. .B ftppr
  55. [options]
  56. .br
  57. .B admin
  58. [options]
  59. .br
  60. .B dnspr
  61. [options]
  62. .br
  63. .B tcppm
  64. [options]
  65. <SRCPORT> <DSTADDR> <DSTPORT>
  66. .br
  67. .B udppm
  68. [options]
  69. <SRCPORT> <DSTADDR> <DSTPORT>
  70. .br
  71. Descriptions:
  72. .br
  73. .B proxy
  74. \- HTTP/HTTPS proxy (default port 3128)
  75. .br
  76. .B socks
  77. \- SOCKS 4/4.5/5 proxy (default port 1080)
  78. .br
  79. .B pop3p
  80. \- POP3 proxy (default port 110)
  81. .br
  82. .B ftppr
  83. \- FTP proxy (default port 21)
  84. .br
  85. .B admin
  86. \- Web interface (default port 80)
  87. .br
  88. .B dnspr
  89. \- caching DNS proxy (default port 53)
  90. .br
  91. .B tcppm
  92. \- TCP portmapper
  93. .br
  94. .B udppm
  95. \- UDP portmapper
  96. .br
  97. Options:
  98. .br
  99. .B -pNUMBER
  100. change default server port to NUMBER
  101. .br
  102. .B -n
  103. disable NTLM authentication (required if passwords are stored in Unix crypt format.
  104. .br
  105. .B -n1
  106. enable NTLMv1 authentication.
  107. .br
  108. .B -s
  109. (for admin) - secure, allow only secure operations (currently only traffic counters
  110. view without ability to reset).
  111. .br
  112. (for dnspr) - simple, do not use 'resolver' and 3proxy cache, always use external DNS server.
  113. .br
  114. (for udppm) - singlepacket, expect only one packet from both client and server
  115. .br
  116. .B -u
  117. Never ask for username/password
  118. .br
  119. .B -u2
  120. (socks) require username/password in authentication methods
  121. .br
  122. .B -a
  123. (for proxy) - anonymous proxy (no information about client reported)
  124. .br
  125. .B -a1
  126. (for proxy) - anonymous proxy (random client information reported)
  127. .br
  128. .B -a2
  129. (for proxy) - generate Via: and X-Forwared-For: instead of Forwarded:
  130. .br
  131. .B -6
  132. Only resolve IPv6 addresses. IPv4 addresses are packed in IPv6 in IPV6_V6ONLY compatible way.
  133. .br
  134. .B -4
  135. Only resolve IPv4 addresses
  136. .br
  137. .B -46
  138. Resolve IPv6 addresses if IPv4 address is not resolvable
  139. .br
  140. .B -64
  141. Resolve IPv4 addresses if IPv6 address is not resolvable
  142. .br
  143. .B -RHOST:port
  144. listen on given local HOST:port for incoming connections instead of making remote outgoing connection. Can be used with another 3proxy service running -r option for connect back functionality. Most commonly used with tcppm. HOST can be given as IP or hostname, useful in case of dynamic DNS.
  145. .br
  146. .B -rHOST:port
  147. connect to given remote HOST:port instead of listening local connection on -p or default port. Can be used with another 3proxy service running -R option for connect back functionality. Most commonly used with proxy or socks. HOST can be given as IP or hostname, useful in case of dynamic DNS.
  148. .br
  149. Also, all options mentioned for
  150. .BR proxy (8)
  151. .BR socks (8)
  152. .BR pop3p (8)
  153. .BR tcppm (8)
  154. .BR udppm (8)
  155. .BR ftppr (8)
  156. are also supported.
  157. .br
  158. Portmapping services listen at SRCPORT and connect to DSTADDR:DSTPORT
  159. HTTP and SOCKS proxies are standard.
  160. .br
  161. POP3 proxy must be configured as POP3 server and requires username in the form of:
  162. pop3username@pop3server. If POP3 proxy access must be authenticated, you can
  163. specify username as proxy_username:proxy_password:POP3_username@pop3server
  164. .br
  165. DNS proxy resolves any types of records but only hostnames are cached. It
  166. requires nserver/nscache to be configured. If nserver is configured as TCP,
  167. redirections are applied on connection, so parent proxy may be used to resolve
  168. names to IP.
  169. .br
  170. FTP proxy can be used as FTP server in any FTP client or configured as FTP
  171. proxy on a client with FTP proxy support. Username format is one of
  172. .br
  173. FTPuser@FTPServer
  174. .br
  175. FTPuser:FTPpassword@FTPserver
  176. .br
  177. proxyuser:proxypassword:FTPuser:FTPpassword@FTPserver
  178. .br
  179. 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
  180. .br
  181. .B include
  182. <path>
  183. .br
  184. Include config file
  185. .br
  186. .B config
  187. <path>
  188. .br
  189. Path to configuration file to use on 3proxy restart or to save configuration.
  190. .br
  191. .B writable
  192. .br
  193. ReOpens configuration file for write access via Web interface,
  194. and re-reads it. Usually should be first command on config file
  195. but in combination with "config" it can be used anywhere to open
  196. alternate config file. Think twice before using it.
  197. .br
  198. .B end
  199. .br
  200. End of configuration
  201. .br
  202. .B log
  203. [[@|&]logfile] [<LOGTYPE>]
  204. .br
  205. sets logfile for all gateways
  206. .br
  207. @ - (for Unix) use syslog, filename is used as ident name
  208. .br
  209. & - use ODBC, filename consists of comma-delimited datasource,username,password (username and password are optional)
  210. .br
  211. LOGTYPE is one of:
  212. .br
  213. M - Monthly
  214. .br
  215. W - Weekly (starting from Sunday)
  216. .br
  217. D - Daily
  218. .br
  219. H - Hourly
  220. .br
  221. if logfile is not specified logging goes to stdout. You can specify individual logging options for gateway by using
  222. -l option in gateway configuration.
  223. .br
  224. "log" command supports same format specifications for filename template
  225. as "logformat" (if filename contains '%' sign it's believed to be template).
  226. As with "logformat" filename must begin with 'L' or 'G' to specify Local or
  227. Grinwitch time zone for all time-based format specificators.
  228. .br
  229. .B rotate
  230. <n>
  231. how many archived log files to keep
  232. .br
  233. .B logformat
  234. <format>
  235. .br
  236. Format for log record. First symbol in format must be L (local time)
  237. or G (absolute Grinwitch time).
  238. It can be preceeded with -XXX+Y where XXX is list of characters to be
  239. filtered in user input (any non-printable characters are filtered too
  240. in this case) and Y is replacement character. For example, "-,%+ L" in
  241. the beginning of logformat means comma and percent are replaced
  242. with space and all time based elemnts are in local time zone.
  243. .br
  244. You can use:
  245. .br
  246. %y - Year in 2 digit format
  247. .br
  248. %Y - Year in 4 digit format
  249. .br
  250. %m - Month number
  251. .br
  252. %o - Month abbriviature
  253. .br
  254. %d - Day
  255. .br
  256. %H - Hour
  257. .br
  258. %M - Minute
  259. .br
  260. %S - Second
  261. .br
  262. %t - Timstamp (in seconds since 01-Jan-1970)
  263. .br
  264. %. - milliseconds
  265. .br
  266. %z - timeZone (from Grinvitch)
  267. .br
  268. %D - request duration (in milliseconds)
  269. .br
  270. %b - average send rate per request (in Bytes per second) this speed is typically below connection speed shown by download manager.
  271. .br
  272. %B - average receive rate per request (in Bytes per second) this speed is typically below connection speed shown by download manager.
  273. .br
  274. %U - Username
  275. .br
  276. %N - service Name
  277. .br
  278. %p - service Port
  279. .br
  280. %E - Error code
  281. .br
  282. %C - Client IP
  283. .br
  284. %c - Client port
  285. .br
  286. %R - Remote IP
  287. .br
  288. %r - Remote port
  289. .br
  290. %i - Internal IP used to accept client connection
  291. .br
  292. %e - External IP used to establish connection
  293. .br
  294. %Q - Requested IP
  295. .br
  296. %q - Requested port
  297. .br
  298. %n - requested hostname
  299. .br
  300. %I - bytes In
  301. .br
  302. %O - bytes Out
  303. .br
  304. %h - Hops (redirections) count
  305. .br
  306. %T - service specific Text
  307. .br
  308. %N1-N2T - (N1 and N2 are positive numbers) - log only fields from N1 thorugh N2 of service specific text
  309. .br
  310. in case of ODBC logging logformat specifies SQL statement, for exmample:
  311. .br
  312. 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')"
  313. .br
  314. .B logdump
  315. <in_traffic_limit> <out_traffic_limit>
  316. .br
  317. Immediately creates additional log records if given amount of incoming/outgoing
  318. traffic is achieved for connection, without waiting for connection to finish.
  319. It may be useful to prevent information about long-lasting downloads on server
  320. shutdown.
  321. .br
  322. .B archiver
  323. <ext> <commandline>
  324. .br
  325. Archiver to use for log files. <ext> is file extension produced by
  326. archiver. Filename will be last argument to archiver, optionally you
  327. can use %A as produced archive name and %F as filename.
  328. .br
  329. .B timeouts
  330. <BYTE_SHORT> <BYTE_LONG> <STRING_SHORT> <STRING_LONG> <CONNECTION_SHORT> <CONNECTION_LONG> <DNS> <CHAIN>
  331. .br
  332. Sets timeout values
  333. .br
  334. BYTE_SHORT - short timeout for single byte, is usually used for receiving single byte from stream.
  335. .br
  336. BYTE_LONG - long timeout for single byte, is usually used for receiving first byte in frame (for example first byte in socks request).
  337. .br
  338. STRING_SHORT - short timeout, for character string within stream (for example to wait between 2 HTTP headers)
  339. .br
  340. STRING_LONG - long timeout, for first string in stream (for example to wait for HTTP request).
  341. .br
  342. CONNECTION_SHORT - inactivity timeout for short connections (HTTP, POP3, etc).
  343. .br
  344. CONNECTION_LONG - inactivity timeout for long connection (SOCKS, portmappers, etc).
  345. .br
  346. DNS - timeout for DNS request before requesting next server
  347. .br
  348. CHAIN - timeout for reading data from chained connection
  349. .br
  350. .br
  351. .B nserver
  352. <ipaddr>[:port][/tcp]
  353. .br
  354. Nameserver to use for name resolutions. If none specified
  355. or name server fails system routines for name resolution will be
  356. used. It's better to specify nserver because gethostbyname() may
  357. be thread unsafe. Optional port number may be specified.
  358. If optional /tcp is added to IP address, name resolution will be
  359. performed over TCP.
  360. .br
  361. .B nscache
  362. <cachesize>
  363. .B nscache6
  364. <cachesize>
  365. .br
  366. Cache <cachesize> records for name resolution (nscache for IPv4,
  367. nscache6 for IPv6). Cachesize usually should be large enougth
  368. (for example 65536).
  369. .br
  370. .B nsrecord
  371. <hostname> <hostaddr>
  372. .br
  373. Adds static record to nscache. nscache must be enabled. If 0.0.0.0
  374. is used as a hostaddr host will never resolve, it can be used to
  375. blacklist something or together with
  376. .B dialer
  377. command to set up UDL for dialing.
  378. .br
  379. .B fakeresolve
  380. .br
  381. All names are resolved to 127.0.0.2 address. Usefull if all requests are
  382. redirected to parent proxy with http, socks4+, connect+ or socks5+.
  383. .br
  384. .B dialer
  385. <progname>
  386. .br
  387. Execute progname if external name can't be resolved.
  388. Hint: if you use nscache, dialer may not work, because names will
  389. be resolved through cache. In this case you can use something like
  390. http://dial.right.now/ from browser to set up connection.
  391. .br
  392. .B internal
  393. <ipaddr>
  394. .br
  395. sets ip address of internal interface. This IP address will be used
  396. to bind gateways. Alternatively you can use -i option for individual
  397. gateways. Since 0.8 version, IPv6 address may be used.
  398. .br
  399. .B external
  400. <ipaddr>
  401. .br
  402. sets ip address of external interface. This IP address will be source
  403. address for all connections made by proxy. Alternatively you can use
  404. -e option to specify individual address for gateway. Since 0.8 version
  405. External or -e can be given twice: once with IPv4 and once with IPv6 address.
  406. .br
  407. .B maxconn
  408. <number>
  409. .br
  410. sets maximum number of simulationeous connections to each services
  411. started after this command. Default is 100.
  412. .br
  413. .B service
  414. .br
  415. (depricated). Indicates 3proxy to behave as Windows 95/98/NT/2000/XP
  416. service, no effect for Unix. Not required for 3proxy 0.6 and above. If
  417. you upgraded from previous version of 3proxy use --remove and --install
  418. to reinstall service.
  419. .br
  420. .B daemon
  421. .br
  422. Should be specified to close console. Do not use 'daemon' with 'service'.
  423. At least under FreeBSD 'daemon' should preceed any proxy service
  424. and log commands to avoid sockets problem. Always place it in the beginning
  425. of the configuration file.
  426. .br
  427. .B auth
  428. <authtype> [...]
  429. .br
  430. Type of user authorization. Currently supported:
  431. .br
  432. none - no authentication or authorization required.
  433. .br
  434. Note: is auth is none any ip based limitation, redirection, etc will not work.
  435. This is default authentication type
  436. .br
  437. iponly - authentication by access control list with username ignored.
  438. Appropriate for most cases
  439. .br
  440. useronly - authentication by username without checking for any password with
  441. authorization by ACLs. Useful for e.g. SOCKSv4 proxy and icqpr (icqpr set UIN /
  442. AOL screen name as a username)
  443. .br
  444. dnsname - authentication by DNS hostnname with authorization by ACLs.
  445. DNS hostname is resolved via PTR (reverse) record and validated (resolved
  446. name must resolve to same IP address). It's recommended to use authcache by
  447. ip for this authentication.
  448. NB: there is no any password check, name may be spoofed.
  449. .br
  450. strong - username/password authentication required. It will work with
  451. SOCKSv5, FTP, POP3 and HTTP proxy.
  452. .br
  453. cache - cached authentication, may be used with 'authcache'.
  454. .br
  455. Plugins may add additional authentication types.
  456. .br
  457. It's possible to use few authentication types in the same commands. E.g.
  458. .br
  459. auth iponly strong
  460. .br
  461. In this case 'strong' authentication will be used only in case resource
  462. access can not be performed with 'iponly' authentication, that is username is
  463. required in ACL. It's usefull to protect access to some resources with
  464. password allowing passwordless access to another resources, or to use
  465. IP-based authentication for dedicated laptops and request username/password for
  466. shared ones.
  467. .br
  468. .B authcache
  469. <cachtype> <cachtime>
  470. .br
  471. Cache authentication information to given amount of time (cachetime) in seconds.
  472. Cahtype is one of:
  473. .br
  474. ip - after successful authentication all connections during caching time
  475. from same IP are assigned to the same user, username is not requested.
  476. .br
  477. ip,user username is requested and all connections from the same IP are
  478. assigned to the same user without actual authentication.
  479. .br
  480. user - same as above, but IP is not checked.
  481. .br
  482. user,password - both username and password are checked against cached ones.
  483. .br
  484. Use auth type 'cache' for cached authentication
  485. .br
  486. .B allow
  487. <userlist> <sourcelist> <targetlist> <targetportlist> <operationlist>
  488. <weekdayslist> <timeperiodslist>
  489. .br
  490. .B deny
  491. <userlist> <sourcelist> <targetlist> <targetportlist> <operationlist>
  492. <weekdayslist> <timeperiodslist>
  493. .br
  494. Access control entries. All lists are comma-separated, no spaces are
  495. allowed. Usernames are case sensitive (if used with authtype nbname
  496. username must be in uppercase). Source and target lists may contain
  497. IP addresses (W.X.Y.Z), ranges A.B.C.D - W.X.Y.Z (since 0.8) or CIDRs
  498. (W.X.Y.Z/L). Since 0.6, targetlist may also contain host names,
  499. instead of addresses. It's possible to use wildmask in
  500. the begginning and in the the end of hostname, e.g. *badsite.com or
  501. *badcontent*. Hostname is only checked if hostname presents in request.
  502. Targetportlist may contain ports (X) or port ranges lists (X-Y). For any field
  503. * sign means "ANY" If access list is empty it's assumed to be
  504. .br
  505. allow *
  506. .br
  507. If access list is not empty last item in access list is assumed to be
  508. .br
  509. deny *
  510. .br
  511. You may want explicitly add "deny *" to the end of access list to prevent
  512. HTTP proxy from requesting user's password.
  513. Access lists are checked after user have requested any resource.
  514. If you want 3proxy to reject connections from specific addresses
  515. immediately without any conditions you should either bind proxy
  516. to appropriate interface only or to use ip filters.
  517. .br
  518. Operation is one of:
  519. .br
  520. CONNECT - establish outgoing TCP connection
  521. .br
  522. BIND - bind TCP port for listening
  523. .br
  524. UDPASSOC - make UDP association
  525. .br
  526. ICMPASSOC - make ICMP association (for future use)
  527. .br
  528. HTTP_GET - HTTP GET request
  529. .br
  530. HTTP_PUT - HTTP PUT request
  531. .br
  532. HTTP_POST - HTTP POST request
  533. .br
  534. HTTP_HEAD - HTTP HEAD request
  535. .br
  536. HTTP_CONNECT - HTTP CONNECT request
  537. .br
  538. HTTP_OTHER - over HTTP request
  539. .br
  540. HTTP - matches any HTTP request except HTTP_CONNECT
  541. .br
  542. HTTPS - same as HTTP_CONNECT
  543. .br
  544. FTP_GET - FTP get request
  545. .br
  546. FTP_PUT - FTP put request
  547. .br
  548. FTP_LIST - FTP list request
  549. .br
  550. FTP_DATA - FTP data connection. Note: FTP_DATA requires access to dynamic
  551. non-ptivileged (1024-65535) ports on remote side.
  552. .br
  553. FTP - matches any FTP/FTP Data request
  554. .br
  555. ADMIN - access to administration interface
  556. .br
  557. 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
  558. 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.
  559. .br
  560. .B parent
  561. <weight> <type> <ip> <port> <username> <password>
  562. .br
  563. this command must follow "allow" rule. It extends last allow rule to
  564. build proxy chain. Proxies may be grouped. Proxy inside the
  565. group is selected randomly. If few groups are specified one proxy
  566. is randomly picked from each group and chain of proxies is created
  567. (that is second proxy connected through first one and so on).
  568. Weight is used to group proxies. Weigt is a number between 1 and 1000.
  569. Weights are summed and proxies are grouped together untill weight of
  570. group is 1000. That is:
  571. .br
  572. allow *
  573. .br
  574. parent 500 socks5 192.168.10.1 1080
  575. .br
  576. parent 500 connect 192.168.10.1 3128
  577. .br
  578. makes 3proxy to randomly choose between 2 proxies for all outgoing
  579. connections. These 2 proxies form 1 group (summarized weight is 1000).
  580. .br
  581. allow * * * 80
  582. .br
  583. parent 1000 socks5 192.168.10.1 1080
  584. .br
  585. parent 1000 connect 192.168.20.1 3128
  586. .br
  587. parent 300 socks4 192.168.30.1 1080
  588. .br
  589. parent 700 socks5 192.168.40.1 1080
  590. .br
  591. creates chain of 3 proxies: 192.168.10.1, 192.168.20.1 and third
  592. is (192.168.30.1 with probability of 0.3 or 192.168.40.1
  593. with probability of 0.7) for outgoing web connections.
  594. .br
  595. type is one of:
  596. .br
  597. tcp - simply redirect connection. TCP is always last in chain.
  598. .br
  599. http - redirect to HTTP proxy. HTTP is always last chain.
  600. .br
  601. pop3 - redirect to POP3 proxy (only local redirection is supported, can not be
  602. used for chaining)
  603. .br
  604. ftp - redirect to FTP proxy (only local redirection is supported, can not be
  605. used for chaining)
  606. .br
  607. connect - parent is HTTP CONNECT method proxy
  608. .br
  609. connect+ - parent is HTTP CONNECT proxy with name resolution
  610. .br
  611. socks4 - parent is SOCKSv4 proxy
  612. .br
  613. socks4+ - parent is SOCKSv4 proxy with name resolution (SOCKSv4a)
  614. .br
  615. socks5 - parent is SOCKSv5 proxy
  616. .br
  617. socks5+ - parent is SOCKSv5 proxy with name resolution
  618. .br
  619. socks4b - parent is SOCKS4b (broken SOCKSv4 implementation with shortened
  620. server reply. I never saw this kind ofservers byt they say there are).
  621. Normally you should not use this option. Do not mess this option with
  622. SOCKSv4a (socks4+).
  623. .br
  624. socks5b - parent is SOCKS5b (broken SOCKSv5 implementation with shortened
  625. server reply. I think you will never find it useful). Never use this option
  626. unless you know exactly you need it.
  627. .br
  628. admin - redirect request to local 'admin' service (with -s parameter).
  629. .br
  630. Use "+" proxy only with "fakeresolve" option
  631. .br
  632. IP and port are ip addres and port of parent proxy server.
  633. If IP is zero, ip is taken from original request, only port is changed.
  634. If port is zero, it's taken from original request, only IP is changed.
  635. If both IP and port are zero - it's a special case of local redirection,
  636. it works only with
  637. .B socks
  638. proxy. In case of local redirection request is redirected to different service,
  639. .B ftp
  640. locally redirects to
  641. .B ftppr
  642. .B pop3
  643. locally redirects to
  644. .B pop3p
  645. .B http
  646. locally redurects to
  647. .B proxy
  648. .B admin
  649. locally redirects to admin -s service.
  650. .br
  651. Main purpose of local redirections is to have requested resource
  652. (URL or POP3 username) logged and protocol-specific filters to be applied.
  653. In case of local redirection ACLs are revied twice: first, by SOCKS proxy up to
  654. 'parent' command and then with gateway service connection is
  655. redirected (HTTP, FTP or POP3) after 'parent' command. It means,
  656. additional 'allow' command is required for redirected requests, for
  657. example:
  658. .br
  659. allow * * * 80
  660. .br
  661. parent 1000 http 0.0.0.0 0
  662. .br
  663. allow * * * 80 HTTP_GET,HTTP_POST
  664. .br
  665. socks
  666. .br
  667. redirects all SOCKS requests with target port 80 to local HTTP proxy,
  668. local HTTP proxy parses requests and allows only GET and POST requests.
  669. .br
  670. parent 1000 http 1.2.3.4 0
  671. .br
  672. Changes external address for given connection to 1.2.3.4
  673. (an equivalent to -e1.2.3.4)
  674. .br
  675. Optional username and password are used to authenticate on parent
  676. proxy. Username of '*' means username must be supplied by user.
  677. .br
  678. .B nolog
  679. <n>
  680. .br
  681. extends last allow or deny command to prevent logging, e.g.
  682. .br
  683. allow * * 192.168.1.1
  684. .br
  685. nolog
  686. .br
  687. .B weight
  688. <n>
  689. .br
  690. extends last allow or deny command to set weight for this request
  691. .br
  692. allow * * 192.168.1.1
  693. .br
  694. weight 100
  695. .br
  696. Weight may be used for different purposes.
  697. .br
  698. .B force
  699. .br
  700. .B noforce
  701. .br
  702. If force is specified for service, configuration reload will require all current
  703. sessions of this service to be re-authenticated. If ACL is changed or user account
  704. is removed, old connections which do not match current are closed.
  705. noforce allows to keep previously authenticated connections.
  706. .br
  707. .B bandlimin
  708. <rate> <userlist> <sourcelist> <targetlist> <targetportlist> <operationlist>
  709. .br
  710. .B nobandlimin
  711. <userlist> <sourcelist> <targetlist> <targetportlist> <operationlist>
  712. .br
  713. .B bandlimout
  714. <rate> <userlist> <sourcelist> <targetlist> <targetportlist> <operationlist>
  715. .br
  716. .B nobandlimout
  717. <userlist> <sourcelist> <targetlist> <targetportlist> <operationlist>
  718. .br
  719. bandlim sets bandwith limitation filter to <rate> bps (bits per second)
  720. (if you want to specife bytes per second - multiply your value to 8).
  721. bandlim rules act in a same manner as allow/deny rules except
  722. one thing: bandwidth limiting is applied to all services, not to some
  723. specific service.
  724. bandlimin and nobandlimin applies to incoming traffic
  725. bandlimout and nobandlimout applies to outgoing traffic
  726. If tou want to ratelimit your clients with ip's 192.168.10.16/30 (4
  727. addresses) to 57600 bps you have to specify 4 rules like
  728. .br
  729. bandlimin 57600 * 192.168.10.16
  730. .br
  731. bandlimin 57600 * 192.168.10.17
  732. .br
  733. bandlimin 57600 * 192.168.10.18
  734. .br
  735. bandlimin 57600 * 192.168.10.19
  736. .br
  737. and every of you clients will have 56K channel. If you specify
  738. .br
  739. bandlimin 57600 * 192.168.10.16/30
  740. .br
  741. you will have 56K channel shared between all clients.
  742. if you want, for example, to limit all speed ecept access to POP3 you can use
  743. .br
  744. nobandlimin * * * 110
  745. .br
  746. before the rest of bandlim rules.
  747. .br
  748. .B counter
  749. <filename> <reporttype> <repotname>
  750. .br
  751. .B countin
  752. <number> <type> <limit> <userlist> <sourcelist> <targetlist> <targetportlist> <operationlist>
  753. .br
  754. .B nocountin
  755. <userlist> <sourcelist> <targetlist> <targetportlist> <operationlist>
  756. .br
  757. .B countout
  758. <number> <type> <limit> <userlist> <sourcelist> <targetlist> <targetportlist> <operationlist>
  759. .br
  760. .B nocountout
  761. <userlist> <sourcelist> <targetlist> <targetportlist> <operationlist>
  762. .br
  763. counter, countin, nocountin, countout, noucountout commands are
  764. used to set traffic limit
  765. in MB for period of time (day, week or month). Filename is a path
  766. to a special file where traffic information is permanently stored.
  767. number is sequential number of record in this file. If number is 0
  768. no traffic information on this counter is saved in file (that is
  769. if proxy restarted all information is loosed) overwise it should be
  770. unique sequential number.
  771. Type specifies a type of counter. Type is one of:
  772. .br
  773. H - counter is resetted hourly
  774. .br
  775. D - counter is resetted daily
  776. .br
  777. W - counter is resetted weekly
  778. .br
  779. M - counter is resetted monthely
  780. .br
  781. reporttype/repotname may be used to generate traffic reports.
  782. Reporttype is one of D,W,M,H(hourly) and repotname specifies filename
  783. template for reports. Report is text file with counter values in
  784. format:
  785. .br
  786. <COUNTERNUMBER> <TRAF>
  787. .br
  788. The rest of parameters is identical to bandlim/nobandlim.
  789. .br
  790. .B users
  791. username[:pwtype:password] ...
  792. .br
  793. pwtype is one of:
  794. .br
  795. none (empty) - use system authentication
  796. .br
  797. CL - password is cleartext
  798. .br
  799. CR - password is crypt-style password
  800. .br
  801. NT - password is NT password (in hex)
  802. .br
  803. example:
  804. .br
  805. users test1:CL:password1 "test2:CR:$1$lFDGlder$pLRb4cU2D7GAT58YQvY49."
  806. .br
  807. users test3:NT:BD7DFBF29A93F93C63CB84790DA00E63
  808. .br
  809. Note: double quotes are requiered because password contains $ sign.
  810. .br
  811. .B flush
  812. .br
  813. empty active access list. Access list must be flushed avery time you creating
  814. new access list for new service. For example:
  815. .br
  816. allow *
  817. .br
  818. pop3p
  819. .br
  820. flush
  821. .br
  822. allow * 192.168.1.0/24
  823. .br
  824. socks
  825. .br
  826. sets different ACLs for
  827. .B pop3p
  828. and
  829. .B socks
  830. .br
  831. .B system
  832. <command>
  833. .br
  834. execute system command
  835. .br
  836. .B pidfile
  837. <filename>
  838. .br
  839. write pid of current process to file. It can be used to manipulate
  840. 3proxy with signals under Unix. Currently next signals are available:
  841. .br
  842. .B monitor
  843. <filename>
  844. .br
  845. If file monitored changes in modification time or size, 3proxy reloads
  846. configuration within one minute. Any number of files may be monitored.
  847. .br
  848. .B setuid
  849. <uid>
  850. .br
  851. calls setuid(uid), uid must be numeric. Unix only. Warning: under some Linux
  852. kernels setuid() works onle for current thread. It makes it impossible to suid
  853. for all threads.
  854. .br
  855. .B setgid
  856. <gid>
  857. .br
  858. calls setgid(gid), gid must be numeric. Unix only.
  859. .br
  860. .B chroot
  861. <path>
  862. .br
  863. calls chroot(path). Unix only.
  864. .br
  865. .B stacksize
  866. <value_to_add_to_default_stack_size>
  867. .br
  868. Change default size for threads stack. May be required in some situation,
  869. e.g. with non-default plugins, on on some platforms (some FreeBSD version
  870. may require adjusting stack size due to invalid defined value in system
  871. header files, this value is also oftent reqruied to be changed for ODBC and
  872. PAM support on Linux. If you experience 3proxy
  873. crash on request processing, try to set some positive value. You may start with
  874. stacksize 65536
  875. and then find the minimal value for service to work. If you experience
  876. memory shortage, you can try to experiment with negative values.
  877. .SH PLUGINS
  878. .br
  879. .B plugin
  880. <path_to_shared_library> <function_to_call> [<arg1> ...]
  881. .br
  882. Loads specified library and calls given export function with given arguments,
  883. as
  884. .br
  885. int functions_to_call(struct pluginlink * pl, int argc, char * argv[]);
  886. .br
  887. function_to_call must return 0 in case of success, value > 0 to indicate error.
  888. .br
  889. .B filtermaxsize
  890. <max_size_of_data_to_filter>
  891. .br
  892. If Content-length (or another data length) is greater than given value, no
  893. data filtering will be performed thorugh filtering plugins to avoid data
  894. corruption and/or Content-Length chaging. Default is 1MB (1048576).
  895. .SH BUGS
  896. Report all bugs to
  897. .BR 3proxy@3proxy.ru
  898. .SH SEE ALSO
  899. 3proxy(8), proxy(8), ftppr(8), socks(8), pop3p(8), tcppm(8), udppm(8), syslogd(8),
  900. .br
  901. http://3proxy.ru/
  902. .SH TRIVIA
  903. 3APA3A is pronounced as \`\`zaraza\'\'.
  904. .SH AUTHORS
  905. 3proxy is designed by Vladimir 3APA3A Dubrovin
  906. .RI ( 3proxy@3proxy.ru )