Merge commit 'dkg/master'
[monkeysphere.git] / src / monkeysphere-server
index fd7b58330ae6fc58a5696958ccbb122713e99bdd..e099a74a86fdbf7e1f59ea63230dfc30b0bc961e 100755 (executable)
@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 # monkeysphere-server: MonkeySphere server admin tool
 #
@@ -21,6 +21,9 @@ DATE=$(date -u '+%FT%T')
 # unset some environment variables that could screw things up
 GREP_OPTIONS=
 
+# assuming other problems don't crop up, we'll return 0 as success
+ERR=0
+
 ########################################################################
 # FUNCTIONS
 ########################################################################
@@ -28,69 +31,111 @@ GREP_OPTIONS=
 usage() {
 cat <<EOF
 usage: $PGRM <subcommand> [args]
-Monkeysphere server admin tool.
+MonkeySphere server admin tool.
 
 subcommands:
-  update-users (s) [USER]...                 update user authorized_keys file
-  gen-key (g)                                generate gpg key for the server
-  publish-key (p)                            publish server gpg to keyserver
-  trust-key (t) KEYID [KEYID]...             mark keyid as trusted
-  update-user-userids (u) USER UID [UID]...  add/update userid for user
-  help (h,?)                                 this help
+  update-users (u) [USER]...            update users authorized_keys files
+  gen-key (g) [HOSTNAME]                generate gpg key for the server
+  show-fingerprint (f)                  show server's host key fingerprint
+  publish-key (p)                       publish server's host key to keyserver
+  trust-key (t) KEYID [LEVEL]           set owner trust for keyid
+  help (h,?)                            this help
 
 EOF
 }
 
 # generate server gpg key
 gen_key() {
-    KEY_TYPE=${KEY_TYPE:-RSA}
-    KEY_LENGTH=${KEY_LENGTH:-2048}
-    KEY_USAGE=${KEY_USAGE:-encrypt,auth}
-    SERVICE=${SERVICE:-ssh}
-    HOSTNAME_FQDN=${HOSTNAME_FQDN:-$(hostname -f)}
+    local hostName
+
+    hostName=${1:-$(hostname --fqdn)}
+    service=${SERVICE:-"ssh"}
+    userID="${service}://${hostName}"
 
-    USERID=${USERID:-"$SERVICE"://"$HOSTNAME_FQDN"}
+    if gpg --list-key ="$userID" > /dev/null 2>&1 ; then
+       failure "Key for '$userID' already exists"
+    fi
 
-    echo "key parameters:"
+    # set key defaults
+    KEY_TYPE=${KEY_TYPE:-"RSA"}
+    KEY_LENGTH=${KEY_LENGTH:-"2048"}
+    KEY_USAGE=${KEY_USAGE:-"auth"}
+    KEY_EXPIRE=${KEY_EXPIRE:-"0"}
     cat <<EOF
+Please specify how long the key should be valid.
+         0 = key does not expire
+      <n>  = key expires in n days
+      <n>w = key expires in n weeks
+      <n>m = key expires in n months
+      <n>y = key expires in n years
+EOF
+    read -p "Key is valid for? ($KEY_EXPIRE) " KEY_EXPIRE; KEY_EXPIRE=${KEY_EXPIRE:-"0"}
+
+    # set key parameters
+    keyParameters=$(cat <<EOF
 Key-Type: $KEY_TYPE
 Key-Length: $KEY_LENGTH
 Key-Usage: $KEY_USAGE
-Name-Real: $USERID
+Name-Real: $userID
+Expire-Date: $KEY_EXPIRE
 EOF
+)
+
+    # add the revoker field if requested
+    # FIXME: the "1:" below assumes that $REVOKER's key is an RSA key.  why?
+    # FIXME: why is this marked "sensitive"?  how will this signature ever
+    # be transmitted to the expected revoker?
+    if [ "$REVOKER" ] ; then
+       keyParameters="${keyParameters}"$(cat <<EOF
 
-    read -p "generate key? [Y|n]: " OK; OK=${OK:=Y}
+Revoker: 1:$REVOKER sensitive
+EOF
+)
+    fi
+
+    echo "The following key parameters will be used:"
+    echo "$keyParameters"
+
+    read -p "Generate key? [Y|n]: " OK; OK=${OK:=Y}
     if [ ${OK/y/Y} != 'Y' ] ; then
        failure "aborting."
     fi
 
-    if gpg --list-key ="$USERID" > /dev/null 2>&1 ; then
-       failure "key for '$USERID' already exists"
-    fi
+    # add commit command
+    keyParameters="${keyParameters}"$(cat <<EOF
 
-    echo "generating server key..."
-    gpg --batch --gen-key <<EOF
-Key-Type: $KEY_TYPE
-Key-Length: $KEY_LENGTH
-Key-Usage: $KEY_USAGE
-Name-Real: $USERID
 %commit
+%echo done
 EOF
+)
+
+    log "generating server key... "
+    echo "$keyParameters" | gpg --batch --gen-key
+
+    # output the server fingerprint
+    fingerprint_server_key "=${userID}"
+
+    # find the key fingerprint of the server primary key
+    keyID=$(gpg --list-key --with-colons --with-fingerprint "=${userID}" | \
+       grep '^fpr:' | head -1 | cut -d: -f10)
+
+    # write the key to the file
+    # NOTE: assumes that the primary key is the proper key to use
+    (umask 077 && gpgsecret2ssh "$keyID" > "${MS_HOME}/ssh_host_rsa_key")
+    log "Private SSH host key output to file: ${MS_HOME}/ssh_host_rsa_key"
 }
 
-# publish server key to keyserver
-publish_key() {
-    read -p "publish key to $KEYSERVER? [Y|n]: " OK; OK=${OK:=Y}
-    if [ ${OK/y/Y} != 'Y' ] ; then
-       failure "aborting."
-    fi
+# gpg output key fingerprint
+fingerprint_server_key() {
+    local ID
 
-    keyID=$(gpg --list-key --with-colons ="$USERID" 2> /dev/null | grep '^pub:' | cut -d: -f5)
+    if [ -z "$1" ] ; then
+       ID="$1"
+    else
+       ID="=ssh://$(hostname --fqdn)"
+    fi
 
-    # dummy command so as not to publish fakes keys during testing
-    # eventually:
-    #gpg --send-keys --keyserver "$KEYSERVER" "$keyID"
-    echo "gpg --send-keys --keyserver $KEYSERVER $keyID"
+    gpg --fingerprint --list-secret-keys "$ID"
 }
 
 ########################################################################
@@ -109,96 +154,111 @@ MS_CONF=${MS_CONF:-"$MS_HOME"/monkeysphere-server.conf}
 [ -e "$MS_CONF" ] && . "$MS_CONF"
 
 # set empty config variable with defaults
-GNUPGHOME=${GNUPGHOME:-"$MS_HOME"/gnupg}
-KEYSERVER=${KEYSERVER:-subkeys.pgp.net}
-REQUIRED_KEY_CAPABILITY=${REQUIRED_KEY_CAPABILITY:-"e a"}
-USER_CONTROLLED_AUTHORIZED_KEYS=${USER_CONTROLLED_AUTHORIZED_KEYS:-%h/.ssh/authorized_keys}
-STAGING_AREA=${STAGING_AREA:-"$LIB"/stage}
+GNUPGHOME=${GNUPGHOME:-"${MS_HOME}/gnupg"}
+KEYSERVER=${KEYSERVER:-"subkeys.pgp.net"}
+CHECK_KEYSERVER=${CHECK_KEYSERVER:="true"}
+REQUIRED_USER_KEY_CAPABILITY=${REQUIRED_USER_KEY_CAPABILITY:-"a"}
+AUTHORIZED_USER_IDS=${AUTHORIZED_USER_IDS:-"%h/.config/monkeysphere/authorized_user_ids"}
+USER_CONTROLLED_AUTHORIZED_KEYS=${USER_CONTROLLED_AUTHORIZED_KEYS:-"%h/.ssh/authorized_keys"}
 
 export GNUPGHOME
 
+# make sure the monkeysphere home directory exists
+mkdir -p "${MS_HOME}/authorized_user_ids"
 # make sure gpg home exists with proper permissions
 mkdir -p -m 0700 "$GNUPGHOME"
+# make sure the authorized_keys directory exists
+mkdir -p "${CACHE}/authorized_keys"
 
 case $COMMAND in
-    'update-users'|'s')
+    'update-users'|'update-user'|'u')
        if [ "$1" ] ; then
