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 cata‐
20       logued on the server (spam) or 1 if the mail is not catalogued by the
21       server (not a spam). "razor-check" should be invoked against every
22       incoming mail by mail processors (like procmail) or MTAs (like send‐
23       mail). An alternate method would be to call "razor-check" from cron, at
24       regular intervals, to identify and mark spam in queued mailboxes.
25
26       If "razor-check" is passed more than one mail, it will check each
27       against the database, printing out the serial number of every mail con‐
28       sidered to be spam.  "razor-check" supports mbox-formatted files with 1
29       or more mails in them as well as files containing a single RFC 822
30       (non-mbox) mail.  More than one file may be present on the command
31       line, can be either a non-mbox or mbox in any order.  However, more
32       than one non-mbox mail cannot be read from stdin.
33

USAGE

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

RECIPES

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

AUTHORS

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

LICENSE

130       This is free software, distributed under the ARTISTIC license.
131
132
133
134perl v5.8.8                       2002-07-26                    RAZOR-CHECK(1)