src/monkeysphere-host

   1 #!/usr/bin/env bash
   2
   3 # monkeysphere-host: Monkeysphere host admin tool
   4 #
   5 # The monkeysphere scripts are written by:
   6 # Jameson Rollins <jrollins@finestructure.net>
   7 # Jamie McClelland <jm@mayfirst.org>
   8 # Daniel Kahn Gillmor <dkg@fifthhorseman.net>
   9 # Micah Anderson <micah@riseup.net>
  10 #
  11 # They are Copyright 2008-2009, and are all released under the GPL,
  12 # version 3 or later.
  13
  14 ########################################################################
  15 set -e
  16
  17 # set the pipefail option so pipelines fail on first command failure
  18 set -o pipefail
  19
  20 PGRM=$(basename $0)
  21
  22 SYSSHAREDIR=${MONKEYSPHERE_SYSSHAREDIR:-"/usr/share/monkeysphere"}
  23 export SYSSHAREDIR
  24 . "${SYSSHAREDIR}/common" || exit 1
  25
  26 SYSDATADIR=${MONKEYSPHERE_SYSDATADIR:-"/var/lib/monkeysphere"}
  27 export SYSDATADIR
  28
  29 # sharedir for host functions
  30 MHSHAREDIR="${SYSSHAREDIR}/mh"
  31
  32 # datadir for host functions
  33 MHDATADIR="${SYSDATADIR}/host"
  34
  35 # temp directory for temp gnupghome directories for add_revoker
  36 MHTMPDIR="${MHDATADIR}/tmp"
  37 export MHTMPDIR
  38
  39 # host pub key files
  40 HOST_KEY_FILE="${SYSDATADIR}/ssh_host_rsa_key.pub.gpg"
  41
  42 # UTC date in ISO 8601 format if needed
  43 DATE=$(date -u '+%FT%T')
  44
  45 # unset some environment variables that could screw things up
  46 unset GREP_OPTIONS
  47
  48 # default return code
  49 RETURN=0
  50
  51 ########################################################################
  52 # FUNCTIONS
  53 ########################################################################
  54
  55 usage() {
  56     cat <<EOF >&2
  57 usage: $PGRM <subcommand> [options] [args]
  58 Monkeysphere host admin tool.
  59
  60 subcommands:
  61  show-key (s)                        output all host key information
  62  set-expire (e) EXPIRE               set host key expiration
  63  add-hostname (n+) NAME[:PORT]       add hostname user ID to host key
  64  revoke-hostname (n-) NAME[:PORT]    revoke hostname user ID
  65  add-revoker (o) FINGERPRINT         add a revoker to the host key
  66  revoke-key (r)                      revoke host key
  67  publish-key (p)                     publish host key to keyserver
  68
  69  import-key (i) [NAME[:PORT]]        import existing ssh key to gpg
  70
  71  version (v)                         show version number
  72  help (h,?)                          this help
  73
  74 See ${PGRM}(8) for more info.
  75 EOF
  76 }
  77
  78 # function to interact with the gpg keyring
  79 gpg_host() {
  80     GNUPGHOME="$GNUPGHOME_HOST" gpg "$@"
  81 }
  82
  83 # command to list the info about the host key, in colon format
  84 gpg_host_list() {
  85     gpg_host --list-keys --with-colons --fixed-list-mode \
  86         --with-fingerprint --with-fingerprint \
  87         "0x${HOST_FINGERPRINT}!"
  88
  89 }
  90
  91 # command for edit key scripts, takes scripts on stdin
  92 # FIXME: should we supress all the edit script spew?  or pipe it
  93 # through log debug?
  94 gpg_host_edit() {
  95     gpg_host --quiet --command-fd 0 --edit-key \
  96         "0x${HOST_FINGERPRINT}!" "$@"
  97 }
  98
  99 # export the host public key to the monkeysphere gpg pub key file
 100 update_gpg_pub_file() {
 101     log debug "updating openpgp public key file '$HOST_KEY_FILE'..."
 102     gpg_host --export --armor --export-options export-minimal \
 103         "0x${HOST_FINGERPRINT}!" > "$HOST_KEY_FILE"
 104 }
 105
 106 # load the host fingerprint into the fingerprint variable, using the
 107 # export gpg pub key file
 108 # FIXME: this seems much less than ideal, with all this temp keyring
 109 # stuff.  is there a way we can do this without having to create temp
 110 # files?  what if we stored the fingerprint in MHDATADIR/fingerprint?
 111 load_fingerprint() {
 112     if [ -f "$HOST_KEY_FILE" ] ; then
 113         HOST_FINGERPRINT=$( \
 114             (FUBAR=$(mktemp -d) && export GNUPGHOME="$FUBAR" \
 115             && gpg --quiet --import \
 116             && gpg --quiet --list-keys --with-colons --with-fingerprint \
 117             && rm -rf "$FUBAR") <"$HOST_KEY_FILE" \
 118             | grep '^fpr:' | cut -d: -f10 )
 119     else
 120         HOST_FINGERPRINT=
 121     fi
 122 }
 123
 124 # load the host fingerprint into the fingerprint variable, using the
 125 # gpg host secret key
 126 load_fingerprint_secret() {
 127     HOST_FINGERPRINT=$( \
 128         gpg_host --quiet --list-secret-key \
 129         --with-colons --with-fingerprint \
 130         | grep '^fpr:' | cut -d: -f10 )
 131 }
 132
 133 # fail if host key present
 134 check_host_key() {
 135     [ ! -s "$HOST_KEY_FILE" ] \
 136         || failure "An OpenPGP host key already exists."
 137 }
 138
 139 # fail if host key not present
 140 check_host_no_key() {
 141     [ -s "$HOST_KEY_FILE" ] \
 142         || failure "You don't appear to have a Monkeysphere host key on this server.
 143 Please run 'monkeysphere-host import-key' first."
 144 }
 145
 146 # output the index of a user ID on the host key
 147 # return 1 if user ID not found
 148 find_host_userid() {
 149     local userID="$1"
 150     local tmpuidMatch
 151     local line
 152
 153     # match to only ultimately trusted user IDs
 154     tmpuidMatch="u:$(echo $userID | gpg_escape)"
 155
 156     # find the index of the requsted user ID
 157     # NOTE: this is based on circumstantial evidence that the order of
 158     # this output is the appropriate index
 159     line=$(gpg_host_list | egrep '^(uid|uat):' | cut -f2,10 -d: | \
 160         grep -n -x -F "$tmpuidMatch" 2>/dev/null)
 161
 162     if [ "$line" ] ; then
 163         echo ${line%%:*}
 164         return 0
 165     else
 166         return 1
 167     fi
 168 }
 169
 170 # show info about the host key
 171 show_key() {
 172     local GNUPGHOME
 173
 174     # tmp gpghome dir
 175     export GNUPGHOME=$(mktemp -d)
 176
 177     # trap to remove tmp dir if break
 178     trap "rm -rf $GNUPGHOME" EXIT
 179
 180     # import the host key into the tmp dir
 181     gpg --quiet --import <"$HOST_KEY_FILE"
 182
 183     HOST_FINGERPRINT=$(gpg --quiet --list-keys --with-colons --with-fingerprint \
 184         | grep '^fpr:' | cut -d: -f10 )
 185
 186     # list the host key info
 187     # FIXME: make no-show-keyring work so we don't have to do the grep'ing
 188     # FIXME: can we show uid validity somehow?
 189     gpg --list-keys --fingerprint \
 190         --list-options show-unusable-uids 2>/dev/null \
 191         | grep -v "^${GNUPGHOME}/pubring.gpg$" \
 192         | egrep -v '^-+$'
 193
 194     # list the pgp fingerprint
 195     echo "OpenPGP fingerprint: $HOST_FINGERPRINT"
 196
 197     # list the ssh fingerprint
 198     echo -n "ssh fingerprint: "
 199     ssh-keygen -l -f /dev/stdin \
 200         <<<$(openpgp2ssh <"$HOST_KEY_FILE" 2>/dev/null) \
 201         | awk '{ print $1, $2, $4 }'
 202
 203     # remove the tmp file
 204     trap - EXIT
 205     rm -rf "$GNUPGHOME"
 206 }
 207
 208 ########################################################################
 209 # MAIN
 210 ########################################################################
 211
 212 # unset variables that should be defined only in config file of in
 213 # MONKEYSPHERE_ variables
 214 unset LOG_LEVEL
 215 unset KEYSERVER
 216 unset MONKEYSPHERE_USER
 217 unset PROMPT
 218
 219 # load configuration file
 220 [ -e ${MONKEYSPHERE_HOST_CONFIG:="${SYSCONFIGDIR}/monkeysphere-host.conf"} ] && . "$MONKEYSPHERE_HOST_CONFIG"
 221
 222 # set empty config variable with ones from the environment, or with
 223 # defaults
 224 LOG_LEVEL=${MONKEYSPHERE_LOG_LEVEL:=${LOG_LEVEL:="INFO"}}
 225 KEYSERVER=${MONKEYSPHERE_KEYSERVER:=${KEYSERVER:="pool.sks-keyservers.net"}}
 226 MONKEYSPHERE_USER=${MONKEYSPHERE_MONKEYSPHERE_USER:=${MONKEYSPHERE_USER:="monkeysphere"}}
 227 PROMPT=${MONKEYSPHERE_PROMPT:=${PROMPT:="true"}}
 228
 229 # other variables
 230 CHECK_KEYSERVER=${MONKEYSPHERE_CHECK_KEYSERVER:="true"}
 231 GNUPGHOME_HOST=${MONKEYSPHERE_GNUPGHOME_HOST:="${MHDATADIR}"}
 232
 233 # export variables needed in su invocation
 234 export DATE
 235 export MODE
 236 export LOG_LEVEL
 237 export KEYSERVER
 238 export MONKEYSPHERE_USER
 239 export PROMPT
 240 export CHECK_KEYSERVER
 241 export GNUPGHOME_HOST
 242 export GNUPGHOME
 243 export HOST_FINGERPRINT=
 244
 245 # get subcommand
 246 COMMAND="$1"
 247 [ "$COMMAND" ] || failure "Type '$PGRM help' for usage."
 248 shift
 249
 250 case $COMMAND in
 251     'show-key'|'show'|'s')
 252         check_host_no_key
 253         show_key
 254         ;;
 255
 256     'set-expire'|'extend-key'|'e')
 257         check_host_no_key
 258         load_fingerprint
 259         source "${MHSHAREDIR}/set_expire"
 260         set_expire "$@"
 261         ;;
 262
 263     'add-hostname'|'add-name'|'n+')
 264         check_host_no_key
 265         load_fingerprint
 266         source "${MHSHAREDIR}/add_hostname"
 267         add_hostname "$@"
 268         ;;
 269
 270     'revoke-hostname'|'revoke-name'|'n-')
 271         check_host_no_key
 272         load_fingerprint
 273         source "${MHSHAREDIR}/revoke_hostname"
 274         revoke_hostname "$@"
 275         ;;
 276
 277     'add-revoker'|'o')
 278         check_host_no_key
 279         load_fingerprint
 280         source "${MHSHAREDIR}/add_revoker"
 281         add_revoker "$@"
 282         ;;
 283
 284     'revoke-key'|'r')
 285         check_host_no_key
 286         load_fingerprint
 287         source "${MHSHAREDIR}/revoke_key"
 288         revoke_key "$@"
 289         ;;
 290
 291     'publish-key'|'publish'|'p')
 292         check_host_no_key
 293         load_fingerprint
 294         source "${MHSHAREDIR}/publish_key"
 295         publish_key
 296         ;;
 297
 298     'import-key'|'i')
 299         check_host_key
 300         source "${MHSHAREDIR}/import_key"
 301         import_key "$@"
 302         ;;
 303
 304     'diagnostics'|'d')
 305         load_fingerprint
 306         source "${MHSHAREDIR}/diagnostics"
 307         diagnostics
 308         ;;
 309
 310     'version'|'v')
 311         echo "$VERSION"
 312         ;;
 313
 314     '--help'|'help'|'-h'|'h'|'?')
 315         usage
 316         ;;
 317
 318     *)
 319         failure "Unknown command: '$COMMAND'
 320 Type '$PGRM help' for usage."
 321         ;;
 322 esac
 323
 324 exit "$RETURN"