mirror of
https://github.com/3proxy/3proxy.git
synced 2025-02-23 18:45:40 +08:00
Russian plugin documentation added
This commit is contained in:
parent
e78d9f8327
commit
27a190cd04
90
doc/html/plugins/PCREPlugin.ru.html
Normal file
90
doc/html/plugins/PCREPlugin.ru.html
Normal file
@ -0,0 +1,90 @@
|
|||||||
|
<h3>Плагин регулярных выражений совместимых с Perl (PCRE) для 3proxy</h3>
|
||||||
|
|
||||||
|
Фильтрующий плагин используется для создания правил поиска и замены
|
||||||
|
регулярных выражений в запросе, заголовков запроса и ответа и данных.
|
||||||
|
Добавляет поддержку 3х новых команд в файле конфигурации:
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
pcre TYPE FILTER_ACTION REGEXP [ACE]
|
||||||
|
pcre_rewrite TYPE FILTER_ACTION REGEXP REWRITE_EXPRESSION [ACE]
|
||||||
|
pcre_extend FILTER_ACTION [ACE]
|
||||||
|
pcre_options OPTION1 [...]
|
||||||
|
</pre>
|
||||||
|
pcre - позволяет искать совпадения
|
||||||
|
<br>pcre_rewrite - дополнительно позволяет производить замену подстрок
|
||||||
|
<br>pcre_extend - расширяет ACL последней команды pcre или pcre_rewrite путем
|
||||||
|
добавления еще одной ACE (аналогично списку правил allow/deny).
|
||||||
|
<br>pcre_options - позволяет устанавливать опции поиска, доступны следующие опции:
|
||||||
|
PCRE_CASELESS,
|
||||||
|
PCRE_MULTILINE,
|
||||||
|
PCRE_DOTALL,
|
||||||
|
PCRE_EXTENDED,
|
||||||
|
PCRE_ANCHORED,
|
||||||
|
PCRE_DOLLAR_ENDONLY,
|
||||||
|
PCRE_EXTRA,
|
||||||
|
PCRE_NOTBOL,
|
||||||
|
PCRE_NOTEOL,
|
||||||
|
PCRE_UNGREEDY,
|
||||||
|
PCRE_NOTEMPTY,
|
||||||
|
PCRE_UTF8,
|
||||||
|
PCRE_NO_AUTO_CAPTURE,
|
||||||
|
PCRE_NO_UTF8_CHECK,
|
||||||
|
PCRE_AUTO_CALLOUT,
|
||||||
|
PCRE_PARTIAL,
|
||||||
|
PCRE_DFA_SHORTEST,
|
||||||
|
PCRE_DFA_RESTART,
|
||||||
|
PCRE_FIRSTLINE,
|
||||||
|
PCRE_DUPNAMES,
|
||||||
|
PCRE_NEWLINE_CR,
|
||||||
|
PCRE_NEWLINE_LF,
|
||||||
|
PCRE_NEWLINE_CRLF,
|
||||||
|
PCRE_NEWLINE_ANY,
|
||||||
|
PCRE_NEWLINE_ANYCRLF,
|
||||||
|
PCRE_BSR_ANYCRLF,
|
||||||
|
PCRE_BSR_UNICODE
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>TYPE - тип фильтруемых данных. Может содержать одно или
|
||||||
|
несколько (список через запятую) значений:
|
||||||
|
<ul>
|
||||||
|
<li>request - содержимое запроса клиента (например строка HTTP GET-запроса).
|
||||||
|
(в настоящий момент изменение запроса не приводит к изменению адреса запрашиваемого хоста)
|
||||||
|
<li>cliheader - содержимое заголовков запроса клиента, например заголовки HTTP
|
||||||
|
<li>srvheader - содержимое заголовков ответа сервера, например заголовки HTTP
|
||||||
|
<li>clidata - данные полученные от клиента, например данные POST-запроса
|
||||||
|
<li>srvdata - данные полученные от сервера, например содержимое HTML-страницы
|
||||||
|
</ul>
|
||||||
|
<li>FILTER_ACTION - действие при совпадении. Может принимать значение
|
||||||
|
<ul>allow - разрешить данный запрос без просмотра дальнейших правил
|
||||||
|
<li>deny - запретить данный запрос без просмотра дальнейших правил
|
||||||
|
<li>dunno - продолжить анализ правил (полезно для pcre_rewrite)
|
||||||
|
</ul>
|
||||||
|
<li>REGEXP - регулярное выражение в формате PCRE (perl). Используйте * если не
|
||||||
|
требуется проерка регулярного выражения.
|
||||||
|
<li>REWRITE_EXPRESSION - строка замены. Может содержать макроподстановки
|
||||||
|
(не тестировалось) $1, $2 и т.д. аналогично perl. $0 - полная найденная
|
||||||
|
подстрока. В строке замены можно использовать сочетания \r, \n для вставки
|
||||||
|
новых строк. Строка может быть пустой ("").
|
||||||
|
<li>ACE - Список контроля доступа (имя пользователя, IP источника, IP назначения, порт и т.д.),
|
||||||
|
полностью аналогичный ACE в командах allow, deny, bandlimin и т.п. Регулярное
|
||||||
|
выражение проверяется только при совпадении ACE с запросом. ВНИМАНИЕ:
|
||||||
|
использование регулярных выражений не требует авторизации и не заменяет ее.
|
||||||
|
Авторизацию необходимо конфигурировать отдельно.
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h4>Пример:</h4>
|
||||||
|
<pre>
|
||||||
|
plugin PCREPlugin.dll pcre_plugin
|
||||||
|
pcre request deny "porn|sex" user1,user2,user3 192.168.0.0/16
|
||||||
|
pcre srvheader deny "Content-type: application"
|
||||||
|
pcre_rewrite clidata,srvdata dunno "porn|sex|pussy" "***" baduser
|
||||||
|
pcre_extend deny * 192.168.0.1/16
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<h4>Загрузить:</h4>
|
||||||
|
<ul>
|
||||||
|
<li>Плагин включен в дистрибутив 3proxy 0.6
|
||||||
|
<li>Пример конфигурации (by Dennis Garber): <A HREF="NoPornLitest.cfg.txt">NoPornLitest.cfg</A>
|
||||||
|
</ul>
|
32
doc/html/plugins/SSLPlugin.ru.html
Normal file
32
doc/html/plugins/SSLPlugin.ru.html
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
<h3>Плагин SSL/TLS для 3proxy</h3>
|
||||||
|
|
||||||
|
Плагин используется для транспарентной дешифровки SSL-трафика с подменой сертификата.
|
||||||
|
Плагин не должен использоваться в рабочем окружении, т.к. его использование дает возможность обхода проверок SSL.
|
||||||
|
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
ssl_certcache PATH_TO_CACHE
|
||||||
|
ssl_mitm
|
||||||
|
ssl_nomitm
|
||||||
|
</pre>
|
||||||
|
ssl_certcache - путь к кэшу сертификатов. Для транспорентной подмены сертификатов в кэше должно находиться 3 файла: 3proxy.pem - публичный
|
||||||
|
самоподписанный сертификат, 3proxy.key - ключ от этого сертификата, server.key - ключ с которым будут генерироваться подменные сертификаты.
|
||||||
|
Сгенерированные сертификаты будут помещаться в этот же каталог.
|
||||||
|
<br>ssl_mitm - подменять сертитфикаты для запущенных ниже сервисов
|
||||||
|
<br>ssl_nomitm - не подменять сертитфикаты для запущенных ниже сервисов
|
||||||
|
|
||||||
|
|
||||||
|
<h4>Пример:</h4>
|
||||||
|
<pre>
|
||||||
|
plugin /path/to/SslPlugin.dll ssl_plugin
|
||||||
|
ssl_certcache /path/to/cache/
|
||||||
|
ssl_mitm
|
||||||
|
proxy -p3128
|
||||||
|
ssl_nomitm
|
||||||
|
proxy -p3129
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<h4>Загрузить:</h4>
|
||||||
|
<ul>
|
||||||
|
<li>Плагин включен в дистрибутив 3proxy 0.8
|
||||||
|
</ul>
|
18
doc/html/plugins/StringsPlugin.ru.html
Normal file
18
doc/html/plugins/StringsPlugin.ru.html
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
<h3>Плагин подмены строк 3proxy</h3>
|
||||||
|
|
||||||
|
Используется, в частности, для руссификации сообщений выдаваемых 3proxy.
|
||||||
|
Для корректной работы требуется 0.6 версия 3proxy.
|
||||||
|
Все сообщения были взяты из proxy.c
|
||||||
|
и вынесенны в отдельный файл. Пример файла rus-win1251.3ps.
|
||||||
|
Всего 15 секций на момент написания плагина в файле rus-win1251.3ps каждая секция отделяется строкой "[end]"
|
||||||
|
новая строка определяется строкой "\n"
|
||||||
|
|
||||||
|
<h4>Пример:</h4>
|
||||||
|
<pre>
|
||||||
|
plugin "StringsPlugin.dll" start c:\3proxy\bin\rus-win1251.3ps
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<h4>Загрузить:</h4>
|
||||||
|
<ul>
|
||||||
|
<li>Плагин включен в дистрибутив 3proxy 0.6
|
||||||
|
</ul>
|
69
doc/html/plugins/TrafficPlugin.ru.html
Normal file
69
doc/html/plugins/TrafficPlugin.ru.html
Normal file
@ -0,0 +1,69 @@
|
|||||||
|
<h3>Плагин коррекции траффика 3proxy</h3>
|
||||||
|
Как известно, 3proxy считает траффик не сетевой, а прикладной.
|
||||||
|
Обычно прикладной траффик немного меньше (примерно на 10%) чем сетевой,
|
||||||
|
однако в некоторых случаях, например когда пользователи сети играют в
|
||||||
|
игры, сетевой траффик может превысить прикладной в 4-5 раз. Это довольно неприятно,
|
||||||
|
так как получается, что они за это не платят.
|
||||||
|
<p>
|
||||||
|
Происходит это потому, что в каждом посланом пакете есть заголовок+данные. Заголовок
|
||||||
|
весит порядка 50-60 байт а количество данных может меняться от 15-20 байт (что характерно для игр)
|
||||||
|
до 800-900 байт (у IE). Также количество данных в пакете зависит от загрузки сети,
|
||||||
|
удалённости сервера и прочих причин.
|
||||||
|
<p>
|
||||||
|
Данный плагин может исправить такую ситуацию. Он может умножать счётчик траффика
|
||||||
|
при окончании соединения на некоторый коэффициент либо добавлять к данным размеры заголовков пакетов,
|
||||||
|
которые прошли по сети.
|
||||||
|
<h4>Использование</h4>
|
||||||
|
<ol>
|
||||||
|
<li>Извлечь TrafficPlugin.dll в каталог с 3proxy.exe
|
||||||
|
<li>Стартовать плагин в 3proxy.cfg
|
||||||
|
<pre>
|
||||||
|
plugin TrafficPlugin.dll start
|
||||||
|
</pre>
|
||||||
|
<li>Добавить правила:
|
||||||
|
<br>
|
||||||
|
ДЛЯ РЕЖИМА ДОМНОЖЕНИЯ ТРАФФИКА НА ЧИСЛО:
|
||||||
|
<pre>
|
||||||
|
trafcorrect m <сервис> <исходящий порт> <коэффициент>
|
||||||
|
</pre>
|
||||||
|
где: <сервис> может быть proxy, socks4, socks45, socks5, tcppm, udppm, pop3p
|
||||||
|
если сервис указан неверно то считается, что это может быть любой сервис.
|
||||||
|
можно использовать *, тогда правило будет считаться для любого сервиса.
|
||||||
|
<br> <исходящий порт> - порт, к которому подключается прокси сервер. * - любой
|
||||||
|
<коэффициент> - число на каоторое домнажается траффик. Обязательный параметр.
|
||||||
|
Должен быть от больше 0 и меньше 100
|
||||||
|
<br>
|
||||||
|
ДЛЯ РЕЖИМА С УЧЁТОМ РАЗМЕРА ЗАГОЛОВКОВ ПАКЕТОВ:
|
||||||
|
<pre>
|
||||||
|
trafcorrect p <сервис> <tcp/udp> <исходящий порт> [размер пустого пакета]
|
||||||
|
</pre>
|
||||||
|
<tcp/udp> - протокол, по которому осуществляется соединение.
|
||||||
|
[размер пакета] - средний размер пустого пакета. Можно определить захватив
|
||||||
|
данные при помощи такой утилиты как Ethereal. Параметр необязателен. Если отсутствует,
|
||||||
|
то размер пакета будет считаться равным 66 байт.
|
||||||
|
<br>Режимы можно смешивать.
|
||||||
|
Следует учитывать, что плугин создаёт список всех правил изменения траффика.
|
||||||
|
Когда происходит окончание соединения выполняется первое подходящее правило.
|
||||||
|
</ol>
|
||||||
|
Подсчет трафика в любом режиме не является точным, это некоторая аппроксимация
|
||||||
|
позволяющаяподсчитать трафик с точностью до нескольких процентов.
|
||||||
|
|
||||||
|
<h4>Пример:</h4>
|
||||||
|
<pre>
|
||||||
|
plugin "TrafficPlugin.dll" start
|
||||||
|
trafcorrect m socks5 6112 4.5
|
||||||
|
trafcorrect m socks5 * 1.1
|
||||||
|
</pre>
|
||||||
|
следующее неверно:
|
||||||
|
<pre>
|
||||||
|
plugin "TrafficPlugin.dll" start
|
||||||
|
trafcorrect m socks5 * 1.1
|
||||||
|
trafcorrect m socks5 6112 4.5
|
||||||
|
</pre>
|
||||||
|
Вторая строчка выполнена никогда не будет, т.к. правило 1 содержит *.
|
||||||
|
|
||||||
|
|
||||||
|
<h4>Загрузить:</h4>
|
||||||
|
<ul>
|
||||||
|
<li>Плагин включен в дистрибутив 3proxy 0.6
|
||||||
|
</ul>
|
33
doc/html/plugins/WindowsAuthentication.html
Normal file
33
doc/html/plugins/WindowsAuthentication.html
Normal file
@ -0,0 +1,33 @@
|
|||||||
|
|
||||||
|
<h3>3proxy Windows Authentication plugin</h3>
|
||||||
|
Support for cleartext authentication against Windows domain or local Windows account.
|
||||||
|
<h4>Usage:</h4>
|
||||||
|
<ol>
|
||||||
|
<li>Extract WindowsAuthentication.dll to the same folder with 3proxy executable.
|
||||||
|
<li>Create 3ProxyAllowedGroup - Windows system group allowed to use proxy.
|
||||||
|
You can choose different group name. Group can be either local or
|
||||||
|
Active Directory. Every account allowed to use 3proxy must be included in this
|
||||||
|
group either directly or through group nesting.
|
||||||
|
<li>Configure plugin with 'plugin' command in 3proxy.cfg, e.g.:
|
||||||
|
<pre><code>
|
||||||
|
plugin "WindowsAuthentication.dll" WindowsAuthentication "3ProxyAllowedGroup"
|
||||||
|
</code></pre>
|
||||||
|
<br>WindowsAuthentication.dll - location of DLL, if DLL is located in different folder
|
||||||
|
from 3proxy.exe you must specify complete path to DLL here. 3ProxyAllowedGroup - Windows
|
||||||
|
system group allowed to use 3proxy.
|
||||||
|
After plugin is loaded, 'windows' authentication type is supported.
|
||||||
|
|
||||||
|
<li>Configure 'auth windows' for services that require Windows authentication.
|
||||||
|
<li>It's recommended you also configure authentication caching (see 'authcache'),
|
||||||
|
to prevent excessive workload for domain controller. Example:
|
||||||
|
<pre>
|
||||||
|
authcache user,pass 900
|
||||||
|
auth cache windows
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<li>NTLM authentication is not currently supported for plugins, you should use proxy -n key to disable it.
|
||||||
|
</ol>
|
||||||
|
<h4>Download:</h4>
|
||||||
|
<ul>
|
||||||
|
<li>Plugin is included into 3proxy 0.6 binary and source distribution
|
||||||
|
</ul>
|
35
doc/html/plugins/WindowsAuthentication.ru.html
Normal file
35
doc/html/plugins/WindowsAuthentication.ru.html
Normal file
@ -0,0 +1,35 @@
|
|||||||
|
<h3>Плагин аутентификации Windows для 3proxy</h3>
|
||||||
|
Поддерживается только аутентификация открытым текстом в домене или на локальной машине Windows.
|
||||||
|
<h4>Использование</h4>
|
||||||
|
<ol>
|
||||||
|
<li>Извлечь WindowsAuthentication.dll в каталог с 3proxy.exe
|
||||||
|
<li>Создать 3ProxyAllowedGroup - системная группа Windows, которой разрешено использование прокси. Ее необходимо создать (можно
|
||||||
|
использовать группу с другим именем, см. ниже). Учетные записи пользователей, которым разрешен доступ к прокси
|
||||||
|
должны быть включены в группу непосредственно или посредством включения их групп. Группа может быть как локальной, так и в
|
||||||
|
ActiveDirectory.
|
||||||
|
<li>В файле конфигурации загрузить dll с помощью команды plugin:
|
||||||
|
<br>plugin "WindowsAuthentication.dll" WindowsAuthentication "3ProxyAllowedGroup"
|
||||||
|
<br>Если DLL находится в другом каталоге, то вместо "WindowsAuthentication.dll"
|
||||||
|
необходимо указать полный путь к DLL. 3ProxyAllowedGroup - название системной группы,
|
||||||
|
которой разрешен доступ к прокси.
|
||||||
|
<li>Плагин добавляет новый тип аутентификации - windows. Т.е. для использования
|
||||||
|
Windows-аутентификации надо дать команду
|
||||||
|
<pre>
|
||||||
|
auth windows
|
||||||
|
</pre>
|
||||||
|
<li>Не рекомендуется использовать данный плагин без кэширования
|
||||||
|
аутентификации (authcache), т.к. это приведет к увеличению нагрузки на
|
||||||
|
сервер/контроллер домена. Пример:
|
||||||
|
<pre>
|
||||||
|
authcache user,pass 900
|
||||||
|
auth cache windows
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<li>В настоящее время не поддерживается NTLM-аутентификация для плагинов,
|
||||||
|
поэтому необходимо запускать proxy с ключиком -n.
|
||||||
|
</ol>
|
||||||
|
<h4>Загрузить:</h4>
|
||||||
|
<ul>
|
||||||
|
<li>Плагин включен в дистрибутив 3proxy 0.6
|
||||||
|
</ul>
|
||||||
|
|
Loading…
Reference in New Issue
Block a user