aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVsevolod Stakhov <vsevolod@highsecure.ru>2016-06-24 10:17:05 +0100
committerVsevolod Stakhov <vsevolod@highsecure.ru>2016-06-24 10:17:05 +0100
commit7bee0ab305e454db604b103116f8185345b4d3fe (patch)
treed082e79ccab72f8f2dbe313d1005dd934860669b
parentad861c4e2c2a9535ad8058f72c5de02204d7a1a5 (diff)
downloadrspamd-7bee0ab305e454db604b103116f8185345b4d3fe.tar.gz
rspamd-7bee0ab305e454db604b103116f8185345b4d3fe.zip
[Doc] Add openphish documentation
-rw-r--r--doc/markdown/modules/phishing.md28
1 files changed, 26 insertions, 2 deletions
diff --git a/doc/markdown/modules/phishing.md b/doc/markdown/modules/phishing.md
index 4f6d86159..52e6dd6b6 100644
--- a/doc/markdown/modules/phishing.md
+++ b/doc/markdown/modules/phishing.md
@@ -27,10 +27,10 @@ Here is an example of full module configuration.
~~~ucl
phishing {
symbol = "R_PHISHING"; # Default symbol
-
+
# Check only domains from this list
domains = "file:///path/to/map";
-
+
# Make exclusions for known redirectors
redirector_domains = [
# URL/path for map, colon, name of symbol
@@ -57,3 +57,27 @@ payments system phishing.
Finally, the default symbol is yielded- if `domains` is specified then
only if the phished domain is found in the related map.
+
+## Openphish support
+
+Since version 1.3, there is [openphish](https://openphish.com) support in rspamd.
+Now rspamd loads this public feed as a map (using HTTPS) and checks URLs in messages using
+openphish list. If any match is found, then rspamd adds symbol `PHISHED_OPENPHISH`.
+
+If you use research or commercial data feed, rspamd can also use its data and gives
+more details about URLs found: their sector (e.g. 'Finance'), brand name (e.g.
+'Bank of Zimbabwe') and other useful information.
+
+There are couple of options available to configure openphish module:
+
+~~~ucl
+phishing {
+ # URL of feed, default is public url:
+ openphish_map = "https://www.openphish.com/feed.txt";
+ # For premium feed, change that to your personal URL, e.g.
+ # openphish_map = "https://openphish.com/samples/premium_feed.json";
+
+ # Change this to true if premium feed is enabled
+ openphish_premium = false;
+}
+~~~