]> source.dussan.org Git - rspamd.git/commitdiff
Add SPF module documentation.
authorVsevolod Stakhov <vsevolod@highsecure.ru>
Sat, 9 May 2015 21:25:25 +0000 (22:25 +0100)
committerVsevolod Stakhov <vsevolod@highsecure.ru>
Sat, 9 May 2015 21:25:25 +0000 (22:25 +0100)
doc/markdown/modules/spf.md

index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..d858a7af3b0f02a72917f59c48ddc489b557b08c 100644 (file)
@@ -0,0 +1,34 @@
+# SPF module
+
+SPF module performs checks of the sender's [SPF](http://www.openspf.org/) policy.
+Many mail providers uses SPF records to define which hosts are eligible to send email
+for this specific domain. In fact, there are many possibilities to create and use
+SPF records, however, all they check merely the sender's domain and the sender's IP.
+
+The specific case are automated messages from the special mailer daemon address:
+`<>`. In this case rspamd uses `HELO` to grab domain information as specified in the
+standart.
+
+## Principles of work
+
+`SPF` can be a powerfull tool when properly used. However, it is very fragile in many
+cases: when a message is somehow redirected or reconstructed by mailing lists software.
+
+Moreover, many mail providers have no clear understanding of this technology and
+misuse the SPF technique. Hence, the scores for SPF symbols are relatively small
+in rspamd.
+
+SPF uses DNS service extensively, therefore rspamd maintain the cache of SPF records.
+This caches operates on principle of `least recently used` expiration. All cached items
+lifetimes is accordingly limited by the matching DNS record time to live.
+
+You can manually specify the size of this cache by configuring SPF module:
+
+~~~nginx
+spf {
+       spf_cache_size = 1k; # cache up to 1000 of the most recent SPF records
+}
+~~~
+
+Currently, rspamd supports the full set of SPF elements, macroes and has internal
+protection from DNS recursion.
\ No newline at end of file