X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=src%2Fmonkeysphere-host;h=3c2e3eead29106f3c15d43824ef13e47b98c9c6e;hb=7dbd6806e538ff8732dd87fcf20bfd8271464552;hp=94392647c32693ce74bce898debcfd818e69170b;hpb=26bdfd9c0aa0853ca1ea80e1980e7e9849646e10;p=monkeysphere.git diff --git a/src/monkeysphere-host b/src/monkeysphere-host index 9439264..fab3ef7 100755 --- a/src/monkeysphere-host +++ b/src/monkeysphere-host @@ -3,32 +3,45 @@ # monkeysphere-host: Monkeysphere host admin tool # # The monkeysphere scripts are written by: -# Jameson Rollins +# Jameson Rollins # Jamie McClelland # Daniel Kahn Gillmor +# Micah Anderson # -# They are Copyright 2008, and are all released under the GPL, version 3 -# or later. +# They are Copyright 2008-2010, and are all released under the GPL, +# version 3 or later. ######################################################################## +set -e + +# set the pipefail option so pipelines fail on first command failure +set -o pipefail + PGRM=$(basename $0) SYSSHAREDIR=${MONKEYSPHERE_SYSSHAREDIR:-"/usr/share/monkeysphere"} export SYSSHAREDIR -. "${SYSSHAREDIR}/common" || exit 1 +. "${SYSSHAREDIR}/defaultenv" +. "${SYSSHAREDIR}/common" -SYSDATADIR=${MONKEYSPHERE_SYSDATADIR:-"/var/lib/monkeysphere/host"} +SYSDATADIR=${MONKEYSPHERE_SYSDATADIR:-"/var/lib/monkeysphere"} export SYSDATADIR +# sharedir for host functions +MHSHAREDIR="${SYSSHAREDIR}/mh" + +# datadir for host functions +MHDATADIR="${SYSDATADIR}/host" + +# host pub key files +HOST_KEY_FILE="${SYSDATADIR}/host_keys.pub.pgp" + # UTC date in ISO 8601 format if needed DATE=$(date -u '+%FT%T') # unset some environment variables that could screw things up unset GREP_OPTIONS -# default return code -RETURN=0 - ######################################################################## # FUNCTIONS ######################################################################## @@ -39,214 +52,307 @@ usage: $PGRM [options] [args] Monkeysphere host admin tool. subcommands: - show-key (s) output all host key information - extend-key (e) EXPIRE extend host key expiration - add-hostname (n+) NAME[:PORT] add hostname user ID to host key - revoke-hostname (n-) NAME[:PORT] revoke hostname user ID - add-revoker (o) FINGERPRINT add a revoker to the host key - revoke-key (r) revoke host key - publish-key (p) publish server host key to keyserver - - expert - import-key (i) NAME[:PORT] import existing ssh key to gpg - --keyfile (-f) FILE key file to import - --expire (-e) EXPIRE date to expire - gen-key (g) NAME[:PORT] generate gpg key for the host - --length (-l) BITS key length in bits (2048) - --expire (-e) EXPIRE date to expire - diagnostics (d) monkeysphere host status - - version (v) show version number - help (h,?) this help - + import-key (i) FILE SERVICENAME import PEM-encoded key from file + show-keys (s) [KEYID ...] output host key information + publish-keys (p) [KEYID ...] publish key(s) to keyserver + set-expire (e) EXPIRE [KEYID] set key expiration + add-servicename (n+) SERVICENAME [KEYID] + add a service name to key + revoke-servicename (n-) SERVICENAME [KEYID] + revoke a service name from key + add-revoker (r+) REVOKER_KEYID|FILE [KEYID] + add a revoker to key + revoke-key [KEYID] generate and/or publish revocation + certificate for key + + version (v) show version number + help (h,?) this help + +See ${PGRM}(8) for more info. EOF } -# function to run command as monkeysphere user -su_monkeysphere_user() { - # if the current user is the monkeysphere user, then just eval - # command - if [ $(id -un) = "$MONKEYSPHERE_USER" ] ; then - eval "$@" +# function to interact with the gpg keyring +gpg_host() { + GNUPGHOME="$GNUPGHOME_HOST" gpg --no-greeting --quiet --no-tty "$@" +} - # otherwise su command as monkeysphere user +# list the info about the a key, in colon format, to stdout +gpg_host_list_keys() { + if [ "$1" ] ; then + gpg_host --list-keys --with-colons --fixed-list-mode \ + --with-fingerprint --with-fingerprint \ + "$1" else - su "$MONKEYSPHERE_USER" -c "$@" + gpg_host --list-keys --with-colons --fixed-list-mode \ + --with-fingerprint --with-fingerprint fi } -# function to interact with the host gnupg keyring -gpg_host() { - local returnCode - - GNUPGHOME="$GNUPGHOME_HOST" - export GNUPGHOME - - # NOTE: we supress this warning because we need the monkeysphere - # user to be able to read the host pubring. we realize this might - # be problematic, but it's the simplest solution, without too much - # loss of security. - gpg --no-permission-warning "$@" - returnCode="$?" - - # always reset the permissions on the host pubring so that the - # monkeysphere user can read the trust signatures - chgrp "$MONKEYSPHERE_USER" "${GNUPGHOME_HOST}/pubring.gpg" - chmod g+r "${GNUPGHOME_HOST}/pubring.gpg" - - return "$returnCode" +# edit key scripts, takes scripts on stdin, and keyID as first input +gpg_host_edit() { + gpg_host --command-fd 0 --edit-key "$@" } -# output just key fingerprint -fingerprint_server_key() { - # set the pipefail option so functions fails if can't read sec key - set -o pipefail +# export the monkeysphere OpenPGP pub key file +update_pgp_pub_file() { + log debug "updating openpgp public key file '$HOST_KEY_FILE'..." + gpg_host --export --armor --export-options export-minimal \ + $(gpg_host --list-secret-keys --with-colons --fingerprint | grep ^fpr | cut -f10 -d:) \ + > "$HOST_KEY_FILE" +} + +# check that the service name is well formed +check_service_name() { + local name="$1" + log error "FIX ME: check service name" +} + +# fail if host key not present +check_no_keys() { + [ -s "$HOST_KEY_FILE" ] \ + || failure "You don't appear to have a Monkeysphere host key on this server. +Please run 'monkeysphere-host import-key' import a key." +} + +# key input to functions, outputs full fingerprint of specified key if +# found +check_key_input() { + local keyID="$1" + # array of fingerprints + local fprs=($(list_primary_fingerprints <"$HOST_KEY_FILE")) + + case ${#fprs[@]} in + 0) + failure "You don't appear to have any Monkeysphere host keys. +Please run 'monkeysphere-host import-key' to import a key." + ;; + 1) + : + ;; + *) + if [ -z "$keyID" ] ; then + failure "Your host keyring contains multiple keys. +Please specify one to act on (see 'monkeysphere-host show-keys')." + fi + ;; + esac + printf '%s\n' "${fprs[@]}" | grep "${keyID}$" \ + || failure "Host key '$keyID' not found." +} + +# return 0 if user ID was found. +# return 1 if user ID not found. +check_key_userid() { + local keyID="$1" + local userID="$2" + local tmpuidMatch + + # match to only "unknown" user IDs (host has no need for ultimate trust) + tmpuidMatch="uid:-:$(echo $userID | gpg_escape)" - gpg_host --list-secret-keys --fingerprint \ - --with-colons --fixed-list-mode 2> /dev/null | \ - grep '^fpr:' | head -1 | cut -d: -f10 2>/dev/null + # See whether the requsted user ID is present + gpg_host_list_keys "$keyID" | cut -f1,2,10 -d: | \ + grep -q -x -F "$tmpuidMatch" 2>/dev/null } -# function to check for host secret key -check_host_keyring() { - fingerprint_server_key >/dev/null \ - || failure "You don't appear to have a Monkeysphere host key on this server. Please run 'monkeysphere-server gen-key' first." +prompt_userid_exists() { + local userID="$1" + local gpgOut + local fingerprint + + if gpgOut=$(gpg_host_list_keys "=${userID}" 2>/dev/null) ; then + fingerprint=$(echo "$gpgOut" | grep '^fpr:' | cut -d: -f10) + if [ "$PROMPT" != "false" ] ; then + printf "Service name '%s' is already being used by key '%s'.\nAre you sure you want to use it again? (y/N) " "$fingerprint" "$userID" >&2 + read OK; OK=${OK:=N} + if [ "${OK/y/Y}" != 'Y' ] ; then + failure "Service name not added." + fi + else + log info "Key '%s' is already using the service name '%s'." "$fingerprint" "$userID" >&2 + fi + fi +} + +# run command looped over keys +multi_key() { + local cmd="$1" + shift + local keys=$@ + local i=0 + local fprs=($(list_primary_fingerprints <"$HOST_KEY_FILE")) + local key + + check_no_keys + + if [[ -z "$1" || "$1" == '--all' ]] ; then + keys="${fprs[@]}" + fi + + for key in $keys ; do + if (( i++ > 0 )) ; then + echo "##############################" + fi + eval "$cmd" "$key" + done } -# show info about the host key +# show info about the a key show_key() { - local fingerprintPGP - local fingerprintSSH - local ret=0 - - # FIXME: you shouldn't have to be root to see the host key fingerprint - if is_root ; then - check_host_keyring - fingerprintPGP=$(fingerprint_server_key) - gpg_authentication "--fingerprint --list-key --list-options show-unusable-uids $fingerprintPGP" 2>/dev/null - echo "OpenPGP fingerprint: $fingerprintPGP" + local id="$1" + local GNUPGHOME + local fingerprint + local tmpssh + local revokers + + # tmp gpghome dir + export GNUPGHOME=$(msmktempdir) + + # trap to remove tmp dir if break + trap "rm -rf $GNUPGHOME" EXIT + + # import the host key into the tmp dir + gpg --quiet --import <"$HOST_KEY_FILE" + + # get the gpg fingerprint + if gpg --quiet --list-keys \ + --with-colons --with-fingerprint "$id" \ + | grep '^fpr:' | cut -d: -f10 > "$GNUPGHOME"/fingerprint ; then + fingerprint=$(cat "$GNUPGHOME"/fingerprint) else - log info "You must be root to see host OpenPGP fingerprint." - ret='1' + failure "ID '$id' not found." fi - if [ -f "${SYSDATADIR}/ssh_host_rsa_key.pub" ] ; then - fingerprintSSH=$(ssh-keygen -l -f "${SYSDATADIR}/ssh_host_rsa_key.pub" | \ - awk '{ print $1, $2, $4 }') - echo "ssh fingerprint: $fingerprintSSH" - else - log info "SSH host key not found." - ret='1' + # create the ssh key + tmpssh="$GNUPGHOME"/ssh_host_key_rsa_pub + gpg --export "$fingerprint" 2>/dev/null \ + | openpgp2ssh 2>/dev/null >"$tmpssh" + + # list the host key info + # FIXME: make no-show-keyring work so we don't have to do the grep'ing + # FIXME: can we show uid validity somehow? + gpg --list-keys --list-options show-unusable-uids "$fingerprint" 2>/dev/null \ + | grep -v "^${GNUPGHOME}/pubring.gpg$" \ + | egrep -v '^-+$' + + # list revokers, if there are any + revokers=$(gpg --list-keys --with-colons --fixed-list-mode "$fingerprint" \ + | awk -F: '/^rvk:/{ print $10 }' ) + if [ "$revokers" ] ; then + echo "The following keys are allowed to revoke this host key:" + for key in $revokers ; do + echo "revoker: $key" + done + echo fi -return $ret + # list the pgp fingerprint + echo "OpenPGP fingerprint: $fingerprint" + + # list the ssh fingerprint + echo -n "ssh fingerprint: " + ssh-keygen -l -f "$tmpssh" | awk '{ print $1, $2, $4 }' + + # remove the tmp file + trap - EXIT + rm -rf "$GNUPGHOME" } ######################################################################## # MAIN ######################################################################## -# unset variables that should be defined only in config file -unset KEYSERVER -unset AUTHORIZED_USER_IDS -unset RAW_AUTHORIZED_KEYS -unset MONKEYSPHERE_USER - # load configuration file -[ -e ${MONKEYSPHERE_SERVER_CONFIG:="${SYSCONFIGDIR}/monkeysphere-server.conf"} ] && . "$MONKEYSPHERE_SERVER_CONFIG" +[ -e ${MONKEYSPHERE_HOST_CONFIG:="${SYSCONFIGDIR}/monkeysphere-host.conf"} ] \ + && . "$MONKEYSPHERE_HOST_CONFIG" # set empty config variable with ones from the environment, or with # defaults -LOG_LEVEL=${MONKEYSPHERE_LOG_LEVEL:=${LOG_LEVEL:="INFO"}} -KEYSERVER=${MONKEYSPHERE_KEYSERVER:=${KEYSERVER:="pool.sks-keyservers.net"}} -AUTHORIZED_USER_IDS=${MONKEYSPHERE_AUTHORIZED_USER_IDS:=${AUTHORIZED_USER_IDS:="%h/.monkeysphere/authorized_user_ids"}} -RAW_AUTHORIZED_KEYS=${MONKEYSPHERE_RAW_AUTHORIZED_KEYS:=${RAW_AUTHORIZED_KEYS:="%h/.ssh/authorized_keys"}} -MONKEYSPHERE_USER=${MONKEYSPHERE_MONKEYSPHERE_USER:=${MONKEYSPHERE_USER:="monkeysphere"}} +LOG_LEVEL=${MONKEYSPHERE_LOG_LEVEL:=$LOG_LEVEL} +KEYSERVER=${MONKEYSPHERE_KEYSERVER:=$KEYSERVER} +CHECK_KEYSERVER=${MONKEYSPHERE_CHECK_KEYSERVER:=$CHECK_KEYSERVER} +MONKEYSPHERE_USER=${MONKEYSPHERE_MONKEYSPHERE_USER:=$MONKEYSPHERE_USER} +MONKEYSPHERE_GROUP=$(get_primary_group "$MONKEYSPHERE_USER") +PROMPT=${MONKEYSPHERE_PROMPT:=$PROMPT} # other variables -CHECK_KEYSERVER=${MONKEYSPHERE_CHECK_KEYSERVER:="true"} -REQUIRED_USER_KEY_CAPABILITY=${MONKEYSPHERE_REQUIRED_USER_KEY_CAPABILITY:="a"} -GNUPGHOME_HOST=${MONKEYSPHERE_GNUPGHOME_HOST:="${SYSDATADIR}/gnupg-host"} -GNUPGHOME_AUTHENTICATION=${MONKEYSPHERE_GNUPGHOME_AUTHENTICATION:="${SYSDATADIR}/gnupg-authentication"} +GNUPGHOME_HOST=${MONKEYSPHERE_GNUPGHOME_HOST:="${MHDATADIR}"} +LOG_PREFIX=${MONKEYSPHERE_LOG_PREFIX:='ms: '} # export variables needed in su invocation export DATE -export MODE -export MONKEYSPHERE_USER export LOG_LEVEL export KEYSERVER export CHECK_KEYSERVER -export REQUIRED_USER_KEY_CAPABILITY +export MONKEYSPHERE_USER +export MONKEYSPHERE_GROUP +export PROMPT export GNUPGHOME_HOST -export GNUPGHOME_AUTHENTICATION export GNUPGHOME +export HOST_FINGERPRINT +export LOG_PREFIX + +if [ "$#" -eq 0 ] ; then + usage + failure "Please supply a subcommand." +fi # get subcommand COMMAND="$1" -[ "$COMMAND" ] || failure "Type '$PGRM help' for usage." shift case $COMMAND in - 'show-key'|'show'|'s') - show_server_key + 'import-key'|'i') + source "${MHSHAREDIR}/import_key" + import_key "$@" ;; - 'extend-key'|'e') - check_host_keyring - extend_key "$@" + 'show-keys'|'show-key'|'show'|'s') + multi_key show_key "$@" ;; - 'add-hostname'|'add-name'|'n+') - check_host_keyring - add_hostname "$@" + 'set-expire'|'extend-key'|'e') + source "${MHSHAREDIR}/set_expire" + set_expire "$@" ;; - 'revoke-hostname'|'revoke-name'|'n-') - check_host_keyring - revoke_hostname "$@" + 'add-servicename'|'add-hostname'|'add-name'|'n+') + source "${MHSHAREDIR}/add_name" + add_name "$@" ;; - 'add-revoker'|'o') - check_host_keyring + 'revoke-servicename'|'revoke-hostname'|'revoke-name'|'n-') + source "${MHSHAREDIR}/revoke_name" + revoke_name "$@" + ;; + + 'add-revoker'|'r+') + source "${MHSHAREDIR}/add_revoker" add_revoker "$@" ;; - 'revoke-key'|'r') - check_host_keyring + 'revoke-key') + source "${MHSHAREDIR}/revoke_key" revoke_key "$@" ;; - 'publish-key'|'publish'|'p') - check_host_keyring - publish_server_key + 'publish-keys'|'publish-key'|'publish'|'p') + source "${MHSHAREDIR}/publish_key" + multi_key publish_key "$@" + ;; + + 'diagnostics'|'d') + source "${MHSHAREDIR}/diagnostics" + diagnostics ;; - 'expert'|'e') - check_user - SUBCOMMAND="$1" - shift - case "$SUBCOMMAND" in - 'import-key'|'i') - import_key "$@" - ;; - - 'gen-key'|'g') - gen_key "$@" - ;; - - 'diagnostics'|'d') - diagnostics - ;; - - *) - failure "Unknown expert subcommand: '$COMMAND' -Type '$PGRM help' for usage." - ;; - esac + 'update-pgp-pub-file') + update_pgp_pub_file ;; 'version'|'v') - echo "$VERSION" + version ;; '--help'|'help'|'-h'|'h'|'?') @@ -255,8 +361,6 @@ Type '$PGRM help' for usage." *) failure "Unknown command: '$COMMAND' -Type '$PGRM help' for usage." +Try '$PGRM help' for usage." ;; esac - -exit "$RETURN"