+           # get users from command line
            unames="$@"
        else
-           unames=$(ls -1 "$MS_HOME"/authorized_user_ids)
+           # or just look at all users if none specified
+           unames=$(getent passwd | cut -d: -f1)
        fi
 
+       # loop over users
        for uname in $unames ; do
            MODE="authorized_keys"
-           authorizedUserIDs="$MS_HOME"/authorized_user_ids/"$uname"
-           cacheDir="$STAGING_AREA"/"$uname"/user_keys
-           msAuthorizedKeys="$STAGING_AREA"/"$uname"/authorized_keys
 
-            # make sure authorized_user_ids file exists
-           if [ ! -s "$authorizedUserIDs" ] ; then
-               log "authorized_user_ids file for '$uname' is empty or does not exist."
+           # check all specified users exist
+           if ! getent passwd "$uname" >/dev/null ; then
+               error "----- unknown user '$uname' -----"
+               continue
+           fi
+
+           # set authorized_user_ids variable,
+           # translate ssh-style path variables
+           authorizedUserIDs=$(translate_ssh_variables "$uname" "$AUTHORIZED_USER_IDS")
+
+           # skip user if authorized_user_ids file does not exist
+           if [ ! -f "$authorizedUserIDs" ] ; then
+               #FIXME: what about a user with no authorized_user_ids
+               # file, but with an authorized_keys file when
+               # USER_CONTROLLED_AUTHORIZED_KEYS is set?
                continue
            fi
 
