alphabetize the options
[monkeysphere.git] / src / monkeysphere-server
index 19b457fed71ea65cf34fa85234f22181619ea1e6..0a2f04b00bcb9624b7b4fdfba23bfb197d339bf2 100755 (executable)
@@ -37,26 +37,26 @@ usage: $PGRM <subcommand> [options] [args]
 MonkeySphere server admin tool.
 
 subcommands:
 update-users (u) [USER]...            update user authorized_keys files
-
 gen-key (g) [HOSTNAME]                generate gpg key for the server
-    -l|--length BITS                      key length in bits (2048)
-    -e|--expire EXPIRE                    date to expire
-    -r|--revoker FINGERPRINT              add a revoker
 show-fingerprint (f)                  show server's host key fingerprint
 publish-key (p)                       publish server's host key to keyserver
-
-  add-identity-certifier (a) KEYID      import and tsign a certification key
-    -n|--domain DOMAIN                    limit ID certifications to IDs in DOMAIN ()
-    -t|--trust TRUST                      trust level of certifier (full)
-    -d|--depth DEPTH                      trust depth for certifier (1)
-  remove-identity-certifier (r) KEYID   remove a certification key
-  list-identity-certifiers (l)          list certification keys
-
-  gpg-authentication-cmd CMD            gnupg-authentication command
-
-  help (h,?)                            this help
-
update-users (u) [USER]...          update user authorized_keys files
+
gen-key (g) [HOSTNAME]              generate gpg key for the server
+   -l|--length BITS                    key length in bits (2048)
+   -e|--expire EXPIRE                  date to expire
+   -r|--revoker FINGERPRINT            add a revoker
show-fingerprint (f)                show server's host key fingerprint
publish-key (p)                     publish server's host key to keyserver
+ diagnostics (d)                     report on the server's monkeysphere status
+
+ add-identity-certifier (a) KEYID    import and tsign a certification key
+   -n|--domain DOMAIN                  limit ID certifications to IDs in DOMAIN
+   -t|--trust TRUST                    trust level of certifier (full)
+   -d|--depth DEPTH                    trust depth for certifier (1)
+ remove-identity-certifier (r) KEYID remove a certification key
+ list-identity-certifiers (l)        list certification keys
+
+ gpg-authentication-cmd CMD          gnupg-authentication command
+
+ help (h,?)                          this help
 EOF
 }
 
