first pass at revoking hostnames.
[monkeysphere.git] / src / monkeysphere-server
index 03a4ccba8484686eef7b1086d948db97f33fc5ed..6ffd41ffb78b3b3c8d36bed25434c42060235769 100755 (executable)
@@ -32,31 +32,34 @@ RETURN=0
 ########################################################################
 
 usage() {
-cat <<EOF
+    cat <<EOF
 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
+ gen-key (g) [NAME[:PORT]]           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
+ add-hostname (n+) NAME[:PORT]       add hostname user ID to server key
+ revoke-hostname (n-) NAME[:PORT]    revoke hostname user ID
+ show-key (s)                        output all server host key information
+ fingerprint (f)                     output just the key fingerprint
+ publish-key (p)                     publish server host key to keyserver
+ diagnostics (d)                     report on server monkeysphere status
+
+ add-id-certifier (c+) KEYID         import and tsign a certification key
+   -n|--domain DOMAIN                  limit ID certifications to 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
+ remove-id-certifier (c-) KEYID      remove a certification key
+ list-id-certifiers (c)              list certification keys
 
  gpg-authentication-cmd CMD          gnupg-authentication command
 
help (h,?)                          this help
-h|--help|help (h,?)                this help
 EOF
 }
 
@@ -97,6 +100,17 @@ gpg_authentication() {
     su_monkeysphere_user "gpg $@"
 }
 
+# output key information
+show_server_key() {
+    gpg_host --list-secret-keys --fingerprint
+}
+
+# output just key fingerprint
+fingerprint_server_key() {
+    gpg_host --list-secret-keys --fingerprint --with-colons --fixed-list-mode | \
+       grep '^fpr:' | head -1 | cut -d: -f10
+}
+
 # update authorized_keys for users
 update_users() {
     if [ "$1" ] ; then
@@ -236,7 +250,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
@@ -339,9 +353,8 @@ EOF
     # output the server fingerprint
     fingerprint_server_key "=${userID}"
 
-    # find the key fingerprint of the server primary key
-    fingerprint=$(gpg_host --list-key --with-colons --with-fingerprint "=${userID}" | \
-       grep '^fpr:' | head -1 | cut -d: -f10)
+    # find the key fingerprint of the newly generated key
+    fingerprint=$(fingerprint_server_key)
 
     # export host ownertrust to authentication keyring
     log "setting ultimate owner trust for server key..."
@@ -356,109 +369,190 @@ EOF
     log "Private SSH host key output to file: ${VARLIB}/ssh_host_rsa_key"
 }
 
