home *** CD-ROM | disk | FTP | other *** search
/ PC World 1999 February / PCWorld_1999-02_cd.bin / software / servis / Pgp31 / pgpk.doc < prev    next >
Encoding:
Text File  |  1998-03-14  |  6.0 KB  |  155 lines
  1.  
  2. PGPK(1)                          User Manual                          PGPK(1)
  3.  
  4. NAME
  5.   pgpk - Public and Private key management for PGP.
  6.  
  7. SYNOPSIS
  8.   pgpk [-a keyfile ... | -c [userid] | -d <userid> | -e <userid>
  9.   | -g | -l[l] [userid] | --revoke[s] <userid> | -r[u|s] <userid>
  10.   | -s <userid> [-u <yourid>] | -x <userid> [-o <outfile>]] [-z]
  11.  
  12. DESCRIPTION
  13.   pgpk Manages public and private keys for PGP.  Unlike other PGP applica-
  14.   tions, pgpk is stream based and not file based; if no files are specified,
  15.   stdin and stdout are used.
  16.  
  17. OPTIONS
  18.   All configuration options can be controlled from the command line.  See
  19.   pgp.cfg(5) for a complete list and how to specify them.
  20.  
  21.   -a [keyfile]
  22.        Adds the contents of keyfile to your keyring.  If keyfile is not
  23.        specified, input is taken from stdin.  Keyfile may also be an URL; the
  24.        supported protocols are hkp (Horowitz Key Protocol), http and finger.
  25.        To add foo@bar.baz.com's key to your keyring from PGP, Inc's server,
  26.        for example, enter:
  27.  
  28.        pgpk -a hkp://keys.pgp.com/foo@bar.baz.com
  29.  
  30.        If foo@bar.baz.com has his key in his finger information, you could
  31.        add that with:
  32.  
  33.        pgpk -a finger://bar.baz.com/foo
  34.  
  35.        If foo@bar.baz.com has his key on his web page, you could add that
  36.        with:
  37.  
  38.        pgpk -a http://www.baz.com/foo/DSSkey.html
  39.  
  40.        If the Keyfile is not obviously a filename (it doesn't begin with "/"
  41.        or "./") and it doesn't exist as a readable file, an attempt will be
  42.        made to fetch it from your default keyserver using the Horowitz Key
  43.        Protocol.  (See pgp.cfg(5) for information on setting your default
  44.        keyserver).  For example, if there is no file named foo@bar.baz.com
  45.        readable in the current directory,
  46.  
  47.        pgpk -a foo@bar.baz.com
  48.  
  49.        will extract foo@bar.baz.com's key from your default keyserver.  Some
  50.        people consider this a security risk (as it could potentially leak
  51.        information about the files on your system if you make a typing
  52.        error).  Use the GetNotFoundKeyFiles configuration option to disable
  53.        this behavior.
  54.  
  55.   -c [userid]
  56.        Checks the signatures of all keys on your public keyring.  If [userid]
  57.        is specified, only the signatures on that key are checked.  This com-
  58.        mand performs pgpk -ll on all specified keys, then outputs an explicit
  59.        listing of trust and validity for each key.  Trust is the amount of
  60.        trust placed in each key as an introducer.  Validity is the certainty
  61.        that the key and user ID belong together.  Both this command and the
  62.        long listing function output a leading column which succinctly
  63.        describes the condition of the key.
  64.  
  65.        The possible leading columns can have the following first three char-
  66.        acter values:
  67.  
  68.        pub A public key
  69.        ret A revoked key
  70.        sec A secret key
  71.        sub A sub-key (in 5.0, this is always a Diffie-Hellman key)
  72.        SIG A signature issued by a public key to which you have
  73.        thecorresponding private key (i.e., your key)
  74.        sig A signature issued by a public key to which you do NOT have the
  75.        corresponding private key (i.e., someone else's key)
  76.        uid A user ID
  77.  
  78.        Following this column is a single character which describes other
  79.        attributes of the object:
  80.  
  81.        % The object is not valid (it does not have enough trusted signatures)
  82.        ? No information is available about the object (generally because it
  83.        is a signature from a key that is not on your keyring)
  84.        ! The object has been checked
  85.        * The object has been tried
  86.        @ The object is disabled
  87.        + The object is axiomatically trusted (i.e., it's your key)
  88.  
  89.   -d <userid>
  90.        Toggles the disablement of <userid>'s key on your public keyring.
  91.  
  92.   -e <userid>
  93.        Edits <userid>'s key.  If this is your key, it allows you to edit your
  94.        userid(s) and passphrase.  If it is someone else's key, it allows you
  95.        to edit the trust you have in that person as an introducer.
  96.  
  97.   -g   Generate a public/private key pair.
  98.  
  99.   -l[l] [userid]
  100.        Lists information about a key.  -ll lists more information about a
  101.        key.  If [userid] is specified, that key is listed.  Otherwise, all
  102.        keys are listed.  See -c, above, for more information about the long
  103.        format.
  104.  
  105.   -o outfile
  106.        Specifies that output should go to outfile.  If not specified, output
  107.        goes to stdout.  If the output file is from a key extraction (see -x,
  108.        below), you may specify an hkp (Horowitz Key Protocol) URL.  For exam-
  109.        ple: pgpk -x foo@bar.baz.com -o hkp://keys.pgp.com would send
  110.        foo@bar.baz.com's key to the PGP, Inc. public key server.
  111.  
  112.   --revoke <userid>
  113.        Permanently revokes the key specified.  There is no way to undo this,
  114.        so don't play with it if you don't mean it.
  115.  
  116.   --revokes <userid>
  117.        Permanently revokes your signature (if any) on the key specified.
  118.  
  119.   -r <userid>
  120.        Removes <userid>'s key from your public keyring, and your private as
  121.        well, if it's there.
  122.  
  123.   -ru <userid>
  124.        Removes the given userid from your public and private keyrings.
  125.  
  126.   -rs <userid>
  127.        Removes the given signature from your public keyring.
  128.  
  129.   -s <userid> [-u <yourid>]
  130.        Signs <userid>'s key with your default signing key.  If -u is speci-
  131.        fied, uses that key, instead.
  132.  
  133.   -x <userid>
  134.        Extracts the specified key in ASCII-armored form.
  135.  
  136.   -z   Batch mode.  See pgp-integration(7) for a discussion of integrating
  137.        pgp support into your application.
  138.  
  139. EXAMPLE
  140.   pgpk -g Generates a key.
  141.  
  142. FILES
  143.   ~/.pgp/pgp.cfg
  144.        User-specific configuration file.  In previous releases, this file was
  145.        called config.txt.  See pgp.cfg(5) for further details.
  146.  
  147. BUGS
  148.        See pgp(1).
  149.  
  150. SEE ALSO
  151.   pgp(1), pgpv(1), pgpe(1), pgps(1),
  152.   pgp.cfg(5),
  153.   pgp-integration(7), http://www.pgp.com (US versions) and
  154.   http://www.pgpi.com (International versions)
  155.