# managed directories
ETC="/etc/monkeysphere"
export ETC
-CACHE="/var/cache/monkeysphere"
-export CACHE
-ERR=0
-export ERR
########################################################################
### UTILITY FUNCTIONS
# 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).
file="$1"
string="$2"
+ # if the line is there are removed, return 0
if [ "$file" -a "$string" ] ; then
grep -v "$string" "$file" | sponge "$file"
+ return 0
+ # otherwise return 1
+ else
+ return 1
fi
}
# 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
+### 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
}
# (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"
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"
}
########################################################################
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
-
# 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."
# 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
# 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 ok
local keyid
+ local idOK
+ local idRemoved
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}"
+
+ for line in $(process_user_id "ssh://${host}") ; do
+ ok=$(echo "$line" | cut -d: -f1)
+ keyid=$(echo "$line" | cut -d: -f2)
+
sshKey=$(gpg2ssh "$keyid")
- # remove the old host key line
- remove_line "$KNOWN_HOSTS" "$sshKey"
+
+ # remove the old host key line, and note if removed
+ remove_line "$KNOWN_HOSTS" "$sshKey" && idRemoved=true
+
# if key OK, add new host line
if [ "$ok" -eq '0' ] ; then
# hash if specified
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
+ else
+ return 1
+ fi
+}
+
+# update the known_hosts file for a set of hosts listed on command
+# line
+update_known_hosts() {
+ local nHosts
+ local host
+ local nHostsOK
+ local nHostsBAD
+
+ # 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 all hosts were OK, return 0
+ if [ "$nHostsOK" -eq "$nHosts" ] ; then
+ return 0
+
+ # if all hosts were BAD, return 2
+ elif [ "$nHostsBAD" -eq "$nHosts" ] ; then
+ return 2
+
+ # else return 1
+ else
+ return 1
+ 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 ok
local keyid
+ local idOK
+ local idRemoved
userID="$1"
log "processing user ID: $userID"
- process_user_id "$userID" | \
- while read -r ok keyid ; do
+ for line in $(process_user_id "$userID") ; do
+ 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"
+ remove_line "$AUTHORIZED_KEYS" "$sshKey" && idRemoved=true
+
# if key OK, add new host line
if [ "$ok" -eq '0' ] ; then
ssh2authorized_keys "$userID" "$sshKey" >> "$AUTHORIZED_KEYS"
+
+ # 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
+ 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
- # 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
+ # 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
+ # 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 all ids were OK, return 0
+ if [ "$nIDsOK" -eq "$nIDs" ] ; then
+ return 0
+
+ # if all ids were BAD, return 2
+ elif [ "$nIDsBAD" -eq "$nIDs" ] ; then
+ return 2
+
+ # else return 1
+ else
+ return 1
+ 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_uid_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
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
# 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"
}