3proxy.cfg.3.html 34 KB

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