@@ -143,13 +143,15 @@ update_users() {
 
        log "----- user: $uname -----"
 
+        # exit if the authorized_user_ids file is empty
        if ! check_key_file_permissions "$uname" "$AUTHORIZED_USER_IDS" ; then
-           log "Improper permissions on authorized_user_ids file."
+           log "Improper permissions on authorized_user_ids file path."
            continue
        fi
 
+       # check permissions on the authorized_keys file path
        if ! check_key_file_permissions "$uname" "$RAW_AUTHORIZED_KEYS" ; then
-           log "Improper permissions on authorized_keys file."
+           log "Improper permissions on authorized_keys file path path."
            continue
        fi
 
@@ -206,8 +208,7 @@ update_users() {
        chgrp $(getent passwd "$uname" | cut -f4 -d:) "$AUTHORIZED_KEYS"
        chmod g+r "$AUTHORIZED_KEYS"
 
-       # if the resulting authorized_keys file is not empty, move
-       # it into place
+       # move the resulting authorized_keys file into place
        mv -f "$AUTHORIZED_KEYS" "${VARLIB}/authorized_keys/${uname}"
 
        # destroy temporary directory
@@ -235,7 +236,7 @@ gen_key() {
     revoker=
 
     # get options
-    TEMP=$(getopt -o l:e:r: -l length:,expire:,revoker: -n "$PGRM" -- "$@")
+    TEMP=$(getopt -o e:l:r -l expire:,length:,revoker: -n "$PGRM" -- "$@")
 
     if [ $? != 0 ] ; then
        exit 1
@@ -378,6 +379,118 @@ publish_server_key() {
     exit 255
 }
 
+diagnostics() {
+#  * check on the status and validity of the key and public certificates
+    local seckey
+    local keysfound
+    local curdate
+    local warnwindow
+    local warndate
+    local create
+    local expire
+    local uid
+    local fingerprint
+    local badhostkeys
+
+    seckey=$(gpg_host --list-secret-keys --fingerprint --with-colons --fixed-list-mode)
+    keysfound=$(echo "$seckey" | grep -c ^sec:)
+    curdate=$(date +%s)
+    # warn when anything is 2 months away from expiration
+    warnwindow='2 months'
+    warndate=$(date +%s -d "$warnwindow")
+
+    echo "Checking host GPG key..."
+    if (( "$keysfound" < 1 )); then
+       echo "! No host key found."
+       echo " - Recommendation: run 'monkeysphere-server gen-key'"
+    elif (( "$keysfound" > 1 )); then
+       echo "! More than one host key found?"
+       # FIXME: recommend a way to resolve this
+    else
+       create=$(echo "$seckey" | grep ^sec: | cut -f6 -d:)
+       expire=$(echo "$seckey" | grep ^sec: | cut -f7 -d:)
+       fingerprint=$(echo "$seckey" | grep ^fpr: | head -n1 | cut -f10 -d:)
+       # check for key expiration:
+       if [ "$expire" ]; then
+           if (( "$expire"  < "$curdate" )); then
+               echo "! Host key is expired."
+               # FIXME: recommend a way to resolve this other than re-keying?
+           elif (( "$expire" < "$warndate" )); then
+               echo "! Host key expires in less than $warnwindow:" $(date -d "$(( $expire - $curdate )) seconds" +%F)
+               # FIXME: recommend a way to resolve this?
+           fi
+       fi
+
+        # and weirdnesses:
+       if [ "$create" ] && (( "$create" > "$curdate" )); then
+           echo "! Host key was created in the future(?!). Is your clock correct?"
+           echo " - Recommendation: Check clock ($(date +%F_%T)); use NTP?"
+       fi
+
+        # check for UserID expiration:
+       echo "$seckey" | grep ^uid: | cut -d: -f6,7,10 | \
+       while IFS=: read create expire uid ; do
+           # FIXME: should we be doing any checking on the form
+           # of the User ID?  Should we be unmangling it somehow?
+
+           if [ "$create" ] && (( "$create" > "$curdate" )); then
+               echo "! User ID '$uid' was created in the future(?!).  Is your clock correct?"
+               echo " - Recommendation: Check clock ($(date +%F_%T)); use NTP?"
+           fi
+           if [ "$expire" ] ; then
+               if (( "$expire" < "$curdate" )); then
+                   echo "! User ID '$uid' is expired."
+                       # FIXME: recommend a way to resolve this
+               elif (( "$expire" < "$warndate" )); then
+                   echo "! User ID '$uid' expires in less than $warnwindow:" $(date -d "$(( $expire - $curdate )) seconds" +%F)                
+                   # FIXME: recommend a way to resolve this
+               fi
+           fi
+       done
+           
+# FIXME: verify that the host key is properly published to the
+#   keyservers (do this with the non-privileged user)
+
+# FIXME: check that there are valid, non-expired certifying signatures
+#   attached to the host key after fetching from the public keyserver
+#   (do this with the non-privileged user as well)
+
+# FIXME: propose adding a revoker to the host key if none exist (do we
+#   have a way to do that after key generation?)
+
+       # Ensure that the ssh_host_rsa_key file is present and non-empty:
+       echo "Checking host SSH key..."
+       if [ ! -s "${VARLIB}/ssh_host_rsa_key" ] ; then
+           echo "! The host key as prepared for SSH (${VARLIB}/ssh_host_rsa_key) is missing or empty."
+       else
+           if [ $(stat -c '%a' "${VARLIB}/ssh_host_rsa_key") != 600 ] ; then
+               echo "! Permissions seem wrong for ${VARLIB}/ssh_host_rsa_key -- should be 0600."
+           fi
+
+           # propose changes needed for sshd_config (if any)
+           if ! grep -q "^HostKey ${VARLIB}/ssh_host_rsa_key$" /etc/ssh/sshd_config; then
+               echo "! /etc/ssh/sshd_config does not point to the monkeysphere host key (${VARLIB}/ssh_host_rsa_key)."
+               echo " - Recommendation: add a line to /etc/ssh/sshd_config: 'HostKey ${VARLIB}/ssh_host_rsa_key'"
+           fi
+           if badhostkeys=$(grep '^HostKey' | grep -q -v "^HostKey ${VARLIB}/ssh_host_rsa_key$") ; then
+               echo "! /etc/sshd_config refers to some non-monkeysphere host keys:"
+               echo "$badhostkeys"
+               echo "- Recommendation: remove the above HostKey lines from /etc/ssh/sshd_config"
+           fi
+       fi
+    fi
+
+# FIXME: look at the ownership/privileges of the various keyrings,
+#    directories housing them, etc (what should those values be?  can
+#    we make them as minimal as possible?)
+
+# FIXME: look to see that the ownertrust rules are set properly on the
+#    authentication keyring
+
+# FIXME:  make sure that at least one identity certifier exists
+
+}
+
 # retrieve key from web of trust, import it into the host keyring, and
 # ltsign the key in the host keyring so that it may certify other keys
 add_certifier() {
@@ -566,6 +679,10 @@ case $COMMAND in
        publish_server_key
        ;;
 
+    'diagnostics'|'d')
+       diagnostics
+       ;;
+
     'add-identity-certifier'|'add-certifier'|'a')
        add_certifier "$1"
        ;;