broke out ssh-askpass-style prompting (to feed to gpg); implemented first pass at...
[monkeysphere.git] / src / monkeysphere
index cfd57357c6e9c4906ea3e14b1c8f9b43808c5af2..c6ecaa4d88ae014752de71856c1dae146a476057 100755 (executable)
@@ -32,47 +32,93 @@ umask 077
 ########################################################################
 
 usage() {
-cat <<EOF
+    cat <<EOF
 usage: $PGRM <subcommand> [options] [args]
 MonkeySphere client tool.
 
 subcommands:
-  update-known_hosts (k) [HOST]...  update known_hosts file
-  update-authorized_keys (a)        update authorized_keys file
-  gen-subkey (g) KEYID              generate an 'a' capable subkey
-    -l|--length BITS                  key length in bits (2048)
-    -e|--expire EXPIRE                date to expire
-  help (h,?)                        this help
+ update-known_hosts (k) [HOST]...    update known_hosts file
+ update-authorized_keys (a)          update authorized_keys file
+ gen-subkey (g) [KEYID]              generate an authentication subkey
+   --length (-l) BITS                  key length in bits (2048)
+   --expire (-e) EXPIRE                date to expire
+ subkey-to-ssh-agent (s)             store authentication subkey in ssh-agent
+ help (h,?)                          this help
 
 EOF
 }
 
 # generate a subkey with the 'a' usage flags set
-# FIXME: this needs some tweaking to clean it up
 gen_subkey(){
+    local keyLength
+    local keyExpire
     local keyID
     local gpgOut
     local userID
 
-    keyID="$1"
+    # set default key parameter values
+    keyLength=
+    keyExpire=
 
-    gpgOut=$(gpg --quiet --fixed-list-mode --list-keys --with-colons \
-       "$keyID" 2> /dev/null)
+    # get options
+    TEMP=$(getopt -o l:e: -l length:,expire: -n "$PGRM" -- "$@")
 
-    # fail if there only "tru" lines are output from gpg, which
-    # indicates the key was not found.
-    if [ -z "$(echo "$gpgOut" | grep -v '^tru:')" ] ; then
-       failure "Key ID '$keyID' not found."
+    if [ $? != 0 ] ; then
+       exit 1
     fi
 
-    # fail if multiple pub lines are returned, which means the id given
-    # is not unique
-    if [ $(echo "$gpgOut" | grep '^pub:' | wc -l) -gt '1' ] ; then
+    # Note the quotes around `$TEMP': they are essential!
+    eval set -- "$TEMP"
+
+    while true ; do
+       case "$1" in
+           -l|--length)
+               keyLength="$2"
+               shift 2
+               ;;
+           -e|--expire)
+               keyExpire="$2"
+               shift 2
+               ;;
+           --)
+               shift
+               ;;
+            *)
+               break
+               ;;
+       esac
+    done
+
+    if [ -z "$1" ] ; then
+       # find all secret keys
+       keyID=$(gpg --with-colons --list-secret-keys | grep ^sec | cut -f5 -d:)
+       # if multiple sec keys exist, fail
+       if (( $(echo "$keyID" | wc -l) > 1 )) ; then
+           echo "Multiple secret keys found:"
+           echo "$keyID"
+           failure "Please specify which primary key to use."
+       fi
+    else
+       keyID="$1"
+    fi
+    if [ -z "$keyID" ] ; then
+       failure "You have no secret key available.  You should create an OpenPGP
+key before joining the monkeysphere. You can do this with:
+   gpg --gen-key"
+    fi
+
+    # get key output, and fail if not found
+    gpgOut=$(gpg --quiet --fixed-list-mode --list-secret-keys --with-colons \
+       "$keyID") || failure
+
+    # fail if multiple sec lines are returned, which means the id
+    # given is not unique
+    if [ $(echo "$gpgOut" | grep '^sec:' | wc -l) -gt '1' ] ; then
        failure "Key ID '$keyID' is not unique."
     fi
 
     # prompt if an authentication subkey already exists
-    if echo "$gpgOut" | egrep "^(pub|sub):" | cut -d: -f 12 | grep -q a ; then
+    if echo "$gpgOut" | egrep "^(sec|ssb):" | cut -d: -f 12 | grep -q a ; then
        echo "An authentication subkey already exists for key '$keyID'."
        read -p "Are you sure you would like to generate another one? (y/N) " OK; OK=${OK:N}
        if [ "${OK/y/Y}" != 'Y' ] ; then