-# gpg output key fingerprint
-fingerprint_server_key() {
-    gpg_host --fingerprint --list-secret-keys
+# add hostname user ID to server key
+add_hostname() {
+    if [ -z "$1" ] ; then
+       failure "You must specify a hostname to add."
+    fi
+
+    userID="ssh://${1}"
+
+    if [ "$(gpg_host --list-key "=${userID}")" ] ; then
+       failure "Host userID '$userID' already exists."
+    fi
+
+    fingerprint=$(fingerprint_server_key)
+
+    adduidCommand=$(cat <<EOF
+adduid
+$userID
+
+
+O
+save
+EOF
+       )
+
+    # add uid
+    echo "$adduidCommand" | gpg_host --quiet --command-fd 0 --edit-key "$fingerprint"
+
+    echo "NOTE: new host userID has not been published."
+    echo "Use '$PGRM publish-key' to publish these changes."
+}
+
+# revoke hostname user ID to server key
+revoke_hostname() {
+    local msg
+    local uidNum
+    local tmpuidMatch
+    local fpr
+    local linenum
+
+    if [ -z "$1" ] ; then
+       failure "You must specify a hostname to revoke."
+    fi
+
+    fpr=$(fingerprint_server_key)
+    tmpuidMatch="u:$(escape "$1")"
+
+    if linenum=$(gpg_host --list-keys --with-colons --fixed-list-mode "$fpr" | egrep '^(uid|uat):' | cut -f2,10 -d: | grep -n -x -F 'r:Foo T. Bar (DO NOT USE!) <foo@example.net>') ; then
+       uidNum=${linenum%%:*}
+    else
+       failure "no non-revoked hostname '$1' is listed."
+    fi
+
+    msg="hostname removed by monkeysphere-server on $(date +%F)"
+    
+
+    revuidCommand=$(cat <<EOF
+$uidNum
+revuid
+y
+4
+$msg
+
+y
+save
+EOF
+)
+
+    echo "$revuidCommand" | gpg_host --quiet --command-fd 0 --edit-key "0x$fingerprint"\!
+
+    echo "NOTE: host userID revokation has not been published."
+    echo "Use '$PGRM publish-key' to publish these changes."
 }
 
 # publish server key to keyserver
 publish_server_key() {
-    read -p "Really publish key to $KEYSERVER? (y/N) " OK; OK=${OK:=N}
+    read -p "Really publish host key to $KEYSERVER? (y/N) " OK; OK=${OK:=N}
     if [ ${OK/y/Y} != 'Y' ] ; then
        failure "aborting."
     fi
 
+    # find the key fingerprint
+    fingerprint=$(fingerprint_server_key)
+
     # 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_authentication "--keyserver $KEYSERVER --send-keys $(hostname -f)"
-    echo "NOT PUBLISHED (to avoid permanent publication errors during monkeysphere development)."
-    echo "The following command should publish the key:"
-    echo "monkeysphere-server gpg-authentication-cmd '--keyserver $KEYSERVER --send-keys $(hostname -f)'"
-    exit 255
+    gpg_authentication "--keyserver $KEYSERVER --send-keys $fingerprint"
 }
 
 diagnostics() {
 #  * check on the status and validity of the key and public certificates
     local seckey
     local keysfound
-    local keyexp
     local curdate
     local warnwindow
     local warndate
+    local create
+    local expire
+    local uid
+    local fingerprint
+    local badhostkeys
 
-    seckey=$(gpg_host --list-secret-keys --with-colons --fixed-list-mode)
+    seckey=$(fingerprint_server_key)
     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'"
+       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
-       if (( "$keysfound" > 1 )); then
-           echo "more than one host key found?"
-       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:
-           keyexp=$(echo "$seckey" | grep ^sec: | cut -f7 -d:)
-           if (( "$keyexp"  < "$curdate" )); then
-               echo "Host key is expired!"
+       if [ "$expire" ]; then
+           if (( "$expire"  < "$curdate" )); then
+               echo "! Host key is expired."
                # FIXME: recommend a way to resolve this other than re-keying?
-           elif (( "$keyexp" < "$warndate" )); then
-               echo "Host key expires in less than $warnwindow"
+           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 (( $(echo "$seckey" | grep ^sec: | cut -f6 -d:) > "$curdate" )); then
-               echo "Host key was created in the future(?!). Is your clock correct?"
-               echo "Recommendation: Check clock ($(date +%F_%T)); use NTP?"
-           fi
+       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"
+       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
-                   fi
+               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
-           done
+           fi
+       done
            
 # FIXME: verify that the host key is properly published to the
-#   keyservers
+#   keyservers (do this with the non-privileged user)
 
 # FIXME: check that there are valid, non-expired certifying signatures
-#   attached to the host key
+#   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:
-           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
+       # 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
+           # propose changes needed for sshd_config (if any)
+           if ! grep -q "^HostKey[[:space:]]\+${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 -i '^HostKey' | grep -q -v "^HostKey[[:space:]]\+${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
@@ -472,6 +566,17 @@ diagnostics() {
 
 # FIXME:  make sure that at least one identity certifier exists
 
+    echo "Checking for MonkeySphere-enabled public-key authentication for users ..."
+    # Ensure that User ID authentication is enabled:
+    if ! grep -q "^AuthorizedKeysFile[[:space:]]\+${VARLIB}/authorized_keys/%u$" /etc/ssh/sshd_config; then
+       echo "! /etc/ssh/sshd_config does not point to monkeysphere authorized keys."
+       echo " - Recommendation: add a line to /etc/ssh/sshd_config: 'AuthorizedKeysFile ${VARLIB}/authorized_keys/%u'"
+    fi
+    if badauthorizedkeys=$(grep -i '^AuthorizedKeysFile' | grep -q -v "^AuthorizedKeysFile[[:space:]]\+${VARLIB}/authorized_keys/%u$") ; then
+       echo "! /etc/sshd_config refers to non-monkeysphere authorized_keys files:"
+       echo "$badauthorizedkeys"
+       echo " - Recommendation: remove the above AuthorizedKeysFile lines from /etc/ssh/sshd_config"
+    fi
 }
 
 # retrieve key from web of trust, import it into the host keyring, and
@@ -654,11 +759,23 @@ case $COMMAND in
        gen_key "$@"
        ;;
 
-    'show-fingerprint'|'f')
+    'add-hostname'|'add-name'|'n+')
+       add_hostname "$@"
+       ;;
+
+    'revoke-hostname'|'revoke-name'|'n-')
+       revoke_hostname "$@"
+       ;;
+
+    'show-key'|'show'|'s')
+       show_server_key
+       ;;
+
+    'show-fingerprint'|'fingerprint'|'f')
        fingerprint_server_key
        ;;
 
-    'publish-key'|'p')
+    'publish-key'|'publish'|'p')
        publish_server_key
        ;;
 
@@ -666,15 +783,15 @@ case $COMMAND in
        diagnostics
        ;;
 
-    'add-identity-certifier'|'add-certifier'|'a')
-       add_certifier "$1"
+    'add-identity-certifier'|'add-id-certifier'|'add-certifier'|'c+')
+       add_certifier "$@"
        ;;
 
-    'remove-identity-certifier'|'remove-certifier'|'r')
-       remove_certifier "$1"
+    'remove-identity-certifier'|'remove-id-certifier'|'remove-certifier'|'c-')
+       remove_certifier "$@"
        ;;
 
-    'list-identity-certifiers'|'list-certifiers'|'list-certifier'|'l')
+    'list-identity-certifiers'|'list-id-certifiers'|'list-certifiers'|'list-certifier'|'c')
        list_certifiers "$@"
        ;;
 
@@ -682,7 +799,7 @@ case $COMMAND in
        gpg_authentication_cmd "$@"
        ;;
 
-    'help'|'h'|'?')
+    '--help'|'help'|'-h'|'h'|'?')
         usage
         ;;