281 lines
7.1 KiB
HTML
281 lines
7.1 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of GPG-WKS-CLIENT</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>GPG-WKS-CLIENT</H1>
|
|
Section: GNU Privacy Guard 2.2 (1)<BR>Updated: 2019-11-23<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
<B>gpg-wks-client</B>
|
|
|
|
- Client for the Web Key Service
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<B>gpg-wks-client</B>
|
|
|
|
[<I>options</I>]
|
|
|
|
<B>--supported</B>
|
|
|
|
<I>user-id</I>
|
|
|
|
<BR>
|
|
|
|
<B>gpg-wks-client</B>
|
|
|
|
[<I>options</I>]
|
|
|
|
<B>--check</B>
|
|
|
|
<I>user-id</I>
|
|
|
|
<BR>
|
|
|
|
<B>gpg-wks-client</B>
|
|
|
|
[<I>options</I>]
|
|
|
|
<B>--create</B>
|
|
|
|
<I>fingerprint</I>
|
|
|
|
<I>user-id</I>
|
|
|
|
<BR>
|
|
|
|
<B>gpg-wks-client</B>
|
|
|
|
[<I>options</I>]
|
|
|
|
<B>--receive</B>
|
|
|
|
<BR>
|
|
|
|
<B>gpg-wks-client</B>
|
|
|
|
[<I>options</I>]
|
|
|
|
<B>--read</B>
|
|
|
|
<P>
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
The <B>gpg-wks-client</B> is used to send requests to a Web Key
|
|
Service provider. This is usuallay done to upload a key into a Web
|
|
Key Directory.
|
|
<P>
|
|
With the <B>--supported</B> command the caller can test whether a
|
|
site supports the Web Key Service. The argument is an arbitrary
|
|
address in the to be tested domain. For example
|
|
'<I><A HREF="mailto:foo@example.net">foo@example.net</A></I>'. The command returns success if the Web Key
|
|
Service is supported. The operation is silent; to get diagnostic
|
|
output use the option <B>--verbose</B>. See option
|
|
<B>--with-colons</B> for a variant of this command.
|
|
<P>
|
|
With the <B>--check</B> command the caller can test whether a key
|
|
exists for a supplied mail address. The command returns success if a
|
|
key is available.
|
|
<P>
|
|
The <B>--create</B> command is used to send a request for
|
|
publication in the Web Key Directory. The arguments are the
|
|
fingerprint of the key and the user id to publish. The output from
|
|
the command is a properly formatted mail with all standard headers.
|
|
This mail can be fed to <B><A HREF="/cgi-bin/man/man2html?8+sendmail">sendmail</A>(8)</B> or any other tool to
|
|
actually send that mail. If <B><A HREF="/cgi-bin/man/man2html?8+sendmail">sendmail</A>(8)</B> is installed the
|
|
option <B>--send</B> can be used to directly send the created
|
|
request. If the provider request a 'mailbox-only' user id and no such
|
|
user id is found, <B>gpg-wks-client</B> will try an additional user
|
|
id.
|
|
<P>
|
|
The <B>--receive</B> and <B>--read</B> commands are used to
|
|
process confirmation mails as send from the service provider. The
|
|
former expects an encrypted MIME messages, the latter an already
|
|
decrypted MIME message. The result of these commands are another mail
|
|
which can be send in the same way as the mail created with
|
|
<B>--create</B>.
|
|
<P>
|
|
The command <B>--install-key</B> manually installs a key into a
|
|
local directory (see option <B>-C</B>) reflecting the structure of a
|
|
WKD. The arguments are a file with the keyblock and the user-id to
|
|
install. If the first argument resembles a fingerprint the key is
|
|
taken from the current keyring; to force the use of a file, prefix the
|
|
first argument with "./". If no arguments are given the parameters
|
|
are read from stdin; the expected format are lines with the
|
|
fingerprint and the mailbox separated by a space. The command
|
|
<B>--remove-key</B> removes a key from that directory, its only
|
|
argument is a user-id.
|
|
<P>
|
|
The command <B>--print-wkd-hash</B> prints the WKD user-id identifiers
|
|
and the corresponding mailboxes from the user-ids given on the command
|
|
line or via stdin (one user-id per line).
|
|
<P>
|
|
The command <B>--print-wkd-url</B> prints the URLs used to fetch the
|
|
key for the given user-ids from WKD. The meanwhile preferred format
|
|
with sub-domains is used here.
|
|
<P>
|
|
<B>gpg-wks-client</B> is not commonly invoked directly and thus it
|
|
is not installed in the bin directory. Here is an example how it can
|
|
be invoked manually to check for a Web Key Directory entry for
|
|
'<I><A HREF="mailto:foo@example.org">foo@example.org</A></I>':
|
|
<P>
|
|
<DL COMPACT><DT id="1"><DD>
|
|
<PRE>
|
|
$(gpgconf --list-dirs libexecdir)/gpg-wks-client --check <A HREF="mailto:foo@example.net">foo@example.net</A>
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
<A NAME="lbAE"> </A>
|
|
<H2>OPTIONS</H2>
|
|
|
|
<P>
|
|
<B>gpg-wks-client</B> understands these options:
|
|
<P>
|
|
<P>
|
|
<DL COMPACT>
|
|
<DT id="2"><B>--send</B>
|
|
|
|
<DD>
|
|
Directly send created mails using the <B>sendmail</B> command.
|
|
Requires installation of that command.
|
|
<P>
|
|
<DT id="3"><B>--with-colons</B>
|
|
|
|
<DD>
|
|
This option has currently only an effect on the <B>--supported</B>
|
|
command. If it is used all arguments on the command line are taken
|
|
as domain names and tested for WKD support. The output format is one
|
|
line per domain with colon delimited fields. The currently specified
|
|
fields are (future versions may specify additional fields):
|
|
<P>
|
|
<DL COMPACT><DT id="4"><DD>
|
|
<P>
|
|
<DL COMPACT>
|
|
<DT id="5"><B>1 - domain</B>
|
|
|
|
<DD>
|
|
This is the domain name. Although quoting is not required for valid
|
|
domain names this field is specified to be quoted in standard C
|
|
manner.
|
|
<P>
|
|
<DT id="6"><B>2 - WKD</B>
|
|
|
|
<DD>
|
|
If the value is true the domain supports the Web Key Directory.
|
|
<P>
|
|
<DT id="7"><B>3 - WKS</B>
|
|
|
|
<DD>
|
|
If the value is true the domain supports the Web Key Service
|
|
protocol to upload keys to the directory.
|
|
<P>
|
|
<DT id="8"><B>4 - error-code</B>
|
|
|
|
<DD>
|
|
This may contain an gpg-error code to describe certain
|
|
failures. Use 'gpg-error CODE' to explain the code.
|
|
<P>
|
|
<DT id="9"><B>5 - protocol-version</B>
|
|
|
|
<DD>
|
|
The minimum protocol version supported by the server.
|
|
<P>
|
|
<DT id="10"><B>6 - auth-submit</B>
|
|
|
|
<DD>
|
|
The auth-submit flag from the policy file of the server.
|
|
<P>
|
|
<DT id="11"><B>7 - mailbox-only</B>
|
|
|
|
<DD>
|
|
The mailbox-only flag from the policy file of the server.
|
|
</DL>
|
|
</DL>
|
|
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<DT id="12"><B>--output </B><I>file</I>
|
|
|
|
<DD>
|
|
|
|
<B>-o</B>
|
|
|
|
Write the created mail to <I>file</I> instead of stdout. Note that the
|
|
value <B>-</B> for <I>file</I> is the same as writing to stdout.
|
|
<P>
|
|
<DT id="13"><B>--status-fd </B><I>n</I>
|
|
|
|
<DD>
|
|
Write special status strings to the file descriptor <I>n</I>.
|
|
This program returns only the status messages SUCCESS or FAILURE which
|
|
are helpful when the caller uses a double fork approach and can't
|
|
easily get the return code of the process.
|
|
<P>
|
|
<DT id="14"><B>-C </B><I>dir</I>
|
|
|
|
<DD>
|
|
|
|
<B>--directory </B><I>dir</I>
|
|
|
|
Use <I>dir</I> as top level directory for the commands
|
|
<B>--install-key</B> and <B>--remove-key</B>. The default is
|
|
'<I>openpgpkey</I>'.
|
|
<P>
|
|
<DT id="15"><B>--verbose</B>
|
|
|
|
<DD>
|
|
Enable extra informational output.
|
|
<P>
|
|
<DT id="16"><B>--quiet</B>
|
|
|
|
<DD>
|
|
Disable almost all informational output.
|
|
<P>
|
|
<DT id="17"><B>--version</B>
|
|
|
|
<DD>
|
|
Print version of the program and exit.
|
|
<P>
|
|
<DT id="18"><B>--help</B>
|
|
|
|
<DD>
|
|
Display a brief help page and exit.
|
|
<P>
|
|
</DL>
|
|
<P>
|
|
|
|
<P>
|
|
<P>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?1+gpg-wks-server">gpg-wks-server</A></B>(1)
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="19"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="20"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="21"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="22"><A HREF="#lbAE">OPTIONS</A><DD>
|
|
<DT id="23"><A HREF="#lbAF">SEE ALSO</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:15 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|