# monkeysphere-host: Monkeysphere host admin tool
#
# The monkeysphere scripts are written by:
-# Jameson Rollins <jrollins@fifthhorseman.net>
+# Jameson Rollins <jrollins@finestructure.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
-# or later.
+# They are Copyright 2008-2009, and are all released under the GPL,
+# version 3 or later.
########################################################################
+set -e
+
+# set the pipefail option so pipelines fail on first command failure
+set -o pipefail
+
PGRM=$(basename $0)
SYSSHAREDIR=${MONKEYSPHERE_SYSSHAREDIR:-"/usr/share/monkeysphere"}
export SYSSHAREDIR
. "${SYSSHAREDIR}/common" || exit 1
-SYSDATADIR=${MONKEYSPHERE_SYSDATADIR:-"/var/lib/monkeysphere/host"}
+SYSDATADIR=${MONKEYSPHERE_SYSDATADIR:-"/var/lib/monkeysphere"}
export SYSDATADIR
-# monkeysphere temp directory, in sysdatadir to enable atomic moves of
-# authorized_keys files
-MSTMPDIR="${SYSDATADIR}/tmp"
-export MSTMPDIR
+# sharedir for host functions
+MHSHAREDIR="${SYSSHAREDIR}/mh"
+
+# datadir for host functions
+MHDATADIR="${SYSDATADIR}/host"
+
+# host pub key files
+HOST_KEY_PUB="${SYSDATADIR}/ssh_host_rsa_key.pub"
+HOST_KEY_PUB_GPG="${SYSDATADIR}/ssh_host_rsa_key.pub.gpg"
# UTC date in ISO 8601 format if needed
DATE=$(date -u '+%FT%T')
subcommands:
show-key (s) output all host key information
- extend-key (e) EXPIRE extend host key expiration
+ set-expire (e) EXPIRE set host key expiration
add-hostname (n+) NAME[:PORT] add hostname user ID to host key
revoke-hostname (n-) NAME[:PORT] revoke hostname user ID
add-revoker (o) FINGERPRINT add a revoker to the host key
revoke-key (r) revoke host key
- publish-key (p) publish server host key to keyserver
-
- expert
- import-key (i) import existing ssh key to gpg
- --hostname (-h) NAME[:PORT] hostname for key user ID
- --keyfile (-f) FILE key file to import
- --expire (-e) EXPIRE date to expire
- gen-key (g) generate gpg key for the host
- --hostname (-h) NAME[:PORT] hostname for key user ID
- --length (-l) BITS key length in bits (2048)
- --expire (-e) EXPIRE date to expire
- --revoker (-r) FINGERPRINT add a revoker
- diagnostics (d) monkeysphere host status
+ publish-key (p) publish host key to keyserver
+
+ expert <expert-subcommand> run expert command
+ expert help expert command help
version (v) show version number
help (h,?) this help
EOF
}
-# function to run command as monkeysphere user
-su_monkeysphere_user() {
- # if the current user is the monkeysphere user, then just eval
- # command
- if [ $(id -un) = "$MONKEYSPHERE_USER" ] ; then
- eval "$@"
+# function to interact with the gpg keyring
+gpg_host() {
+ GNUPGHOME="$GNUPGHOME_HOST" gpg "$@"
+}
+
+# command to list the info about the host key, in colon format
+gpg_host_list() {
+ gpg_host --list-keys --with-colons --fixed-list-mode \
+ --with-fingerprint --with-fingerprint \
+ "0x${HOST_FINGERPRINT}!"
+
+}
+
+# command for edit key scripts, takes scripts on stdin
+gpg_host_edit() {
+ gpg_host --quiet --command-fd 0 --edit-key \
+ "0x${HOST_FINGERPRINT}!" "$@"
+}
+
+# export the host key to stdout
+gpg_host_export() {
+ gpg_host --export --armor --export-options export-minimal \
+ "0x${HOST_FINGERPRINT}!"
+}
+
+# export the host secret key to the monkeysphere ssh sec key file
+# NOTE: assumes that the primary key is the proper key to use
+create_ssh_sec_file() {
+ log debug "creating ssh secret key file..."
+ (umask 077 && \
+ gpg_host --export-secret-key "$HOST_FINGERPRINT" | \
+ openpgp2ssh "$HOST_FINGERPRINT" > "${MHDATADIR}/ssh_host_rsa_key")
+ log info "SSH host secret key file: ${MHDATADIR}/ssh_host_rsa_key"
+}
+
+# export the host public key to the monkeysphere ssh pub key file
+create_ssh_pub_file() {
+ log debug "creating ssh public key file..."
+ ssh-keygen -y -f "${MHDATADIR}/ssh_host_rsa_key" > "$HOST_KEY_PUB"
+ log info "SSH host public key file: $HOST_KEY_PUB"
+}
- # otherwise su command as monkeysphere user
+# export the host public key to the monkeysphere gpg pub key file
+create_gpg_pub_file() {
+ log debug "creating openpgp public key file..."
+ gpg_host_export > "$HOST_KEY_PUB_GPG"
+ log info "GPG host public key file: $HOST_KEY_PUB_GPG"
+}
+
+# load the host fingerprint into the fingerprint variable, using the
+# export gpg pub key file
+load_fingerprint() {
+ if [ -f "$HOST_KEY_PUB_GPG" ] ; then
+ HOST_FINGERPRINT=$( \
+ (FUBAR=$(mktemp -d) && export GNUPGHOME="$FUBAR" \
+ && gpg --quiet --import \
+ && gpg --quiet --list-keys --with-colons --with-fingerprint \
+ && rm -rf "$FUBAR") <"$HOST_KEY_PUB_GPG" \
+ | grep '^fpr:' | cut -d: -f10 )
else
- su "$MONKEYSPHERE_USER" -c "$@"
+ HOST_FINGERPRINT=
fi
}
-# function to interact with the host gnupg keyring
-gpg_host() {
- local returnCode
-
- GNUPGHOME="$GNUPGHOME_HOST"
- export GNUPGHOME
-
- # NOTE: we supress this warning because we need the monkeysphere
- # user to be able to read the host pubring. we realize this might
- # be problematic, but it's the simplest solution, without too much
- # loss of security.
- gpg --no-permission-warning "$@"
- returnCode="$?"
-
- # always reset the permissions on the host pubring so that the
- # monkeysphere user can read the trust signatures
- chgrp "$MONKEYSPHERE_USER" "${GNUPGHOME_HOST}/pubring.gpg"
- chmod g+r "${GNUPGHOME_HOST}/pubring.gpg"
-
- return "$returnCode"
+# load the host fingerprint into the fingerprint variable, using the
+# gpg host secret key
+load_fingerprint_secret() {
+ HOST_FINGERPRINT=$( \
+ gpg_host --quiet --list-secret-key \
+ --with-colons --with-fingerprint \
+ | grep '^fpr:' | cut -d: -f10 )
}
-# check if user is root
-is_root() {
- [ $(id -u 2>/dev/null) = '0' ]
+# output host key ssh fingerprint
+load_ssh_fingerprint() {
+ [ -f "$HOST_KEY_PUB" ] || return 0
+ HOST_FINGERPRINT_SSH=$(ssh-keygen -l -f "$HOST_KEY_PUB" \
+ | awk '{ print $1, $2, $4 }')
}
-# check that user is root, for functions that require root access
-check_user() {
- is_root || failure "You must be root to run this command."
+# fail if host key present
+check_host_key() {
+ [ -z "$HOST_FINGERPRINT" ] \
+ || failure "An OpenPGP host key already exists."
}
-# output just key fingerprint
-fingerprint_server_key() {
- # set the pipefail option so functions fails if can't read sec key
- set -o pipefail
-
- gpg_host --list-secret-keys --fingerprint \
- --with-colons --fixed-list-mode 2> /dev/null | \
- grep '^fpr:' | head -1 | cut -d: -f10 2>/dev/null
+# fail if host key not present
+check_host_no_key() {
+ [ "$HOST_FINGERPRINT" ] \
+ || failure "You don't appear to have a Monkeysphere host key on this server. Please run 'monkeysphere-host expert import-key' first."
}
-# function to check for host secret key
-check_host_keyring() {
- fingerprint_server_key >/dev/null \
- || failure "You don't appear to have a Monkeysphere host key on this server. Please run 'monkeysphere-server gen-key' first."
+# output the index of a user ID on the host key
+# return 1 if user ID not found
+find_host_userid() {
+ local userID="$1"
+ local tmpuidMatch
+ local line
+
+ # match to only ultimately trusted user IDs
+ tmpuidMatch="u:$(echo $userID | gpg_escape)"
+
+ # find the index of the requsted user ID
+ # NOTE: this is based on circumstantial evidence that the order of
+ # this output is the appropriate index
+ line=$(gpg_host_list | egrep '^(uid|uat):' | cut -f2,10 -d: | \
+ grep -n -x -F "$tmpuidMatch" 2>/dev/null)
+
+ if [ "$line" ] ; then
+ echo ${line%%:*}
+ return 0
+ else
+ return 1
+ fi
}
# show info about the host key
show_key() {
- local fingerprintPGP
- local fingerprintSSH
- local ret=0
-
- # FIXME: you shouldn't have to be root to see the host key fingerprint
- if is_root ; then
- check_host_keyring
- fingerprintPGP=$(fingerprint_server_key)
- gpg_authentication "--fingerprint --list-key --list-options show-unusable-uids $fingerprintPGP" 2>/dev/null
- echo "OpenPGP fingerprint: $fingerprintPGP"
- else
- log info "You must be root to see host OpenPGP fingerprint."
- ret='1'
- fi
+ gpg_host --fingerprint --list-key --list-options show-unusable-uids \
+ "0x${HOST_FINGERPRINT}!" 2>/dev/null
+ # FIXME: make sure expiration date is shown
+
+ echo "OpenPGP fingerprint: $HOST_FINGERPRINT"
- if [ -f "${SYSDATADIR}/ssh_host_rsa_key.pub" ] ; then
- fingerprintSSH=$(ssh-keygen -l -f "${SYSDATADIR}/ssh_host_rsa_key.pub" | \
- awk '{ print $1, $2, $4 }')
- echo "ssh fingerprint: $fingerprintSSH"
+ load_ssh_fingerprint
+
+ if [ "$HOST_FINGERPRINT_SSH" ] ; then
+ echo "ssh fingerprint: $HOST_FINGERPRINT_SSH"
else
- log info "SSH host key not found."
- ret='1'
+ log error "SSH host key not found."
fi
-return $ret
+ # FIXME: other relevant key parameters?
}
########################################################################
# unset variables that should be defined only in config file
unset KEYSERVER
-unset AUTHORIZED_USER_IDS
-unset RAW_AUTHORIZED_KEYS
unset MONKEYSPHERE_USER
# load configuration file
-[ -e ${MONKEYSPHERE_SERVER_CONFIG:="${SYSCONFIGDIR}/monkeysphere-server.conf"} ] && . "$MONKEYSPHERE_SERVER_CONFIG"
+[ -e ${MONKEYSPHERE_HOST_CONFIG:="${SYSCONFIGDIR}/monkeysphere-host.conf"} ] && . "$MONKEYSPHERE_HOST_CONFIG"
# set empty config variable with ones from the environment, or with
# defaults
# other variables
CHECK_KEYSERVER=${MONKEYSPHERE_CHECK_KEYSERVER:="true"}
-REQUIRED_USER_KEY_CAPABILITY=${MONKEYSPHERE_REQUIRED_USER_KEY_CAPABILITY:="a"}
-GNUPGHOME_HOST=${MONKEYSPHERE_GNUPGHOME_HOST:="${SYSDATADIR}/gnupg-host"}
-GNUPGHOME_AUTHENTICATION=${MONKEYSPHERE_GNUPGHOME_AUTHENTICATION:="${SYSDATADIR}/gnupg-authentication"}
+GNUPGHOME_HOST=${MONKEYSPHERE_GNUPGHOME_HOST:="${MHDATADIR}"}
# export variables needed in su invocation
export DATE
export MODE
-export MONKEYSPHERE_USER
export LOG_LEVEL
+export MONKEYSPHERE_USER
export KEYSERVER
-export CHECK_KEYSERVER
-export REQUIRED_USER_KEY_CAPABILITY
export GNUPGHOME_HOST
-export GNUPGHOME_AUTHENTICATION
export GNUPGHOME
+export HOST_FINGERPRINT=
+export HOST_FINGERPRINT_SSH=
# get subcommand
COMMAND="$1"
case $COMMAND in
'show-key'|'show'|'s')
- show_server_key
+ load_fingerprint
+ check_host_no_key
+ show_key
;;
- 'extend-key'|'e')
- check_user
- check_host_keyring
- extend_key "$@"
+ 'set-expire'|'extend-key'|'e')
+ load_fingerprint
+ check_host_no_key
+ source "${MHSHAREDIR}/set_expire"
+ set_expire "$@"
;;
'add-hostname'|'add-name'|'n+')
- check_user
- check_host_keyring
+ load_fingerprint
+ check_host_no_key
+ source "${MHSHAREDIR}/add_hostname"
add_hostname "$@"
;;
'revoke-hostname'|'revoke-name'|'n-')
- check_user
- check_host_keyring
+ load_fingerprint
+ check_host_no_key
+ source "${MHSHAREDIR}/revoke_hostname"
revoke_hostname "$@"
;;
'add-revoker'|'o')
- check_user
- check_host_keyring
+ load_fingerprint
+ check_host_no_key
+ source "${MHSHAREDIR}/add_revoker"
add_revoker "$@"
;;
'revoke-key'|'r')
- check_user
- check_host_keyring
+ load_fingerprint
+ check_host_no_key
+ source "${MHSHAREDIR}/revoke_key"
revoke_key "$@"
;;
'publish-key'|'publish'|'p')
- check_user
- check_host_keyring
- publish_server_key
+ load_fingerprint
+ check_host_no_key
+ source "${MHSHAREDIR}/publish_key"
+ publish_key
;;
- 'expert'|'e')
- check_user
+ 'expert')
SUBCOMMAND="$1"
shift
case "$SUBCOMMAND" in
+ 'help'|'h'|'?')
+ cat <<EOF
+usage: $PGRM expert <subcommand> [options] [args]
+
+expert subcommands:
+ import-key (i) [NAME[:PORT]] import existing ssh key to gpg
+ gen-key (g) [NAME[:PORT]] generate gpg key for the host
+ --length (-l) BITS key length in bits (2048)
+ diagnostics (d) monkeysphere host status
+
+EOF
+ ;;
+
'import-key'|'i')
+ load_fingerprint
+ check_host_key
+ source "${MHSHAREDIR}/import_key"
import_key "$@"
;;
'gen-key'|'g')
+ load_fingerprint
+ check_host_key
+ source "${MHSHAREDIR}/gen_key"
gen_key "$@"
;;
'diagnostics'|'d')
+ source "${MHSHAREDIR}/diagnostics"
diagnostics
;;
projects / monkeysphere.git / blobdiff