man/man1/monkeysphere.1

   1 .TH MONKEYSPHERE "1" "June 2008" "monkeysphere 0.1" "User Commands"
   2
   3 .SH NAME
   4
   5 monkeysphere \- Monkeysphere client user interface
   6
   7 .SH SYNOPSIS
   8
   9 .B monkeysphere \fIsubcommand\fP [\fIargs\fP]
  10
  11 .SH DESCRIPTION
  12
  13 \fBMonkeysphere\fP is a framework to leverage the OpenPGP web of trust
  14 for OpenSSH authentication.  OpenPGP keys are tracked via GnuPG, and
  15 added to the authorized_keys and known_hosts files used by OpenSSH for
  16 connection authentication.
  17
  18 \fBmonkeysphere\fP is the Monkeysphere client utility.
  19
  20 .SH SUBCOMMANDS
  21
  22 \fBmonkeysphere\fP takes various subcommands:
  23 .TP
  24 .B update-known_hosts [HOST]...
  25 Update the known_hosts file.  For each specified host, gpg will be
  26 queried for a key associated with the host URI (see HOST
  27 IDENTIFICATION in monkeysphere(5)), optionally querying a keyserver.
  28 If an acceptable key is found for the host (see KEY ACCEPTABILITY in
  29 monkeysphere(5)), the key is added to the user's known_hosts file.  If
  30 a key is found but is unacceptable for the host, any matching keys are
  31 removed from the user's known_hosts file.  If no gpg key is found for
  32 the host, nothing is done.  If no hosts are specified, all hosts
  33 listed in the known_hosts file will be processed.  This subcommand
  34 will exit with a status of 0 if at least one acceptable key was found
  35 for a specified host, 1 if no matching keys were found at all, and 2
  36 if matching keys were found but none were acceptable.  `k' may be used
  37 in place of `update-known_hosts'.
  38 .TP
  39 .B update-authorized_keys
  40 Update the authorized_keys file.  First all monkeysphere keys are
  41 cleared from the authorized_keys file.  Then, for each user ID in the
  42 user's authorized_user_ids file, gpg will be queried for keys
  43 associated with that user ID, optionally querying a keyserver.  If an
  44 acceptable key is found (see KEY ACCEPTABILITY in monkeysphere(5)),
  45 the key is added to the user's authorized_keys file.  If a key is
  46 found but is unacceptable for the user ID, any matching keys are
  47 removed from the user's authorized_keys file.  If no gpg key is found
  48 for the user ID, nothing is done.  This subcommand will exit with a
  49 status of 0 if at least one acceptable key was found for a user ID, 1
  50 if no matching keys were found at all, and 2 if matching keys were
  51 found but none were acceptable.  `a' may be used in place of
  52 `update-authorized_keys'.
  53 .TP
  54 .B gen-subkey KEYID
  55 Generate an authentication subkey.  For the primary key with the
  56 specified key ID, generate a subkey with "authentication" capability
  57 that can be used for monkeysphere transactions.  An expiration length
  58 can be specified with the `-e' or `--expire' option (prompt
  59 otherwise).  `g' may be used in place of `gen-subkey'.
  60 .TP
  61 .B help
  62 Output a brief usage summary.  `h' or `?' may be used in place of
  63 `help'.
  64
  65 .SH ENVIRONMENT
  66
  67 The following environment variables will override those specified in
  68 the monkeysphere.conf configuration file (defaults in parentheses):
  69 .TP
  70 MONKEYSPHERE_GNUPGHOME, GNUPGHOME
  71 GnuPG home directory (~/.gnupg).
  72 .TP
  73 MONKEYSPHERE_KEYSERVER
  74 OpenPGP keyserver to use (subkeys.pgp.net).
  75 .TP
  76 MONKEYSPHERE_CHECK_KEYSERVER
  77 Whether or not to check keyserver when making gpg queries (`true').
  78 .TP
  79 MONKEYSPHERE_KNOWN_HOSTS
  80 Path to ssh known_hosts file (~/.ssh/known_hosts).
  81 .TP
  82 MONKEYSPHERE_HASH_KNOWN_HOSTS
  83 Whether or not to hash to the known_hosts file entries (`true').
  84 .TP
  85 MONKEYSPHERE_AUTHORIZED_KEYS
  86 Path to ssh authorized_keys file (~/.ssh/authorized_keys).
  87
  88 .SH FILES
  89
  90 .TP
  91 ~/.config/monkeysphere/monkeysphere.conf
  92 User monkeysphere config file.
  93 .TP
  94 /etc/monkeysphere/monkeysphere.conf
  95 System-wide monkeysphere config file.
  96 .TP
  97 ~/.config/monkeysphere/authorized_user_ids
  98 OpenPGP user IDs associated with keys that will be checked for
  99 addition to the authorized_keys file.
 100
 101 .SH AUTHOR
 102
 103 Written by Jameson Rollins <jrollins@fifthhorseman.net>, Daniel
 104 Kahn Gillmor <dkg@fifthhorseman.net>
 105
 106 .SH SEE ALSO
 107
 108 .BR monkeysphere-ssh-proxycommand (1),
 109 .BR monkeysphere-server (8),
 110 .BR monkeysphere (5),
 111 .BR ssh (1),
 112 .BR gpg (1)