1Mail::SpamAssassin::PluUgsienr::CDoCnCt(r3i)buted Perl DMoaciulm:e:nStpaatmiAosnsassin::Plugin::DCC(3)
2
3
4

NAME

6       Mail::SpamAssassin::Plugin::DCC - perform DCC check of messages
7

SYNOPSIS

9         loadplugin Mail::SpamAssassin::Plugin::DCC
10
11         full DCC_CHECK        eval:check_dcc()
12         full DCC_CHECK_50_79  eval:check_dcc_reputation_range('50','79')
13

DESCRIPTION

15       The DCC or Distributed Checksum Clearinghouse is a system of servers
16       collecting and counting checksums of millions of mail messages.  The
17       counts can be used by SpamAssassin to detect and filter spam.
18
19       See https://www.dcc-servers.net/dcc/ for more information about DCC.
20
21       Note that DCC is disabled by default in "v310.pre" because its use
22       requires software that is not distributed with SpamAssassin and that
23       has license restrictions for certain commercial uses.  See the DCC
24       license at https://www.dcc-servers.net/dcc/LICENSE for details.
25
26       Enable it by uncommenting the "loadplugin
27       Mail::SpamAssassin::Plugin::DCC" confdir/v310.pre or by adding this
28       line to your local.pre.  It might also be necessary to install a DCC
29       package, port, rpm, or equivalent from your operating system
30       distributor or a tarball from the primary DCC source at
31       https://www.dcc-servers.net/dcc/#download See also
32       https://www.dcc-servers.net/dcc/INSTALL.html
33

TAGS

35       The following tags are added to the set, available for use in reports,
36       header fields, other plugins, etc.:
37
38         _DCCB_    DCC server ID in X-DCC-*-Metrics header field name
39         _DCCR_    X-DCC-*-Metrics header field body
40         _DCCREP_  DCC Reputation or percent bulk mail (0..100) from
41                     commercial DCC software
42

USER OPTIONS

44       use_dcc (0|1)       (default: 1)
45           Whether to use DCC, if it is available.
46
47       use_dcc_rep (0|1)        (default: 1)
48           Whether to use the commercial DCC Reputation feature, if it is
49           available.  Note that reputation data is free for all starting from
50           DCC 2.x version, where it's automatically used.
51
52       dcc_body_max NUMBER
53       dcc_fuz1_max NUMBER
54       dcc_fuz2_max NUMBER
55           Sets how often a message's body/fuz1/fuz2 checksum must have been
56           reported to the DCC server before SpamAssassin will consider the
57           DCC check hit.  999999 is DCC's MANY count.
58
59           The default is 999999 for all these options.
60
61       dcc_rep_percent NUMBER
62           Only the commercial DCC software provides DCC Reputations (but
63           starting from DCC 2.x version it is available for all).  A DCC
64           Reputation is the percentage of bulk mail received from the last
65           untrusted relay in the path taken by a mail message as measured by
66           all commercial DCC installations.  See
67           http://www.rhyolite.com/dcc/reputations.html You "must" whitelist
68           your trusted relays or MX servers with MX or MXDCC lines in
69           /var/dcc/whiteclnt as described in the main DCC man page to avoid
70           seeing your own MX servers as sources of bulk mail.  See
71           https://www.dcc-servers.net/dcc/dcc-tree/dcc.html#White-and-Blacklists
72           The default is 90.
73

ADMINISTRATOR OPTIONS

75       dcc_timeout n       (default: 5)
76           How many seconds you wait for DCC to complete, before scanning
77           continues without the DCC results. A numeric value is optionally
78           suffixed by a time unit (s, m, h, d, w, indicating seconds
79           (default), minutes, hours, days, weeks).
80
81       dcc_home STRING
82           This option tells SpamAssassin where to find the dcc homedir.  If
83           not specified, try to use the locally configured directory from the
84           "cdcc homedir" command.  Try /var/dcc if that command fails.
85
86       dcc_dccifd_path STRING
87           This option tells SpamAssassin where to find the dccifd socket
88           instead of a local Unix socket named "dccifd" in the "dcc_home"
89           directory.  If a socket is specified or found, use it instead of
90           "dccproc".
91
92           If specified, "dcc_dccifd_path" is the absolute path of local Unix
93           socket or an INET socket specified as "[Host]:Port" or "Host:Port".
94           Host can be an IPv4 or IPv6 address or a host name Port is a TCP
95           port number. The brackets are required for an IPv6 address.
96
97           The default is "undef".
98
99       dcc_path STRING
100           Where to find the "dccproc" client program instead of relying on
101           SpamAssassin to find it in the current PATH or "dcc_home/bin". This
102           must often be set, because the current PATH is cleared by taint
103           mode in the Perl interpreter,
104
105           If a "dccifd" socket is found in "dcc_home" or specified explicitly
106           with "dcc_dccifd_path", use the dccifd(8) interface instead of
107           "dccproc".
108
109           The default is "undef".
110
111       dcc_options options
112           Specify additional options to the dccproc(8) command.  Only
113           characters in the range [0-9A-Za-z ,._/-] are allowed for security
114           reasons.
115
116           The default is "undef".
117
118       dccifd_options options
119           Specify additional options to send to the dccifd daemon with the
120           ASCII protocol described on the dccifd(8) man page.  Only
121           characters in the range [0-9A-Za-z ,._/-] are allowed for security
122           reasons.
123
124           The default is "undef".
125
126       dcc_learn_score n        (default: undef)
127           Report messages with total scores this much larger than the
128           SpamAssassin spam threshold to DCC as spam.
129
130
131
132perl v5.38.0                      2023-07-22Mail::SpamAssassin::Plugin::DCC(3)
Impressum