-#!/bin/bash
+#!/usr/bin/env bash
-# monkeysphere: MonkeySphere client tool
+# monkeysphere: Monkeysphere client tool
#
# The monkeysphere scripts are written by:
# Jameson Rollins <jrollins@fifthhorseman.net>
+# Jamie McClelland <jm@mayfirst.org>
+# Daniel Kahn Gillmor <dkg@fifthhorseman.net>
+# Micah Anderson <micah@riseup.net>
#
-# They are Copyright 2008, and are all released under the GPL, version 3
+# They are Copyright 2008-2009, and are all released under the GPL, version 3
# or later.
########################################################################
PGRM=$(basename $0)
-SHARE=${MONKEYSPHERE_SHARE:-"/usr/share/monkeysphere"}
-export SHARE
-. "${SHARE}/common" || exit 1
+SYSSHAREDIR=${MONKEYSPHERE_SYSSHAREDIR:-"/usr/share/monkeysphere"}
+export SYSSHAREDIR
+. "${SYSSHAREDIR}/common" || exit 1
-# date in UTF format if needed
+# sharedir for host functions
+MSHAREDIR="${SYSSHAREDIR}/m"
+
+# UTC date in ISO 8601 format if needed
DATE=$(date -u '+%FT%T')
# unset some environment variables that could screw things up
# default return code
RETURN=0
+# set the file creation mask to be only owner rw
+umask 077
+
########################################################################
# FUNCTIONS
########################################################################
usage() {
-cat <<EOF
+ cat <<EOF >&2
usage: $PGRM <subcommand> [options] [args]
-MonkeySphere client tool.
+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
-
-EOF
-}
-
-# generate a subkey with the 'a' usage flags set
-# FIXME: this needs some tweaking to clean it up
-gen_subkey(){
- local keyID
- local gpgOut
- local userID
-
- keyID="$1"
-
- gpgOut=$(gpg --quiet --fixed-list-mode --list-keys --with-colons \
- "$keyID" 2> /dev/null)
-
- # 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."
- fi
+ update-known_hosts (k) [HOST]... update known_hosts file
+ update-authorized_keys (a) update authorized_keys file
+ import-subkey (i) import existing ssh key as gpg subkey
+ --keyfile (-f) FILE key file to import
+ --expire (-e) EXPIRE date to expire
+ gen-subkey (g) [KEYID] generate an authentication subkey
+ --length (-l) BITS key length in bits (2048)
+ --expire (-e) EXPIRE date to expire
+ ssh-proxycommand monkeysphere ssh ProxyCommand
+ subkey-to-ssh-agent (s) store authentication subkey in ssh-agent
+ version (v) show version number
+ help (h,?) this help
- # 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
- 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
- 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
- failure "aborting."
- fi
- 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
- 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
- while [ -z "$KEY_EXPIRE" ] ; do
- read -p "Key is valid for? (0) " KEY_EXPIRE
- if ! test_gpg_expire ${KEY_EXPIRE:=0} ; then
- echo "invalid value"
- unset KEY_EXPIRE
- fi
- done
- elif ! test_gpg_expire "$KEY_EXPIRE" ; then
- failure "invalid key expiration value '$KEY_EXPIRE'."
- fi
-
- # generate the list of commands that will be passed to edit-key
- editCommands=$(cat <<EOF
-addkey
-7
-S
-E
-A
-Q
-$KEY_LENGTH
-$KEY_EXPIRE
-save
-EOF
-)
-
- log "generating subkey..."
- echo "$editCommands" | gpg --expert --command-fd 0 --edit-key "$keyID"
- log "done."
}
########################################################################
unset AUTHORIZED_KEYS
# load global config
-[ -r "${ETC}/monkeysphere.conf" ] && . "${ETC}/monkeysphere.conf"
+[ -r "${SYSCONFIGDIR}/monkeysphere.conf" ] && . "${SYSCONFIGDIR}/monkeysphere.conf"
# set monkeysphere home directory
-MONKEYSPHERE_HOME=${MONKEYSPHERE_HOME:="${HOME}/.config/monkeysphere"}
+MONKEYSPHERE_HOME=${MONKEYSPHERE_HOME:="${HOME}/.monkeysphere"}
mkdir -p -m 0700 "$MONKEYSPHERE_HOME"
# load local config
# set empty config variables with ones from the environment, or from
# config file, or with defaults
+LOG_LEVEL=${MONKEYSPHERE_LOG_LEVEL:=${LOG_LEVEL:="INFO"}}
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"}}
# permissions
export GNUPGHOME
mkdir -p -m 0700 "$GNUPGHOME"
+export LOG_LEVEL
# get subcommand
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'
+ # touch the known_hosts file so that the file permission check
+ # below won't fail upon not finding the file
+ (umask 0022 && touch "$KNOWN_HOSTS")
+
+ # check permissions on the known_hosts file path
+ check_key_file_permissions "$USER" "$KNOWN_HOSTS" || failure
+
# if hosts are specified on the command line, process just
# those hosts
if [ "$1" ] ; then
# 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 error "known_hosts file '$KNOWN_HOSTS' does not exist."
+ exit
fi
process_known_hosts
'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 is empty or does not exist."
+ # check permissions on the authorized_user_ids file path
+ check_key_file_permissions "$USER" "$AUTHORIZED_USER_IDS" || failure
+
+ # check permissions on the authorized_keys file path
+ check_key_file_permissions "$USER" "$AUTHORIZED_KEYS" || failure
+
+ # exit if the authorized_user_ids file is empty
+ if [ ! -e "$AUTHORIZED_USER_IDS" ] ; then
+ log error "authorized_user_ids file '$AUTHORIZED_USER_IDS' does not exist."
+ exit
fi
# process authorized_user_ids file
RETURN="$?"
;;
+ 'import-subkey'|'i')
+ source "${MSHAREDIR}/import_subkey"
+ import_subkey "$@"
+ ;;
+
'gen-subkey'|'g')
- keyID="$1"
- if [ -z "$keyID" ] ; then
- failure "You must specify the key ID of your primary key."
- fi
- gen_subkey "$keyID"
+ source "${MSHAREDIR}/gen_subkey"
+ gen_subkey "$@"
+ ;;
+
+ 'ssh-proxycommand'|'p')
+ source "${MSHAREDIR}/ssh_proxycommand"
+ ssh_proxycommand "$@"
+ ;;
+
+ 'subkey-to-ssh-agent'|'s')
+ source "${MSHAREDIR}/subkey_to_ssh_agent"
+ subkey_to_ssh_agent "$@"
+ ;;
+
+ 'version'|'v')
+ echo "$VERSION"
;;
- 'help'|'h'|'?')
+ '--help'|'help'|'-h'|'h'|'?')
usage
;;