7f7d515b748e57f4b4bf24705c2df5123af41942
[gnupg.git] / doc / wks.texi
1 @c wks.texi - man pages for the Web Key Service tools.
2 @c Copyright (C) 2017 g10 Code GmbH
3 @c Copyright (C) 2017 Bundesamt für Sicherheit in der Informationstechnik
4 @c This is part of the GnuPG manual.
5 @c For copying conditions, see the file GnuPG.texi.
6
7 @include defs.inc
8
9 @node Web Key Service
10 @chapter Web Key Service
11
12 GnuPG comes with tools used to maintain and access a Web Key
13 Directory.
14
15 @menu
16 * gpg-wks-client::        Send requests via WKS
17 * gpg-wks-server::        Server to provide the WKS.
18 @end menu
19
20 @c
21 @c  GPG-WKS-CLIENT
22 @c
23 @manpage gpg-wks-client.1
24 @node gpg-wks-client
25 @section Send requests via WKS
26 @ifset manverb
27 .B gpg-wks-client
28 \- Client for the Web Key Service
29 @end ifset
30
31 @mansect synopsis
32 @ifset manverb
33 .B gpg-wks-client
34 .RI [ options ]
35 .B \-\-supported
36 .I user-id
37 .br
38 .B gpg-wks-client
39 .RI [ options ]
40 .B \-\-check
41 .I user-id
42 .br
43 .B gpg-wks-client
44 .RI [ options ]
45 .B \-\-create
46 .I fingerprint
47 .I user-id
48 .br
49 .B gpg-wks-client
50 .RI [ options ]
51 .B \-\-receive
52 .br
53 .B gpg-wks-client
54 .RI [ options ]
55 .B \-\-read
56 @end ifset
57
58 @mansect description
59 The @command{gpg-wks-client} is used to send requests to a Web Key
60 Service provider.  This is usuallay done to upload a key into a Web
61 Key Directory.
62
63 With the @option{--supported} command the caller can test whether a
64 site supports the Web Key Service.  The argument is an arbitray
65 address in the to be tested domain. For example
66 @file{foo@@example.net}.  The command returns success if the Web Key
67 Service is supported.  The operation is silent; to get diagnostic
68 output use the option @option{--verbose}.
69
70 With the @option{--check} command the caller can test whether a key
71 exists for a supplied mail address.  The command returns success if a
72 key is available.
73
74 The @option{--create} command is used to send a request for
75 publication in the Web Key Directory.  The arguments are the
76 fingerprint of the key and the user id to publish.  The output from
77 the command is a properly formatted mail with all standard headers.
78 This mail can be fed to @command{sendmail(8)} or any other tool to
79 actually send that mail.  If @command{sendmail(8)} is installed the
80 option @option{--send} can be used to directly send the created
81 request.  If the provider request a 'mailbox-only' user id and no such
82 user id is found, @command{gpg-wks-client} will try an additional user
83 id.
84
85 The @option{--receive} and @option{--read} commands are used to
86 process confirmation mails as send from the service provider.  The
87 former expects an encrypted MIME messages, the latter an already
88 decrypted MIME message.  The result of these commands are another mail
89 which can be send in the same way as the mail created with
90 @option{--create}.
91
92 @command{gpg-wks-client} is not commonly invoked directly and thus it
93 is not installed in the bin directory.  Here is an example how it can
94 be invoked manually to check for a Web Key Directory entry for
95 @file{foo@@example.org}:
96
97 @example
98 $(gpgconf --list-dirs libexecdir)/gpg-wks-client --check foo@@example.net
99 @end example
100
101 @mansect options
102 @noindent
103 @command{gpg-wks-client} understands these options:
104
105 @table @gnupgtabopt
106
107 @item --send
108 @opindex send
109 Directly send created mails using the @command{sendmail} command.
110 Requires installation of that command.
111
112 @item --output @var{file}
113 @itemx -o
114 @opindex output
115 Write the created mail to @var{file} instead of stdout.  Note that the
116 value @code{-} for @var{file} is the same as writing to stdout.
117
118 @item --status-fd @var{n}
119 @opindex status-fd
120 Write special status strings to the file descriptor @var{n}.
121 This program returns only the status messages SUCCESS or FAILURE which
122 are helpful when the caller uses a double fork approach and can't
123 easily get the return code of the process.
124
125 @item --verbose
126 @opindex verbose
127 Enable extra informational output.
128
129 @item --quiet
130 @opindex quiet
131 Disable almost all informational output.
132
133 @item --version
134 @opindex version
135 Print version of the program and exit.
136
137 @item --help
138 @opindex help
139 Display a brief help page and exit.
140
141 @end table
142
143
144 @mansect see also
145 @ifset isman
146 @command{gpg-wks-server}(1)
147 @end ifset
148
149
150 @c
151 @c  GPG-WKS-SERVER
152 @c
153 @manpage gpg-wks-server.1
154 @node gpg-wks-server
155 @section Provide the Web Key Service
156 @ifset manverb
157 .B gpg-wks-server
158 \- Server providing the Web Key Service
159 @end ifset
160
161 @mansect synopsis
162 @ifset manverb
163 .B gpg-wks-server
164 .RI [ options ]
165 .B \-\-receive
166 .br
167 .B gpg-wks-server
168 .RI [ options ]
169 .B \-\-cron
170 .br
171 .B gpg-wks-server
172 .RI [ options ]
173 .B \-\-list-domains
174 .br
175 .B gpg-wks-server
176 .RI [ options ]
177 .B \-\-check-key
178 .I user-id
179 .br
180 .B gpg-wks-server
181 .RI [ options ]
182 .B \-\-install-key
183 .I file
184 .br
185 .B gpg-wks-server
186 .RI [ options ]
187 .B \-\-remove-key
188 .I user-id
189 .br
190 .B gpg-wks-server
191 .RI [ options ]
192 .B \-\-revoke-key
193 .I user-id
194 @end ifset
195
196 @mansect description
197 The @command{gpg-wks-server} is a server site implementation of the
198 Web Key Service.  It receives requests for publication, sends
199 confirmation requests, receives confirmations, and published the key.
200 It also has features to ease the setup and maintenance of a Web Key
201 Directory.
202
203 When used with the command @option{--receive} a single Web Key Service
204 mail is processed.  Commonly this command is used with the option
205 @option{--send} to directly send the crerated mails back.  See below
206 for an installation example.
207
208 The command @option{--cron} is used for regualr cleanup tasks.  For
209 example non-confirmed requested should be removed after their expire
210 time.  It is best to run this command once a day from a cronjob.
211
212 The command @option{--list-domains} prints all configured domains.
213 Further it creates missing directories for the configuration and
214 prints warnings pertaining to problems in the configuration.
215
216 The command @option{--check-key} (or just @option{--check}) checks
217 whether a key with the given user-id is installed.  The process return
218 success in this case; to also print a diagnostic, use option
219 @option{-v}.  If the key is not installed a diagnostics is printed and
220 the process returns failure; to suppress the diagnostic, use option
221 @option{-q}.  More than one user-id can be given; see also option
222 @option{with-file}.
223
224 The command @option{--remove-key} uninstalls a key from the WKD.  The
225 process return success in this case; to also print a diagnostic, use
226 option @option{-v}.  If the key is not installed a diagnostics is
227 printed and the process returns failure; to suppress the diagnostic,
228 use option @option{-q}.
229
230 The commands @option{--install-key} and @option{--revoke-key} are not
231 yet functional.
232
233
234 @mansect options
235 @noindent
236 @command{gpg-wks-server} understands these options:
237
238 @table @gnupgtabopt
239
240 @item --from @var{mailaddr}
241 @opindex from
242 Use @var{mailaddr} as the default sender address.
243
244 @item --header @var{name}=@var{value}
245 @opindex header
246 Add the mail header "@var{name}: @var{value}" to all outgoing mails.
247
248 @item --send
249 @opindex send
250 Directly send created mails using the @command{sendmail} command.
251 Requires installation of that command.
252
253 @item --output @var{file}
254 @itemx -o
255 @opindex output
256 Write the created mail also to @var{file}. Note that the value
257 @code{-} for @var{file} would write it to stdout.
258
259 @item --with-dir
260 @opindex with-dir
261 Also print the directory name for each domain listed by command
262 @option{--list-domains}.
263
264 @item --with-file
265 @opindex with-file
266 With command @option{--check-key} print for each user-id, the address,
267 'i' for installed key or 'n' for not installed key, and the filename.
268
269 @item --verbose
270 @opindex verbose
271 Enable extra informational output.
272
273 @item --quiet
274 @opindex quiet
275 Disable almost all informational output.
276
277 @item --version
278 @opindex version
279 Print version of the program and exit.
280
281 @item --help
282 @opindex help
283 Display a brief help page and exit.
284
285 @end table
286
287 @noindent
288 @mansect examples
289 @chapheading Examples
290
291 The Web Key Service requires a working directory to store keys
292 pending for publication.  As root create a working directory:
293
294 @example
295   # mkdir /var/lib/gnupg/wks
296   # chown webkey:webkey /var/lib/gnupg/wks
297   # chmod 2750 /var/lib/gnupg/wks
298 @end example
299
300 Then under your webkey account create directories for all your
301 domains.  Here we do it for "example.net":
302
303 @example
304   $ mkdir /var/lib/gnupg/wks/example.net
305 @end example
306
307 Finally run
308
309 @example
310   $ gpg-wks-server --list-domains
311 @end example
312
313 to create the required sub-directories with the permission set
314 correctly.  For each domain a submission address needs to be
315 configured.  All service mails are directed to that address.  It can
316 be the same address for all configured domains, for example:
317
318 @example
319   $ cd /var/lib/gnupg/wks/example.net
320   $ echo key-submission@@example.net >submission-address
321 @end example
322
323 The protocol requires that the key to be published is sent with an
324 encrypted mail to the service.  Thus you need to create a key for
325 the submission address:
326
327 @example
328   $ gpg --batch --passphrase '' --quick-gen-key key-submission@@example.net
329   $ gpg --with-wkd-hash -K key-submission@@example.net
330 @end example
331
332 The output of the last command looks similar to this:
333
334 @example
335   sec   rsa2048 2016-08-30 [SC]
336         C0FCF8642D830C53246211400346653590B3795B
337   uid           [ultimate] key-submission@@example.net
338                 bxzcxpxk8h87z1k7bzk86xn5aj47intu@@example.net
339   ssb   rsa2048 2016-08-30 [E]
340 @end example
341
342 Take the hash of the string "key-submission", which is
343 "bxzcxpxk8h87z1k7bzk86xn5aj47intu" and manually publish that key:
344
345 @example
346   $ gpg --export-options export-minimal --export \
347   >  -o /var/lib/gnupg/wks/example.net/hu/bxzcxpxk8h87z1k7bzk86xn5aj47intu \
348   >  key-submission@@example.new
349 @end example
350
351 Make sure that the created file is world readable.
352
353 Finally that submission address needs to be redirected to a script
354 running @command{gpg-wks-server}.  The @command{procmail} command can
355 be used for this: Redirect the submission address to the user "webkey"
356 and put this into webkey's @file{.procmailrc}:
357
358 @example
359 :0
360 * !^From: webkey@@example.net
361 * !^X-WKS-Loop: webkey.example.net
362 |gpg-wks-server -v --receive \
363      --header X-WKS-Loop=webkey.example.net \
364      --from webkey@@example.net --send
365 @end example
366
367
368 @mansect see also
369 @ifset isman
370 @command{gpg-wks-client}(1)
371 @end ifset