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 ssh authentication.  OpenPGP keys are tracked via GnuPG, and added
  15 to the authorized_keys and known_hosts files used by ssh 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.  For each user ID in the user's
  41 authorized_user_ids file, gpg will be queried for keys associated with
  42 that user ID, optionally querying a keyserver.  If an acceptable key
  43 is found (see KEY ACCEPTABILITY in monkeysphere(5)), the key is added
  44 to the user's authorized_keys file.  If a key is found but is
  45 unacceptable for the user ID, any matching keys are removed from the
  46 user's authorized_keys file.  If no gpg key is found for the user ID,
  47 nothing is done.  This subcommand will exit with a status of 0 if at
  48 least one acceptable key was found for a user ID, 1 if no matching
  49 keys were found at all, and 2 if matching keys were found but none
  50 were acceptable.  `a' may be used in place of
  51 `update-authorized_keys'.
  52 .TP
  53 .B gen-subkey KEYID
  54 Generate an authentication subkey.  For the primary key with the
  55 specified key ID, generate a subkey with "authentication" capability
  56 that can be used for monkeysphere transactions.  An expiration length
  57 can be specified with the `-e' or `--expire' option (prompt
  58 otherwise).  `g' may be used in place of `gen-subkey'.
  59 .TP
  60 .B help
  61 Output a brief usage summary.  `h' or `?' may be used in place of
  62 `help'.
  63
  64 .SH ENVIRONMENT
  65
  66 The following environment variables will override those specified in
  67 the monkeysphere.conf configuration file (defaults in parentheses):
  68 .TP
  69 MONKEYSPHERE_GNUPGHOME, GNUPGHOME
  70 GnuPG home directory (~/.gnupg).
  71 .TP
  72 MONKEYSPHERE_KEYSERVER
  73 OpenPGP keyserver to use (subkeys.pgp.net).
  74 .TP
  75 MONKEYSPHERE_CHECK_KEYSERVER
  76 Whether or not to check keyserver when making gpg queries (`true').
  77 .TP
  78 MONKEYSPHERE_KNOWN_HOSTS
  79 Path to ssh known_hosts file (~/.ssh/known_hosts).
  80 .TP
  81 MONKEYSPHERE_HASH_KNOWN_HOSTS
  82 Whether or not to hash to the known_hosts file entries (`true').
  83 .TP
  84 MONKEYSPHERE_AUTHORIZED_KEYS
  85 Path to ssh authorized_keys file (~/.ssh/authorized_keys).
  86
  87 .SH FILES
  88
  89 .TP
  90 ~/.config/monkeysphere/monkeysphere.conf
  91 User monkeysphere config file.
  92 .TP
  93 /etc/monkeysphere/monkeysphere.conf
  94 System-wide monkeysphere config file.
  95 .TP
  96 ~/.config/monkeysphere/authorized_user_ids
  97 OpenPGP user IDs associated with keys that will be checked for
  98 addition to the authorized_keys file.
  99
 100 .SH AUTHOR
 101
 102 Written by Jameson Rollins <jrollins@fifthhorseman.net>, Daniel
 103 Kahn Gillmor <dkg@fifthhorseman.net>
 104
 105 .SH SEE ALSO
 106
 107 .BR monkeysphere-ssh-proxycommand (1),
 108 .BR monkeysphere-server (8),
 109 .BR monkeysphere (5),
 110 .BR ssh (1),
 111 .BR gpg (1)