.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "RAZOR-WHITELIST 1"
.TH RAZOR-WHITELIST 1 2023-07-25 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
"razor\-whitelist" \- Format for Vipul's Razor Whitelist
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The razor whitelist is a list of email addresses and body signatures.
Emails that match the whitelist are not processed by any of the Razor Agents.
That is, They are not checked, reported, or revoked.  In the case of 
\&\fBrazor\-check\fR\|(1), they are instantly marked as non-spam.
.SH LOCATION
.IX Header "LOCATION"
The razor whitelist is usually \f(CW\*(C`<razorhome>/razor\-whitelist\*(C'\fR. The
\&\f(CW\*(C`whitelist\*(C'\fR parameter in \fBrazor\-agent.conf\fR\|(5) should point to this file. If the
\&\f(CW\*(C`whitelist\*(C'\fR parameter in \fBrazor\-agent.conf\fR\|(5) is missing, \f(CW\*(C`whitelist\*(C'\fR is not used.
.SH FORMAT
.IX Header "FORMAT"
Each whitelist rule is placed on a line of its own. Lines that begin in a
`#' character are considered to be comments and are ignored by the parser.
A rule contains the name of a header and the string to match against the
header, separated by whitespace. Here are some examples:
.PP
.Vb 2
\& to bugtraq@securityfocus.com
\& cc a.list@somewhere.net
.Ve
.PP
These rules imply that when a mail contains \f(CW\*(C`bugtraq@securityfocus.com\*(C'\fR
in its `to' and `cc' headers, it should be whitelisted. It's worth
noting that a match occurs if the address string matches any part of the address.
.PP
.Vb 1
\& from @mydomain.com
.Ve
.PP
A special rule called `sha1' can be used for whitelisting signatures. For example:
.PP
.Vb 1
\& sha1 75f8bcc2357366bbfa9c6ab0b6e5648ed0cf7083
.Ve
.PP
whitelists a message with the body of `test'.
.SH AUTHORS
.IX Header "AUTHORS"
Vipul Ved Prakash <mail@vipul.net>, and Chad Norwood <chad@samo.org>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBrazor\-agents\fR\|(1), \fBrazor\-agent.conf\fR\|(5), \fBrazor\-check\fR\|(1), 
\&\fBrazor\-admin\fR\|(1),  \fBrazor\-report\fR\|(1), \fBrazor\-revoke\fR\|(1)
.SH LICENSE
.IX Header "LICENSE"
This is free software, distributed under the Artistic License 2.0.