Update SSLPlugin documentation

This commit is contained in:
Vladimir Dubrovin 2024-02-19 00:13:08 +03:00
parent 161cbbd452
commit a592f07783
2 changed files with 61 additions and 5 deletions

View File

@ -1,18 +1,27 @@
<h3>3proxy SSL/TLS plugin</h3> <h3>3proxy SSL/TLS plugin</h3>
Plugin can be used to transparently decypher SSL/TLS data. Plugin should never be used in production environment due to Plugin can be used to transparently decypher SSL/TLS data and TLS encryption to proxy.
potential securiy reasons. potential securiy reasons.
<pre> <pre>
ssl_certcache PATH_TO_CACHE ssl_certcache PATH_TO_CACHE
ssl_mitm ssl_mitm
ssl_nomitm ssl_nomitm
ssl_srvcert
ssl_srvkey
ssl_serv
ssl_noserv
</pre> </pre>
<h4>For transparent certificate spoofing:</h4>
ssl_certcache - path to certificates cache. For transparent spoofing cache must contain 3 files: 3proxy.pem - public ssl_certcache - path to certificates cache. For transparent spoofing cache must contain 3 files: 3proxy.pem - public
self-signed certificates, 3proxy.key - key for public certificates, server.key - this key will be used to generates self-signed certificates, 3proxy.key - key for public certificates, server.key - this key will be used to generates
spoofed certificates. spoofed certificates.
Generated certificates will be placed to the same path. Generated certificates will be placed to the same path.
<br>ssl_mitm - spoof certificates for services started below <br>ssl_mitm - spoof certificates for services started below. Using ssl_mitm is insecure, because proxy does not check certificates.
<br>ssl_nomitm - do not spoof certificates for services started below <br>ssl_nomitm - do not spoof certificates for services started below
@ -25,6 +34,25 @@ proxy -p3128
ssl_nomitm ssl_nomitm
proxy -p3129 proxy -p3129
</pre> </pre>
<h4>To protect traffic to server (https:// proxy) - since 0.9.5 version</h4>
ssl_srvcert - Server certificate (should not be selfsigned and must contain Alternative name)
ssl_srvkey - Server ceritifacte key
ssl_serv - require TLS connection for services below
ssl_noserv - do not require TLS connection for services below
Example:
<pre>
plugin /path/to/SSLPlugin.so ssl_plugin
ssl_srvcert path_to_cert
ssl_srvkey path_to_key
ssl_serv
proxy -p33128
ssl_noserv
proxy -p3128
</pre>
creates https:// proxy on 33128 and http:// proxy on 3128
<h4>Download:</h4> <h4>Download:</h4>
<ul> <ul>

View File

@ -1,18 +1,25 @@
<h3>Плагин SSL/TLS для 3proxy</h3> <h3>Плагин SSL/TLS для 3proxy</h3>
Плагин используется для транспарентной дешифровки SSL-трафика с подменой сертификата. Плагин используется для транспарентной дешифровки SSL-трафика с подменой сертификата и для TLS шифрования трафика прокси.
Плагин не должен использоваться в рабочем окружении, т.к. его использование дает возможность обхода проверок SSL.
<pre> <pre>
ssl_certcache PATH_TO_CACHE ssl_certcache PATH_TO_CACHE
ssl_mitm ssl_mitm
ssl_nomitm ssl_nomitm
ssl_srvcert
ssl_srvkey
ssl_serv
ssl_noserv
</pre> </pre>
<h4>Использование для перехвата трафика с подменой сертификата</h4>
ssl_certcache - путь к кэшу сертификатов. Для транспорентной подмены сертификатов в кэше должно находиться 3 файла: 3proxy.pem - публичный ssl_certcache - путь к кэшу сертификатов. Для транспорентной подмены сертификатов в кэше должно находиться 3 файла: 3proxy.pem - публичный
самоподписанный сертификат, 3proxy.key - ключ от этого сертификата, server.key - ключ с которым будут генерироваться подменные сертификаты. самоподписанный сертификат, 3proxy.key - ключ от этого сертификата, server.key - ключ с которым будут генерироваться подменные сертификаты.
Сгенерированные сертификаты будут помещаться в этот же каталог. Сгенерированные сертификаты будут помещаться в этот же каталог.
<br>ssl_mitm - подменять сертитфикаты для запущенных ниже сервисов <br>ssl_mitm - подменять сертитфикаты для запущенных ниже сервисов. Может быть небезопасно, т.к. прокси не проверяет сертификат сервера.
<br>ssl_nomitm - не подменять сертитфикаты для запущенных ниже сервисов <br>ssl_nomitm - не подменять сертитфикаты для запущенных ниже сервисов
@ -26,6 +33,27 @@ ssl_nomitm
proxy -p3129 proxy -p3129
</pre> </pre>
<h4>Использование для TLS шифрования трафика к прокси (с версии 0.9.5)
ssl_srvcert - путь к файлу сертификата сервера. Сертификат должен быть аналогичен сертификату web-сервера (не должен быть самоподписанным и должен содержать AltName).
ssl_srvkey - ключ от серверного сертификата
ssl_serv - шифровать трафик TLS для сервисов ниже
ssl_noserv - не шифровать трафик TLS для сервисов ниже
Пример:
<pre>
plugin /path/to/SSLPlugin.so ssl_plugin
ssl_srvcert path_to_cert
ssl_srvkey path_to_key
ssl_serv
proxy -p33128
ssl_noserv
proxy -p3128
</pre>
На порт 33128 https:// прокси, на порту 3128 http:// прокси
<h4>Загрузить:</h4> <h4>Загрузить:</h4>
<ul> <ul>
<li>Плагин включен в дистрибутив 3proxy 0.8 <li>Плагин включен в дистрибутив 3proxy 0.8