man/man1/monkeysphere.1

   1 .TH MONKEYSPHERE "1" "June 2008" "monkeysphere 0.1" "User Commands"
   2 .SH NAME
   3 monkeysphere \- MonkeySphere client user interface
   4 .PD
   5 .SH SYNOPSIS
   6 .B monkeysphere \fIcommand\fP [\fIargs\fP]
   7 .PD
   8 .SH DESCRIPTION
   9 .PP
  10 MonkeySphere is a system to leverage the OpenPGP Web of Trust for ssh
  11 authentication and encryption.  OpenPGP keys are tracked via GnuPG,
  12 and added to the ssh authorized_keys and known_hosts files to be used
  13 for authentication and encryption of ssh connection.
  14
  15 \fBmonkeysphere\fP is the MonkeySphere client utility.
  16 .PD
  17 .SH SUBCOMMANDS
  18 \fBmonkeysphere\fP takes various subcommands:
  19 .TP
  20 .B update-known_hosts [HOST]...
  21 Update the known_hosts file.  For each specified host, gpg will be
  22 queried for a key associated with the host URI (see HOST URIs),
  23 querying a keyserver if none is found in the user's keychain. search
  24 for a gpg key for the host in the Web of Trust.  If a key is found, it
  25 will be added to the host_keys cache (see KEY CACHES) and any ssh keys
  26 for the host will be removed from the user's known_hosts file.  If the
  27 found key is acceptable (see KEY ACCEPTABILITY), then the host's gpg
  28 key will be added to the known_hosts file.  If no gpg key is found for
  29 the host, then nothing is done.  If no hosts are specified, all hosts
  30 listed in the known_hosts file will be processed.  `k' may be used in
  31 place of `update-known_hosts'.
  32 .TP
  33 .B update-userids [USERID]...
  34 Add/update a user ID to the authorized_user_ids file.  The user IDs
  35 specified should be exact matches to OpenPGP user IDs.  For each
  36 specified user ID, gpg will be queried for a key associated with that
  37 user ID, querying a keyserver if none is found in the user's keychain.
  38 If a key is found, it will be added to the user_keys cache (see KEY
  39 CACHES) and the user ID will be added to the user's
  40 authorized_user_ids file (if it wasn't already present).  `u' may be
  41 used in place of `update-userids'.
  42 .TP
  43 .B remove-userids [USERID]...
  44 Remove a user ID from the authorized_user_ids file.  The user IDs
  45 specified should be exact matches to OpenPGP user IDs.  `r' may be
  46 used in place of `remove-userids'.
  47 .TP
  48 .B update-authorized_keys
  49 Update the monkeysphere authorized_keys file.  The monkeysphere
  50 authorized_keys file will be regenerated from the valid keys in the
  51 user_key cache, and the user's independently controlled
  52 authorized_keys file (usually ~/.ssh/authorized_keys).  `a' may be
  53 used in place of `update-authorized_keys'.
  54 .TP
  55 .B gen-ae-subkey KEYID
  56 Generate an `ae` capable subkey.  For the primary key with the
  57 specified key ID, generate a subkey with "authentication" and
  58 "encryption" capability that can be used for MonkeySphere
  59 transactions.  `g' may be used in place of `gen-ae-subkey'.
  60 .TP
  61 .B help
  62 Output a brief usage summary.  `h' or `?' may be used in place of
  63 `help'.
  64 .PD
  65 .SH KEY ACCEPTABILITY
  66 GPG keys are considered acceptable if the following criteria are met:
  67 .PD
  68 .TP
  69 .B capability
  70 The key must have both the "authentication" and "encrypt" capability
  71 flags.
  72 .TP
  73 .B validity
  74 The key must be "fully" valid, and must not be expired or revoked.
  75 .PD
  76 .SH KEY CACHES
  77 Monkeysphere keeps track of keys in key cache directories.  The files
  78 in the cache are named with the format "USERID_HASH.PUB_KEY_ID", where
  79 USERID_HASH is a hash of the exact OpenPGP user ID, and PUB_KEY_ID is
  80 the key ID of the primary key.  If the user/key ID combo exists in the
  81 Web of Trust but is not acceptable, then the file is empty.  If the
  82 primary key has at least one acceptable sub key, then an ssh-style
  83 key, converted from the OpenPGP key, of all acceptable subkeys will be
  84 stored in the cache file, one per line.  known_hosts style key lines
  85 will be stored in the host_keys cache files, and authorized_keys style
  86 key lines will be stored in the user_keys cache files.  OpenPGP keys
  87 are converted to ssh-style keys with the openpgp2ssh utility (see `man
  88 openpgp2ssh').
  89 .PD
  90 .SH FILES
  91 .PD 1
  92 .TP
  93 ~/.config/monkeysphere/monkeysphere.conf
  94 User monkeysphere config file.
  95 .TP
  96 /etc/monkeysphere/monkeysphere.conf
  97 System-wide monkeysphere config file.
  98 .TP
  99 ~/.config/monkeysphere/authorized_user_ids
 100 GPG user IDs associated with keys that will be checked for addition to
 101 the authorized_keys file.
 102 .TP
 103 ~/.config/monkeysphere/authorized_keys
 104 Monkeysphere generated authorized_keys file.
 105 .TP
 106 ~/.config/monkeysphere/user_keys
 107 User keys cache directory.
 108 .TP
 109 ~/.config/monkeysphere/host_keys
 110 Host keys cache directory.
 111 .PD
 112 .SH AUTHOR
 113 Written by Jameson Rollins <jrollins@fifthhorseman.net>
 114 .PD
 115 .SH SEE ALSO
 116 .BR ssh (1),
 117 .BR monkeysphere-ssh-proxycommand (1),
 118 .BR gpg (1),
 119 .BR monkeysphere-server (8)