3proxy.cfg.3 26 KB

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