2 # This should be sourced by bash (though we welcome changes to make it POSIX sh compliant)
4 # Shared sh functions for the monkeysphere
7 # Jameson Rollins <jrollins@finestructure.net>
8 # Jamie McClelland <jm@mayfirst.org>
9 # Daniel Kahn Gillmor <dkg@fifthhorseman.net>
11 # Copyright 2008-2009, released under the GPL, version 3 or later
13 # all-caps variables are meant to be user supplied (ie. from config
14 # file) and are considered global
16 ########################################################################
20 SYSCONFIGDIR=${MONKEYSPHERE_SYSCONFIGDIR:-"/etc/monkeysphere"}
23 # monkeysphere version
30 KEYSERVER="pool.sks-keyservers.net"
32 # whether or not to check keyservers by defaul
33 CHECK_KEYSERVER="true"
35 # default monkeysphere user
36 MONKEYSPHERE_USER="monkeysphere"
38 # default about whether or not to prompt
41 ########################################################################
44 # failure function. exits with code 255, unless specified otherwise.
46 [ "$1" ] && echo "$1" >&2
50 # write output to stderr based on specified LOG_LEVEL the first
51 # parameter is the priority of the output, and everything else is what
52 # is echoed to stderr. If there is nothing else, then output comes
53 # from stdin, and is not prefaced by log prefix.
61 # don't include SILENT in alllevels: it's handled separately
62 # list in decreasing verbosity (all caps).
63 # separate with $IFS explicitly, since we do some fancy footwork
65 alllevels="DEBUG${IFS}VERBOSE${IFS}INFO${IFS}ERROR"
67 # translate lowers to uppers in global log level
68 LOG_LEVEL=$(echo "$LOG_LEVEL" | tr "[:lower:]" "[:upper:]")
70 # just go ahead and return if the log level is silent
71 if [ "$LOG_LEVEL" = 'SILENT' ] ; then
75 for level in $alllevels ; do
76 if [ "$LOG_LEVEL" = "$level" ] ; then
80 if [ -z "$found" ] ; then
85 # get priority from first parameter, translating all lower to
87 priority=$(echo "$1" | tr "[:lower:]" "[:upper:]")
90 # scan over available levels
91 for level in $alllevels ; do
92 # output if the log level matches, set output to true
93 # this will output for all subsequent loops as well.
94 if [ "$LOG_LEVEL" = "$level" ] ; then
97 if [ "$priority" = "$level" -a "$output" = 'true' ] ; then
108 # run command as monkeysphere user
109 su_monkeysphere_user() {
110 # our main goal here is to run the given command as the the
111 # monkeysphere user, but without prompting for any sort of
112 # authentication. If this is not possible, we should just fail.
114 # FIXME: our current implementation is overly restrictive, because
115 # there may be some su PAM configurations that would allow su
116 # "$MONKEYSPHERE_USER" -c "$@" to Just Work without prompting,
117 # allowing specific users to invoke commands which make use of
120 # chpst (from runit) would be nice to use, but we don't want to
121 # introduce an extra dependency just for this. This may be a
122 # candidate for re-factoring if we switch implementation languages.
125 # if monkeysphere user, run the command under bash
126 "$MONKEYSPHERE_USER")
130 # if root, su command as monkeysphere user
132 su "$MONKEYSPHERE_USER" -c "$@"
137 log error "non-privileged user."
142 # cut out all comments(#) and blank lines from standard input
144 grep -v -e "^[[:space:]]*#" -e '^$' "$1"
147 # cut a specified line from standard input
149 head --line="$1" "$2" | tail -1
152 # make a temporary directory
154 mktemp -d ${TMPDIR:-/tmp}/monkeysphere.XXXXXXXXXX
157 # make a temporary file
159 mktemp ${TMPDIR:-/tmp}/monkeysphere.XXXXXXXXXX
162 # this is a wrapper for doing lock functions.
164 # it lets us depend on either lockfile-progs (preferred) or procmail's
165 # lockfile, and should
167 local use_lockfileprogs=true
171 if ! ( which lockfile-create >/dev/null 2>/dev/null ) ; then
172 if ! ( which lockfile >/dev/null ); then
173 failure "Neither lockfile-create nor lockfile are in the path!"
180 if [ -n "$use_lockfileprogs" ] ; then
181 lockfile-create "$file" || failure "unable to lock '$file'"
183 lockfile -r 20 "${file}.lock" || failure "unable to lock '$file'"
185 log debug "lock created on '$file'."
188 if [ -n "$use_lockfileprogs" ] ; then
189 lockfile-touch --oneshot "$file"
193 log debug "lock touched on '$file'."
196 if [ -n "$use_lockfileprogs" ] ; then
197 lockfile-remove "$file"
201 log debug "lock removed on '$file'."
204 failure "bad argument for lock subfunction '$action'"
209 # for portability, between gnu date and BSD date.
210 # arguments should be: number longunits format
212 # e.g. advance_date 20 seconds +%F
220 # try things the GNU way first
221 if date -d "$number $longunits" "$format" >/dev/null 2>&1; then
222 date -d "$number $longunits" "$format"
224 # otherwise, convert to (a limited version of) BSD date syntax:
248 # this is a longshot, and will likely fail; oh well.
249 shortunits="$longunits"
251 date "-v+${number}${shortunits}" "$format"
256 # check that characters are in a string (in an AND fashion).
257 # used for checking key capability
258 # check_capability capability a [b...]
267 if echo "$usage" | grep -q -v "$capcheck" ; then
276 md5sum "$1" 2> /dev/null
279 # convert escaped characters in pipeline from gpg output back into
281 # FIXME: undo all escape character translation in with-colons gpg
287 # convert nasty chars into gpg-friendly form in pipeline
288 # FIXME: escape everything, not just colons!
293 # prompt for GPG-formatted expiration, and emit result on stdout
294 get_gpg_expiration() {
299 if [ -z "$keyExpire" -a "$PROMPT" = 'true' ]; then
301 Please specify how long the key should be valid.
302 0 = key does not expire
303 <n> = key expires in n days
304 <n>w = key expires in n weeks
305 <n>m = key expires in n months
306 <n>y = key expires in n years
308 while [ -z "$keyExpire" ] ; do
309 read -p "Key is valid for? (0) " keyExpire
310 if ! test_gpg_expire ${keyExpire:=0} ; then
311 echo "invalid value" >&2
315 elif ! test_gpg_expire "$keyExpire" ; then
316 failure "invalid key expiration value '$keyExpire'."
322 passphrase_prompt() {
327 if [ "$DISPLAY" ] && which "${SSH_ASKPASS:-ssh-askpass}" >/dev/null; then
328 "${SSH_ASKPASS:-ssh-askpass}" "$prompt" > "$fifo"
330 read -s -p "$prompt" PASS
331 # Uses the builtin echo, so should not put the passphrase into
332 # the process table. I think. --dkg
333 echo "$PASS" > "$fifo"
337 test_gnu_dummy_s2k_extension() {
339 # this block contains a demonstration private key that has had the
340 # primary key stripped out using the GNU S2K extension known as
341 # "gnu-dummy" (see /usr/share/doc/gnupg/DETAILS.gz). The subkey is
342 # present in cleartext, however.
344 # openpgp2ssh will be able to deal with this based on whether the
345 # local copy of GnuTLS contains read_s2k support that can handle it.
347 # read up on that here:
349 # http://lists.gnu.org/archive/html/gnutls-devel/2008-08/msg00005.html
352 -----BEGIN PGP PRIVATE KEY BLOCK-----
353 Version: GnuPG v1.4.9 (GNU/Linux)
355 lQCVBEO3YdABBACRqqEnucag4+vyZny2M67Pai5+5suIRRvY+Ly8Ms5MvgCi3EVV
356 xT05O/+0ShiRaf+QicCOFrhbU9PZzzU+seEvkeW2UCu4dQfILkmj+HBEIltGnHr3
357 G0yegHj5pnqrcezERURf2e17gGFWX91cXB9Cm721FPXczuKraphKwCA9PwARAQAB
358 /gNlAkdOVQG0OURlbW9uc3RyYXRpb24gS2V5IGZvciBTMksgR05VIGV4dGVuc2lv
359 biAxMDAxIC0tIGdudS1kdW1teYi8BBMBAgAmBQJDt2HQAhsDBQkB4TOABgsJCAcD
360 AgQVAggDBBYCAwECHgECF4AACgkQQZUwSa4UDezTOQP/TMQXUVrWzHYZGopoPZ2+
361 ZS3qddiznBHsgb7MGYg1KlTiVJSroDUBCHIUJvdQKZV9zrzrFl47D07x6hGyUPHV
362 aZXvuITW8t1o5MMHkCy3pmJ2KgfDvdUxrBvLfgPMICA4c6zA0mWquee43syEW9NY
363 g3q61iPlQwD1J1kX1wlimLCdAdgEQ7dh0AEEANAwa63zlQbuy1Meliy8otwiOa+a
364 mH6pxxUgUNggjyjO5qx+rl25mMjvGIRX4/L1QwIBXJBVi3SgvJW1COZxZqBYqj9U
365 8HVT07mWKFEDf0rZLeUE2jTm16cF9fcW4DQhW+sfYm+hi2sY3HeMuwlUBK9KHfW2
366 +bGeDzVZ4pqfUEudABEBAAEAA/0bemib+wxub9IyVFUp7nPobjQC83qxLSNzrGI/
367 RHzgu/5CQi4tfLOnwbcQsLELfker2hYnjsLrT9PURqK4F7udrWEoZ1I1LymOtLG/
368 4tNZ7Mnul3wRC2tCn7FKx8sGJwGh/3li8vZ6ALVJAyOia5TZ/buX0+QZzt6+hPKk
369 7MU1WQIA4bUBjtrsqDwro94DvPj3/jBnMZbXr6WZIItLNeVDUcM8oHL807Am97K1
370 ueO/f6v1sGAHG6lVPTmtekqPSTWBfwIA7CGFvEyvSALfB8NUa6jtk27NCiw0csql
371 kuhCmwXGMVOiryKEfegkIahf2bAd/gnWHPrpWp7bUE20v8YoW22I4wIAhnm5Wr5Q
372 Sy7EHDUxmJm5TzadFp9gq08qNzHBpXSYXXJ3JuWcL1/awUqp3tE1I6zZ0hZ38Ia6
373 SdBMN88idnhDPqPoiKUEGAECAA8FAkO3YdACGyAFCQHhM4AACgkQQZUwSa4UDezm
374 vQP/ZhK+2ly9oI2z7ZcNC/BJRch0/ybQ3haahII8pXXmOThpZohr/LUgoWgCZdXg
375 vP6yiszNk2tIs8KphCAw7Lw/qzDC2hEORjWO4f46qk73RAgSqG/GyzI4ltWiDhqn
376 vnQCFl3+QFSe4zinqykHnLwGPMXv428d/ZjkIc2ju8dRsn4=
378 -----END PGP PRIVATE KEY BLOCK-----
379 " | openpgp2ssh 4129E89D17C1D591 >/dev/null 2>/dev/null
383 # remove all lines with specified string from specified file
392 if [ -z "$file" -o -z "$string" ] ; then
396 if [ ! -e "$file" ] ; then
400 # if the string is in the file...
401 if grep -q -F "$string" "$file" 2> /dev/null ; then
402 tempfile=$(mktemp "${file}.XXXXXXX") || \
403 failure "Unable to make temp file '${file}.XXXXXXX'"
405 # remove the line with the string, and return 0
406 grep -v -F "$string" "$file" >"$tempfile"
407 cat "$tempfile" > "$file"
416 # remove all lines with MonkeySphere strings in file
417 remove_monkeysphere_lines() {
423 if [ -z "$file" ] ; then
427 if [ ! -e "$file" ] ; then
431 tempfile=$(mktemp "${file}.XXXXXXX") || \
432 failure "Could not make temporary file '${file}.XXXXXXX'."
434 egrep -v '^MonkeySphere[[:digit:]]{4}(-[[:digit:]]{2}){2}T[[:digit:]]{2}(:[[:digit:]]{2}){2}$' \
436 cat "$tempfile" > "$file"
440 # translate ssh-style path variables %h and %u
441 translate_ssh_variables() {
448 # get the user's home directory
449 userHome=$(getent passwd "$uname" | cut -d: -f6)
451 # translate '%u' to user name
452 path=${path/\%u/"$uname"}
453 # translate '%h' to user home directory
454 path=${path/\%h/"$userHome"}
459 # test that a string to conforms to GPG's expiration format
461 echo "$1" | egrep -q "^[0-9]+[mwy]?$"
464 # check that a file is properly owned, and that all it's parent
465 # directories are not group/other writable
466 check_key_file_permissions() {
474 # function to check that the given permission corresponds to writability
482 log debug "checking path permission '$path'..."
484 # return 255 if cannot stat file
485 if ! stat=$(ls -ld "$path" 2>/dev/null) ; then
486 log error "could not stat path '$path'."
490 owner=$(echo "$stat" | awk '{ print $3 }')
491 gAccess=$(echo "$stat" | cut -c6)
492 oAccess=$(echo "$stat" | cut -c9)
494 # return 1 if path has invalid owner
495 if [ "$owner" != "$uname" -a "$owner" != 'root' ] ; then
496 log error "improper ownership on path '$path'."
500 # return 2 if path has group or other writability
501 if is_write "$gAccess" || is_write "$oAccess" ; then
502 log error "improper group or other writability on path '$path'."
506 # return zero if all clear, or go to next path
507 if [ "$path" = '/' ] ; then
510 check_key_file_permissions "$uname" $(dirname "$path")
514 ### CONVERSION UTILITIES
516 # output the ssh key for a given key ID
522 gpg --export "$keyID" | openpgp2ssh "$keyID" 2> /dev/null
525 # output known_hosts line from ssh key
534 echo -n "$key" | tr -d '\n'
535 echo " MonkeySphere${DATE}"
538 # output authorized_keys line from ssh key
539 ssh2authorized_keys() {
546 echo -n "$key" | tr -d '\n'
547 echo " MonkeySphere${DATE} ${userID}"
550 # convert key from gpg to ssh known_hosts format
558 # NOTE: it seems that ssh-keygen -R removes all comment fields from
559 # all lines in the known_hosts file. why?
560 # NOTE: just in case, the COMMENT can be matched with the
562 # '^MonkeySphere[[:digit:]]{4}(-[[:digit:]]{2}){2}T[[:digit:]]{2}(:[[:digit:]]{2}){2}$'
564 gpg2ssh "$keyID" | tr -d '\n'
565 echo " MonkeySphere${DATE}"
568 # convert key from gpg to ssh authorized_keys format
569 gpg2authorized_keys() {
576 # NOTE: just in case, the COMMENT can be matched with the
578 # '^MonkeySphere[[:digit:]]{4}(-[[:digit:]]{2}){2}T[[:digit:]]{2}(:[[:digit:]]{2}){2}$'
579 gpg2ssh "$keyID" | tr -d '\n'
580 echo " MonkeySphere${DATE} ${userID}"
585 # retrieve all keys with given user id from keyserver
586 # FIXME: need to figure out how to retrieve all matching keys
587 # (not just first N (5 in this case))
592 if [ "$CHECK_KEYSERVER" != 'true' ] ; then
598 log verbose " checking keyserver $KEYSERVER... "
600 gpg --quiet --batch --with-colons \
601 --command-fd 0 --keyserver "$KEYSERVER" \
602 --search ="$userID" > /dev/null 2>&1
608 ########################################################################
609 ### PROCESSING FUNCTIONS
611 # userid and key policy checking
612 # the following checks policy on the returned keys
613 # - checks that full key has appropriate valididy (u|f)
614 # - checks key has specified capability (REQUIRED_*_KEY_CAPABILITY)
615 # - checks that requested user ID has appropriate validity
616 # (see /usr/share/doc/gnupg/DETAILS.gz)
617 # output is one line for every found key, in the following format:
621 # "flag" is an acceptability flag, 0 = ok, 1 = bad
622 # "sshKey" is the translated gpg key
624 # all log output must go to stderr, as stdout is used to pass the
625 # flag:sshKey to the calling function.
627 # expects global variable: "MODE"
630 local requiredCapability
631 local requiredPubCapability
646 # set the required key capability based on the mode
647 if [ "$MODE" = 'known_hosts' ] ; then
648 requiredCapability="$REQUIRED_HOST_KEY_CAPABILITY"
649 elif [ "$MODE" = 'authorized_keys' ] ; then
650 requiredCapability="$REQUIRED_USER_KEY_CAPABILITY"
652 requiredPubCapability=$(echo "$requiredCapability" | tr "[:lower:]" "[:upper:]")
654 # fetch the user ID if necessary/requested
655 gpg_fetch_userid "$userID"
657 # output gpg info for (exact) userid and store
658 gpgOut=$(gpg --list-key --fixed-list-mode --with-colon \
659 --with-fingerprint --with-fingerprint \
660 ="$userID" 2>/dev/null)
662 # if the gpg query return code is not 0, return 1
663 if [ "$?" -ne 0 ] ; then
664 log verbose " no primary keys found."
668 # loop over all lines in the gpg output and process.
669 echo "$gpgOut" | cut -d: -f1,2,5,10,12 | \
670 while IFS=: read -r type validity keyid uidfpr usage ; do
671 # process based on record type
673 'pub') # primary keys
674 # new key, wipe the slate
681 log verbose " primary key found: $keyid"
683 # if overall key is not valid, skip
684 if [ "$validity" != 'u' -a "$validity" != 'f' ] ; then
685 log debug " - unacceptable primary key validity ($validity)."
688 # if overall key is disabled, skip
689 if check_capability "$usage" 'D' ; then
690 log debug " - key disabled."
693 # if overall key capability is not ok, skip
694 if ! check_capability "$usage" $requiredPubCapability ; then
695 log debug " - unacceptable primary key capability ($usage)."
699 # mark overall key as ok
702 # mark primary key as ok if capability is ok
703 if check_capability "$usage" $requiredCapability ; then
708 if [ "$lastKey" != pub ] ; then
709 log verbose " ! got a user ID after a sub key?! user IDs should only follow primary keys!"
712 # if an acceptable user ID was already found, skip
713 if [ "$uidOK" = 'true' ] ; then
716 # if the user ID does matches...
717 if [ "$(echo "$uidfpr" | gpg_unescape)" = "$userID" ] ; then
718 # and the user ID validity is ok
719 if [ "$validity" = 'u' -o "$validity" = 'f' ] ; then
720 # mark user ID acceptable
723 log debug " - unacceptable user ID validity ($validity)."
729 # output a line for the primary key
731 if [ "$keyOK" -a "$uidOK" -a "$lastKeyOK" ] ; then
732 log verbose " * acceptable primary key."
733 if [ -z "$sshKey" ] ; then
734 log error " ! primary key could not be translated (not RSA or DSA?)."
739 log debug " - unacceptable primary key."
740 if [ -z "$sshKey" ] ; then
741 log debug " ! primary key could not be translated (not RSA or DSA?)."
748 # unset acceptability of last key
753 # don't bother with sub keys if the primary key is not valid
754 if [ "$keyOK" != true ] ; then
758 # don't bother with sub keys if no user ID is acceptable:
759 if [ "$uidOK" != true ] ; then
763 # if sub key validity is not ok, skip
764 if [ "$validity" != 'u' -a "$validity" != 'f' ] ; then
765 log debug " - unacceptable sub key validity ($validity)."
768 # if sub key capability is not ok, skip
769 if ! check_capability "$usage" $requiredCapability ; then
770 log debug " - unacceptable sub key capability ($usage)."
777 'fpr') # key fingerprint
778 fingerprint="$uidfpr"
780 sshKey=$(gpg2ssh "$fingerprint")
782 # if the last key was the pub key, skip
783 if [ "$lastKey" = pub ] ; then
787 # output a line for the sub key
789 if [ "$keyOK" -a "$uidOK" -a "$lastKeyOK" ] ; then
790 log verbose " * acceptable sub key."
791 if [ -z "$sshKey" ] ; then
792 log error " ! sub key could not be translated (not RSA or DSA?)."
797 log debug " - unacceptable sub key."
798 if [ -z "$sshKey" ] ; then
799 log debug " ! sub key could not be translated (not RSA or DSA?)."
806 done | sort -t: -k1 -n -r
807 # NOTE: this last sort is important so that the "good" keys (key
808 # flag '0') come last. This is so that they take precedence when
809 # being processed in the key files over "bad" keys (key flag '1')
812 # process a single host in the known_host file
813 process_host_known_hosts() {
823 # set the key processing mode
824 export MODE='known_hosts'
827 userID="ssh://${host}"
829 log verbose "processing: $host"
835 for line in $(process_user_id "${userID}") ; do
836 # note that key was found
839 ok=$(echo "$line" | cut -d: -f1)
840 sshKey=$(echo "$line" | cut -d: -f2)
842 if [ -z "$sshKey" ] ; then
846 # remove any old host key line, and note if removed nothing is
848 remove_line "$KNOWN_HOSTS" "$sshKey" || noKey=true
850 # if key OK, add new host line
851 if [ "$ok" -eq '0' ] ; then
852 # note that key was found ok
853 nKeysOK=$((nKeysOK+1))
856 if [ "$HASH_KNOWN_HOSTS" = 'true' ] ; then
857 # FIXME: this is really hackish cause ssh-keygen won't
858 # hash from stdin to stdout
859 tmpfile=$(mktemp ${TMPDIR:-/tmp}/tmp.XXXXXXXXXX)
860 ssh2known_hosts "$host" "$sshKey" > "$tmpfile"
861 ssh-keygen -H -f "$tmpfile" 2> /dev/null
862 cat "$tmpfile" >> "$KNOWN_HOSTS"
863 rm -f "$tmpfile" "${tmpfile}.old"
865 ssh2known_hosts "$host" "$sshKey" >> "$KNOWN_HOSTS"
868 # log if this is a new key to the known_hosts file
869 if [ "$noKey" ] ; then
870 log info "* new key for $host added to known_hosts file."
875 # if at least one key was found...
876 if [ "$nKeys" -gt 0 ] ; then
877 # if ok keys were found, return 0
878 if [ "$nKeysOK" -gt 0 ] ; then
884 # if no keys were found, return 1
890 # update the known_hosts file for a set of hosts listed on command
892 update_known_hosts() {
899 # the number of hosts specified on command line
905 # touch the known_hosts file so that the file permission check
906 # below won't fail upon not finding the file
907 (umask 0022 && touch "$KNOWN_HOSTS")
909 # check permissions on the known_hosts file path
910 check_key_file_permissions "$USER" "$KNOWN_HOSTS" || failure
912 # create a lockfile on known_hosts:
913 lock create "$KNOWN_HOSTS"
914 # FIXME: we're discarding any pre-existing EXIT trap; is this bad?
915 trap "lock remove $KNOWN_HOSTS" EXIT
917 # note pre update file checksum
918 fileCheck="$(file_hash "$KNOWN_HOSTS")"
922 process_host_known_hosts "$host"
926 nHostsOK=$((nHostsOK+1))
929 nHostsBAD=$((nHostsBAD+1))
933 # touch the lockfile, for good measure.
934 lock touch "$KNOWN_HOSTS"
937 # remove the lockfile and the trap
938 lock remove "$KNOWN_HOSTS"
941 # note if the known_hosts file was updated
942 if [ "$(file_hash "$KNOWN_HOSTS")" != "$fileCheck" ] ; then
943 log debug "known_hosts file updated."
946 # if an acceptable host was found, return 0
947 if [ "$nHostsOK" -gt 0 ] ; then
949 # else if no ok hosts were found...
951 # if no bad host were found then no hosts were found at all,
953 if [ "$nHostsBAD" -eq 0 ] ; then
955 # else if at least one bad host was found, return 2
962 # process hosts from a known_hosts file
963 process_known_hosts() {
966 # exit if the known_hosts file does not exist
967 if [ ! -e "$KNOWN_HOSTS" ] ; then
968 failure "known_hosts file '$KNOWN_HOSTS' does not exist."
971 log debug "processing known_hosts file..."
973 hosts=$(meat "$KNOWN_HOSTS" | cut -d ' ' -f 1 | grep -v '^|.*$' | tr , ' ' | tr '\n' ' ')
975 if [ -z "$hosts" ] ; then
976 log debug "no hosts to process."
980 # take all the hosts from the known_hosts file (first
981 # field), grep out all the hashed hosts (lines starting
983 update_known_hosts $hosts
986 # process uids for the authorized_keys file
987 process_uid_authorized_keys() {
994 # set the key processing mode
995 export MODE='authorized_keys'
999 log verbose "processing: $userID"
1005 for line in $(process_user_id "$userID") ; do
1006 # note that key was found
1009 ok=$(echo "$line" | cut -d: -f1)
1010 sshKey=$(echo "$line" | cut -d: -f2)
1012 if [ -z "$sshKey" ] ; then
1016 # remove the old host key line
1017 remove_line "$AUTHORIZED_KEYS" "$sshKey"
1019 # if key OK, add new host line
1020 if [ "$ok" -eq '0' ] ; then
1021 # note that key was found ok
1022 nKeysOK=$((nKeysOK+1))
1024 ssh2authorized_keys "$userID" "$sshKey" >> "$AUTHORIZED_KEYS"
1028 # if at least one key was found...
1029 if [ "$nKeys" -gt 0 ] ; then
1030 # if ok keys were found, return 0
1031 if [ "$nKeysOK" -gt 0 ] ; then
1037 # if no keys were found, return 1
1043 # update the authorized_keys files from a list of user IDs on command
1045 update_authorized_keys() {
1052 # the number of ids specified on command line
1058 # check permissions on the authorized_keys file path
1059 check_key_file_permissions "$USER" "$AUTHORIZED_KEYS" || failure
1061 # create a lockfile on authorized_keys
1062 lock create "$AUTHORIZED_KEYS"
1063 # FIXME: we're discarding any pre-existing EXIT trap; is this bad?
1064 trap "lock remove $AUTHORIZED_KEYS" EXIT
1066 # note pre update file checksum
1067 fileCheck="$(file_hash "$AUTHORIZED_KEYS")"
1069 # remove any monkeysphere lines from authorized_keys file
1070 remove_monkeysphere_lines "$AUTHORIZED_KEYS"
1073 # process the user ID, change return code if key not found for
1075 process_uid_authorized_keys "$userID"
1080 nIDsOK=$((nIDsOK+1))
1083 nIDsBAD=$((nIDsBAD+1))
1087 # touch the lockfile, for good measure.
1088 lock touch "$AUTHORIZED_KEYS"
1091 # remove the lockfile and the trap
1092 lock remove "$AUTHORIZED_KEYS"
1097 # note if the authorized_keys file was updated
1098 if [ "$(file_hash "$AUTHORIZED_KEYS")" != "$fileCheck" ] ; then
1099 log debug "authorized_keys file updated."
1102 # if an acceptable id was found, return 0
1103 if [ "$nIDsOK" -gt 0 ] ; then
1105 # else if no ok ids were found...
1107 # if no bad ids were found then no ids were found at all, and
1109 if [ "$nIDsBAD" -eq 0 ] ; then
1111 # else if at least one bad id was found, return 2
1118 # process an authorized_user_ids file for authorized_keys
1119 process_authorized_user_ids() {
1124 authorizedUserIDs="$1"
1126 # exit if the authorized_user_ids file is empty
1127 if [ ! -e "$authorizedUserIDs" ] ; then
1128 failure "authorized_user_ids file '$authorizedUserIDs' does not exist."
1131 # check permissions on the authorized_user_ids file path
1132 check_key_file_permissions "$USER" "$authorizedUserIDs" || failure
1134 log debug "processing authorized_user_ids file..."
1136 if ! meat "$authorizedUserIDs" > /dev/null ; then
1137 log debug " no user IDs to process."
1143 # extract user IDs from authorized_user_ids file
1145 for line in $(meat "$authorizedUserIDs") ; do
1146 userIDs["$nline"]="$line"
1150 update_authorized_keys "${userIDs[@]}"
1153 # takes a gpg key or keys on stdin, and outputs a list of
1154 # fingerprints, one per line:
1155 list_primary_fingerprints() {
1156 local fake=$(msmktempdir)
1157 GNUPGHOME="$fake" gpg --no-tty --quiet --import
1158 GNUPGHOME="$fake" gpg --with-colons --fingerprint --list-keys | \
1159 awk -F: '/^fpr:/{ print $10 }'
1164 check_cruft_file() {
1168 if [ -e "$loc" ] ; then
1169 printf "! The file '%s' is no longer used by\n monkeysphere (as of version %s), and can be removed.\n\n" "$loc" "$version" | log info
1173 check_upgrade_dir() {
1177 if [ -d "$loc" ] ; then
1178 printf "The presence of directory '%s' indicates that you have\nnot yet completed a monkeysphere upgrade.\nYou should probably run the following script:\n %s/transitions/%s\n\n" "$loc" "$SYSSHAREDIR" "$version" | log info
1182 ## look for cruft from old versions of the monkeysphere, and notice if
1183 ## upgrades have not been run:
1185 check_upgrade_dir "${SYSCONFIGDIR}/gnupg-host" 0.23
1186 check_upgrade_dir "${SYSCONFIGDIR}/gnupg-authentication" 0.23
1188 check_cruft_file "${SYSCONFIGDIR}/gnupg-authentication.conf" 0.23
1189 check_cruft_file "${SYSCONFIGDIR}/gnupg-host.conf" 0.23
1192 for foo in "${SYSDATADIR}/backup-from-"*"-transition" ; do
1193 if [ -d "$foo" ] ; then
1194 printf "! %s\n" "$foo" | log info
1198 if [ "$found" ] ; then
1199 printf "The directories above are backups left over from a monkeysphere transition.\nThey may contain copies of sensitive data (host keys, certifier lists), but\nthey are no longer needed by monkeysphere.\nYou may remove them at any time.\n\n" | log info