X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=src%2Fcommon;h=44bdb670f515384646bd6d92a5f11ad6e6b5329a;hb=39f3516d7f57397cb61c5a28d3d199ad9bb1a719;hp=d20d306c63793c375fe4d03f77f1c4595b5fe8e8;hpb=56e8fa26a4ce594f2c5c71b600df11fc9f255956;p=monkeysphere.git diff --git a/src/common b/src/common index d20d306..44bdb67 100644 --- a/src/common +++ b/src/common @@ -20,14 +20,10 @@ export ETC ######################################################################## ### UTILITY FUNCTIONS -error() { - log "$1" - ERR=${2:-'1'} -} - +# failure function. exits with code 255, unless specified otherwise. failure() { echo "$1" >&2 - exit ${2:-'1'} + exit ${2:-'255'} } # write output to stderr @@ -68,11 +64,106 @@ check_capability() { return 0 } -# convert escaped characters from gpg output back into original -# character -# FIXME: undo all escape character translation in with-colons gpg output -unescape() { - echo "$1" | sed 's/\\x3a/:/' +# hash of a file +file_hash() { + md5sum "$1" 2> /dev/null +} + +# convert escaped characters in pipeline from gpg output back into +# original character +# FIXME: undo all escape character translation in with-colons gpg +# output +gpg_unescape() { + sed 's/\\x3a/:/g' +} + +# convert nasty chars into gpg-friendly form in pipeline +# FIXME: escape everything, not just colons! +gpg_escape() { + sed 's/:/\\x3a/g' +} + +# prompt for GPG-formatted expiration, and emit result on stdout +get_gpg_expiration() { + local keyExpire= + + cat >&2 < = key expires in n days + w = key expires in n weeks + m = key expires in n months + y = key expires in n years +EOF + while [ -z "$keyExpire" ] ; do + read -p "Key is valid for? (0) " keyExpire + if ! test_gpg_expire ${keyExpire:=0} ; then + echo "invalid value" >&2 + unset keyExpire + fi + done + echo "$keyExpire" +} + +passphrase_prompt() { + local prompt="$1" + local fifo="$2" + local PASS + + if [ "$DISPLAY" ] && which "${SSH_ASKPASS:-ssh-askpass}" >/dev/null; then + "${SSH_ASKPASS:-ssh-askpass}" "$prompt" > "$fifo" + else + read -s -p "$prompt" PASS + # Uses the builtin echo, so should not put the passphrase into + # the process table. I think. --dkg + echo "$PASS" > "$fifo" + fi +} + +test_gnu_dummy_s2k_extension() { + +# this block contains a demonstration private key that has had the +# primary key stripped out using the GNU S2K extension known as +# "gnu-dummy" (see /usr/share/doc/gnupg/DETAILS.gz). The subkey is +# present in cleartext, however. + +# openpgp2ssh will be able to deal with this based on whether the +# local copy of GnuTLS contains read_s2k support that can handle it. + +# read up on that here: + +# http://lists.gnu.org/archive/html/gnutls-devel/2008-08/msg00005.html + +echo " +-----BEGIN PGP PRIVATE KEY BLOCK----- +Version: GnuPG v1.4.9 (GNU/Linux) + +lQCVBEO3YdABBACRqqEnucag4+vyZny2M67Pai5+5suIRRvY+Ly8Ms5MvgCi3EVV +xT05O/+0ShiRaf+QicCOFrhbU9PZzzU+seEvkeW2UCu4dQfILkmj+HBEIltGnHr3 +G0yegHj5pnqrcezERURf2e17gGFWX91cXB9Cm721FPXczuKraphKwCA9PwARAQAB +/gNlAkdOVQG0OURlbW9uc3RyYXRpb24gS2V5IGZvciBTMksgR05VIGV4dGVuc2lv +biAxMDAxIC0tIGdudS1kdW1teYi8BBMBAgAmBQJDt2HQAhsDBQkB4TOABgsJCAcD +AgQVAggDBBYCAwECHgECF4AACgkQQZUwSa4UDezTOQP/TMQXUVrWzHYZGopoPZ2+ +ZS3qddiznBHsgb7MGYg1KlTiVJSroDUBCHIUJvdQKZV9zrzrFl47D07x6hGyUPHV +aZXvuITW8t1o5MMHkCy3pmJ2KgfDvdUxrBvLfgPMICA4c6zA0mWquee43syEW9NY +g3q61iPlQwD1J1kX1wlimLCdAdgEQ7dh0AEEANAwa63zlQbuy1Meliy8otwiOa+a +mH6pxxUgUNggjyjO5qx+rl25mMjvGIRX4/L1QwIBXJBVi3SgvJW1COZxZqBYqj9U +8HVT07mWKFEDf0rZLeUE2jTm16cF9fcW4DQhW+sfYm+hi2sY3HeMuwlUBK9KHfW2 ++bGeDzVZ4pqfUEudABEBAAEAA/0bemib+wxub9IyVFUp7nPobjQC83qxLSNzrGI/ +RHzgu/5CQi4tfLOnwbcQsLELfker2hYnjsLrT9PURqK4F7udrWEoZ1I1LymOtLG/ +4tNZ7Mnul3wRC2tCn7FKx8sGJwGh/3li8vZ6ALVJAyOia5TZ/buX0+QZzt6+hPKk +7MU1WQIA4bUBjtrsqDwro94DvPj3/jBnMZbXr6WZIItLNeVDUcM8oHL807Am97K1 +ueO/f6v1sGAHG6lVPTmtekqPSTWBfwIA7CGFvEyvSALfB8NUa6jtk27NCiw0csql +kuhCmwXGMVOiryKEfegkIahf2bAd/gnWHPrpWp7bUE20v8YoW22I4wIAhnm5Wr5Q +Sy7EHDUxmJm5TzadFp9gq08qNzHBpXSYXXJ3JuWcL1/awUqp3tE1I6zZ0hZ38Ia6 +SdBMN88idnhDPqPoiKUEGAECAA8FAkO3YdACGyAFCQHhM4AACgkQQZUwSa4UDezm +vQP/ZhK+2ly9oI2z7ZcNC/BJRch0/ybQ3haahII8pXXmOThpZohr/LUgoWgCZdXg +vP6yiszNk2tIs8KphCAw7Lw/qzDC2hEORjWO4f46qk73RAgSqG/GyzI4ltWiDhqn +vnQCFl3+QFSe4zinqykHnLwGPMXv428d/ZjkIc2ju8dRsn4= +=CR5w +-----END PGP PRIVATE KEY BLOCK----- +" | openpgp2ssh 4129E89D17C1D591 >/dev/null 2>/dev/null + } # remove all lines with specified string from specified file @@ -83,8 +174,17 @@ remove_line() { file="$1" string="$2" - # if the line is there are removed, return 0 - if [ "$file" -a "$string" ] ; then + if [ -z "$file" -o -z "$string" ] ; then + return 1 + fi + + if [ ! -e "$file" ] ; then + return 1 + fi + + # if the string is in the file... + if grep -q -F "$string" "$file" 2> /dev/null ; then + # remove the line with the string, and return 0 grep -v -F "$string" "$file" | sponge "$file" return 0 # otherwise return 1 @@ -93,6 +193,24 @@ remove_line() { fi } +# remove all lines with MonkeySphere strings in file +remove_monkeysphere_lines() { + local file + + file="$1" + + if [ -z "$file" ] ; then + return 1 + fi + + if [ ! -e "$file" ] ; then + return 1 + fi + + egrep -v '^MonkeySphere[[:digit:]]{4}(-[[:digit:]]{2}){2}T[[:digit:]]{2}(:[[:digit:]]{2}){2}$' \ + "$file" | sponge "$file" +} + # translate ssh-style path variables %h and %u translate_ssh_variables() { local uname @@ -112,6 +230,53 @@ translate_ssh_variables() { echo "$path" } +# test that a string to conforms to GPG's expiration format +test_gpg_expire() { + echo "$1" | egrep -q "^[0-9]+[mwy]?$" +} + +# check that a file is properly owned, and that all it's parent +# directories are not group/other writable +check_key_file_permissions() { + local user + local path + local access + local gAccess + local oAccess + + # function to check that an octal corresponds to writability + is_write() { + [ "$1" -eq 2 -o "$1" -eq 3 -o "$1" -eq 6 -o "$1" -eq 7 ] + } + + user="$1" + path="$2" + + # return 0 is path does not exist + [ -e "$path" ] || return 0 + + owner=$(stat --format '%U' "$path") + access=$(stat --format '%a' "$path") + gAccess=$(echo "$access" | cut -c2) + oAccess=$(echo "$access" | cut -c3) + + # check owner + if [ "$owner" != "$user" -a "$owner" != 'root' ] ; then + return 1 + fi + + # check group/other writability + if is_write "$gAccess" || is_write "$oAccess" ; then + return 2 + fi + + if [ "$path" = '/' ] ; then + return 0 + else + check_key_file_permissions $(dirname "$path") + fi +} + ### CONVERSION UTILITIES # output the ssh key for a given key ID @@ -224,7 +389,7 @@ gpg_fetch_userid() { # (see /usr/share/doc/gnupg/DETAILS.gz) # output is one line for every found key, in the following format: # -# flag fingerprint +# flag:fingerprint # # "flag" is an acceptability flag, 0 = ok, 1 = bad # "fingerprint" is the fingerprint of the key @@ -256,23 +421,21 @@ process_user_id() { fi requiredPubCapability=$(echo "$requiredCapability" | tr "[:lower:]" "[:upper:]") + # fetch the user ID if necessary/requested + gpg_fetch_userid "$userID" + # output gpg info for (exact) userid and store gpgOut=$(gpg --list-key --fixed-list-mode --with-colon \ --with-fingerprint --with-fingerprint \ ="$userID" 2>/dev/null) - # fetch the user ID if necessary/requested - gpg_fetch_userid "$userID" - # if the gpg query return code is not 0, return 1 if [ "$?" -ne 0 ] ; then - log " - key not found." + log " no primary keys found." return 1 fi # loop over all lines in the gpg output and process. - # need to do it this way (as opposed to "while read...") so that - # variables set in loop will be visible outside of loop echo "$gpgOut" | cut -d: -f1,2,5,10,12 | \ while IFS=: read -r type validity keyid uidfpr usage ; do # process based on record type @@ -312,29 +475,41 @@ process_user_id() { fi ;; 'uid') # user ids - # if an acceptable user ID was already found, skip - if [ "$uidOK" ] ; then + if [ "$lastKey" != pub ] ; then + log " - got a user ID after a sub key?! user IDs should only follow primary keys!" continue fi - # if the user ID does not match, skip - if [ "$(unescape "$uidfpr")" != "$userID" ] ; then + # if an acceptable user ID was already found, skip + if [ "$uidOK" = 'true' ] ; then continue fi - # if the user ID validity is not ok, skip - if [ "$validity" != 'u' -a "$validity" != 'f' ] ; then + # if the user ID does matches... + if [ "$(echo "$uidfpr" | gpg_unescape)" = "$userID" ] ; then + # and the user ID validity is ok + if [ "$validity" = 'u' -o "$validity" = 'f' ] ; then + # mark user ID acceptable + uidOK=true + fi + else continue fi - # mark user ID acceptable - uidOK=true - # output a line for the primary key # 0 = ok, 1 = bad if [ "$keyOK" -a "$uidOK" -a "$lastKeyOK" ] ; then - log " * acceptable key found." - echo "0:${fingerprint}" + log " * acceptable primary key." + if [ -z "$sshKey" ] ; then + log " ! primary key could not be translated (not RSA or DSA?)." + else + echo "0:${sshKey}" + fi else - echo "1:${fingerprint}" + log " - unacceptable primary key." + if [ -z "$sshKey" ] ; then + log " ! primary key could not be translated (not RSA or DSA?)." + else + echo "1:${sshKey}" + fi fi ;; 'sub') # sub keys @@ -342,7 +517,17 @@ process_user_id() { lastKey=sub lastKeyOK= fingerprint= + + # don't bother with sub keys if the primary key is not valid + if [ "$keyOK" != true ] ; then + continue + fi + # don't bother with sub keys if no user ID is acceptable: + if [ "$uidOK" != true ] ; then + continue + fi + # if sub key validity is not ok, skip if [ "$validity" != 'u' -a "$validity" != 'f' ] ; then continue @@ -358,51 +543,76 @@ process_user_id() { 'fpr') # key fingerprint fingerprint="$uidfpr" + sshKey=$(gpg2ssh "$fingerprint") + # if the last key was the pub key, skip if [ "$lastKey" = pub ] ; then continue fi - - # output a line for the last subkey + + # output a line for the sub key # 0 = ok, 1 = bad if [ "$keyOK" -a "$uidOK" -a "$lastKeyOK" ] ; then - log " * acceptable key found." - echo "0:${fingerprint}" + log " * acceptable sub key." + if [ -z "$sshKey" ] ; then + log " ! sub key could not be translated (not RSA or DSA?)." + else + echo "0:${sshKey}" + fi else - echo "1:${fingerprint}" + log " - unacceptable sub key." + if [ -z "$sshKey" ] ; then + log " ! sub key could not be translated (not RSA or DSA?)." + else + echo "1:${sshKey}" + fi fi ;; esac - done + done | sort -t: -k1 -n -r + # NOTE: this last sort is important so that the "good" keys (key + # flag '0') come last. This is so that they take precedence when + # being processed in the key files over "bad" keys (key flag '1') } # process a single host in the known_host file process_host_known_hosts() { local host local userID + local nKeys + local nKeysOK local ok - local keyid - local idOK - local idRemoved + local sshKey local tmpfile host="$1" + userID="ssh://${host}" - log "processing host: $host" + log "processing: $host" - userID="ssh://${host}" + nKeys=0 + nKeysOK=0 + + IFS=$'\n' + for line in $(process_user_id "${userID}") ; do + # note that key was found + nKeys=$((nKeys+1)) - for line in $(process_user_id "ssh://${host}") ; do ok=$(echo "$line" | cut -d: -f1) - keyid=$(echo "$line" | cut -d: -f2) + sshKey=$(echo "$line" | cut -d: -f2) - sshKey=$(gpg2ssh "$keyid") + if [ -z "$sshKey" ] ; then + continue + fi # remove the old host key line, and note if removed - remove_line "$KNOWN_HOSTS" "$sshKey" && idRemoved=true + remove_line "$KNOWN_HOSTS" "$sshKey" # if key OK, add new host line if [ "$ok" -eq '0' ] ; then + # note that key was found ok + nKeysOK=$((nKeysOK+1)) + # hash if specified if [ "$HASH_KNOWN_HOSTS" = 'true' ] ; then # FIXME: this is really hackish cause ssh-keygen won't @@ -415,21 +625,19 @@ process_host_known_hosts() { else ssh2known_hosts "$host" "$sshKey" >> "$KNOWN_HOSTS" fi - - # note that at least one ok id was found - idOK=true fi done - # if at least one ok id was found, return 0 - if [ "$idOK" ] ; then - return 0 - - # if ids were only removed, return 2 - elif [ "$idRemoved" ] ; then - return 2 - - # else return 1, to indicate nothing happened + # if at least one key was found... + if [ "$nKeys" -gt 0 ] ; then + # if ok keys were found, return 0 + if [ "$nKeysOK" -gt 0 ] ; then + return 0 + # else return 2 + else + return 2 + fi + # if no keys were found, return 1 else return 1 fi @@ -439,9 +647,10 @@ process_host_known_hosts() { # line update_known_hosts() { local nHosts - local host local nHostsOK local nHostsBAD + local fileCheck + local host # the number of hosts specified on command line nHosts="$#" @@ -455,6 +664,9 @@ update_known_hosts() { # create a lockfile on known_hosts lockfile-create "$KNOWN_HOSTS" + # note pre update file checksum + fileCheck="$(file_hash "$KNOWN_HOSTS")" + for host ; do # process the host process_host_known_hosts "$host" @@ -476,21 +688,23 @@ update_known_hosts() { lockfile-remove "$KNOWN_HOSTS" # note if the known_hosts file was updated - if [ "$nHostsOK" -gt 0 -o "$nHostsBAD" -gt 0 ] ; then + if [ "$(file_hash "$KNOWN_HOSTS")" != "$fileCheck" ] ; then log "known_hosts file updated." fi - # if all hosts were OK, return 0 - if [ "$nHostsOK" -eq "$nHosts" ] ; then + # if an acceptable host was found, return 0 + if [ "$nHostsOK" -gt 0 ] ; then return 0 - - # if all hosts were BAD, return 2 - elif [ "$nHostsBAD" -eq "$nHosts" ] ; then - return 2 - - # else return 1 + # else if no ok hosts were found... else - return 1 + # if no bad host were found then no hosts were found at all, + # and return 1 + if [ "$nHostsBAD" -eq 0 ] ; then + return 1 + # else if at least one bad host was found, return 2 + else + return 2 + fi fi } @@ -502,6 +716,11 @@ process_known_hosts() { hosts=$(meat "$KNOWN_HOSTS" | cut -d ' ' -f 1 | grep -v '^|.*$' | tr , ' ' | tr '\n' ' ') + if [ -z "$hosts" ] ; then + log "no hosts to process." + return + fi + # take all the hosts from the known_hosts file (first # field), grep out all the hashed hosts (lines starting # with '|')... @@ -511,42 +730,52 @@ process_known_hosts() { # process uids for the authorized_keys file process_uid_authorized_keys() { local userID + local nKeys + local nKeysOK local ok - local keyid - local idOK - local idRemoved + local sshKey userID="$1" - log "processing user ID: $userID" + log "processing: $userID" + + nKeys=0 + nKeysOK=0 + IFS=$'\n' for line in $(process_user_id "$userID") ; do + # note that key was found + nKeys=$((nKeys+1)) + ok=$(echo "$line" | cut -d: -f1) - keyid=$(echo "$line" | cut -d: -f2) + sshKey=$(echo "$line" | cut -d: -f2) - sshKey=$(gpg2ssh "$keyid") + if [ -z "$sshKey" ] ; then + continue + fi # remove the old host key line - remove_line "$AUTHORIZED_KEYS" "$sshKey" && idRemoved=true + remove_line "$AUTHORIZED_KEYS" "$sshKey" # if key OK, add new host line if [ "$ok" -eq '0' ] ; then - ssh2authorized_keys "$userID" "$sshKey" >> "$AUTHORIZED_KEYS" + # note that key was found ok + nKeysOK=$((nKeysOK+1)) - # note that at least one ok id was found - idOK=true + ssh2authorized_keys "$userID" "$sshKey" >> "$AUTHORIZED_KEYS" fi done - # if at least one ok id was found, return 0 - if [ "$idOK" ] ; then - return 0 - - # if ids were only removed, return 2 - elif [ "$idRemoved" ] ; then - return 2 - - # else return 1, to indicate nothing happened + # if at least one key was found... + if [ "$nKeys" -gt 0 ] ; then + # if ok keys were found, return 0 + if [ "$nKeysOK" -gt 0 ] ; then + return 0 + # else return 2 + else + return 2 + fi + # if no keys were found, return 1 else return 1 fi @@ -559,6 +788,7 @@ update_authorized_keys() { local nIDs local nIDsOK local nIDsBAD + local fileCheck # the number of ids specified on command line nIDs="$#" @@ -572,6 +802,12 @@ update_authorized_keys() { # create a lockfile on authorized_keys lockfile-create "$AUTHORIZED_KEYS" + # note pre update file checksum + fileCheck="$(file_hash "$AUTHORIZED_KEYS")" + + # remove any monkeysphere lines from authorized_keys file + remove_monkeysphere_lines "$AUTHORIZED_KEYS" + for userID ; do # process the user ID, change return code if key not found for # user ID @@ -595,79 +831,49 @@ update_authorized_keys() { lockfile-remove "$AUTHORIZED_KEYS" # note if the authorized_keys file was updated - if [ "$nIDsOK" -gt 0 -o "$nIDsBAD" -gt 0 ] ; then + if [ "$(file_hash "$AUTHORIZED_KEYS")" != "$fileCheck" ] ; then log "authorized_keys file updated." fi - # if all ids were OK, return 0 - if [ "$nIDsOK" -eq "$nIDs" ] ; then + # if an acceptable id was found, return 0 + if [ "$nIDsOK" -gt 0 ] ; then return 0 - - # if all ids were BAD, return 2 - elif [ "$nIDsBAD" -eq "$nIDs" ] ; then - return 2 - - # else return 1 + # else if no ok ids were found... else - return 1 + # if no bad ids were found then no ids were found at all, and + # return 1 + if [ "$nIDsBAD" -eq 0 ] ; then + return 1 + # else if at least one bad id was found, return 2 + else + return 2 + fi fi } # process an authorized_user_ids file for authorized_keys process_authorized_user_ids() { local line + local nline local userIDs authorizedUserIDs="$1" log "processing authorized_user_ids file..." - # extract user IDs from authorized_user_ids file - for line in $(seq 1 $(meat "$authorizedUserIDs" | wc -l)) ; do - userIDs[$((line-1))]=$(cutline "$line" "$authorizedUserIDs") - done - - update_authorized_keys "${userIDs[@]}" -} - -# EXPERIMENTAL (unused) process userids found in authorized_keys file -# go through line-by-line, extract monkeysphere userids from comment -# fields, and process each userid -# NOT WORKING -process_authorized_keys() { - local authorizedKeys - local userID - local returnCode - - # default return code is 0, and is set to 1 if a key for a user - # is not found - returnCode=0 - - authorizedKeys="$1" - - # take all the monkeysphere userids from the authorized_keys file - # comment field (third field) that starts with "MonkeySphere uid:" - # FIXME: needs to handle authorized_keys options (field 0) - meat "$authorizedKeys" | \ - while read -r options keytype key comment ; do - # if the comment field is empty, assume the third field was - # the comment - if [ -z "$comment" ] ; then - comment="$key" - fi + if ! meat "$authorizedUserIDs" > /dev/null ; then + log "no user IDs to process." + return + fi - if echo "$comment" | egrep -v -q '^MonkeySphere[[:digit:]]{4}(-[[:digit:]]{2}){2}T[[:digit:]]{2}(:[[:digit:]]{2}){2}' ; then - continue - fi - userID=$(echo "$comment" | awk "{ print $2 }") - if [ -z "$userID" ] ; then - continue - fi + nline=0 - # process the userid - log "processing userid: '$userID'" - process_user_id "$userID" > /dev/null || returnCode=1 + # extract user IDs from authorized_user_ids file + IFS=$'\n' + for line in $(meat "$authorizedUserIDs") ; do + userIDs["$nline"]="$line" + nline=$((nline+1)) done - return "$returnCode" + update_authorized_keys "${userIDs[@]}" }