chiark / gitweb /
Initial commit as found
[modbot-mtm.git] / stump / local / man / man1 / pmcheck.1
1 .TH PMCHECK 1 "PGP Moose"
2 .\"@(#)pmcheck.1        1.5 (PGPMoose) 95/11/15
3 .SH NAME
4 pmcheck \- check veracity and applicability of
5 signatures in news articles.
6 .SH SYNOPSIS
7 .B pmcheck
8 .I [newsgroups|user] [file] 
9 .SH DESCRIPTION
10 .I Pmcheck
11 accepts an article from the named
12 .IR file
13 (or standard input if not specified),
14 and performs certain checks against digital
15 signatures present in X-Auth: headers
16 in the news articles. There are two common modes
17 of use
18 of \f2pmcheck\fP, and these are described
19 separately for simplicity, even though there is
20 considerable ability to mix-and-match.
21 .LP
22 The first use is when a person is reading news,
23 and sees an article and wishes to check whether
24 the article is an approved posting to a moderated
25 newsgroup, or an approved posting from a
26 particular individual user. Piping the article
27 through \f2pmcheck\fP will give a list of valid
28 signatures (or signatures which couldn't be
29 checked because corresponding PGP public keys
30 were unavailable), and of course generate error
31 messages for invalid signatures, which indicate
32 either forged or altered articles. Any alteration
33 might have been intentional, but bear in mind the
34 possibility that an alteration could have been an
35 artifact of the news system, despite precautions
36 against this.
37 .LP
38 The second use, and the reason for the existence
39 of the PGP Moose system, is when an article is
40 automatically checked upon receipt by a
41 designated news hub. In this case, a moderated
42 newsgroup or user name (represented by an
43 electronic mail address) will be specified, and
44 it is considered an error if there is no
45 corresponding X-Auth: header, or if for
46 any reason it doesn't check out. Furthermore, there
47 can be a configured file which lists pairs of
48 newsgroup/user names, and corresponding PGP user
49 IDs who are allowed to authorise such postings.
50 Even a valid signature from an individual who is
51 not listed in this file will be considered an
52 error. All X-Auth: headers will be
53 checked if their newsgroup/user name appears in
54 the checking file, the only way in which the
55 argument is special is that such a header for
56 that newsgroup or user \f3must\fP appear.
57 The intention is that any article which fails
58 this authentication process will be reported to
59 the user or newsgroup moderator(s), and might be
60 automatically cancelled. This is to react quickly
61 to spamming attacks on moderated newsgroups.
62 .SH EXIT STATUS
63 .I Pmcheck
64 returns an exit status of 0 if everything is all right, and non-zero otherwise.
65 In particular, an exit status of 1 means that the article was not
66 approved with the PGP Moose when it should have been, and a status of
67 2 is returned for all other authentication problems.
68 .SH SEE ALSO
69 .IR pmapp (1),
70 .IR pmcanon (1)
71 for a description of the fields which go into the
72 signature calculation,
73 the PGP User's Manual,
74 the PGP Moose README file for an understanding of
75 how it all hangs together.
76 .SH BUGS
77 Currently \f3pmcheck\fP always allows cancel
78 messages to pass, despite the fact that
79 \f3pmdaemon\fP always authenticates them. The
80 potential consequences of an automated cancellation-war were
81 simply too horrible to contemplate.
82 .SH AUTHOR
83 Greg Rose, RoSecure Software.