razor-report(1)

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

NAME

6       "razor-report" - Razor Reporting Agent
7

SYNOPSIS

9           razor-report [options]  file_with_mail_in_rfc822_format
10
11           $ cat mail | razor-report
12           $ razor-report ./mail
13           $ razor-report -d ./mail
14

DESCRIPTION

16       "razor-report" is the Razor Reporting Agent which is used for reporting
17       spam messages to a Razor Nomination Server. "razor-report" should be
18       generally called from a MUA, although there are no restrictions on
19       invoking it from the command-line. "razor-report" is a filter, which
20       means that spam messages should be piped through it. By default,
21       "razor-report" backgrounds and detaches itself from the control
22       terminal at start-up.
23
24       If "razor-report" is passed more than one mail, it will report each
25       against the database.  Please use this with caution, we don't want the
26       database filled up with mails incorrectly identified as spam.
27       "razor-report" supports mbox-formatted files with 1 or more mails in
28       them as well as files containing a single RFC 822 (non-mbox) mail.
29       More than one file may be present on the command line, can be either a
30       non-mbox or mbox in any order.
31
32       However, more than one non-mbox mail cannot be read from stdin.  Both
33       "razor-report" and razor-revoke(1) require user authentication to work,
34       see razor-admin(1). This allows the Razor Nomination Server to keep
35       track of how many messages a user reports and revokes. The more
36       messages a user correctly reports and/or correctly revokes, the more
37       trust the user earns. Likewise, when messages are incorrectly reported
38       or revoked, the trust goes down for that user. Highly trusted users
39       will have the most affect on the Razor Catalogue.
40

USAGE

42       "razor-report" takes following arguments:
43
44       "-h"
45           Print a usage message and exit.
46
47       "-v"
48           Print the version number and exit.
49
50       "-d | --verbose"
51           Print debugging information to stdout.
52
53       "-debuglevel=n | -dl=n"
54           Set debug level to 'n'.  Default is 3 without "-d" option, 9 with.
55
56       "-whitelist=file"
57           Specify file to use for whitelisting.  Overrides 'whitelist' option
58           in "razor-agent.conf".
59
60       "-s"
61           Simulate a check. Do everything except talk to the server.
62
63       "-conf=filename"
64           Specifies an alternate configuration file.  If not specified, it is
65           computed, see razor-agents(1) manpage for details.  See
66           razor-agent.conf(5) manpage for various configuration options.  The
67           default is "<razorhome>/razor-agent.conf".
68
69       "-home=dir"
70           Specify razorhome directory.  This is where the configuration file,
71           logfiles, identities, and server files live.  If not specified, it
72           is computed, see razor-agents(1) manpage for details.
73
74       "-logfile=file"
75           Specify file to log to instead of whats in configuration file.  The
76           default is "<razorhome>/razor-agent.log".
77
78       "-ident=filename"
79           Specify an identify file to use for authenticating with Razor
80           Servers.  If not specified, "<razorhome>/identity-<user>" is used.
81
82       "-rs=razor.server.com"
83           Use this Razor Nomination Server instead of reading
84           "servers.nomination.lst".
85
86       "-H"
87           Compute and print the signature of the mail contents and exit. If
88           "-e=integer" is not specified, all supported engines will be used.
89
90       "-S=string"
91           Accept a list of pre-computed (with "-H") signatures on the command
92           line, instead of computing one from mail content. Signatures can be
93           submitted in hex or base64, but base64 is preferred. Requires
94           "-e=integer". Usage:
95
96           razor-report -e 1 -S a8a3d545adb73f9733675571ffeaf10cba87745b
97
98       "-e=integer"
99           Specify engine used to create signatures. Must be 1, 2, 3, or 4 in
100           this version. Engine 1, or "-e=1", is used for Razor 1.x
101           signatures. Used only with "-S=string" or "-H".
102
103       "-ep4=string"
104           String used by engine 4 when computing signatures. Published by the
105           Razor Nomination Servers and updated very frequently. Used only
106           when "-e=4".
107
108       "-i=filename"
109           Use identity from filename instead of reading <razorhome>/identity.
110           Razor Servers compute trust for each unique identity.  Razor Agents
111           figure out the identity by a 2 step process.  First, check if
112           identity is specified via cmd-line (-i=file).  If not there, then
113           look in <razorhome> for identity file.  If <razorhome> has no
114           identity file, authentication will fail - you cannot report or
115           revoke.  See razor-agents.conf(5) for more on <razorhome>.
116           ---fixme----
117
118       "-a"
119           Authenticate only.  If authenticated, exit 0; if not, exit 1.
120
121       "-f"
122           Stay in foreground, do not detach and run in background.
123

INTEGRATION WITH MUTT

125       Add the following line to "mutt.conf"
126
127            macro index S "|/usr/bin/razor-report"
128
129       Then press S on the spam message in "mutt" to report it with
130       "razor-report". Since "razor-report" forks, the control will return
131       immediately.
132

AUTHORS

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

LICENSE

141       This is free software, distributed under the Artistic License 2.0.
142
143
144
145perl v5.30.1                      2020-01-30                   RAZOR-REPORT(1)