3 # monkeysphere-server: MonkeySphere server admin tool
5 # The monkeysphere scripts are written by:
6 # Jameson Rollins <jrollins@fifthhorseman.net>
7 # Jamie McClelland <jm@mayfirst.org>
8 # Daniel Kahn Gillmor <dkg@fifthhorseman.net>
10 # They are Copyright 2008, and are all released under the GPL, version 3
13 ########################################################################
16 SYSSHAREDIR=${MONKEYSPHERE_SYSSHAREDIR:-"/usr/share/monkeysphere"}
18 . "${SYSSHAREDIR}/common" || exit 1
20 SYSDATADIR=${MONKEYSPHERE_SYSDATADIR:-"/var/lib/monkeysphere"}
23 # monkeysphere temp directory, in sysdatadir to enable atomic moves of
24 # authorized_keys files
25 MSTMPDIR="${SYSDATADIR}/tmp"
28 # UTC date in ISO 8601 format if needed
29 DATE=$(date -u '+%FT%T')
31 # unset some environment variables that could screw things up
37 ########################################################################
39 ########################################################################
43 usage: $PGRM <subcommand> [options] [args]
44 Monkeysphere server admin tool.
47 update-users (u) [USER]... update user authorized_keys files
49 import-key (i) import existing ssh key to gpg
50 --hostname (-h) NAME[:PORT] hostname for key user ID
51 --keyfile (-f) FILE key file to import
52 --expire (-e) EXPIRE date to expire
53 gen-key (g) generate gpg key for the host
54 --hostname (-h) NAME[:PORT] hostname for key user ID
55 --length (-l) BITS key length in bits (2048)
56 --expire (-e) EXPIRE date to expire
57 --revoker (-r) FINGERPRINT add a revoker
58 extend-key (e) EXPIRE extend host key expiration
59 add-hostname (n+) NAME[:PORT] add hostname user ID to host key
60 revoke-hostname (n-) NAME[:PORT] revoke hostname user ID
61 add-revoker (o) FINGERPRINT add a revoker to the host key
62 revoke-key (r) revoke host key
63 show-key (s) output all server host key information
64 publish-key (p) publish server host key to keyserver
65 diagnostics (d) report on server monkeysphere status
67 add-id-certifier (c+) KEYID import and tsign a certification key
68 --domain (-n) DOMAIN limit ID certifications to DOMAIN
69 --trust (-t) TRUST trust level of certifier (full)
70 --depth (-d) DEPTH trust depth for certifier (1)
71 remove-id-certifier (c-) KEYID remove a certification key
72 list-id-certifiers (c) list certification keys
74 gpg-authentication-cmd CMD give a gpg command to the
75 authentication keyring
77 version (v) show version number
83 # function to run command as monkeysphere user
84 su_monkeysphere_user() {
85 # if the current user is the monkeysphere user, then just eval
87 if [ $(id -un) = "$MONKEYSPHERE_USER" ] ; then
90 # otherwise su command as monkeysphere user
92 su "$MONKEYSPHERE_USER" -c "$@"
96 # function to interact with the host gnupg keyring
100 GNUPGHOME="$GNUPGHOME_HOST"
103 # NOTE: we supress this warning because we need the monkeysphere
104 # user to be able to read the host pubring. we realize this might
105 # be problematic, but it's the simplest solution, without too much
107 gpg --no-permission-warning "$@"
110 # always reset the permissions on the host pubring so that the
111 # monkeysphere user can read the trust signatures
112 chgrp "$MONKEYSPHERE_USER" "${GNUPGHOME_HOST}/pubring.gpg"
113 chmod g+r "${GNUPGHOME_HOST}/pubring.gpg"
118 # function to interact with the authentication gnupg keyring
119 # FIXME: this function requires basically accepts only a single
120 # argument because of problems with quote expansion. this needs to be
122 gpg_authentication() {
123 GNUPGHOME="$GNUPGHOME_AUTHENTICATION"
126 su_monkeysphere_user "gpg $@"
129 # check if user is root
131 [ $(id -u 2>/dev/null) = '0' ]
134 # check that user is root, for functions that require root access
136 is_root || failure "You must be root to run this command."
139 # output just key fingerprint
140 fingerprint_server_key() {
141 # set the pipefail option so functions fails if can't read sec key
144 gpg_host --list-secret-keys --fingerprint \
145 --with-colons --fixed-list-mode 2> /dev/null | \
146 grep '^fpr:' | head -1 | cut -d: -f10 2>/dev/null
149 # function to check for host secret key
150 check_host_keyring() {
151 fingerprint_server_key >/dev/null \
152 || failure "You don't appear to have a Monkeysphere host key on this server. Please run 'monkeysphere-server gen-key' first."
155 # output key information
161 # FIXME: you shouldn't have to be root to see the host key fingerprint
164 fingerprintPGP=$(fingerprint_server_key)
165 gpg_authentication "--fingerprint --list-key --list-options show-unusable-uids $fingerprintPGP" 2>/dev/null
166 echo "OpenPGP fingerprint: $fingerprintPGP"
168 log info "You must be root to see host OpenPGP fingerprint."
172 if [ -f "${SYSDATADIR}/ssh_host_rsa_key.pub" ] ; then
173 fingerprintSSH=$(ssh-keygen -l -f "${SYSDATADIR}/ssh_host_rsa_key.pub" | \
174 awk '{ print $1, $2, $4 }')
175 echo "ssh fingerprint: $fingerprintSSH"
177 log info "SSH host key not found."
184 # update authorized_keys for users
187 # get users from command line
190 # or just look at all users if none specified
191 unames=$(getent passwd | cut -d: -f1)
197 MODE="authorized_keys"
200 GNUPGHOME="$GNUPGHOME_AUTHENTICATION"
202 # check to see if the gpg trust database has been initialized
203 if [ ! -s "${GNUPGHOME}/trustdb.gpg" ] ; then
204 failure "GNUPG trust database uninitialized. Please see MONKEYSPHERE-SERVER(8)."
207 # make sure the authorized_keys directory exists
208 mkdir -p "${SYSDATADIR}/authorized_keys"
211 for uname in $unames ; do
212 # check all specified users exist
213 if ! id "$uname" >/dev/null ; then
214 log error "----- unknown user '$uname' -----"
218 log verbose "----- user: $uname -----"
220 # make temporary directory
221 TMPLOC=$(mktemp -d ${MSTMPDIR}/tmp.XXXXXXXXXX) || failure "Could not create temporary directory!"
223 # trap to delete temporary directory on exit
224 trap "rm -rf $TMPLOC" EXIT
226 # create temporary authorized_user_ids file
227 TMP_AUTHORIZED_USER_IDS="${TMPLOC}/authorized_user_ids"
228 touch "$TMP_AUTHORIZED_USER_IDS"
230 # create temporary authorized_keys file
231 AUTHORIZED_KEYS="${TMPLOC}/authorized_keys"
232 touch "$AUTHORIZED_KEYS"
234 # set restrictive permissions on the temporary files
235 # FIXME: is there a better way to do this?
237 chmod 0600 "$AUTHORIZED_KEYS"
238 chmod 0600 "$TMP_AUTHORIZED_USER_IDS"
239 chown -R "$MONKEYSPHERE_USER" "$TMPLOC"
241 # process authorized_user_ids file
242 log debug "checking for authorized_user_ids..."
243 # translating ssh-style path variables
244 authorizedUserIDs=$(translate_ssh_variables "$uname" "$AUTHORIZED_USER_IDS")
245 if [ -s "$authorizedUserIDs" ] ; then
246 # check permissions on the authorized_user_ids file path
247 if check_key_file_permissions "$uname" "$authorizedUserIDs" ; then
248 # copy user authorized_user_ids file to temporary
250 cat "$authorizedUserIDs" > "$TMP_AUTHORIZED_USER_IDS"
252 # export needed variables
253 export AUTHORIZED_KEYS
254 export TMP_AUTHORIZED_USER_IDS
256 # process authorized_user_ids file, as monkeysphere
258 su_monkeysphere_user \
259 ". ${SYSSHAREDIR}/common; process_authorized_user_ids $TMP_AUTHORIZED_USER_IDS"
262 log debug "not processing authorized_user_ids."
265 log debug "empty or absent authorized_user_ids file."
268 # add user-controlled authorized_keys file if specified
269 # translate ssh-style path variables
270 rawAuthorizedKeys=$(translate_ssh_variables "$uname" "$RAW_AUTHORIZED_KEYS")
271 if [ "$rawAuthorizedKeys" != 'none' ] ; then
272 log debug "checking for raw authorized_keys..."
273 if [ -s "$rawAuthorizedKeys" ] ; then
274 # check permissions on the authorized_keys file path
275 if check_key_file_permissions "$uname" "$rawAuthorizedKeys" ; then
276 log verbose "adding raw authorized_keys file... "
277 cat "$rawAuthorizedKeys" >> "$AUTHORIZED_KEYS"
279 log debug "not adding raw authorized_keys file."
282 log debug "empty or absent authorized_keys file."
286 # move the new authorized_keys file into place
287 if [ -s "$AUTHORIZED_KEYS" ] ; then
288 # openssh appears to check the contents of the
289 # authorized_keys file as the user in question, so the
290 # file must be readable by that user at least.
292 # but in general, we don't want the user tampering with
293 # this file directly, so we'll adopt this approach: Own
294 # the file by the monkeysphere-server invoker (usually
295 # root, but should be the same uid that sshd is launched
296 # as); change the group of the file so that members of the
297 # user's group can read it.
299 # FIXME: is there a better way to do this?
300 chown $(whoami) "$AUTHORIZED_KEYS" && \
301 chgrp $(id -g "$uname") "$AUTHORIZED_KEYS" && \
302 chmod g+r "$AUTHORIZED_KEYS" && \
303 mv -f "$AUTHORIZED_KEYS" "${SYSDATADIR}/authorized_keys/${uname}" || \
305 log error "Failed to install authorized_keys for '$uname'!"
306 rm -f "${SYSDATADIR}/authorized_keys/${uname}"
307 # indicate that there has been a failure:
311 rm -f "${SYSDATADIR}/authorized_keys/${uname}"
317 # destroy temporary directory
322 # import an existing ssh key to a gpg key
324 local hostName=$(hostname -f)
325 local keyFile="/etc/ssh/ssh_host_rsa_key"
329 # check for presense of secret key
330 # FIXME: is this the proper test to be doing here?
331 fingerprint_server_key >/dev/null \
332 && failure "An OpenPGP host key already exists."
350 if [ "$(echo "$1" | cut -c 1)" = '-' ] ; then
351 failure "Unknown option '$1'.
352 Type '$PGRM help' for usage."
359 if [ ! -f "$keyFile" ] ; then
360 failure "SSH secret key file '$keyFile' not found."
363 userID="ssh://${hostName}"
365 # prompt about key expiration if not specified
366 keyExpire=$(get_gpg_expiration "$keyExpire")
368 echo "The following key parameters will be used for the host private key:"
369 echo "Import: $keyFile"
370 echo "Name-Real: $userID"
371 echo "Expire-Date: $keyExpire"
373 read -p "Import key? (Y/n) " OK; OK=${OK:=Y}
374 if [ ${OK/y/Y} != 'Y' ] ; then
378 log verbose "importing ssh key..."
379 # translate ssh key to a private key
381 pem2openpgp "$userID" "$keyExpire" < "$sshKey" | gpg_host --import)
383 # find the key fingerprint of the newly converted key
384 fingerprint=$(fingerprint_server_key)
386 # export host ownertrust to authentication keyring
387 log verbose "setting ultimate owner trust for host key..."
388 echo "${fingerprint}:6:" | gpg_host "--import-ownertrust"
389 echo "${fingerprint}:6:" | gpg_authentication "--import-ownertrust"
391 # export public key to file
392 gpg_authentication "--export-options export-minimal --armor --export 0x${fingerprint}\!" > "${SYSDATADIR}/ssh_host_rsa_key.pub.gpg"
393 log info "SSH host public key in OpenPGP form: ${SYSDATADIR}/ssh_host_rsa_key.pub.gpg"
395 # show info about new key
399 # generate server gpg key
402 local keyLength="2048"
403 local keyUsage="auth"
406 local hostName=$(hostname -f)
411 # check for presense of secret key
412 # FIXME: is this the proper test to be doing here?
413 fingerprint_server_key >/dev/null \
414 && failure "An OpenPGP host key already exists."
436 if [ "$(echo "$1" | cut -c 1)" = '-' ] ; then
437 failure "Unknown option '$1'.
438 Type '$PGRM help' for usage."
445 userID="ssh://${hostName}"
447 # prompt about key expiration if not specified
448 keyExpire=$(get_gpg_expiration "$keyExpire")
453 Key-Length: $keyLength
456 Expire-Date: $keyExpire"
458 # add the revoker field if specified
459 # FIXME: the "1:" below assumes that $REVOKER's key is an RSA key.
460 # FIXME: key is marked "sensitive"? is this appropriate?
461 if [ "$revoker" ] ; then
464 Revoker: 1:${revoker} sensitive"
467 echo "The following key parameters will be used for the host private key:"
468 echo "$keyParameters"
470 read -p "Generate key? (Y/n) " OK; OK=${OK:=Y}
471 if [ ${OK/y/Y} != 'Y' ] ; then
476 # must include blank line!
483 log verbose "generating host key..."
484 echo "$keyParameters" | gpg_host --batch --gen-key
486 # find the key fingerprint of the newly generated key
487 fingerprint=$(fingerprint_server_key)
489 # export host ownertrust to authentication keyring
490 log verbose "setting ultimate owner trust for host key..."
491 echo "${fingerprint}:6:" | gpg_authentication "--import-ownertrust"
493 # translate the private key to ssh format, and export to a file
495 # NOTE: assumes that the primary key is the proper key to use
497 gpg_host --export-secret-key "$fingerprint" | \
498 openpgp2ssh "$fingerprint" > "${SYSDATADIR}/ssh_host_rsa_key")
499 log info "SSH host private key output to file: ${SYSDATADIR}/ssh_host_rsa_key"
500 ssh-keygen -y -f "${SYSDATADIR}/ssh_host_rsa_key" > "${SYSDATADIR}/ssh_host_rsa_key.pub"
501 log info "SSH host public key output to file: ${SYSDATADIR}/ssh_host_rsa_key.pub"
502 gpg_authentication "--export-options export-minimal --armor --export 0x${fingerprint}\!" > "${SYSDATADIR}/ssh_host_rsa_key.pub.gpg"
503 log info "SSH host public key in OpenPGP form: ${SYSDATADIR}/ssh_host_rsa_key.pub.gpg"
505 # show info about new key
509 # extend the lifetime of a host key:
511 local fpr=$(fingerprint_server_key)
514 # get the new expiration date
515 extendTo=$(get_gpg_expiration "$extendTo")
517 gpg_host --quiet --command-fd 0 --edit-key "$fpr" <<EOF
524 echo "NOTE: Host key expiration date adjusted, but not yet published."
525 echo "Run '$PGRM publish-key' to publish the new expiration date."
528 # add hostname user ID to server key
536 if [ -z "$1" ] ; then
537 failure "You must specify a hostname to add."
542 fingerprint=$(fingerprint_server_key)
544 # match to only ultimately trusted user IDs
545 tmpuidMatch="u:$(echo $userID | gpg_escape)"
547 # find the index of the requsted user ID
548 # NOTE: this is based on circumstantial evidence that the order of
549 # this output is the appropriate index
550 if line=$(gpg_host --list-keys --with-colons --fixed-list-mode "0x${fingerprint}!" \
551 | egrep '^(uid|uat):' | cut -f2,10 -d: | grep -n -x -F "$tmpuidMatch") ; then
552 failure "Host userID '$userID' already exists."
555 echo "The following user ID will be added to the host key:"
557 read -p "Are you sure you would like to add this user ID? (y/N) " OK; OK=${OK:=N}
558 if [ ${OK/y/Y} != 'Y' ] ; then
559 failure "User ID not added."
562 # edit-key script command to add user ID
563 adduidCommand=$(cat <<EOF
572 # execute edit-key script
573 if echo "$adduidCommand" | \
574 gpg_host --quiet --command-fd 0 --edit-key "0x${fingerprint}!" ; then
576 # update the trustdb for the authentication keyring
577 gpg_authentication "--check-trustdb"
582 echo "NOTE: User ID added to key, but key not published."
583 echo "Run '$PGRM publish-key' to publish the new user ID."
585 failure "Problem adding user ID."
589 # revoke hostname user ID to server key
599 if [ -z "$1" ] ; then
600 failure "You must specify a hostname to revoke."
603 echo "WARNING: There is a known bug in this function."
604 echo "This function has been known to occasionally revoke the wrong user ID."
605 echo "Please see the following bug report for more information:"
606 echo "http://web.monkeysphere.info/bugs/revoke-hostname-revoking-wrong-userid/"
607 read -p "Are you sure you would like to proceed? (y/N) " OK; OK=${OK:=N}
608 if [ ${OK/y/Y} != 'Y' ] ; then
614 fingerprint=$(fingerprint_server_key)
616 # match to only ultimately trusted user IDs
617 tmpuidMatch="u:$(echo $userID | gpg_escape)"
619 # find the index of the requsted user ID
620 # NOTE: this is based on circumstantial evidence that the order of
621 # this output is the appropriate index
622 if line=$(gpg_host --list-keys --with-colons --fixed-list-mode "0x${fingerprint}!" \
623 | egrep '^(uid|uat):' | cut -f2,10 -d: | grep -n -x -F "$tmpuidMatch") ; then
626 failure "No non-revoked user ID '$userID' is found."
629 echo "The following host key user ID will be revoked:"
631 read -p "Are you sure you would like to revoke this user ID? (y/N) " OK; OK=${OK:=N}
632 if [ ${OK/y/Y} != 'Y' ] ; then
633 failure "User ID not revoked."
636 message="Hostname removed by monkeysphere-server $DATE"
638 # edit-key script command to revoke user ID
639 revuidCommand=$(cat <<EOF
651 # execute edit-key script
652 if echo "$revuidCommand" | \
653 gpg_host --quiet --command-fd 0 --edit-key "0x${fingerprint}!" ; then
655 # update the trustdb for the authentication keyring
656 gpg_authentication "--check-trustdb"
661 echo "NOTE: User ID revoked, but revocation not published."
662 echo "Run '$PGRM publish-key' to publish the revocation."
664 failure "Problem revoking user ID."
668 # add a revoker to the host key
671 failure "not implemented yet!"
674 # revoke the host key
677 failure "not implemented yet!"
680 # publish server key to keyserver
681 publish_server_key() {
682 read -p "Really publish host key to $KEYSERVER? (y/N) " OK; OK=${OK:=N}
683 if [ ${OK/y/Y} != 'Y' ] ; then
684 failure "key not published."
687 # find the key fingerprint
688 fingerprint=$(fingerprint_server_key)
691 gpg_authentication "--keyserver $KEYSERVER --send-keys '0x${fingerprint}!'"
696 # * check on the status and validity of the key and public certificates
708 local problemsfound=0
710 # FIXME: what's the correct, cross-platform answer?
711 sshd_config=/etc/ssh/sshd_config
712 seckey=$(gpg_host --list-secret-keys --fingerprint --with-colons --fixed-list-mode)
713 keysfound=$(echo "$seckey" | grep -c ^sec:)
715 # warn when anything is 2 months away from expiration
716 warnwindow='2 months'
717 warndate=$(advance_date $warnwindow +%s)
719 if ! id monkeysphere >/dev/null ; then
720 echo "! No monkeysphere user found! Please create a monkeysphere system user with bash as its shell."
721 problemsfound=$(($problemsfound+1))
724 if ! [ -d "$SYSDATADIR" ] ; then
725 echo "! no $SYSDATADIR directory found. Please create it."
726 problemsfound=$(($problemsfound+1))
729 echo "Checking host GPG key..."
730 if (( "$keysfound" < 1 )); then
731 echo "! No host key found."
732 echo " - Recommendation: run 'monkeysphere-server gen-key'"
733 problemsfound=$(($problemsfound+1))
734 elif (( "$keysfound" > 1 )); then
735 echo "! More than one host key found?"
736 # FIXME: recommend a way to resolve this
737 problemsfound=$(($problemsfound+1))
739 create=$(echo "$seckey" | grep ^sec: | cut -f6 -d:)
740 expire=$(echo "$seckey" | grep ^sec: | cut -f7 -d:)
741 fingerprint=$(echo "$seckey" | grep ^fpr: | head -n1 | cut -f10 -d:)
742 # check for key expiration:
743 if [ "$expire" ]; then
744 if (( "$expire" < "$curdate" )); then
745 echo "! Host key is expired."
746 echo " - Recommendation: extend lifetime of key with 'monkeysphere-server extend-key'"
747 problemsfound=$(($problemsfound+1))
748 elif (( "$expire" < "$warndate" )); then
749 echo "! Host key expires in less than $warnwindow:" $(advance_date $(( $expire - $curdate )) seconds +%F)
750 echo " - Recommendation: extend lifetime of key with 'monkeysphere-server extend-key'"
751 problemsfound=$(($problemsfound+1))
756 if [ "$create" ] && (( "$create" > "$curdate" )); then
757 echo "! Host key was created in the future(?!). Is your clock correct?"
758 echo " - Recommendation: Check clock ($(date +%F_%T)); use NTP?"
759 problemsfound=$(($problemsfound+1))
762 # check for UserID expiration:
763 echo "$seckey" | grep ^uid: | cut -d: -f6,7,10 | \
764 while IFS=: read create expire uid ; do
765 # FIXME: should we be doing any checking on the form
766 # of the User ID? Should we be unmangling it somehow?
768 if [ "$create" ] && (( "$create" > "$curdate" )); then
769 echo "! User ID '$uid' was created in the future(?!). Is your clock correct?"
770 echo " - Recommendation: Check clock ($(date +%F_%T)); use NTP?"
771 problemsfound=$(($problemsfound+1))
773 if [ "$expire" ] ; then
774 if (( "$expire" < "$curdate" )); then
775 echo "! User ID '$uid' is expired."
776 # FIXME: recommend a way to resolve this
777 problemsfound=$(($problemsfound+1))
778 elif (( "$expire" < "$warndate" )); then
779 echo "! User ID '$uid' expires in less than $warnwindow:" $(advance_date $(( $expire - $curdate )) seconds +%F)
780 # FIXME: recommend a way to resolve this
781 problemsfound=$(($problemsfound+1))
786 # FIXME: verify that the host key is properly published to the
787 # keyservers (do this with the non-privileged user)
789 # FIXME: check that there are valid, non-expired certifying signatures
790 # attached to the host key after fetching from the public keyserver
791 # (do this with the non-privileged user as well)
793 # FIXME: propose adding a revoker to the host key if none exist (do we
794 # have a way to do that after key generation?)
796 # Ensure that the ssh_host_rsa_key file is present and non-empty:
798 echo "Checking host SSH key..."
799 if [ ! -s "${SYSDATADIR}/ssh_host_rsa_key" ] ; then
800 echo "! The host key as prepared for SSH (${SYSDATADIR}/ssh_host_rsa_key) is missing or empty."
801 problemsfound=$(($problemsfound+1))
803 if [ $(ls -l "${SYSDATADIR}/ssh_host_rsa_key" | cut -f1 -d\ ) != '-rw-------' ] ; then
804 echo "! Permissions seem wrong for ${SYSDATADIR}/ssh_host_rsa_key -- should be 0600."
805 problemsfound=$(($problemsfound+1))
808 # propose changes needed for sshd_config (if any)
809 if ! grep -q "^HostKey[[:space:]]\+${SYSDATADIR}/ssh_host_rsa_key$" "$sshd_config"; then
810 echo "! $sshd_config does not point to the monkeysphere host key (${SYSDATADIR}/ssh_host_rsa_key)."
811 echo " - Recommendation: add a line to $sshd_config: 'HostKey ${SYSDATADIR}/ssh_host_rsa_key'"
812 problemsfound=$(($problemsfound+1))
814 if badhostkeys=$(grep -i '^HostKey' "$sshd_config" | grep -v "^HostKey[[:space:]]\+${SYSDATADIR}/ssh_host_rsa_key$") ; then
815 echo "! $sshd_config refers to some non-monkeysphere host keys:"
817 echo " - Recommendation: remove the above HostKey lines from $sshd_config"
818 problemsfound=$(($problemsfound+1))
821 # FIXME: test (with ssh-keyscan?) that the running ssh
822 # daemon is actually offering the monkeysphere host key.
827 # FIXME: look at the ownership/privileges of the various keyrings,
828 # directories housing them, etc (what should those values be? can
829 # we make them as minimal as possible?)
831 # FIXME: look to see that the ownertrust rules are set properly on the
832 # authentication keyring
834 # FIXME: make sure that at least one identity certifier exists
836 # FIXME: look at the timestamps on the monkeysphere-generated
837 # authorized_keys files -- warn if they seem out-of-date.
839 # FIXME: check for a cronjob that updates monkeysphere-generated
843 echo "Checking for MonkeySphere-enabled public-key authentication for users ..."
844 # Ensure that User ID authentication is enabled:
845 if ! grep -q "^AuthorizedKeysFile[[:space:]]\+${SYSDATADIR}/authorized_keys/%u$" "$sshd_config"; then
846 echo "! $sshd_config does not point to monkeysphere authorized keys."
847 echo " - Recommendation: add a line to $sshd_config: 'AuthorizedKeysFile ${SYSDATADIR}/authorized_keys/%u'"
848 problemsfound=$(($problemsfound+1))
850 if badauthorizedkeys=$(grep -i '^AuthorizedKeysFile' "$sshd_config" | grep -v "^AuthorizedKeysFile[[:space:]]\+${SYSDATADIR}/authorized_keys/%u$") ; then
851 echo "! $sshd_config refers to non-monkeysphere authorized_keys files:"
852 echo "$badauthorizedkeys"
853 echo " - Recommendation: remove the above AuthorizedKeysFile lines from $sshd_config"
854 problemsfound=$(($problemsfound+1))
857 if [ "$problemsfound" -gt 0 ]; then
858 echo "When the above $problemsfound issue"$(if [ "$problemsfound" -eq 1 ] ; then echo " is" ; else echo "s are" ; fi)" resolved, please re-run:"
859 echo " monkeysphere-server diagnostics"
861 echo "Everything seems to be in order!"
865 # retrieve key from web of trust, import it into the host keyring, and
866 # ltsign the key in the host keyring so that it may certify other keys
876 # set default values for trust depth and domain
897 if [ "$(echo "$1" | cut -c 1)" = '-' ] ; then
898 failure "Unknown option '$1'.
899 Type '$PGRM help' for usage."
907 if [ -z "$keyID" ] ; then
908 failure "You must specify the key ID of a key to add, or specify a file to read the key from."
910 if [ -f "$keyID" ] ; then
911 echo "Reading key from file '$keyID':"
912 importinfo=$(gpg_authentication "--import" < "$keyID" 2>&1) || failure "could not read key from '$keyID'"
913 # FIXME: if this is tried when the key database is not
914 # up-to-date, i got these errors (using set -x):
916 # ++ su -m monkeysphere -c '\''gpg --import'\''
917 # Warning: using insecure memory!
918 # gpg: key D21739E9: public key "Daniel Kahn Gillmor <dkg@fifthhorseman.net>" imported
919 # gpg: Total number processed: 1
920 # gpg: imported: 1 (RSA: 1)
921 # gpg: can'\''t create `/var/monkeysphere/gnupg-host/pubring.gpg.tmp'\'': Permission denied
922 # gpg: failed to rebuild keyring cache: Permission denied
923 # gpg: 3 marginal(s) needed, 1 complete(s) needed, PGP trust model
924 # gpg: depth: 0 valid: 1 signed: 0 trust: 0-, 0q, 0n, 0m, 0f, 1u
925 # gpg: next trustdb check due at 2009-01-10'
926 # + failure 'could not read key from '\''/root/dkg.gpg'\'''
927 # + echo 'could not read key from '\''/root/dkg.gpg'\'''
929 keyID=$(echo "$importinfo" | grep '^gpg: key ' | cut -f2 -d: | cut -f3 -d\ )
930 if [ -z "$keyID" ] || [ $(echo "$keyID" | wc -l) -ne 1 ] ; then
931 failure "Expected there to be a single gpg key in the file."
934 # get the key from the key server
935 gpg_authentication "--keyserver $KEYSERVER --recv-key '0x${keyID}!'" || failure "Could not receive a key with this ID from the '$KEYSERVER' keyserver."
941 # get the full fingerprint of a key ID
942 fingerprint=$(gpg_authentication "--list-key --with-colons --with-fingerprint 0x${keyID}!" | \
943 grep '^fpr:' | grep "$keyID" | cut -d: -f10)
945 if [ -z "$fingerprint" ] ; then
946 failure "Key '$keyID' not found."
951 gpg_authentication "--fingerprint 0x${fingerprint}!"
953 echo "Are you sure you want to add the above key as a"
954 read -p "certifier of users on this system? (y/N) " OK; OK=${OK:-N}
955 if [ "${OK/y/Y}" != 'Y' ] ; then
956 failure "Identity certifier not added."
959 # export the key to the host keyring
960 gpg_authentication "--export 0x${fingerprint}!" | gpg_host --import
962 if [ "$trust" = marginal ]; then
964 elif [ "$trust" = full ]; then
967 failure "Trust value requested ('$trust') was unclear (only 'marginal' or 'full' are supported)."
971 # NOTE: *all* user IDs will be ltsigned
972 ltsignCommand=$(cat <<EOF
984 if echo "$ltsignCommand" | \
985 gpg_host --quiet --command-fd 0 --edit-key "0x${fingerprint}!" ; then
987 # update the trustdb for the authentication keyring
988 gpg_authentication "--check-trustdb"
991 echo "Identity certifier added."
993 failure "Problem adding identify certifier."
997 # delete a certifiers key from the host keyring
1003 if [ -z "$keyID" ] ; then
1004 failure "You must specify the key ID of a key to remove."
1007 if gpg_authentication "--no-options --list-options show-uid-validity --keyring ${GNUPGHOME_AUTHENTICATION}/pubring.gpg --list-key 0x${keyID}!" ; then
1008 read -p "Really remove above listed identity certifier? (y/N) " OK; OK=${OK:-N}
1009 if [ "${OK/y/Y}" != 'Y' ] ; then
1010 failure "Identity certifier not removed."
1016 # delete the requested key
1017 if gpg_authentication "--delete-key --batch --yes 0x${keyID}!" ; then
1018 # delete key from host keyring as well
1019 gpg_host --delete-key --batch --yes "0x${keyID}!"
1021 # update the trustdb for the authentication keyring
1022 gpg_authentication "--check-trustdb"
1025 echo "Identity certifier removed."
1027 failure "Problem removing identity certifier."
1031 # list the host certifiers
1036 # find trusted keys in authentication keychain
1037 keys=$(gpg_authentication "--no-options --list-options show-uid-validity --keyring ${GNUPGHOME_AUTHENTICATION}/pubring.gpg --list-keys --with-colons --fingerprint" | \
1038 grep ^pub: | cut -d: -f2,5 | egrep '^(u|f):' | cut -d: -f2)
1041 for key in $keys ; do
1042 gpg_authentication "--no-options --list-options show-uid-validity --keyring ${GNUPGHOME_AUTHENTICATION}/pubring.gpg --list-key --fingerprint $key"
1046 # issue command to gpg-authentication keyring
1047 gpg_authentication_cmd() {
1048 gpg_authentication "$@"
1051 ########################################################################
1053 ########################################################################
1055 # unset variables that should be defined only in config file
1057 unset AUTHORIZED_USER_IDS
1058 unset RAW_AUTHORIZED_KEYS
1059 unset MONKEYSPHERE_USER
1061 # load configuration file
1062 [ -e ${MONKEYSPHERE_SERVER_CONFIG:="${SYSCONFIGDIR}/monkeysphere-server.conf"} ] && . "$MONKEYSPHERE_SERVER_CONFIG"
1064 # set empty config variable with ones from the environment, or with
1066 LOG_LEVEL=${MONKEYSPHERE_LOG_LEVEL:=${LOG_LEVEL:="INFO"}}
1067 KEYSERVER=${MONKEYSPHERE_KEYSERVER:=${KEYSERVER:="pool.sks-keyservers.net"}}
1068 AUTHORIZED_USER_IDS=${MONKEYSPHERE_AUTHORIZED_USER_IDS:=${AUTHORIZED_USER_IDS:="%h/.monkeysphere/authorized_user_ids"}}
1069 RAW_AUTHORIZED_KEYS=${MONKEYSPHERE_RAW_AUTHORIZED_KEYS:=${RAW_AUTHORIZED_KEYS:="%h/.ssh/authorized_keys"}}
1070 MONKEYSPHERE_USER=${MONKEYSPHERE_MONKEYSPHERE_USER:=${MONKEYSPHERE_USER:="monkeysphere"}}
1073 CHECK_KEYSERVER=${MONKEYSPHERE_CHECK_KEYSERVER:="true"}
1074 REQUIRED_USER_KEY_CAPABILITY=${MONKEYSPHERE_REQUIRED_USER_KEY_CAPABILITY:="a"}
1075 GNUPGHOME_HOST=${MONKEYSPHERE_GNUPGHOME_HOST:="${SYSDATADIR}/gnupg-host"}
1076 GNUPGHOME_AUTHENTICATION=${MONKEYSPHERE_GNUPGHOME_AUTHENTICATION:="${SYSDATADIR}/gnupg-authentication"}
1078 # export variables needed in su invocation
1081 export MONKEYSPHERE_USER
1084 export CHECK_KEYSERVER
1085 export REQUIRED_USER_KEY_CAPABILITY
1086 export GNUPGHOME_HOST
1087 export GNUPGHOME_AUTHENTICATION
1092 [ "$COMMAND" ] || failure "Type '$PGRM help' for usage."
1096 'update-users'|'update-user'|'u')
1118 'add-hostname'|'add-name'|'n+')
1124 'revoke-hostname'|'revoke-name'|'n-')
1127 revoke_hostname "$@"
1142 'show-key'|'show'|'s')
1146 'publish-key'|'publish'|'p')
1157 'add-identity-certifier'|'add-id-certifier'|'add-certifier'|'c+')
1163 'remove-identity-certifier'|'remove-id-certifier'|'remove-certifier'|'c-')
1166 remove_certifier "$@"
1169 'list-identity-certifiers'|'list-id-certifiers'|'list-certifiers'|'list-certifier'|'c')
1172 list_certifiers "$@"
1175 'gpg-authentication-cmd')
1177 gpg_authentication_cmd "$@"
1184 '--help'|'help'|'-h'|'h'|'?')
1189 failure "Unknown command: '$COMMAND'
1190 Type '$PGRM help' for usage."