gpg: Add option --weak-digest to gpg and gpgv.
[gnupg.git] / doc / gpgv.texi
1 @c Copyright (C) 2004 Free Software Foundation, Inc.
2 @c This is part of the GnuPG manual.
3 @c For copying conditions, see the file GnuPG.texi.
4
5 @c
6 @c This is included by tools.texi.
7 @c
8
9 @include defs.inc
10
11 @c Begin GnuPG 1.x specific stuff
12 @ifset gpgone
13 @macro gpgvname
14 gpgv
15 @end macro
16 @manpage gpgv.1
17 @node gpgv
18 @section Verify OpenPGP signatures
19 @ifset manverb
20 .B gpgv
21 \- Verify OpenPGP signatures
22 @end ifset
23
24 @mansect synopsis
25 @ifset manverb
26 .B  gpgv
27 .RI [ options ]
28 .I signed_files
29 @end ifset
30 @end ifset
31 @c End GnuPG 1.x specific stuff
32
33 @c Begin GnuPG 2 specific stuff
34 @ifclear gpgone
35 @macro gpgvname
36 gpgv2
37 @end macro
38 @manpage gpgv2.1
39 @node gpgv
40 @section Verify OpenPGP signatures
41 @ifset manverb
42 .B gpgv2
43 \- Verify OpenPGP signatures
44 @end ifset
45
46 @mansect synopsis
47 @ifset manverb
48 .B  gpgv2
49 .RI [ options ]
50 .I signed_files
51 @end ifset
52 @end ifclear
53 @c End GnuPG 2 specific stuff
54
55
56
57 @mansect description
58 @code{@gpgvname} is an OpenPGP signature verification tool.
59
60 This program is actually a stripped-down version of @code{gpg} which is
61 only able to check signatures. It is somewhat smaller than the fully-blown
62 @code{gpg} and uses a different (and simpler) way to check that
63 the public keys used to make the signature are valid. There are
64 no configuration files and only a few options are implemented.
65
66 @code{@gpgvname} assumes that all keys in the keyring are trustworthy.
67 That does also mean that it does not check for expired or revoked
68 keys.
69
70 By default a keyring named @file{trustedkeys.kbx} is used; if that
71 does not exist a keyring named @file{trustedkeys.gpg} is used.  The
72 default keyring is assumed to be in the home directory of GnuPG,
73 either the default home directory or the one set by an option or an
74 environment variable.  The option @code{--keyring} may be used to
75 specify a different keyring or even multiple keyrings.
76
77
78 @noindent
79 @mansect options
80 @code{@gpgvname} recognizes these options:
81
82 @table @gnupgtabopt
83
84 @item --verbose
85 @itemx -v
86 @opindex verbose
87 Gives more information during processing. If used
88 twice, the input data is listed in detail.
89
90 @item --quiet
91 @itemx -q
92 @opindex quiet
93 Try to be as quiet as possible.
94
95 @item --keyring @var{file}
96 @opindex keyring
97 Add @var{file} to the list of keyrings.
98 If @var{file} begins with a tilde and a slash, these
99 are replaced by the HOME directory. If the filename
100 does not contain a slash, it is assumed to be in the
101 home-directory ("~/.gnupg" if --homedir is not used).
102
103 @item --status-fd @var{n}
104 @opindex status-fd
105 Write special status strings to the file descriptor @var{n}.  See the
106 file DETAILS in the documentation for a listing of them.
107
108 @item --logger-fd @code{n}
109 @opindex logger-fd
110 Write log output to file descriptor @code{n} and not to stderr.
111
112 @item --ignore-time-conflict
113 @opindex ignore-time-conflict
114 GnuPG normally checks that the timestamps associated with keys and
115 signatures have plausible values. However, sometimes a signature seems to
116 be older than the key due to clock problems. This option turns these
117 checks into warnings.
118
119 @include opt-homedir.texi
120
121 @item --weak-digest @code{name}
122 @opindex weak-digest
123 Treat the specified digest algorithm as weak.  Signatures made over
124 weak digests algorithms are normally rejected. This option can be
125 supplied multiple times if multiple algorithms should be considered
126 weak.  MD5 is always considered weak, and does not need to be listed
127 explicitly.
128
129 @end table
130
131 @mansect return value
132
133 The program returns 0 if everything is fine, 1 if at least
134 one signature was bad, and other error codes for fatal errors.
135
136 @mansect examples
137 @subsection Examples
138
139 @table @asis
140
141 @item @gpgvname @code{pgpfile}
142 @itemx @gpgvname @code{sigfile} [@code{datafile}]
143 Verify the signature of the file. The second form is used for detached
144 signatures, where @code{sigfile} is the detached signature (either
145 ASCII-armored or binary) and @code{datafile} contains the signed data;
146 if @code{datafile} is "-" the signed data is expected on
147 @code{stdin}; if @code{datafile} is not given the name of the file
148 holding the signed data is constructed by cutting off the extension
149 (".asc", ".sig" or ".sign") from @code{sigfile}.
150
151 @end table
152
153 @mansect environment
154 @subsection Environment
155
156 @table @asis
157
158 @item HOME
159 Used to locate the default home directory.
160
161 @item GNUPGHOME
162 If set directory used instead of "~/.gnupg".
163
164 @end table
165
166 @mansect files
167 @subsection FILES
168
169 @table @asis
170
171 @item ~/.gnupg/trustedkeys.gpg
172 The default keyring with the allowed keys.
173
174 @end table
175
176 @mansect see also
177 @command{gpg2}(1)
178 @include see-also-note.texi
179