X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=src%2Fcommon;h=6fc5f3318d10dc39f4482ddf6efccea44003d7f5;hb=3395f4669a79bc3233fd3f1e14d988416d7ba2f7;hp=00ee7b04a124db6679959c35b5c000b2e9ea2389;hpb=f511119f57f076147acb2b5dccae597b34df6c8d;p=monkeysphere.git diff --git a/src/common b/src/common index 00ee7b0..6fc5f33 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). @@ -80,8 +79,18 @@ remove_line() { 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 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 } @@ -96,22 +105,68 @@ translate_ssh_variables() { # get the user's home directory userHome=$(getent passwd "$uname" | cut -d: -f6) - # translate ssh-style path variables + # translate '%u' to user name path=${path/\%u/"$uname"} + # translate '%h' to user home directory path=${path/\%h/"$userHome"} 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]?$" +} + +# 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 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 } @@ -181,6 +236,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" @@ -189,18 +249,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" } ######################################################################## @@ -246,11 +304,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 \ @@ -325,9 +380,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 @@ -360,35 +415,55 @@ 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 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 tmpfile host="$1" - userID="ssh://${host}" log "processing host: $host" - process_user_id "ssh://${host}" | \ - while read -r ok keyid ; do + 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 + if [ -z "$sshKey" ] ; then + log " ! key could not be translated." + continue + fi + + # 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 @@ -403,11 +478,102 @@ 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 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 + # 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 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' ' ') + + # 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 @@ -415,47 +581,132 @@ process_uid_authorized_keys() { log "processing user ID: $userID" - process_user_id "$userID" | \ - while read -r ok keyid ; do + 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") + if [ -z "$sshKey" ] ; then + log " ! key could not be translated." + continue + fi + # 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 } -# 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 + + # 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 - # 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 + # create a lockfile on authorized_keys + lockfile-create "$AUTHORIZED_KEYS" + + for userID ; do + # 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" + + # note if the authorized_keys file was updated + if [ "$nIDsOK" -gt 0 -o "$nIDsBAD" -gt 0 ] ; then + log "authorized_keys file updated." + fi + + # 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 nline + local userIDs authorizedUserIDs="$1" - cat "$authorizedUserIDs" | meat | \ - while read -r userid ; do - process_uid_authorized_keys "$userid" + log "processing authorized_user_ids file..." + + 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[@]}" } # EXPERIMENTAL (unused) process userids found in authorized_keys file @@ -465,13 +716,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 @@ -489,52 +745,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" }