-           log "processing authorized_keys for user '$uname'..."
+           log "----- user: $uname -----"
 
-           process_authorized_ids "$authorizedUserIDs" "$cacheDir"
+           # temporary authorized_keys file
+           AUTHORIZED_KEYS=$(mktemp)
 
-            # write output key file
-           log "writing monkeysphere authorized_keys file... "
-           touch "$msAuthorizedKeys"
-           if [ "$(ls "$cacheDir")" ] ; then
-               log -n "adding gpg keys... "
-               cat "$cacheDir"/* > "$msAuthorizedKeys"
-               echo "done."
-           else
-               log "no gpg keys to add."
+           # skip if the user's authorized_user_ids file is empty
+           if [ ! -s "$authorizedUserIDs" ] ; then
+               log "authorized_user_ids file '$authorizedUserIDs' is empty."
+               #FIXME: what about a user with an empty
+               # authorized_user_ids file, but with an
+               # authorized_keys file when
+               # USER_CONTROLLED_AUTHORIZED_KEYS is set?
+               continue
            fi
-           if [ "$USER_CONTROLLED_AUTHORIZED_KEYS" ] ; then
-               userHome=$(getent passwd "$uname" | cut -d: -f6)
-               userAuthorizedKeys=${USER_CONTROLLED_AUTHORIZED_KEYS/\%h/"$userHome"}
-               if [ -s "$userAuthorizedKeys" ] ; then
-                   log -n "adding user authorized_keys file... "
-                   cat "$userAuthorizedKeys" >> "$msAuthorizedKeys"
-                   echo "done."
+
+           # process authorized_user_ids file
+           log "processing authorized_user_ids file..."
+           process_authorized_user_ids "$authorizedUserIDs"
+
+           # add user-controlled authorized_keys file path if specified
+           if [ "$USER_CONTROLLED_AUTHORIZED_KEYS" != '-' ] ; then
+               userAuthorizedKeys=$(translate_ssh_variables "$uname" "$USER_CONTROLLED_AUTHORIZED_KEYS")
+               if [ -f "$userAuthorizedKeys" ] ; then
+                   log -n "adding user's authorized_keys file... "
+                   cat "$userAuthorizedKeys" >> "$AUTHORIZED_KEYS"
+                   loge "done."
                fi
            fi
-           log "monkeysphere authorized_keys file generated:"
-           log "$msAuthorizedKeys"
+
+            # openssh appears to check the contents of the
+            # authorized_keys file as the user in question, so the file
+            # must be readable by that user at least.
+            # FIXME: is there a better way to do this?
+            chgrp $(getent passwd "$uname" | cut -f4 -d:) "$AUTHORIZED_KEYS"
+            chmod g+r "$AUTHORIZED_KEYS"
+
+           # move the temp authorized_keys file into place
+           mv -f "$AUTHORIZED_KEYS" "${CACHE}/authorized_keys/${uname}"
+
+           log "authorized_keys file updated."
        done
        ;;
 
     'gen-key'|'g')
-       gen_key
+       gen_key "$1"
        ;;
 
-    'publish-key'|'p')
-       publish_key
+    'show-fingerprint'|'f')
+       fingerprint_server_key "$@"
        ;;
 
-    'trust-key'|'t')
-       if [ -z "$1" ] ; then
-           failure "you must specify at least one key to trust."
-       fi
-       for keyID ; do
-           trust_key "$keyID"
-       done
+    'publish-key'|'p')
+       publish_server_key
        ;;
 
-    'update-user-userids'|'u')
-       uname="$1"
-       shift
-       if [ -z "$uname" ] ; then
-           failure "you must specify user."
-       fi
-       if [ -z "$1" ] ; then
-           failure "you must specify at least one userid."
-       fi
-       AUTHORIZED_USER_IDS="$MS_HOME"/authorized_user_ids/"$uname"
-       userKeysCacheDir="$STAGING_AREA"/"$uname"/user_keys
-       for userID ; do
-           update_userid "$userID" "$userKeysCacheDir"
-       done
+    'trust-key'|'trust-key'|'t')
+       trust_key "$@"
        ;;
 
     'help'|'h'|'?')
@@ -207,6 +267,8 @@ case $COMMAND in
 
     *)
         failure "Unknown command: '$COMMAND'
-Type 'cereal-admin help' for usage."
+Type '$PGRM help' for usage."
         ;;
 esac
+
+exit "$ERR"