diff options
author | Vsevolod Stakhov <vsevolod@rambler-co.ru> | 2008-11-06 18:32:32 +0300 |
---|---|---|
committer | Vsevolod Stakhov <vsevolod@rambler-co.ru> | 2008-11-06 18:32:32 +0300 |
commit | 2175980532791f90807eb03ef99d6f7006ada4e6 (patch) | |
tree | aa7b728c7d072c044df938952b2dd875eac2342f | |
parent | 31395157b14e12c4eb70a574a5cedb587d61b200 (diff) | |
download | rspamd-2175980532791f90807eb03ef99d6f7006ada4e6.tar.gz rspamd-2175980532791f90807eb03ef99d6f7006ada4e6.zip |
* Use utf8 in description files
--HG--
rename : README-classify.koi8.txt => README-classify.utf8.txt
rename : README.koi8.txt => README.utf8.txt
-rw-r--r-- | README-classify.utf8.txt (renamed from README-classify.koi8.txt) | 0 | ||||
-rw-r--r-- | README.koi8.txt | 82 | ||||
-rw-r--r-- | README.utf8.txt | 82 |
3 files changed, 82 insertions, 82 deletions
diff --git a/README-classify.koi8.txt b/README-classify.utf8.txt index 9f3934c90..9f3934c90 100644 --- a/README-classify.koi8.txt +++ b/README-classify.utf8.txt diff --git a/README.koi8.txt b/README.koi8.txt deleted file mode 100644 index fdecd4132..000000000 --- a/README.koi8.txt +++ /dev/null @@ -1,82 +0,0 @@ -API Rspamd. -=========== - -TODO. - -Логика работы фильтров rspamd. -============================== - -1) Все фильтры регистрируются в конфиг файле в описании цепочек фильтров: -header_filters=regexp,my_func -где имя фильтра - это либо название c модуля, либо название перл функции -Типы фильтров: -* header_filters - фильтр заголовков -* mime_filters - фильтр для каждой mime части -* message_filters - фильтр всего сообщения целиком -* url_filters - фильтры URL ссылок -Свои результаты фильтры регистрируют при помощи добавления результата в метрику. - -2) Метрика - это символьное значение, в котором регистрируют свои результаты фильтры -Существует метрика по умолчанию - "default", в которой регистрируют результаты фильтры, -для которых явно не определена метрика -Для каждой метрики существует специальная функция консолидации, которая рассчитывает коэффициенты -результатов согласно внутренней логике соответствия символов и коэффициентов. По умолчанию такой -функцией является простая сумма, которая настраивается особым образом в конфигурационном файле: - -# Блок factors -factors { - # Например, "SURBL_DNS"=5.0 - "SYMBOL_NAME" = coefficient; -}; -Также для метрики можно зарегистрировать особую функцию, прописав в описании метрики -metric { - name = "test_metric"; - function = "some_function"; - required_score = 20.0; -}; -Пока поддерживаются только перловые функции. - -3) Результат - это пара значений: SYMBOL:FLAG, при этом, SYMBOL - это -строчка, характеризующая результат, а FLAG - сработал данный фильтр или нет -(1 или 0). Результат добавляется в метрику, после чего передается функции консолидации. - -4) Итог - на выходе мы имеем обработанное сообщение, список метрик и их символов и результаты -проверки. - -Протокол. -========= - -Формат ответа: -SPAMD/1.1 0 EX_OK -\ / \/ - Версия Код - ошибки -Spam: False ; 2 / 5 -Это формат совместимости с sa-spamd (без метрик) - -Новый формат ответа: -RSPAMD/1.0 0 EX_OK -Metric: Name ; Spam_Result ; Spam_Mark / Spam_Mark_Required -Metric: Name2 ; Spam_Result2 ; Spam_Mark2 / Spam_Mark_Required2 - -Заголовков типа metric может быть несколько. -Формат вывода символов: -SYMBOL1, SYMBOL2, SYMBOL3 -- формат совместимости с sa-spamd -Metric: SYMBOL1, SYMBOL2, SYMBOL3 -- формат rspamd - -Формат ответа зависит от формата запроса: -PROCESS SPAMC/1.2 -\ / \ / -Команда Версия - -SPAMC - протокол совместимости с sa-spamd -RSPAMC - новый протокол rspamd -В любом из режимов работы поддерживаются следующие заголовки: -Content-Length - длина сообщения -Helo - HELO, полученный от клиента -From - MAIL FROM -IP - IP клиента -Recipient-Number - число реципиентов -Rcpt - реципиент - -Эти значения могут использоваться в фильтрах rspamd. diff --git a/README.utf8.txt b/README.utf8.txt new file mode 100644 index 000000000..e68b2b2f6 --- /dev/null +++ b/README.utf8.txt @@ -0,0 +1,82 @@ +API Rspamd. +=========== + +TODO. + +п⌡п╬пЁп╦п╨п╟ я─п╟п╠п╬я┌я▀ я└п╦п╩я▄я┌я─п╬п╡ rspamd. +============================== + +1) п▓я│п╣ я└п╦п╩я▄я┌я─я▀ я─п╣пЁп╦я│я┌я─п╦я─я┐я▌я┌я│я▐ п╡ п╨п╬п╫я└п╦пЁ я└п╟п╧п╩п╣ п╡ п╬п©п╦я│п╟п╫п╦п╦ я├п╣п©п╬я┤п╣п╨ я└п╦п╩я▄я┌я─п╬п╡: +header_filters=regexp,my_func +пЁп╢п╣ п╦п╪я▐ я└п╦п╩я▄я┌я─п╟ - я█я┌п╬ п╩п╦п╠п╬ п╫п╟п╥п╡п╟п╫п╦п╣ c п╪п╬п╢я┐п╩я▐, п╩п╦п╠п╬ п╫п╟п╥п╡п╟п╫п╦п╣ п©п╣я─п╩ я└я┐п╫п╨я├п╦п╦ +п╒п╦п©я▀ я└п╦п╩я▄я┌я─п╬п╡: +* header_filters - я└п╦п╩я▄я┌я─ п╥п╟пЁп╬п╩п╬п╡п╨п╬п╡ +* mime_filters - я└п╦п╩я▄я┌я─ п╢п╩я▐ п╨п╟п╤п╢п╬п╧ mime я┤п╟я│я┌п╦ +* message_filters - я└п╦п╩я▄я┌я─ п╡я│п╣пЁп╬ я│п╬п╬п╠я┴п╣п╫п╦я▐ я├п╣п╩п╦п╨п╬п╪ +* url_filters - я└п╦п╩я▄я┌я─я▀ URL я│я│я▀п╩п╬п╨ +п║п╡п╬п╦ я─п╣п╥я┐п╩я▄я┌п╟я┌я▀ я└п╦п╩я▄я┌я─я▀ я─п╣пЁп╦я│я┌я─п╦я─я┐я▌я┌ п©я─п╦ п©п╬п╪п╬я┴п╦ п╢п╬п╠п╟п╡п╩п╣п╫п╦я▐ я─п╣п╥я┐п╩я▄я┌п╟я┌п╟ п╡ п╪п╣я┌я─п╦п╨я┐. + +2) п°п╣я┌я─п╦п╨п╟ - я█я┌п╬ я│п╦п╪п╡п╬п╩я▄п╫п╬п╣ п╥п╫п╟я┤п╣п╫п╦п╣, п╡ п╨п╬я┌п╬я─п╬п╪ я─п╣пЁп╦я│я┌я─п╦я─я┐я▌я┌ я│п╡п╬п╦ я─п╣п╥я┐п╩я▄я┌п╟я┌я▀ я└п╦п╩я▄я┌я─я▀ +п║я┐я┴п╣я│я┌п╡я┐п╣я┌ п╪п╣я┌я─п╦п╨п╟ п©п╬ я┐п╪п╬п╩я┤п╟п╫п╦я▌ - "default", п╡ п╨п╬я┌п╬я─п╬п╧ я─п╣пЁп╦я│я┌я─п╦я─я┐я▌я┌ я─п╣п╥я┐п╩я▄я┌п╟я┌я▀ я└п╦п╩я▄я┌я─я▀, +п╢п╩я▐ п╨п╬я┌п╬я─я▀я┘ я▐п╡п╫п╬ п╫п╣ п╬п©я─п╣п╢п╣п╩п╣п╫п╟ п╪п╣я┌я─п╦п╨п╟ +п■п╩я▐ п╨п╟п╤п╢п╬п╧ п╪п╣я┌я─п╦п╨п╦ я│я┐я┴п╣я│я┌п╡я┐п╣я┌ я│п©п╣я├п╦п╟п╩я▄п╫п╟я▐ я└я┐п╫п╨я├п╦я▐ п╨п╬п╫я│п╬п╩п╦п╢п╟я├п╦п╦, п╨п╬я┌п╬я─п╟я▐ я─п╟я│я│я┤п╦я┌я▀п╡п╟п╣я┌ п╨п╬я█я└я└п╦я├п╦п╣п╫я┌я▀ +я─п╣п╥я┐п╩я▄я┌п╟я┌п╬п╡ я│п╬пЁп╩п╟я│п╫п╬ п╡п╫я┐я┌я─п╣п╫п╫п╣п╧ п╩п╬пЁп╦п╨п╣ я│п╬п╬я┌п╡п╣я┌я│я┌п╡п╦я▐ я│п╦п╪п╡п╬п╩п╬п╡ п╦ п╨п╬я█я└я└п╦я├п╦п╣п╫я┌п╬п╡. п÷п╬ я┐п╪п╬п╩я┤п╟п╫п╦я▌ я┌п╟п╨п╬п╧ +я└я┐п╫п╨я├п╦п╣п╧ я▐п╡п╩я▐п╣я┌я│я▐ п©я─п╬я│я┌п╟я▐ я│я┐п╪п╪п╟, п╨п╬я┌п╬я─п╟я▐ п╫п╟я│я┌я─п╟п╦п╡п╟п╣я┌я│я▐ п╬я│п╬п╠я▀п╪ п╬п╠я─п╟п╥п╬п╪ п╡ п╨п╬п╫я└п╦пЁя┐я─п╟я├п╦п╬п╫п╫п╬п╪ я└п╟п╧п╩п╣: + +# п▒п╩п╬п╨ factors +factors { + # п²п╟п©я─п╦п╪п╣я─, "SURBL_DNS"=5.0 + "SYMBOL_NAME" = coefficient; +}; +п╒п╟п╨п╤п╣ п╢п╩я▐ п╪п╣я┌я─п╦п╨п╦ п╪п╬п╤п╫п╬ п╥п╟я─п╣пЁп╦я│я┌я─п╦я─п╬п╡п╟я┌я▄ п╬я│п╬п╠я┐я▌ я└я┐п╫п╨я├п╦я▌, п©я─п╬п©п╦я│п╟п╡ п╡ п╬п©п╦я│п╟п╫п╦п╦ п╪п╣я┌я─п╦п╨п╦ +metric { + name = "test_metric"; + function = "some_function"; + required_score = 20.0; +}; +п÷п╬п╨п╟ п©п╬п╢п╢п╣я─п╤п╦п╡п╟я▌я┌я│я▐ я┌п╬п╩я▄п╨п╬ п©п╣я─п╩п╬п╡я▀п╣ я└я┐п╫п╨я├п╦п╦. + +3) п═п╣п╥я┐п╩я▄я┌п╟я┌ - я█я┌п╬ п©п╟я─п╟ п╥п╫п╟я┤п╣п╫п╦п╧: SYMBOL:FLAG, п©я─п╦ я█я┌п╬п╪, SYMBOL - я█я┌п╬ +я│я┌я─п╬я┤п╨п╟, я┘п╟я─п╟п╨я┌п╣я─п╦п╥я┐я▌я┴п╟я▐ я─п╣п╥я┐п╩я▄я┌п╟я┌, п╟ FLAG - я│я─п╟п╠п╬я┌п╟п╩ п╢п╟п╫п╫я▀п╧ я└п╦п╩я▄я┌я─ п╦п╩п╦ п╫п╣я┌ +(1 п╦п╩п╦ 0). п═п╣п╥я┐п╩я▄я┌п╟я┌ п╢п╬п╠п╟п╡п╩я▐п╣я┌я│я▐ п╡ п╪п╣я┌я─п╦п╨я┐, п©п╬я│п╩п╣ я┤п╣пЁп╬ п©п╣я─п╣п╢п╟п╣я┌я│я▐ я└я┐п╫п╨я├п╦п╦ п╨п╬п╫я│п╬п╩п╦п╢п╟я├п╦п╦. + +4) п≤я┌п╬пЁ - п╫п╟ п╡я▀я┘п╬п╢п╣ п╪я▀ п╦п╪п╣п╣п╪ п╬п╠я─п╟п╠п╬я┌п╟п╫п╫п╬п╣ я│п╬п╬п╠я┴п╣п╫п╦п╣, я│п©п╦я│п╬п╨ п╪п╣я┌я─п╦п╨ п╦ п╦я┘ я│п╦п╪п╡п╬п╩п╬п╡ п╦ я─п╣п╥я┐п╩я▄я┌п╟я┌я▀ +п©я─п╬п╡п╣я─п╨п╦. + +п÷я─п╬я┌п╬п╨п╬п╩. +========= + +п╓п╬я─п╪п╟я┌ п╬я┌п╡п╣я┌п╟: +SPAMD/1.1 0 EX_OK +\ / \/ + п▓п╣я─я│п╦я▐ п п╬п╢ + п╬я┬п╦п╠п╨п╦ +Spam: False ; 2 / 5 +п╜я┌п╬ я└п╬я─п╪п╟я┌ я│п╬п╡п╪п╣я│я┌п╦п╪п╬я│я┌п╦ я│ sa-spamd (п╠п╣п╥ п╪п╣я┌я─п╦п╨) + +п²п╬п╡я▀п╧ я└п╬я─п╪п╟я┌ п╬я┌п╡п╣я┌п╟: +RSPAMD/1.0 0 EX_OK +Metric: Name ; Spam_Result ; Spam_Mark / Spam_Mark_Required +Metric: Name2 ; Spam_Result2 ; Spam_Mark2 / Spam_Mark_Required2 + +п≈п╟пЁп╬п╩п╬п╡п╨п╬п╡ я┌п╦п©п╟ metric п╪п╬п╤п╣я┌ п╠я▀я┌я▄ п╫п╣я│п╨п╬п╩я▄п╨п╬. +п╓п╬я─п╪п╟я┌ п╡я▀п╡п╬п╢п╟ я│п╦п╪п╡п╬п╩п╬п╡: +SYMBOL1, SYMBOL2, SYMBOL3 -- я└п╬я─п╪п╟я┌ я│п╬п╡п╪п╣я│я┌п╦п╪п╬я│я┌п╦ я│ sa-spamd +Metric: SYMBOL1, SYMBOL2, SYMBOL3 -- я└п╬я─п╪п╟я┌ rspamd + +п╓п╬я─п╪п╟я┌ п╬я┌п╡п╣я┌п╟ п╥п╟п╡п╦я│п╦я┌ п╬я┌ я└п╬я─п╪п╟я┌п╟ п╥п╟п©я─п╬я│п╟: +PROCESS SPAMC/1.2 +\ / \ / +п п╬п╪п╟п╫п╢п╟ п▓п╣я─я│п╦я▐ + +SPAMC - п©я─п╬я┌п╬п╨п╬п╩ я│п╬п╡п╪п╣я│я┌п╦п╪п╬я│я┌п╦ я│ sa-spamd +RSPAMC - п╫п╬п╡я▀п╧ п©я─п╬я┌п╬п╨п╬п╩ rspamd +п▓ п╩я▌п╠п╬п╪ п╦п╥ я─п╣п╤п╦п╪п╬п╡ я─п╟п╠п╬я┌я▀ п©п╬п╢п╢п╣я─п╤п╦п╡п╟я▌я┌я│я▐ я│п╩п╣п╢я┐я▌я┴п╦п╣ п╥п╟пЁп╬п╩п╬п╡п╨п╦: +Content-Length - п╢п╩п╦п╫п╟ я│п╬п╬п╠я┴п╣п╫п╦я▐ +Helo - HELO, п©п╬п╩я┐я┤п╣п╫п╫я▀п╧ п╬я┌ п╨п╩п╦п╣п╫я┌п╟ +From - MAIL FROM +IP - IP п╨п╩п╦п╣п╫я┌п╟ +Recipient-Number - я┤п╦я│п╩п╬ я─п╣я├п╦п©п╦п╣п╫я┌п╬п╡ +Rcpt - я─п╣я├п╦п©п╦п╣п╫я┌ + +п╜я┌п╦ п╥п╫п╟я┤п╣п╫п╦я▐ п╪п╬пЁя┐я┌ п╦я│п©п╬п╩я▄п╥п╬п╡п╟я┌я▄я│я▐ п╡ я└п╦п╩я▄я┌я─п╟я┘ rspamd. |