# Daniel Kahn Gillmor <dkg@fifthhorseman.net>
# Micah Anderson <micah@riseup.net>
#
-# They are Copyright 2008-2009, and are all released under the GPL,
+# They are Copyright 2008-2010, and are all released under the GPL,
# version 3 or later.
########################################################################
MHDATADIR="${SYSDATADIR}/host"
# host pub key files
-HOST_KEY_FILE="${SYSDATADIR}/ssh_host_rsa_key.pub.gpg"
+HOST_KEY_FILE="${SYSDATADIR}/host_keys.pub.pgp"
# UTC date in ISO 8601 format if needed
DATE=$(date -u '+%FT%T')
Monkeysphere host admin tool.
subcommands:
- import-key (i) FILE NAME[:PORT] import existing ssh key to gpg
- show-key (s) output all host key information
- publish-key (p) publish host key to keyserver
- 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 (r+) KEYID|FILE add a revoker to the host key
- revoke-key generate and/or publish revocation
- certificate for host key
-
- version (v) show version number
- help (h,?) this help
+ import-key (i) FILE SERVICENAME import PEM-encoded key from file
+ show-keys (s) [KEYID ...] output host key information
+ publish-keys (p) [KEYID ...] publish key(s) to keyserver
+ set-expire (e) EXPIRE [KEYID] set key expiration
+ add-servicename (n+) SERVICENAME [KEYID]
+ add a service name to key
+ revoke-servicename (n-) SERVICENAME [KEYID]
+ revoke a service name from key
+ add-revoker (r+) REVOKER_KEYID|FILE [KEYID]
+ add a revoker to key
+ revoke-key [KEYID] generate and/or publish revocation
+ certificate for key
+
+ version (v) show version number
+ help (h,?) this help
See ${PGRM}(8) for more info.
EOF
GNUPGHOME="$GNUPGHOME_HOST" gpg --no-greeting --quiet --no-tty "$@"
}
-# command to list the info about the host key, in colon format, to
-# stdout
-gpg_host_list() {
- gpg_host --list-keys --with-colons --fixed-list-mode \
- --with-fingerprint --with-fingerprint \
- "0x${HOST_FINGERPRINT}!"
-
+# list the info about the a key, in colon format, to stdout
+gpg_host_list_keys() {
+ if [ "$1" ] ; then
+ gpg_host --list-keys --with-colons --fixed-list-mode \
+ --with-fingerprint --with-fingerprint \
+ "$1"
+ else
+ gpg_host --list-keys --with-colons --fixed-list-mode \
+ --with-fingerprint --with-fingerprint
+ fi
}
-# command for edit key scripts, takes scripts on stdin
+# edit key scripts, takes scripts on stdin, and keyID as first input
gpg_host_edit() {
- gpg_host --command-fd 0 --edit-key "0x${HOST_FINGERPRINT}!" "$@"
+ gpg_host --command-fd 0 --edit-key "$@"
}
-# export the host public key to the monkeysphere gpg pub key file
-update_gpg_pub_file() {
+# export the monkeysphere OpenPGP pub key file
+update_pgp_pub_file() {
log debug "updating openpgp public key file '$HOST_KEY_FILE'..."
gpg_host --export --armor --export-options export-minimal \
- "0x${HOST_FINGERPRINT}!" > "$HOST_KEY_FILE"
+ $(gpg_host --list-secret-keys --with-colons --fingerprint | grep ^fpr | cut -f10 -d:) \
+ > "$HOST_KEY_FILE"
}
-# load the host fingerprint into the fingerprint variable, using the
-# export gpg pub key file
-# FIXME: this seems much less than ideal, with all this temp keyring
-# stuff. is there a way we can do this without having to create temp
-# files? what if we stored the fingerprint in MHDATADIR/fingerprint?
-load_fingerprint() {
- if [ -f "$HOST_KEY_FILE" ] ; 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_FILE" \
- | grep '^fpr:' | cut -d: -f10 )
- else
- failure "host key gpg pub file not found."
+# check that the service name is well formed. we assume that the
+# service name refers to a host; DNS labels for host names are limited
+# to a very small range of characters (see RFC 1912, section 2.1).
+
+# FIXME: i'm failing to check here for label components that are
+# all-number (e.g. ssh://666.666), which are technically not allowed
+# (though some exist on the 'net, apparently)
+
+# FIXME: this will probably misbehave if raw IP addresses are provided,
+# either IPv4 or IPv6 using the bracket notation.
+
+# FIXME: this doesn't address the use of hashed User IDs.
+
+check_service_name() {
+ local name="$1"
+ local errs=""
+ local scheme
+ local port
+ local assigned_ports
+
+ [ -n "$name" ] || \
+ failure "You must supply a service name to check"
+
+ printf '%s' "$name" | perl -n -e '($str = $_) =~ s/\s//g ; exit !(lc($str) eq $_);' || \
+ failure "Not a valid service name: '$name'
+
+Service names should be canonicalized to all lower-case,
+with no whitespace"
+
+ [[ "$name" =~ ^[a-z0-9./:-]+$ ]] || \
+ failure "Not a valid service name: '$name'
+
+Service names should contain only lower-case ASCII letters
+numbers, dots (.), hyphens (-), slashes (/), and a colon (:).
+If you are using non-ASCII characters (e.g. IDN), you should
+use the canonicalized ASCII (NAMEPREP -> Punycode) representation
+(see RFC 3490)."
+
+ [[ "$name" =~ \. ]] || \
+ failure "Not a valid service name: '$name'
+
+Service names should use fully-qualified domain names (FQDN), but the
+domain name you chose appears to only have the local part. For
+example: don't use 'ssh://foo' ; use 'ssh://foo.example.com' instead."
+
+ [[ "$name" =~ ^[a-z0-9]([a-z0-9-]*[a-z0-9])?://[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.|((\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)+))(:[1-9][0-9]{0,4})?$ ]] || \
+ failure "Not a valid service name: '$name'
+
+Service names look like <scheme>://full.example.com[:<portnumber>],
+where <scheme> is something like ssh or https, and <portnumber> is
+a decimal number (supplied only if the service is on a non-standard
+port)."
+
+ scheme=$(cut -f1 -d: <<<"$name")
+ port=$(cut -f3 -d: <<<"$name")
+
+ # check that the scheme name is found in the system services
+ # database
+ available_=$(get_port_for_service "$scheme") || \
+ log error "Error looking up service scheme named '%s'" "$scheme"
+
+ # FIXME: if the service isn't found, or does not have a port, what
+ # should we do? at the moment, we're just warning.
+
+ if [ -n "$port" ]; then
+ # check that the port number is a legitimate port number (> 0, < 65536)
+ [ "$port" -gt 0 ] && [ "$port" -lt 65536 ] || \
+ failure "The given port number should be greater than 0 and
+less than 65536. '$port' is not OK"
+
+ # if the port number is given, and the scheme is in the services
+ # database, check that the port number does *not* match the
+ # default port.
+ if (printf '%s' "$assigned_ports" | grep -q -F -x "$port" ) ; then
+ failure $(printf "The scheme %s uses port number %d by default.
+You should leave off the port number if it is the default" "$scheme" "$port")
+ fi
fi
-}
-
-# load the host fingerprint into the fingerprint variable, using the
-# gpg host secret key
-load_fingerprint_secret() {
- HOST_FINGERPRINT=$( \
- gpg_host --list-secret-key --with-colons --with-fingerprint \
- | grep '^fpr:' | cut -d: -f10 )
-}
-# fail if host key present
-check_host_key() {
- [ ! -s "$HOST_KEY_FILE" ] \
- || failure "An OpenPGP host key already exists."
}
# fail if host key not present
-check_host_no_key() {
+check_no_keys() {
[ -s "$HOST_KEY_FILE" ] \
|| failure "You don't appear to have a Monkeysphere host key on this server.
-Please run 'monkeysphere-host import-key...' first."
+Please run 'monkeysphere-host import-key' import a key."
}
-# output the index of a user ID on the host key
-# return 1 if user ID not found
-find_host_userid() {
- local userID="$1"
+# key input to functions, outputs full fingerprint of specified key if
+# found
+check_key_input() {
+ local keyID="$1"
+ # array of fingerprints
+ local fprs=($(list_primary_fingerprints <"$HOST_KEY_FILE"))
+
+ case ${#fprs[@]} in
+ 0)
+ failure "You don't appear to have any Monkeysphere host keys.
+Please run 'monkeysphere-host import-key' to import a key."
+ ;;
+ 1)
+ :
+ ;;
+ *)
+ if [ -z "$keyID" ] ; then
+ failure "Your host keyring contains multiple keys.
+Please specify one to act on (see 'monkeysphere-host show-keys')."
+ fi
+ ;;
+ esac
+ printf '%s\n' "${fprs[@]}" | grep "${keyID}$" \
+ || failure "Host key '$keyID' not found."
+}
+
+# return 0 if user ID was found.
+# return 1 if user ID not found.
+check_key_userid() {
+ local keyID="$1"
+ local userID="$2"
local tmpuidMatch
- local line
- # match to only ultimately trusted user IDs
- tmpuidMatch="u:$(echo $userID | gpg_escape)"
+ # match to only "unknown" user IDs (host has no need for ultimate trust)
+ tmpuidMatch="uid:-:$(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)
+ # See whether the requsted user ID is present
+ gpg_host_list_keys "$keyID" | cut -f1,2,10 -d: | \
+ grep -q -x -F "$tmpuidMatch" 2>/dev/null
+}
- if [ "$line" ] ; then
- echo ${line%%:*}
- return 0
- else
- return 1
+prompt_userid_exists() {
+ local userID="$1"
+ local gpgOut
+ local fingerprint
+
+ if gpgOut=$(gpg_host_list_keys "=${userID}" 2>/dev/null) ; then
+ fingerprint=$(echo "$gpgOut" | grep '^fpr:' | cut -d: -f10)
+ if [ "$PROMPT" != "false" ] ; then
+ printf "Service name '%s' is already being used by key '%s'.\nAre you sure you want to use it again? (y/N) " "$userID" "$fingerprint" >&2
+ read OK; OK=${OK:=N}
+ if [ "${OK/y/Y}" != 'Y' ] ; then
+ failure "Service name not added."
+ fi
+ else
+ log info "Key '%s' is already using the service name '%s'." "$fingerprint" "$userID" >&2
+ fi
fi
}
-# show info about the host key
+# run command looped over keys
+multi_key() {
+ local cmd="$1"
+ shift
+ local keys=$@
+ local i=0
+ local key
+
+ check_no_keys
+
+ local fprs=($(list_primary_fingerprints <"$HOST_KEY_FILE"))
+
+ if [[ -z "$1" || "$1" == '--all' ]] ; then
+ keys="${fprs[@]}"
+ fi
+
+ for key in $keys ; do
+ if (( i++ > 0 )) ; then
+ printf "\n"
+ fi
+ "$cmd" "$key"
+ done
+}
+
+# show info about the a key
show_key() {
+ local id="$1"
local GNUPGHOME
- local TMPSSH
+ local fingerprint
+ local tmpssh
local revokers
# tmp gpghome dir
# import the host key into the tmp dir
gpg --quiet --import <"$HOST_KEY_FILE"
- # create the ssh key
- TMPSSH="$GNUPGHOME"/ssh_host_key_rsa_pub
- gpg --export | openpgp2ssh 2>/dev/null >"$TMPSSH"
-
# get the gpg fingerprint
- HOST_FINGERPRINT=$(gpg --quiet --list-keys --with-colons --with-fingerprint \
- | grep '^fpr:' | cut -d: -f10 )
+ if gpg --quiet --list-keys \
+ --with-colons --with-fingerprint "$id" \
+ | grep '^fpr:' | cut -d: -f10 > "$GNUPGHOME"/fingerprint ; then
+ fingerprint=$(cat "$GNUPGHOME"/fingerprint)
+ else
+ failure "ID '$id' not found."
+ fi
+
+ # create the ssh key
+ tmpssh="$GNUPGHOME"/ssh_host_key_rsa_pub
+ gpg --export --no-armor "$fingerprint" 2>/dev/null \
+ | openpgp2ssh 2>/dev/null >"$tmpssh"
# list the host key info
# FIXME: make no-show-keyring work so we don't have to do the grep'ing
# FIXME: can we show uid validity somehow?
- gpg --list-keys --fingerprint \
- --list-options show-unusable-uids 2>/dev/null \
- | grep -v "^${GNUPGHOME}/pubring.gpg$" \
- | egrep -v '^-+$'
+ gpg --list-keys --list-options show-unusable-uids "$fingerprint" 2>/dev/null \
+ | grep -v "^${GNUPGHOME}/pubring.gpg$" \
+ | egrep -v '^-+$' \
+ | grep -v '^$'
# list revokers, if there are any
- revokers=$(gpg --list-keys --with-colons --fixed-list-mode \
+ revokers=$(gpg --list-keys --with-colons --fixed-list-mode "$fingerprint" \
| awk -F: '/^rvk:/{ print $10 }' )
if [ "$revokers" ] ; then
echo "The following keys are allowed to revoke this host key:"
for key in $revokers ; do
echo "revoker: $key"
done
- echo
fi
# list the pgp fingerprint
- echo "OpenPGP fingerprint: $HOST_FINGERPRINT"
+ echo "OpenPGP fingerprint: $fingerprint"
# list the ssh fingerprint
echo -n "ssh fingerprint: "
- ssh-keygen -l -f "$TMPSSH" | awk '{ print $1, $2, $4 }'
+ ssh-keygen -l -f "$tmpssh" | awk '{ print $1, $2, $4 }'
# remove the tmp file
trap - EXIT
KEYSERVER=${MONKEYSPHERE_KEYSERVER:=$KEYSERVER}
CHECK_KEYSERVER=${MONKEYSPHERE_CHECK_KEYSERVER:=$CHECK_KEYSERVER}
MONKEYSPHERE_USER=${MONKEYSPHERE_MONKEYSPHERE_USER:=$MONKEYSPHERE_USER}
+MONKEYSPHERE_GROUP=$(get_primary_group "$MONKEYSPHERE_USER")
PROMPT=${MONKEYSPHERE_PROMPT:=$PROMPT}
# other variables
export KEYSERVER
export CHECK_KEYSERVER
export MONKEYSPHERE_USER
+export MONKEYSPHERE_GROUP
export PROMPT
export GNUPGHOME_HOST
export GNUPGHOME
export HOST_FINGERPRINT
+export LOG_PREFIX
+
+if [ "$#" -eq 0 ] ; then
+ usage
+ failure "Please supply a subcommand."
+fi
# get subcommand
COMMAND="$1"
-[ "$COMMAND" ] || failure "Type '$PGRM help' for usage."
shift
case $COMMAND in
- 'import-key'|'i')
- check_host_key
+ 'import-key'|'import'|'i')
source "${MHSHAREDIR}/import_key"
import_key "$@"
;;
- 'show-key'|'show'|'s')
- check_host_no_key
- show_key
+ 'show-keys'|'show-key'|'show'|'s')
+ multi_key show_key "$@"
;;
- 'set-expire'|'extend-key'|'e')
- check_host_no_key
- load_fingerprint
+ 'set-expire'|'extend-key'|'extend'|'e')
source "${MHSHAREDIR}/set_expire"
set_expire "$@"
;;
- 'add-hostname'|'add-name'|'n+')
- check_host_no_key
- load_fingerprint
- source "${MHSHAREDIR}/add_hostname"
- add_hostname "$@"
+ 'add-servicename'|'add-hostname'|'add-name'|'n+')
+ source "${MHSHAREDIR}/add_name"
+ add_name "$@"
;;
- 'revoke-hostname'|'revoke-name'|'n-')
- check_host_no_key
- load_fingerprint
- source "${MHSHAREDIR}/revoke_hostname"
- revoke_hostname "$@"
+ 'revoke-servicename'|'revoke-hostname'|'revoke-name'|'n-')
+ source "${MHSHAREDIR}/revoke_name"
+ revoke_name "$@"
;;
'add-revoker'|'r+')
- check_host_no_key
- load_fingerprint
source "${MHSHAREDIR}/add_revoker"
add_revoker "$@"
;;
'revoke-key')
- check_host_no_key
- load_fingerprint
source "${MHSHAREDIR}/revoke_key"
revoke_key "$@"
;;
- 'publish-key'|'publish'|'p')
- check_host_no_key
- load_fingerprint
+ 'publish-keys'|'publish-key'|'publish'|'p')
source "${MHSHAREDIR}/publish_key"
- publish_key
+ multi_key publish_key "$@"
;;
'diagnostics'|'d')
- load_fingerprint
source "${MHSHAREDIR}/diagnostics"
diagnostics
;;
- 'update-gpg-pub-file')
- load_fingerprint_secret
- update_gpg_pub_file
+ 'update-pgp-pub-file')
+ update_pgp_pub_file
;;
- 'version'|'v')
+ 'version'|'--version'|'v')
version
;;
*)
failure "Unknown command: '$COMMAND'
-Type '$PGRM help' for usage."
+Try '$PGRM help' for usage."
;;
esac
projects / monkeysphere.git / blobdiff