Merge commit 'dkg/master'
[monkeysphere.git] / src / common
index 240de38886f5ae39568cf96cb23099946253bbe7..bb988f785e983ad5bcb90492f3390b618ce2c737 100644 (file)
@@ -64,11 +64,23 @@ 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'
 }
 
 # remove all lines with specified string from specified file
@@ -79,17 +91,43 @@ remove_line() {
     file="$1"
     string="$2"
 
-    # if the string is in the file and removed, return 0
+    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
     else
        return 1
     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
@@ -111,7 +149,49 @@ translate_ssh_variables() {
 
 # test that a string to conforms to GPG's expiration format
 test_gpg_expire() {
-    echo "$1" | egrep -q "^[0-9][mwy]?$"
+    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
@@ -226,7 +306,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
@@ -268,13 +348,11 @@ process_user_id() {
 
     # 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
@@ -314,12 +392,20 @@ process_user_id() {
                fi
                ;;
            'uid') # user ids
+               if [ "$lastKey" != pub ] ; then
+                   log " - got a user ID after a sub key!  user IDs should only follow primary keys!"
+                   continue
+               fi
+               # don't bother with a uid if there is no valid or reasonable primary key.
+               if [ "$keyOK" != true ] ; then
+                   continue
+               fi
                # if an acceptable user ID was already found, skip
                if [ "$uidOK" ] ; then
                    continue
                fi
                # if the user ID does not match, skip
-               if [ "$(unescape "$uidfpr")" != "$userID" ] ; then
+               if [ "$(echo "$uidfpr" | gpg_unescape)" != "$userID" ] ; then
                    continue
                fi
                # if the user ID validity is not ok, skip
@@ -333,10 +419,19 @@ process_user_id() {
                # 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
@@ -344,7 +439,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
@@ -360,22 +465,36 @@ 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
@@ -385,26 +504,28 @@ process_host_known_hosts() {
     local nKeys
     local nKeysOK
     local ok
-    local keyid
+    local sshKey
     local tmpfile
 
     host="$1"
-
-    log "processing host: $host"
-
     userID="ssh://${host}"
 
+    log "processing: $host"
+
     nKeys=0
     nKeysOK=0
 
-    for line in $(process_user_id "ssh://${host}") ; do
+    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, and note if removed
        remove_line "$KNOWN_HOSTS" "$sshKey"
@@ -450,6 +571,7 @@ update_known_hosts() {
     local nHosts
     local nHostsOK
     local nHostsBAD
+    local fileCheck
     local host
 
     # the number of hosts specified on command line
@@ -464,6 +586,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"
@@ -485,7 +610,7 @@ 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
 
@@ -513,6 +638,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 '|')...
@@ -525,23 +655,26 @@ process_uid_authorized_keys() {
     local nKeys
     local nKeysOK
     local ok
-    local keyid
+    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"
@@ -577,6 +710,7 @@ update_authorized_keys() {
     local nIDs
     local nIDsOK
     local nIDsBAD
+    local fileCheck
 
     # the number of ids specified on command line
     nIDs="$#"
@@ -590,6 +724,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
@@ -613,7 +753,7 @@ 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
 
@@ -636,58 +776,26 @@ update_authorized_keys() {
 # 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
+    if ! meat "$authorizedUserIDs" > /dev/null ; then
+       log "no user IDs to process."
+       return
+    fi
 
-    # 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
+    nline=0
 
-       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
-
-       # 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[@]}"
 }