Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Thursday, June 13, 2019
 
 

gpg-wks-client (1)

Name

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

Synopsis

gpg-wks-client [options] --supported user-id
gpg-wks-client [options] --check user-id
gpg-wks-client [options] --create fingerprint user-id
gpg-wks-client [options] --receive
gpg-wks-client [options] --read

Description

GPG-WKS-CLIENT(1)            GNU Privacy Guard 2.2           GPG-WKS-CLIENT(1)



NAME
       gpg-wks-client - Client for the Web Key Service

SYNOPSIS
       gpg-wks-client [options] --supported user-id
       gpg-wks-client [options] --check user-id
       gpg-wks-client [options] --create fingerprint user-id
       gpg-wks-client [options] --receive
       gpg-wks-client [options] --read


DESCRIPTION
       The  gpg-wks-client  is  used  to  send  requests  to a Web Key Service
       provider.  This is usuallay done to upload a key into a Web Key  Direc-
       tory.

       With  the  --supported  command the caller can test whether a site sup-
       ports the Web Key Service.  The argument is an arbitray address in  the
       to  be  tested  domain.  For  example  `foo@example.net'.   The command
       returns success if the Web Key Service is supported.  The operation  is
       silent; to get diagnostic output use the option --verbose.

       With the --check command the caller can test whether a key exists for a
       supplied mail address.  The command returns success if a key is  avail-
       able.

       The  --create  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 for-
       matted mail with all standard headers.  This mail can be fed  to  send-
       mail(8)  or  any other tool to actually send that mail.  If sendmail(8)
       is installed the option --send 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, gpg-wks-client will try an additional user id.

       The --receive and --read 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 --create.

       gpg-wks-client 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  `foo@exam-
       ple.org':

         $(gpgconf --list-dirs libexecdir)/gpg-wks-client --check foo@example.net


OPTIONS
       gpg-wks-client understands these options:



       --send Directly   send   created  mails  using  the  sendmail  command.
              Requires installation of that command.


       --output file
       -o     Write the created mail to file instead of stdout.  Note that the
              value - for file is the same as writing to stdout.


       --status-fd n
              Write  special  status  strings  to the file descriptor n.  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.


       --verbose
              Enable extra informational output.


       --quiet
              Disable almost all informational output.


       --version
              Print version of the program and exit.


       --help Display a brief help page and exit.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | crypto/gnupg          |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+
SEE ALSO
       gpg-wks-server(1)






NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source                was                downloaded                from
       https://www.gnupg.org/ftp/gcrypt/gnupg/gnupg-2.2.8.tar.bz2

       Further information about this software can be found on the open source
       community website at http://www.gnupg.org/.



GnuPG 2.2.8                       2018-06-06                 GPG-WKS-CLIENT(1)