X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=src%2Fcommon;h=240de38886f5ae39568cf96cb23099946253bbe7;hb=5fadec09dcd44c4dcad657a0f3d96878b592b77b;hp=c90fdd09c0d861e07328e41748fc3912994fe2e0;hpb=0dee9fdb0ebeebc5ff0cc10098f659d4730f2580;p=monkeysphere.git

diff --git a/src/common b/src/common
index c90fdd0..240de38 100644
--- a/src/common
+++ b/src/common
@@ -16,22 +16,14 @@
 # managed directories
 ETC="/etc/monkeysphere"
 export ETC
-CACHE="/var/cache/monkeysphere"
-export CACHE
-ERR=0
-export ERR
 
 ########################################################################
 ### 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
@@ -46,12 +38,12 @@ loge() {
 
 # cut out all comments(#) and blank lines from standard input
 meat() {
-    grep -v -e "^[[:space:]]*#" -e '^$'
+    grep -v -e "^[[:space:]]*#" -e '^$' "$1"
 }
 
 # cut a specified line from standard input
 cutline() {
-    head --line="$1" | tail -1
+    head --line="$1" "$2" | tail -1
 }
 
 # check that characters are in a string (in an AND fashion).
@@ -87,8 +79,14 @@ remove_line() {
     file="$1"
     string="$2"
 
-    if [ "$file" -a "$string" ] ; then
-	grep -v "$string" "$file" | sponge "$file"
+    # if the string is in the file and removed, return 0
+    if grep -q -F "$string" "$file" 2> /dev/null ; then
+	grep -v -F "$string" "$file" | sponge "$file"
+	return 0
+
+    # otherwise return 1
+    else
+	return 1
     fi
 }
 
@@ -111,15 +109,18 @@ translate_ssh_variables() {
     echo "$path"
 }
 
-### CONVERTION UTILITIES
+# test that a string to conforms to GPG's expiration format
+test_gpg_expire() {
+    echo "$1" | egrep -q "^[0-9][mwy]?$"
+}
+
+### CONVERSION UTILITIES
 
 # output the ssh key for a given key ID
 gpg2ssh() {
     local keyID
     
-    #keyID="$1" #TMP
-    # only use last 16 characters until openpgp2ssh can take all 40 #TMP
-    keyID=$(echo "$1" | cut -c 25-) #TMP
+    keyID="$1"
 
     gpg --export "$keyID" | openpgp2ssh "$keyID" 2> /dev/null
 }
@@ -189,6 +190,11 @@ gpg2authorized_keys() {
 # (not just first N (5 in this case))
 gpg_fetch_userid() {
     local userID
+    local returnCode
+
+    if [ "$CHECK_KEYSERVER" != 'true' ] ; then
+	return 0
+    fi
 
     userID="$1"
 
@@ -197,18 +203,16 @@ gpg_fetch_userid() {
 	gpg --quiet --batch --with-colons \
 	--command-fd 0 --keyserver "$KEYSERVER" \
 	--search ="$userID" > /dev/null 2>&1
+    returnCode="$?"
     loge "done."
-}
 
-# get the full fingerprint of a key ID
-get_key_fingerprint() {
-    local keyID
-
-    keyID="$1"
+    # if the user is the monkeysphere user, then update the
+    # monkeysphere user's trustdb
+    if [ $(id -un) = "$MONKEYSPHERE_USER" ] ; then
+	gpg_authentication "--check-trustdb" > /dev/null 2>&1
+    fi
 
-    gpg --list-key --with-colons --fixed-list-mode \
-	--with-fingerprint "$keyID" | grep "$keyID" | \
-	grep '^fpr:' | cut -d: -f10
+    return "$returnCode"
 }
 
 ########################################################################
@@ -254,11 +258,8 @@ process_user_id() {
     fi
     requiredPubCapability=$(echo "$requiredCapability" | tr "[:lower:]" "[:upper:]")
 
-    # if CHECK_KEYSERVER variable set, check the keyserver
-    # for the user ID
-    if [ "$CHECK_KEYSERVER" = "true" ] ; then
-	gpg_fetch_userid "$userID"
-    fi
+    # 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 \
@@ -333,9 +334,9 @@ process_user_id() {
 		# 0 = ok, 1 = bad
 		if [ "$keyOK" -a "$uidOK" -a "$lastKeyOK" ] ; then
 		    log "  * acceptable key found."
-		    echo 0 "$fingerprint"
+		    echo "0:${fingerprint}"
 		else
-		    echo 1 "$fingerprint"
+		    echo "1:${fingerprint}"
 		fi
 		;;
 	    'sub') # sub keys
@@ -368,116 +369,285 @@ process_user_id() {
 		# 0 = ok, 1 = bad
 		if [ "$keyOK" -a "$uidOK" -a "$lastKeyOK" ] ; then
 		    log "  * acceptable key found."
-		    echo 0 "$fingerprint"
+		    echo "0:${fingerprint}"
 		else
-		    echo 1 "$fingerprint"
+		    echo "1:${fingerprint}"
 		fi
 		;;
 	esac
     done
 }
 
-# process hosts in the known_host file
-process_hosts_known_hosts() {
+# 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 tmpfile
 
+    host="$1"
+
+    log "processing host: $host"
+
+    userID="ssh://${host}"
+
+    nKeys=0
+    nKeysOK=0
+
+    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=$(gpg2ssh "$keyid")
+
+	# remove the old host key line, and note if removed
+	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
+		# hash from stdin to stdout
+		tmpfile=$(mktemp)
+		ssh2known_hosts "$host" "$sshKey" > "$tmpfile"
+		ssh-keygen -H -f "$tmpfile" 2> /dev/null
+		cat "$tmpfile" >> "$KNOWN_HOSTS"
+		rm -f "$tmpfile" "${tmpfile}.old"
+	    else
+		ssh2known_hosts "$host" "$sshKey" >> "$KNOWN_HOSTS"
+	    fi
+	fi
+    done
+
+    # 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
+}
+
+# update the known_hosts file for a set of hosts listed on command
+# line
+update_known_hosts() {
+    local nHosts
+    local nHostsOK
+    local nHostsBAD
+    local host
+
+    # the number of hosts specified on command line
+    nHosts="$#"
+
+    nHostsOK=0
+    nHostsBAD=0
+
+    # set the trap to remove any lockfiles on exit
+    trap "lockfile-remove $KNOWN_HOSTS" EXIT
+
     # create a lockfile on known_hosts
     lockfile-create "$KNOWN_HOSTS"
 
     for host ; do
-	log "processing host: $host"
-
-	userID="ssh://${host}"
-
-	process_user_id "ssh://${host}" | \
-	while read -r ok keyid ; do
-	    sshKey=$(gpg2ssh "$keyid")
-	    # remove the old host key line
-	    remove_line "$KNOWN_HOSTS" "$sshKey"
-	    # if key OK, add new host line
-	    if [ "$ok" -eq '0' ] ; then
-		# hash if specified
-		if [ "$HASH_KNOWN_HOSTS" = 'true' ] ; then
-		    # FIXME: this is really hackish cause ssh-keygen won't
-		    # hash from stdin to stdout
-		    tmpfile=$(mktemp)
-		    ssh2known_hosts "$host" "$sshKey" > "$tmpfile"
-		    ssh-keygen -H -f "$tmpfile" 2> /dev/null
-		    cat "$tmpfile" >> "$KNOWN_HOSTS"
-		    rm -f "$tmpfile" "${tmpfile}.old"
-		else
-		    ssh2known_hosts "$host" "$sshKey" >> "$KNOWN_HOSTS"
-		fi
-	    fi
-	done
+	# process the host
+	process_host_known_hosts "$host"
+	# note the result
+	case "$?" in
+	    0)
+		nHostsOK=$((nHostsOK+1))
+		;;
+	    2)
+		nHostsBAD=$((nHostsBAD+1))
+		;;
+	esac
+
 	# touch the lockfile, for good measure.
 	lockfile-touch --oneshot "$KNOWN_HOSTS"
     done
 
     # remove the lockfile
     lockfile-remove "$KNOWN_HOSTS"
+
+    # note if the known_hosts file was updated
+    if [ "$nHostsOK" -gt 0 -o "$nHostsBAD" -gt 0 ] ; then
+	log "known_hosts file updated."
+    fi
+
+    # if an acceptable host was found, return 0
+    if [ "$nHostsOK" -gt 0 ] ; then
+	return 0
+    # else if no ok hosts were found...
+    else
+	# 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
+}
+
+# process hosts from a known_hosts file
+process_known_hosts() {
+    local hosts
+
+    log "processing known_hosts file..."
+
+    hosts=$(meat "$KNOWN_HOSTS" | cut -d ' ' -f 1 | grep -v '^|.*$' | tr , ' ' | tr '\n' ' ')
+
+    # take all the hosts from the known_hosts file (first
+    # field), grep out all the hashed hosts (lines starting
+    # with '|')...
+    update_known_hosts $hosts
 }
 
 # process uids for the authorized_keys file
-process_uids_authorized_keys() {
+process_uid_authorized_keys() {
     local userID
+    local nKeys
+    local nKeysOK
     local ok
     local keyid
 
+    userID="$1"
+
+    log "processing user ID: $userID"
+
+    nKeys=0
+    nKeysOK=0
+
+    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=$(gpg2ssh "$keyid")
+
+	# remove the old host key line
+	remove_line "$AUTHORIZED_KEYS" "$sshKey"
+
+	# if key OK, add new host line
+	if [ "$ok" -eq '0' ] ; then
+	    # note that key was found ok
+	    nKeysOK=$((nKeysOK+1))
+
+	    ssh2authorized_keys "$userID" "$sshKey" >> "$AUTHORIZED_KEYS"
+	fi
+    done
+
+    # 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
+}
+
+# update the authorized_keys files from a list of user IDs on command
+# line
+update_authorized_keys() {
+    local userID
+    local nIDs
+    local nIDsOK
+    local nIDsBAD
+
+    # the number of ids specified on command line
+    nIDs="$#"
+
+    nIDsOK=0
+    nIDsBAD=0
+
+    # set the trap to remove any lockfiles on exit
+    trap "lockfile-remove $AUTHORIZED_KEYS" EXIT
+
     # create a lockfile on authorized_keys
     lockfile-create "$AUTHORIZED_KEYS"
 
     for userID ; do
-	log "processing user ID: $userID"
-
-	process_user_id "$userID" | \
-	while read -r ok keyid ; do
-	    sshKey=$(gpg2ssh "$keyid")
-	    # remove the old host key line
-	    remove_line "$AUTHORIZED_KEYS" "$sshKey"
-	    # if key OK, add new host line
-	    if [ "$ok" -eq '0' ] ; then
-		ssh2authorized_keys "$userID" "$sshKey" >> "$AUTHORIZED_KEYS"
-	    fi
-	done
+	# process the user ID, change return code if key not found for
+	# user ID
+	process_uid_authorized_keys "$userID"
+
+	# note the result
+	case "$?" in
+	    0)
+		nIDsOK=$((nIDsOK+1))
+		;;
+	    2)
+		nIDsBAD=$((nIDsBAD+1))
+		;;
+	esac
+
 	# touch the lockfile, for good measure.
 	lockfile-touch --oneshot "$AUTHORIZED_KEYS"
     done
 
     # remove the lockfile
     lockfile-remove "$AUTHORIZED_KEYS"
-}
 
-# process known_hosts file
-# go through line-by-line, extract each host, and process with the
-# host processing function
-process_known_hosts() {
-    local hosts
-    local host
+    # note if the authorized_keys file was updated
+    if [ "$nIDsOK" -gt 0 -o "$nIDsBAD" -gt 0 ] ; then
+	log "authorized_keys file updated."
+    fi
 
-    # take all the hosts from the known_hosts file (first field),
-    # grep out all the hashed hosts (lines starting with '|')...
-    cat "$KNOWN_HOSTS" | meat | \
-	cut -d ' ' -f 1 | grep -v '^|.*$' | \
-    while IFS=, read -r -a hosts ; do
-	process_hosts_known_hosts ${hosts[@]}
-    done
+    # if an acceptable id was found, return 0
+    if [ "$nIDsOK" -gt 0 ] ; then
+	return 0
+    # else if no ok ids were found...
+    else
+	# 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 userid
+    local line
+    local userIDs
 
     authorizedUserIDs="$1"
 
-    cat "$authorizedUserIDs" | meat | \
-    while read -r userid ; do
-	process_uids_authorized_keys "$userid"
+    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
@@ -487,13 +657,18 @@ process_authorized_user_ids() {
 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)
-    cat "$authorizedKeys" | meat | \
+    meat "$authorizedKeys" | \
     while read -r options keytype key comment ; do
 	# if the comment field is empty, assume the third field was
 	# the comment
@@ -511,52 +686,8 @@ process_authorized_keys() {
 
 	# process the userid
 	log "processing userid: '$userID'"
-	process_user_id "$userID" > /dev/null
+	process_user_id "$userID" > /dev/null || returnCode=1
     done
-}
-
-##################################################
-### GPG HELPER FUNCTIONS
-
-# retrieve key from web of trust, and set owner trust to "full"
-# if key is found.
-trust_key() {
-    # get the key from the key server
-    if ! gpg --keyserver "$KEYSERVER" --recv-key "$keyID" ; then
-	log "could not retrieve key '$keyID'"
-	return 1
-    fi
-
-    # get key fingerprint
-    fingerprint=$(get_key_fingerprint "$keyID")
-
-    # attach a "non-exportable" signature to the key
-    # this is required for the key to have any validity at all
-    # the 'y's on stdin indicates "yes, i really want to sign"
-    echo -e 'y\ny' | gpg --lsign-key --command-fd 0 "$fingerprint"
-
-    # import "full" trust for fingerprint into gpg
-    echo ${fingerprint}:5: | gpg --import-ownertrust
-    if [ $? = 0 ] ; then
-	log "owner trust updated."
-    else
-	failure "there was a problem changing owner trust."
-    fi	
-}
-
-# publish server key to keyserver
-publish_server_key() {
-    read -p "really publish key to $KEYSERVER? [y|N]: " OK; OK=${OK:=N}
-    if [ ${OK/y/Y} != 'Y' ] ; then
-	failure "aborting."
-    fi
 
-    # publish host key
-    # FIXME: need to figure out better way to identify host key
-    # dummy command so as not to publish fakes keys during testing
-    # eventually:
-    #gpg --keyserver "$KEYSERVER" --send-keys $(hostname -f)
-    echo "NOT PUBLISHED (to avoid permanent publication errors during monkeysphere development).
-To publish manually, do: gpg --keyserver $KEYSERVER --send-keys $(hostname -f)"
-    return 1
+    return "$returnCode"
 }