########################################################################
### 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
file="$1"
string="$2"
- # if the line is there are removed, return 0
- if [ "$file" -a "$string" ] ; then
+ 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
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
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."
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
process_host_known_hosts() {
local host
local userID
+ local nKeys
+ local nKeysOK
local ok
local keyid
- local idOK
- local idRemoved
local tmpfile
host="$1"
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")
+ 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" && 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
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
# 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="$#"
# 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"
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
}
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 '|')...
# 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
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")
+ if [ -z "$sshKey" ] ; then
+ log " ! key could not be translated."
+ 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
local nIDs
local nIDsOK
local nIDsBAD
+ local fileCheck
# the number of ids specified on command line
nIDs="$#"
# 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
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[@]}"