razor-check(1)

1RAZOR-CHECK(1)        User Contributed Perl Documentation       RAZOR-CHECK(1)
2
3
4

NAME

6       "razor-check" - Razor Filtering Agent
7

SYNOPSIS

9           razor-check [options]  [ mail1 [ mail2 .. ] ]
10
11           $ cat mbox | razor-check
12           $ razor-check ./mbox
13           $ razor-check -d mbox mail.1 mail.2 mail.3
14

DESCRIPTION

16       "razor-check" checks a mail against the distributed Razor Catalogue by
17       communicating with a Razor Catalogue Server. It should be invoked
18       before the mail is delivered or processed by a human. "razor-check"
19       terminates with exit value 0 if the signature for the mail is
20       catalogued on the server (spam) or 1 if the mail is not catalogued by
21       the server (not a spam). "razor-check" should be invoked against every
22       incoming mail by mail processors (like procmail) or MTAs (like
23       sendmail). An alternate method would be to call "razor-check" from
24       cron, at regular intervals, to identify and mark spam in queued
25       mailboxes.
26
27       If "razor-check" is passed more than one mail, it will check each
28       against the database, printing out the serial number of every mail
29       considered to be spam.  "razor-check" supports mbox-formatted files
30       with 1 or more mails in them as well as files containing a single RFC
31       822 (non-mbox) mail.  More than one file may be present on the command
32       line, can be either a non-mbox or mbox in any order.  However, more
33       than one non-mbox mail cannot be read from stdin.
34

USAGE

36       "razor-check" is usually run by piping the contents of the mail to it,
37       or by providing the name of the file that contains the mail message to
38       be checked as the last argument. "razor-check" takes the following
39       arguments:
40
41       "-h"
42           Print a usage message and exit.
43
44       "-v"
45           Print the version number and exit.
46
47       "-d | --verbose"
48           Print debugging information.
49
50       "-debuglevel=n | -dl=n"
51           Set debug level to 'n'.  Default is 3 without "-d" option, 9 with.
52
53       "-whitelist=file"
54           Specify file to use for whitelisting.  Overrides 'whitelist' option
55           in "razor-agent.conf".
56
57       "-s"
58           Simulate a check. Do everything except talk to the server.
59
60       "-conf=filename"
61           Specifies an alternate configuration file.  If not specified, it is
62           computed, see razor-agents(1) manpage for details.  See
63           razor-agent.conf(5) manpage for various configuration options.  The
64           default is "<razorhome>/razor-agent.conf".
65
66       "-home=dir"
67           Specify razorhome directory.  This is where the configuration file,
68           logfiles, identities, and server files live.  If not specified, it
69           is computed, see razor-agents(1) manpage for details.
70
71       "-logfile=file"
72           Specify file to log to instead of what is in the configuration
73           file.  The default is "<razorhome>/razor-agent.log".
74
75       "-rs=razor.server.com"
76           Use this Razor Catalogue Server instead of reading
77           "servers.catalogue.lst".
78
79       "-H"
80           Compute and print the signature of the mail contents and exit. If
81           "-e=integer" is not specified, all supported engines will be used.
82
83       "-S=string"
84           Accept a list of pre-computed (with "-H") signatures on the command
85           line, instead of computing one from mail content. Signatures can be
86           submitted in hex or base64, but base64 is preferred. Requires
87           "-e=integer". Usage:
88
89           "razor-report -e 1 -S a8a3d545adb73f9733675571ffeaf10cba87745b"
90
91       "-e=integer"
92           Specify engine used to create signatures. Must be 1, 2, 3, or 4 in
93           this version. Engine 1, or "-e=1", is used for Razor 1.x
94           signatures. Used only with "-S=string" or "-H".
95
96       "-ep4=string"
97           String used by engine 4 when computing signatures. Published by the
98           Razor Catalogue Servers and updated very frequently. Used only when
99           "-e=4".
100

RECIPES

102       "razor-check" is usually invoked from procmail(1). Here are some common
103       ways of using it with procmail:
104
105       To change the "Subject" header if mail is spam:
106               :0 Wc
107               | razor-check
108               :0 Waf
109               | formail -i "Subject: Razor Warning: SPAM/UBE/UCE"
110
111       To add a "X-Razor2-Warning" header to spam:
112               :0 Wc
113               | razor-check
114               :0 Waf
115               | formail -A "X-Razor2-Warning: SPAM."
116
117       To file spam in a mailbox
118               :0 Wc
119               | razor-check
120               :0 Wa
121               /home/foo/Mail/razor-caught
122

AUTHORS

124       Vipul Ved Prakash <mail@vipul.net>, and Chad Norwood <chad@samo.org>
125

LICENSE

131       This is free software, distributed under the Artistic License 2.0.
132
133
134
135perl v5.38.0                      2023-07-21                    RAZOR-CHECK(1)