1GPG-WKS-CLIENT(1)            GNU Privacy Guard 2.2           GPG-WKS-CLIENT(1)
2
3
4

NAME

6       gpg-wks-client - Client for the Web Key Service
7

SYNOPSIS

9       gpg-wks-client [options] --supported user-id
10       gpg-wks-client [options] --check user-id
11       gpg-wks-client [options] --create fingerprint user-id
12       gpg-wks-client [options] --receive
13       gpg-wks-client [options] --read
14
15

DESCRIPTION

17       The  gpg-wks-client  is  used  to  send  requests  to a Web Key Service
18       provider.  This is usuallay done to upload a key into a Web Key  Direc‐
19       tory.
20
21       With  the  --supported  command the caller can test whether a site sup‐
22       ports the Web Key Service.  The argument is an arbitrary address in the
23       to  be  tested  domain.  For  example  ‘foo@example.net’.   The command
24       returns success if the Web Key Service is supported.  The operation  is
25       silent;  to get diagnostic output use the option --verbose.  See option
26       --with-colons for a variant of this command.
27
28       With the --check command the caller can test whether a key exists for a
29       supplied  mail address.  The command returns success if a key is avail‐
30       able.
31
32       The --create command is used to send a request for publication  in  the
33       Web  Key  Directory.   The arguments are the fingerprint of the key and
34       the user id to publish.  The output from the command is a properly for‐
35       matted  mail  with all standard headers.  This mail can be fed to send‐
36       mail(8) or any other tool to actually send that mail.   If  sendmail(8)
37       is installed the option --send can be used to directly send the created
38       request.  If the provider request a 'mailbox-only' user id and no  such
39       user id is found, gpg-wks-client will try an additional user id.
40
41       The  --receive  and  --read  commands  are used to process confirmation
42       mails as send  from  the  service  provider.   The  former  expects  an
43       encrypted  MIME messages, the latter an already decrypted MIME message.
44       The result of these commands are another mail which can be send in  the
45       same way as the mail created with --create.
46
47       The  command  --install-key manually installs a key into a local direc‐
48       tory (see option -C) reflecting the structure of a WKD.  The  arguments
49       are  a file with the keyblock and the user-id to install.  If the first
50       argument resembles a fingerprint the key  is  taken  from  the  current
51       keyring;  to  force  the  use of a file, prefix the first argument with
52       "./".  If no arguments are given the parameters are  read  from  stdin;
53       the expected format are lines with the fingerprint and the mailbox sep‐
54       arated by a space.  The command --remove-key removes a  key  from  that
55       directory, its only argument is a user-id.
56
57       The command --print-wkd-hash prints the WKD user-id identifiers and the
58       corresponding mailboxes from the user-ids given on the command line  or
59       via stdin (one user-id per line).
60
61       The  command  --print-wkd-url prints the URLs used to fetch the key for
62       the given user-ids from WKD.  The meanwhile preferred format with  sub-
63       domains is used here.
64
65       gpg-wks-client  is  not  commonly  invoked  directly and thus it is not
66       installed in the bin directory.  Here is  an  example  how  it  can  be
67       invoked  manually to check for a Web Key Directory entry for ‘foo@exam‐
68       ple.org’:
69
70         $(gpgconf --list-dirs libexecdir)/gpg-wks-client --check foo@example.net
71
72

OPTIONS

74       gpg-wks-client understands these options:
75
76
77
78       --send Directly  send  created  mails  using  the   sendmail   command.
79              Requires installation of that command.
80
81
82       --with-colons
83              This option has currently only an effect on the --supported com‐
84              mand.  If it is used all arguments on the command line are taken
85              as  domain  names and tested for WKD support.  The output format
86              is one line per domain with colon delimited  fields.   The  cur‐
87              rently  specified  fields are (future versions may specify addi‐
88              tional fields):
89
90
91
92              1 - domain
93                     This  is  the  domain  name.   Although  quoting  is  not
94                     required  for  valid domain names this field is specified
95                     to be quoted in standard C manner.
96
97
98              2 - WKD
99                     If the value is true the  domain  supports  the  Web  Key
100                     Directory.
101
102
103              3 - WKS
104                     If the value is true the domain supports the Web Key Ser‐
105                     vice protocol to upload keys to the directory.
106
107
108              4 - error-code
109                     This may contain an gpg-error code  to  describe  certain
110                     failures.  Use 'gpg-error CODE' to explain the code.
111
112
113              5 - protocol-version
114                     The minimum protocol version supported by the server.
115
116
117              6 - auth-submit
118                     The auth-submit flag from the policy file of the server.
119
120
121              7 - mailbox-only
122                     The mailbox-only flag from the policy file of the server.
123
124
125
126
127       --output file
128       -o     Write the created mail to file instead of stdout.  Note that the
129              value - for file is the same as writing to stdout.
130
131
132       --status-fd n
133              Write special status strings to the  file  descriptor  n.   This
134              program  returns  only  the  status  messages SUCCESS or FAILURE
135              which are helpful when the caller uses a  double  fork  approach
136              and can't easily get the return code of the process.
137
138
139       -C dir
140       --directory dir
141              Use  dir  as  top level directory for the commands --install-key
142              and --remove-key.  The default is ‘openpgpkey’.
143
144
145       --verbose
146              Enable extra informational output.
147
148
149       --quiet
150              Disable almost all informational output.
151
152
153       --version
154              Print version of the program and exit.
155
156
157       --help Display a brief help page and exit.
158
159

SEE ALSO

161       gpg-wks-server(1)
162
163
164
165
166
167
168GnuPG 2.2.18                      2019-11-23                 GPG-WKS-CLIENT(1)
Impressum