crypto/external/bsd/netpgp/dist/src/pgp2ssh/pgp2ssh.1

   1 .\" $NetBSD: pgp2ssh.1,v 1.4 2014/02/17 07:23:19 agc Exp $
   2 .\"
   3 .\" Copyright (c) 2010 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This manual page is derived from software contributed to
   7 .\" The NetBSD Foundation by Alistair Crooks (agc@NetBSD.org).
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd February 16, 2014
  31 .Dt PGP2SSH 1
  32 .Os
  33 .Sh NAME
  34 .Nm pgp2ssh
  35 .Nd convert a PGP public key to an SSHv2 key
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Op Fl f address-family
  39 .Op Fl h hostname
  40 .Op Fl p port
  41 .Ar userid ...
  42 .Sh DESCRIPTION
  43 The
  44 .Nm
  45 command retrieves PGP public key information from the key server daemon
  46 using the HKP protocol, and converts the PGP public
  47 key to a format suitable for use by
  48 .Xr ssh 1 .
  49 The
  50 .Xr hkpd 1
  51 is normally used to serve public key information.
  52 The
  53 .Nm
  54 utility is similar to the
  55 .Xr hkpc 1
  56 utility in that it retrieves keys in the same way.
  57 In addition,
  58 .Nm
  59 will convert the format of the key.
  60 .Pp
  61 At the present time, only RSA keys are supported.
  62 There is no intention, at the time of writing, to
  63 support DSA keys, due to their limitations.
  64 .Pp
  65 It is quite possible to serve ssh public keys
  66 across a network using
  67 .Xr hkpd 1
  68 to serve the key, and
  69 .Nm
  70 to retrieve the key using the HKP protocol,
  71 and to save the key in ssh format on the remote computer,
  72 allowing users to login to the remote computer using
  73 .Xr ssh 1 .
  74 .Sh EXIT STATUS
  75 The
  76 .Nm
  77 utility will return 0 for success,
  78 or 1 for failure.
  79 Output will be printed on stdout.
  80 It can be redirected to a file for use by
  81 .Xr ssh 1 .
  82 .Sh SEE ALSO
  83 .Xr hkpc 1 ,
  84 .Xr hkpd 1 ,
  85 .Xr netpgpkeys 1 ,
  86 .Xr ssh 1 ,
  87 .\" .Xr libbz2 3 ,
  88 .Xr libnetpgp 3
  89 .Sh STANDARDS
  90 .Rs
  91 .%A J. Callas
  92 .%A L. Donnerhacke
  93 .%A H. Finney
  94 .%A D. Shaw
  95 .%A R. Thayer
  96 .%D November 2007
  97 .%R RFC 4880
  98 .%T OpenPGP Message Format
  99 .Re
 100 .Sh HISTORY
 101 The
 102 .Nm
 103 command first appeared in
 104 .Nx 6.0 .
 105 .Sh AUTHORS
 106 .An Alistair Crooks Aq Mt agc@NetBSD.org .