@@ -81,11 +127,8 @@ gen_subkey(){
     fi
 
     # set subkey defaults
-    KEY_TYPE="RSA"
-    KEY_LENGTH=${KEY_LENGTH:-}
-    KEY_USAGE="auth"
     # prompt about key expiration if not specified
-    if [ -z "$KEY_EXPIRE" ] ; then
+    if [ -z "$keyExpire" ] ; then
        cat <<EOF
 Please specify how long the key should be valid.
          0 = key does not expire
@@ -94,15 +137,15 @@ Please specify how long the key should be valid.
       <n>m = key expires in n months
       <n>y = key expires in n years
 EOF
-       while [ -z "$KEY_EXPIRE" ] ; do
-           read -p "Key is valid for? (0) " KEY_EXPIRE
-           if ! test_gpg_expire ${KEY_EXPIRE:=0} ; then
+       while [ -z "$keyExpire" ] ; do
+           read -p "Key is valid for? (0) " keyExpire
+           if ! test_gpg_expire ${keyExpire:=0} ; then
                echo "invalid value"
-               unset KEY_EXPIRE
+               unset keyExpire
            fi
        done
-    elif ! test_gpg_expire "$KEY_EXPIRE" ; then
-       failure "invalid key expiration value '$KEY_EXPIRE'."
+    elif ! test_gpg_expire "$keyExpire" ; then
+       failure "invalid key expiration value '$keyExpire'."
     fi
 
     # generate the list of commands that will be passed to edit-key
@@ -113,17 +156,73 @@ S
 E
 A
 Q
-$KEY_LENGTH
-$KEY_EXPIRE
+$keyLength
+$keyExpire
 save
 EOF
 )
 
     log "generating subkey..."
-    echo "$editCommands" | gpg --expert --command-fd 0 --edit-key "$keyID"
+    fifoDir=$(mktemp -d)
+    (umask 077 && mkfifo "$fifoDir/pass")
+    echo "$editCommands" | gpg --passphrase-fd 3 3< "$fifoDir/pass" --expert --command-fd 0 --edit-key "$keyID" &
+
+    passphrase_prompt  "Please enter your passphrase for $keyID: " "$fifoDir/pass"
+
+    rm -rf "$fifoDir"
+    wait
     log "done."
 }
 
+function subkey_to_ssh_agent() {
+    # try to add all authentication subkeys to the agent:
+
+    local authsubkeys
+    local secretkeys
+    local subkey
+    local workingdir
+    local kname
+
+    # get list of secret keys (to work around https://bugs.g10code.com/gnupg/issue945):
+    secretkeys=$(gpg --list-secret-keys --with-colons --fixed-list-mode --fingerprint | grep '^fpr:' | cut -f10 -d: | awk '{ print "0x" $1 "!" }')
+    
+    authsubkeys=$(gpg --list-secret-keys --with-colons --fixed-list-mode --fingerprint --fingerprint $secretkeys | cut -f1,5,10,12 -d: | grep -A1 '^ssb:[^:]*::[^:]*a[^:]*$' | grep '^fpr::' | cut -f3 -d: | sort -u)
+
+    workingdir=$(mktemp -d)
+    umask 077
+    mkfifo "$workingdir/passphrase"
+
+    # FIXME: we're currently allowing any other options to get passed
+    # through to ssh-add.  should we limit it to known ones?  For
+    # example: -d or -c and/or -t <lifetime> 
+
+    # FIXME: how do we know if we succeeded or failed?  ssh-add gives
+    # weird return values under setsid, and if there are more than one 
+
+    for subkey in $authsubkeys; do 
+       kname="MonkeySphere Key $subkey"
+
+       if [ "$1" = '-d' ]; then
+           # we're removing the subkey:
+           gpg --export "0x${subkey}!" | openpgp2ssh "$subkey" > "$workingdir/$kname"
+           (cd "$workingdir" && ssh-add -d "$kname")
+       else
+           # we're adding the subkey:
+           mkfifo "$workingdir/$kname"
+           gpg --quiet --passphrase-fd 3 3<"$workingdir/passphrase" \
+               --export-options export-reset-subkey-passwd,export-minimal,no-export-attributes \
+               --export-secret-subkeys "0x${subkey}!" | openpgp2ssh "$subkey" > "$workingdir/$kname" &
+           (cd "$workingdir" && unset -v DISPLAY && unset -v SSH_ASKPASS && /usr/bin/setsid ssh-add "$@" "$kname" </dev/null )&
+
+           passphrase_prompt "Enter passphrase for MonkeySphere Key $subkey: " "$workingdir/passphrase"
+           wait
+       fi
+       rm -f "$workingdir/$kname"
+    done
+
+    rm -rf "$workingdir"
+}
+
 ########################################################################
 # MAIN
 ########################################################################
@@ -148,7 +247,16 @@ mkdir -p -m 0700 "$MONKEYSPHERE_HOME"
 # set empty config variables with ones from the environment, or from
 # config file, or with defaults
 GNUPGHOME=${MONKEYSPHERE_GNUPGHOME:=${GNUPGHOME:="${HOME}/.gnupg"}}
