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 usually 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 re‐
24       turns 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  en‐
43       crypted  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

OPTIONS

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

SEE ALSO

154       gpg-wks-server(1)
155
156
157
158
159
160
161GnuPG 2.3.3                       2021-10-06                 GPG-WKS-CLIENT(1)
Impressum