rework out user id processing is done to provide better diagnostic output.
[monkeysphere.git] / src / common
index 01e52b8b86c44b11d13ce6a7001498cb7923ea78..f5bb3bbbf4f0d40b5ebce3229658d9fbce4ec339 100644 (file)
@@ -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
@@ -83,9 +79,14 @@ remove_line() {
     file="$1"
     string="$2"
 
-    # if the line is there are removed, return 0
-    if [ "$file" -a "$string" ] ; then
-       grep -v "$string" "$file" | sponge "$file"
+    if [ -z "$file" -o -z "$string" ] ; 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
@@ -112,6 +113,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
@@ -256,23 +304,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
@@ -331,10 +377,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."
+                   else
+                       echo "0:${sshKey}"
+                   fi
                else
-                   echo "1:${fingerprint}"
+                   log "  - unacceptable primary key."
+                   if [ -z "$sshKey" ] ; then
+                       log "   ! primary key could not be translated."
+                   else
+                       echo "1:${sshKey}"
+                   fi
                fi
                ;;
            'sub') # sub keys
@@ -358,18 +413,29 @@ 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 primary 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."
+                   else
+                       echo "0:${sshKey}"
+                   fi
                else
-                   echo "1:${fingerprint}"
+                   log "  - unacceptable sub key."
+                   if [ -z "$sshKey" ] ; then
+                       log "    ! sub key could not be translated."
+                   else
+                       echo "1:${sshKey}"
+                   fi
                fi
                ;;
        esac
@@ -380,29 +446,41 @@ process_user_id() {
 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"
 
-    log "processing host: $host"
+    log "processing: $host"
 
     userID="ssh://${host}"
 
+    nKeys=0
+    nKeysOK=0
+
+    IFS=$'\n'
     for line in $(process_user_id "ssh://${host}") ; 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" && 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 +493,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 +515,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 +532,9 @@ update_known_hosts() {
     # create a lockfile on known_hosts
     lockfile-create "$KNOWN_HOSTS"
 
+    # note pre update file checksum
+    fileCheck=$(md5sum "$KNOWN_HOSTS")
+
     for host ; do
        # process the host
        process_host_known_hosts "$host"
@@ -476,21 +556,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 [ "$(md5sum "$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 +584,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 +598,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 +656,7 @@ update_authorized_keys() {
     local nIDs
     local nIDsOK
     local nIDsBAD
+    local fileCheck
 
     # the number of ids specified on command line
     nIDs="$#"
@@ -572,6 +670,9 @@ update_authorized_keys() {
     # create a lockfile on authorized_keys
     lockfile-create "$AUTHORIZED_KEYS"
 
+    # note pre update file checksum
+    fileCheck=$(md5sum "$AUTHORIZED_KEYS")
+
     for userID ; do
        # process the user ID, change return code if key not found for
        # user ID
@@ -595,36 +696,48 @@ 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 [ "$(md5sum "$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..."
 
+    if ! meat "$authorizedUserIDs" > /dev/null ; then
+       log "no user IDs to process."
+       return
+    fi
+
+    nline=0
+
     # extract user IDs from authorized_user_ids file
-    for line in $(seq 1 $(meat "$authorizedUserIDs" | wc -l)) ; do
-       userIDs[$((line-1))]=$(cutline "$line" "$authorizedUserIDs")
+    IFS=$'\n'
+    for line in $(meat "$authorizedUserIDs") ; do
+       userIDs["$nline"]="$line"
+       nline=$((nline+1))
     done
 
     update_authorized_keys "${userIDs[@]}"