-KEYSERVER=${MONKEYSPHERE_KEYSERVER:=${KEYSERVER:="subkeys.pgp.net"}}
+KEYSERVER=${MONKEYSPHERE_KEYSERVER:="$KEYSERVER"}
+# if keyserver not specified in env or monkeysphere.conf,
+# look in gpg.conf
+if [ -z "$KEYSERVER" ] ; then
+    if [ -f "${GNUPGHOME}/gpg.conf" ] ; then
+       KEYSERVER=$(grep -e "^[[:space:]]*keyserver " "${GNUPGHOME}/gpg.conf" | tail -1 | awk '{ print $2 }')
+    fi
+fi
+# if it's still not specified, use the default
+KEYSERVER=${KEYSERVER:="subkeys.pgp.net"}
 CHECK_KEYSERVER=${MONKEYSPHERE_CHECK_KEYSERVER:=${CHECK_KEYSERVER:="true"}}
 KNOWN_HOSTS=${MONKEYSPHERE_KNOWN_HOSTS:=${KNOWN_HOSTS:="${HOME}/.ssh/known_hosts"}}
 HASH_KNOWN_HOSTS=${MONKEYSPHERE_HASH_KNOWN_HOSTS:=${HASH_KNOWN_HOSTS:="true"}}
@@ -169,46 +277,13 @@ COMMAND="$1"
 [ "$COMMAND" ] || failure "Type '$PGRM help' for usage."
 shift
 
-# unset option variables
-unset KEY_LENGTH
-unset KEY_EXPIRE
-
-# get options for key generation and add-certifier functions
-TEMP=$(getopt -o l:e: -l length:,expire: -n "$PGRM" -- "$@")
-
-if [ $? != 0 ] ; then
-    usage
-    exit 1
-fi
-
-# Note the quotes around `$TEMP': they are essential!
-eval set -- "$TEMP"
-
-while true ; do
-    case "$1" in
-       -l|--length)
-           KEY_LENGTH="$2"
-           shift 2
-           ;;
-       -e|--expire)
-           KEY_EXPIRE="$2"
-           shift 2
-           ;;
-       --)
-           shift
-           ;;
-        *)
-            break
-            ;;
-    esac
-done
-
 case $COMMAND in
     'update-known_hosts'|'update-known-hosts'|'k')
        MODE='known_hosts'
 
+       # check permissions on the known_hosts file path
        if ! check_key_file_permissions "$USER" "$KNOWN_HOSTS" ; then
-           failure "Improper permissions on known_hosts file."
+           failure "Improper permissions on known_hosts file path."
        fi
 
         # if hosts are specified on the command line, process just
@@ -220,8 +295,10 @@ case $COMMAND in
         # otherwise, if no hosts are specified, process every host
         # in the user's known_hosts file
        else
-           if [ ! -s "$KNOWN_HOSTS" ] ; then
-               failure "known_hosts file '$KNOWN_HOSTS' is empty or does not exist."
+           # exit if the known_hosts file does not exist
+           if [ ! -e "$KNOWN_HOSTS" ] ; then
+               log "known_hosts file '$KNOWN_HOSTS' does not exist."
+               exit
            fi
 
            process_known_hosts
@@ -232,13 +309,20 @@ case $COMMAND in
     'update-authorized_keys'|'update-authorized-keys'|'a')
        MODE='authorized_keys'
 
-        # fail if the authorized_user_ids file is empty
-       if [ ! -s "$AUTHORIZED_USER_IDS" ] ; then
-           failure "authorized_user_ids file '$AUTHORIZED_USER_IDS' is empty or does not exist."
+       # check permissions on the authorized_user_ids file path
+       if ! check_key_file_permissions "$USER" "$AUTHORIZED_USER_IDS" ; then
+           failure "Improper permissions on authorized_user_ids file path."
        fi
 
-       if ! check_key_file_permissions "$USER" "$AUTHORIZED_USER_IDS" ; then
-           failure "Improper permissions on authorized_user_ids file."
+       # check permissions on the authorized_keys file path
+       if ! check_key_file_permissions "$USER" "$AUTHORIZED_KEYS" ; then
+           failure "Improper permissions on authorized_keys file path."
+       fi
+
+        # exit if the authorized_user_ids file is empty
+       if [ ! -e "$AUTHORIZED_USER_IDS" ] ; then
+           log "authorized_user_ids file '$AUTHORIZED_USER_IDS' does not exist."
+           exit
        fi
 
        # process authorized_user_ids file
@@ -247,14 +331,14 @@ case $COMMAND in
        ;;
 
     'gen-subkey'|'g')
-       keyID="$1"
-       if [ -z "$keyID" ] ; then
-           failure "You must specify the key ID of your primary key."
-       fi
-       gen_subkey "$keyID"
+       gen_subkey "$@"
+       ;;
+
+    'subkey-to-ssh-agent'|'s')
+       subkey_to_ssh_agent "$@"
        ;;
 
-    'help'|'h'|'?')
+    '--help'|'help'|'-h'|'h'|'?')
         usage
         ;;