X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=src%2Fcommon;h=396670582b289376423a2f70f490358d978b8b48;hb=0e27af63f34c5bb75cef059fc9d76887251c1517;hp=ac43f0a0f37b7f6a4dcda161041c8771035eba21;hpb=18c15c1adf65d47df5b3753c99f06092d81906d0;p=monkeysphere.git diff --git a/src/common b/src/common index ac43f0a..3966705 100644 --- a/src/common +++ b/src/common @@ -16,35 +16,34 @@ # managed directories ETC="/etc/monkeysphere" export ETC -CACHE="/var/cache/monkeysphere" -export CACHE ######################################################################## ### UTILITY FUNCTIONS +# failure function. exits with code 255, unless specified otherwise. failure() { echo "$1" >&2 - exit ${2:-'1'} + exit ${2:-'255'} } # write output to stderr log() { - echo -n "ms: " 1>&2 - echo "$@" 1>&2 + echo -n "ms: " >&2 + echo "$@" >&2 } loge() { - echo "$@" 1>&2 + echo "$@" >&2 } # 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). @@ -73,27 +72,123 @@ unescape() { } # remove all lines with specified string from specified file -remove_file_line() { +remove_line() { local file local string file="$1" string="$2" - if [ "$file" -a "$string" ] ; then - grep -v "$string" "$file" | sponge "$file" + 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 + local home + + uname="$1" + path="$2" + + # get the user's home directory + userHome=$(getent passwd "$uname" | cut -d: -f6) + + # translate '%u' to user name + path=${path/\%u/"$uname"} + # translate '%h' to user home directory + path=${path/\%h/"$userHome"} + + 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 } -### CONVERTION UTILITIES +### 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 } @@ -163,6 +258,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" @@ -171,18 +271,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" } ######################################################################## @@ -228,11 +326,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 \ @@ -241,13 +336,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 @@ -306,10 +399,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 @@ -333,92 +435,74 @@ 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 done } -# update the cache for userid, and prompt to add file to -# authorized_user_ids file if the userid is found in gpg -# and not already in file. -update_userid() { - local userID - - userID="$1" - - log "processing userid: '$userID'" - - # process the user ID to pull it from keyserver - process_user_id "$userID" | grep -q "^0 " - - # check if user ID is in the authorized_user_ids file - if ! grep -q "^${userID}\$" "$AUTHORIZED_USER_IDS" ; then - read -p "user ID not currently authorized. authorize? [Y|n]: " OK; OK=${OK:=Y} - if [ ${OK/y/Y} = 'Y' ] ; then - # add if specified - log -n " adding user ID to authorized_user_ids file... " - echo "$userID" >> "$AUTHORIZED_USER_IDS" - loge "done." - else - # else do nothing - log " authorized_user_ids file untouched." - fi - fi -} - -# remove a userid from the authorized_user_ids file -remove_userid() { - local userID - - userID="$1" - - log "processing userid: '$userID'" - - # check if user ID is in the authorized_user_ids file - if ! grep -q "^${userID}\$" "$AUTHORIZED_USER_IDS" ; then - log " user ID not currently authorized." - return 1 - fi - - # remove user ID from file - log -n " removing user ID '$userID'... " - remove_file_line "$AUTHORIZED_USER_IDS" "^${userID}$" - loge "done." -} - -# process a host in known_host file +# 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 sshKey local tmpfile host="$1" + + log "processing: $host" + userID="ssh://${host}" - log "processing host: $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) + sshKey=$(echo "$line" | cut -d: -f2) + + if [ -z "$sshKey" ] ; then + continue + fi + + # remove the old host key line, and note if removed + remove_line "$KNOWN_HOSTS" "$sshKey" - process_user_id "ssh://${host}" | \ - while read -r ok keyid ; do - sshKey=$(gpg2ssh "$keyid") - # remove the old host key line - remove_file_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 @@ -433,134 +517,253 @@ process_host_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 fileCheck + 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" + + # note pre update file checksum + fileCheck="$(cat "$KNOWN_HOSTS" | md5sum)" + + for host ; do + # 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 [ "$(cat "$KNOWN_HOSTS" | md5sum)" != "$fileCheck" ] ; 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 a uid in an authorized_keys file +# 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' ' ') + + 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 '|')... + update_known_hosts $hosts +} + +# process uids for the authorized_keys file process_uid_authorized_keys() { local userID + 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) + sshKey=$(echo "$line" | cut -d: -f2) + + if [ -z "$sshKey" ] ; then + continue + fi - process_user_id "$userID" | \ - while read -r ok keyid ; do - sshKey=$(gpg2ssh "$keyid") # remove the old host key line - remove_file_line "$AUTHORIZED_KEYS" "$sshKey" + 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 } -# 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 +# 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 + local fileCheck - # 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 - # and process each host - for host in ${hosts[*]} ; do - process_host_known_hosts "$host" - done - done -} + # the number of ids specified on command line + nIDs="$#" -# process an authorized_user_ids file for authorized_keys -process_authorized_user_ids() { - local userid + nIDsOK=0 + nIDsBAD=0 - cat "$AUTHORIZED_USER_IDS" | meat | \ - while read -r userid ; do - process_uid_authorized_keys "$userid" - done -} + # set the trap to remove any lockfiles on exit + trap "lockfile-remove $AUTHORIZED_KEYS" EXIT -# 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 + # create a lockfile on authorized_keys + lockfile-create "$AUTHORIZED_KEYS" - 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 | \ - 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 + # note pre update file checksum + fileCheck="$(cat "$AUTHORIZED_KEYS" | md5sum)" - 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 + # remove any monkeysphere lines from authorized_keys file + remove_monkeysphere_lines "$AUTHORIZED_KEYS" - # process the userid - log "processing userid: '$userID'" - process_user_id "$userID" > /dev/null - done -} + for userID ; do + # process the user ID, change return code if key not found for + # user ID + process_uid_authorized_keys "$userID" -################################################## -### GPG HELPER FUNCTIONS + # note the result + case "$?" in + 0) + nIDsOK=$((nIDsOK+1)) + ;; + 2) + nIDsBAD=$((nIDsBAD+1)) + ;; + esac -# 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 + # touch the lockfile, for good measure. + lockfile-touch --oneshot "$AUTHORIZED_KEYS" + done - # get key fingerprint - fingerprint=$(get_key_fingerprint "$keyID") + # remove the lockfile + lockfile-remove "$AUTHORIZED_KEYS" - # 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" + # note if the authorized_keys file was updated + if [ "$(cat "$AUTHORIZED_KEYS" | md5sum)" != "$fileCheck" ] ; then + log "authorized_keys file updated." + fi - # import "full" trust for fingerprint into gpg - echo ${fingerprint}:5: | gpg --import-ownertrust - if [ $? = 0 ] ; then - log "owner trust updated." + # if an acceptable id was found, return 0 + if [ "$nIDsOK" -gt 0 ] ; then + return 0 + # else if no ok ids were found... else - failure "there was a problem changing owner trust." - fi + # 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 } -# 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." +# 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 - # 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 --send-keys --keyserver "$KEYSERVER" $(hostname -f) - echo "NOT PUBLISHED: gpg --send-keys --keyserver $KEYSERVER $(hostname -f)" + nline=0 + + # extract user IDs from authorized_user_ids file + IFS=$'\n' + for line in $(meat "$authorizedUserIDs") ; do + userIDs["$nline"]="$line" + nline=$((nline+1)) + done + + update_authorized_keys "${userIDs[@]}" }