X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=src%2Fmonkeysphere-host;h=c454354f5b60fd1e85d541401021d25614cd5045;hb=e71c7bb4dff26178f714cd0fcdbb3058effa4066;hp=830646a2d0c2615b98ad86b431818f5b4adc0249;hpb=53fdf9b3e431d9f3538c1b2196276492bec2fc7e;p=monkeysphere.git diff --git a/src/monkeysphere-host b/src/monkeysphere-host index 830646a..c454354 100755 --- a/src/monkeysphere-host +++ b/src/monkeysphere-host @@ -3,27 +3,37 @@ # 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-2009, 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 -SYSDATADIR=${MONKEYSPHERE_SYSDATADIR:-"/var/lib/monkeysphere/host"} +SYSDATADIR=${MONKEYSPHERE_SYSDATADIR:-"/var/lib/monkeysphere"} export SYSDATADIR -# monkeysphere temp directory, in sysdatadir to enable atomic moves of -# authorized_keys files -MSTMPDIR="${SYSDATADIR}/tmp" -export MSTMPDIR +# sharedir for host functions +MHSHAREDIR="${SYSSHAREDIR}/mh" + +# datadir for host functions +MHDATADIR="${SYSDATADIR}/host" + +# host pub key files +HOST_KEY_FILE="${SYSDATADIR}/ssh_host_rsa_key.pub.gpg" # UTC date in ISO 8601 format if needed DATE=$(date -u '+%FT%T') @@ -44,228 +54,94 @@ usage: $PGRM [options] [args] Monkeysphere host admin tool. subcommands: + import-key (i) FILE NAME[:PORT] import existing ssh key to gpg show-key (s) output all host key information - extend-key (e) EXPIRE extend host key expiration + publish-key (p) publish host key to keyserver + set-expire (e) [EXPIRE] set 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) import existing ssh key to gpg - --hostname (-h) NAME[:PORT] hostname for key user ID - --keyfile (-f) FILE key file to import - --expire (-e) EXPIRE date to expire - gen-key (g) generate gpg key for the host - --hostname (-h) NAME[:PORT] hostname for key user ID - --length (-l) BITS key length in bits (2048) - --expire (-e) EXPIRE date to expire - --revoker (-r) FINGERPRINT add a revoker - diagnostics (d) monkeysphere host status + add-revoker (r+) [KEYID|FILE] add a revoker to the host key + revoke-key generate and/or publish revocation + certificate for host 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 "$@" - - # otherwise su command as monkeysphere user - else - su "$MONKEYSPHERE_USER" -c "$@" - fi -} - -# function to interact with the host gnupg keyring +# function to interact with the gpg 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" + GNUPGHOME="$GNUPGHOME_HOST" gpg --no-greeting --quiet --no-tty "$@" } -# check if user is root -is_root() { - [ $(id -u 2>/dev/null) = '0' ] -} +# command to list the info about the host key, in colon format, to +# stdout +gpg_host_list() { + gpg_host --list-keys --with-colons --fixed-list-mode \ + --with-fingerprint --with-fingerprint \ + "0x${HOST_FINGERPRINT}!" -# check that user is root, for functions that require root access -check_user() { - is_root || failure "You must be root to run this command." } -# output just key fingerprint -fingerprint_server_key() { - # set the pipefail option so functions fails if can't read sec key - set -o pipefail - - gpg_host --list-secret-keys --fingerprint \ - --with-colons --fixed-list-mode 2> /dev/null | \ - grep '^fpr:' | head -1 | cut -d: -f10 2>/dev/null +# command for edit key scripts, takes scripts on stdin +gpg_host_edit() { + gpg_host --command-fd 0 --edit-key "0x${HOST_FINGERPRINT}!" "$@" } -# 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." +# export the host public key to the monkeysphere gpg pub key file +update_gpg_pub_file() { + log debug "updating openpgp public key file '$HOST_KEY_FILE'..." + gpg_host --export --armor --export-options export-minimal \ + "0x${HOST_FINGERPRINT}!" > "$HOST_KEY_FILE" } -# output key information -show_server_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" +# load the host fingerprint into the fingerprint variable, using the +# export gpg pub key file +# FIXME: this seems much less than ideal, with all this temp keyring +# stuff. is there a way we can do this without having to create temp +# files? what if we stored the fingerprint in MHDATADIR/fingerprint? +load_fingerprint() { + if [ -f "$HOST_KEY_FILE" ] ; then + HOST_FINGERPRINT=$( \ + (FUBAR=$(mktemp -d) && export GNUPGHOME="$FUBAR" \ + && gpg --quiet --import \ + && gpg --quiet --list-keys --with-colons --with-fingerprint \ + && rm -rf "$FUBAR") <"$HOST_KEY_FILE" \ + | grep '^fpr:' | cut -d: -f10 ) else - log info "You must be root to see host OpenPGP fingerprint." - ret='1' + failure "host key gpg pub file 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' - fi - - return $ret } -# extend the lifetime of a host key: -extend_key() { - local fpr=$(fingerprint_server_key) - local extendTo="$1" - - # get the new expiration date - extendTo=$(get_gpg_expiration "$extendTo") - - gpg_host --quiet --command-fd 0 --edit-key "$fpr" </dev/null) - # update the trustdb for the authentication keyring - gpg_authentication "--check-trustdb" - - show_server_key - - echo - echo "NOTE: User ID revoked, but revocation not published." - echo "Run '$PGRM publish-key' to publish the revocation." + if [ "$line" ] ; then + echo ${line%%:*} + return 0 else - failure "Problem revoking user ID." - fi -} - -# add a revoker to the host key -add_revoker() { - # FIXME: implement! - failure "not implemented yet!" -} - -# revoke the host key -revoke_key() { - # FIXME: implement! - failure "not implemented yet!" -} - -# publish server key to keyserver -publish_server_key() { - read -p "Really publish host key to $KEYSERVER? (y/N) " OK; OK=${OK:=N} - if [ ${OK/y/Y} != 'Y' ] ; then - failure "key not published." + return 1 fi - - # find the key fingerprint - fingerprint=$(fingerprint_server_key) - - # publish host key - gpg_authentication "--keyserver $KEYSERVER --send-keys '0x${fingerprint}!'" } -diagnostics() { -# * check on the status and validity of the key and public certificates - local seckey - local keysfound - local curdate - local warnwindow - local warndate - local create - local expire - local uid - local fingerprint - local badhostkeys - local sshd_config - local problemsfound=0 - - # FIXME: what's the correct, cross-platform answer? - sshd_config=/etc/ssh/sshd_config - seckey=$(gpg_host --list-secret-keys --fingerprint --with-colons --fixed-list-mode) - keysfound=$(echo "$seckey" | grep -c ^sec:) - curdate=$(date +%s) - # warn when anything is 2 months away from expiration - warnwindow='2 months' - warndate=$(advance_date $warnwindow +%s) - - if ! id monkeysphere >/dev/null ; then - echo "! No monkeysphere user found! Please create a monkeysphere system user with bash as its shell." - problemsfound=$(($problemsfound+1)) - fi - - if ! [ -d "$SYSDATADIR" ] ; then - echo "! no $SYSDATADIR directory found. Please create it." - problemsfound=$(($problemsfound+1)) - fi - - echo "Checking host GPG key..." - if (( "$keysfound" < 1 )); then - echo "! No host key found." - echo " - Recommendation: run 'monkeysphere-server gen-key'" - problemsfound=$(($problemsfound+1)) - elif (( "$keysfound" > 1 )); then - echo "! More than one host key found?" - # FIXME: recommend a way to resolve this - problemsfound=$(($problemsfound+1)) - else - create=$(echo "$seckey" | grep ^sec: | cut -f6 -d:) - expire=$(echo "$seckey" | grep ^sec: | cut -f7 -d:) - fingerprint=$(echo "$seckey" | grep ^fpr: | head -n1 | cut -f10 -d:) - # check for key expiration: - if [ "$expire" ]; then - if (( "$expire" < "$curdate" )); then - echo "! Host key is expired." - echo " - Recommendation: extend lifetime of key with 'monkeysphere-server extend-key'" - problemsfound=$(($problemsfound+1)) - elif (( "$expire" < "$warndate" )); then - echo "! Host key expires in less than $warnwindow:" $(advance_date $(( $expire - $curdate )) seconds +%F) - echo " - Recommendation: extend lifetime of key with 'monkeysphere-server extend-key'" - problemsfound=$(($problemsfound+1)) - fi - fi - - # and weirdnesses: - if [ "$create" ] && (( "$create" > "$curdate" )); then - echo "! Host key was created in the future(?!). Is your clock correct?" - echo " - Recommendation: Check clock ($(date +%F_%T)); use NTP?" - problemsfound=$(($problemsfound+1)) - fi - - # check for UserID expiration: - echo "$seckey" | grep ^uid: | cut -d: -f6,7,10 | \ - while IFS=: read create expire uid ; do - # FIXME: should we be doing any checking on the form - # of the User ID? Should we be unmangling it somehow? - - if [ "$create" ] && (( "$create" > "$curdate" )); then - echo "! User ID '$uid' was created in the future(?!). Is your clock correct?" - echo " - Recommendation: Check clock ($(date +%F_%T)); use NTP?" - problemsfound=$(($problemsfound+1)) - fi - if [ "$expire" ] ; then - if (( "$expire" < "$curdate" )); then - echo "! User ID '$uid' is expired." - # FIXME: recommend a way to resolve this - problemsfound=$(($problemsfound+1)) - elif (( "$expire" < "$warndate" )); then - echo "! User ID '$uid' expires in less than $warnwindow:" $(advance_date $(( $expire - $curdate )) seconds +%F) - # FIXME: recommend a way to resolve this - problemsfound=$(($problemsfound+1)) - fi - fi +# show info about the host key +show_key() { + local GNUPGHOME + 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" + + # create the ssh key + TMPSSH="$GNUPGHOME"/ssh_host_key_rsa_pub + openpgp2ssh <"$HOST_KEY_FILE" 2>/dev/null >"$TMPSSH" + + # get the gpg fingerprint + HOST_FINGERPRINT=$(gpg --quiet --list-keys --with-colons --with-fingerprint \ + | grep '^fpr:' | cut -d: -f10 ) + + # 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 --fingerprint \ + --list-options show-unusable-uids 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 \ + | 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 - -# FIXME: verify that the host key is properly published to the -# keyservers (do this with the non-privileged user) - -# FIXME: check that there are valid, non-expired certifying signatures -# attached to the host key after fetching from the public keyserver -# (do this with the non-privileged user as well) - -# FIXME: propose adding a revoker to the host key if none exist (do we -# have a way to do that after key generation?) - - # Ensure that the ssh_host_rsa_key file is present and non-empty: echo - echo "Checking host SSH key..." - if [ ! -s "${SYSDATADIR}/ssh_host_rsa_key" ] ; then - echo "! The host key as prepared for SSH (${SYSDATADIR}/ssh_host_rsa_key) is missing or empty." - problemsfound=$(($problemsfound+1)) - else - if [ $(ls -l "${SYSDATADIR}/ssh_host_rsa_key" | cut -f1 -d\ ) != '-rw-------' ] ; then - echo "! Permissions seem wrong for ${SYSDATADIR}/ssh_host_rsa_key -- should be 0600." - problemsfound=$(($problemsfound+1)) - fi - - # propose changes needed for sshd_config (if any) - if ! grep -q "^HostKey[[:space:]]\+${SYSDATADIR}/ssh_host_rsa_key$" "$sshd_config"; then - echo "! $sshd_config does not point to the monkeysphere host key (${SYSDATADIR}/ssh_host_rsa_key)." - echo " - Recommendation: add a line to $sshd_config: 'HostKey ${SYSDATADIR}/ssh_host_rsa_key'" - problemsfound=$(($problemsfound+1)) - fi - if badhostkeys=$(grep -i '^HostKey' "$sshd_config" | grep -v "^HostKey[[:space:]]\+${SYSDATADIR}/ssh_host_rsa_key$") ; then - echo "! $sshd_config refers to some non-monkeysphere host keys:" - echo "$badhostkeys" - echo " - Recommendation: remove the above HostKey lines from $sshd_config" - problemsfound=$(($problemsfound+1)) - fi - - # FIXME: test (with ssh-keyscan?) that the running ssh - # daemon is actually offering the monkeysphere host key. - - fi fi -# FIXME: look at the ownership/privileges of the various keyrings, -# directories housing them, etc (what should those values be? can -# we make them as minimal as possible?) - -# FIXME: look to see that the ownertrust rules are set properly on the -# authentication keyring - -# FIXME: make sure that at least one identity certifier exists - -# FIXME: look at the timestamps on the monkeysphere-generated -# authorized_keys files -- warn if they seem out-of-date. - -# FIXME: check for a cronjob that updates monkeysphere-generated -# authorized_keys? + # list the pgp fingerprint + echo "OpenPGP fingerprint: $HOST_FINGERPRINT" - echo - echo "Checking for MonkeySphere-enabled public-key authentication for users ..." - # Ensure that User ID authentication is enabled: - if ! grep -q "^AuthorizedKeysFile[[:space:]]\+${SYSDATADIR}/authorized_keys/%u$" "$sshd_config"; then - echo "! $sshd_config does not point to monkeysphere authorized keys." - echo " - Recommendation: add a line to $sshd_config: 'AuthorizedKeysFile ${SYSDATADIR}/authorized_keys/%u'" - problemsfound=$(($problemsfound+1)) - fi - if badauthorizedkeys=$(grep -i '^AuthorizedKeysFile' "$sshd_config" | grep -v "^AuthorizedKeysFile[[:space:]]\+${SYSDATADIR}/authorized_keys/%u$") ; then - echo "! $sshd_config refers to non-monkeysphere authorized_keys files:" - echo "$badauthorizedkeys" - echo " - Recommendation: remove the above AuthorizedKeysFile lines from $sshd_config" - problemsfound=$(($problemsfound+1)) - fi + # list the ssh fingerprint + echo -n "ssh fingerprint: " + ssh-keygen -l -f "$TMPSSH" | awk '{ print $1, $2, $4 }' - if [ "$problemsfound" -gt 0 ]; then - echo "When the above $problemsfound issue"$(if [ "$problemsfound" -eq 1 ] ; then echo " is" ; else echo "s are" ; fi)" resolved, please re-run:" - echo " monkeysphere-server diagnostics" - else - echo "Everything seems to be in order!" - fi + # 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} +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}"} # 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 PROMPT export GNUPGHOME_HOST -export GNUPGHOME_AUTHENTICATION export GNUPGHOME +export HOST_FINGERPRINT # get subcommand COMMAND="$1" @@ -560,72 +250,72 @@ COMMAND="$1" shift case $COMMAND in + 'import-key'|'i') + check_host_key + source "${MHSHAREDIR}/import_key" + import_key "$@" + ;; + 'show-key'|'show'|'s') - show_server_key + check_host_no_key + show_key ;; - 'extend-key'|'e') - check_user - check_host_keyring - extend_key "$@" + 'set-expire'|'extend-key'|'e') + check_host_no_key + load_fingerprint + source "${MHSHAREDIR}/set_expire" + set_expire "$@" ;; 'add-hostname'|'add-name'|'n+') - check_user - check_host_keyring + check_host_no_key + load_fingerprint + source "${MHSHAREDIR}/add_hostname" add_hostname "$@" ;; 'revoke-hostname'|'revoke-name'|'n-') - check_user - check_host_keyring + check_host_no_key + load_fingerprint + source "${MHSHAREDIR}/revoke_hostname" revoke_hostname "$@" ;; - 'add-revoker'|'o') - check_user - check_host_keyring + 'add-revoker'|'r+') + check_host_no_key + load_fingerprint + source "${MHSHAREDIR}/add_revoker" add_revoker "$@" ;; - 'revoke-key'|'r') - check_user - check_host_keyring + 'revoke-key') + check_host_no_key + load_fingerprint + source "${MHSHAREDIR}/revoke_key" revoke_key "$@" ;; 'publish-key'|'publish'|'p') - check_user - check_host_keyring - publish_server_key + check_host_no_key + load_fingerprint + source "${MHSHAREDIR}/publish_key" + publish_key ;; - '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 + 'diagnostics'|'d') + load_fingerprint + source "${MHSHAREDIR}/diagnostics" + diagnostics + ;; + + 'update-gpg-pub-file') + load_fingerprint_secret + update_gpg_pub_file ;; 'version'|'v') - echo "$VERSION" + version ;; '--help'|'help'|'-h'|'h'|'?')