########################################################################
usage() {
-cat <<EOF
+ cat <<EOF
usage: $PGRM <subcommand> [options] [args]
MonkeySphere server admin tool.
subcommands:
update-users (u) [USER]... update user authorized_keys files
- gen-key (g) [HOSTNAME] generate gpg key for the server
- -l|--length BITS key length in bits (2048)
- -e|--expire EXPIRE date to expire
- -r|--revoker FINGERPRINT add a revoker
- show-fingerprint (f) show server's host key fingerprint
- publish-key (p) publish server's host key to keyserver
- diagnostics (d) report on the server's monkeysphere status
-
- add-identity-certifier (a) KEYID import and tsign a certification key
- -n|--domain DOMAIN limit ID certifications to IDs in DOMAIN
- -t|--trust TRUST trust level of certifier (full)
- -d|--depth DEPTH trust depth for certifier (1)
- remove-identity-certifier (r) KEYID remove a certification key
- list-identity-certifiers (l) list certification keys
+ gen-key (g) [NAME[:PORT]] generate gpg key for the server
+ --length (-l) BITS key length in bits (2048)
+ --expire (-e) EXPIRE date to expire
+ --revoker (-r) FINGERPRINT add a revoker
+ add-hostname (n+) NAME[:PORT] add hostname user ID to server key
+ revoke-hostname (n-) NAME[:PORT] revoke hostname user ID
+ show-key (s) output all server host key information
+ fingerprint (f) output just the key fingerprint
+ publish-key (p) publish server host key to keyserver
+ diagnostics (d) report on server monkeysphere status
+
+ add-id-certifier (c+) KEYID import and tsign a certification key
+ --domain (-n) DOMAIN limit ID certifications to DOMAIN
+ --trust (-t) TRUST trust level of certifier (full)
+ --depth (-d) DEPTH trust depth for certifier (1)
+ remove-id-certifier (c-) KEYID remove a certification key
+ list-id-certifiers (c) list certification keys
gpg-authentication-cmd CMD gnupg-authentication command
help (h,?) this help
+
EOF
}
su_monkeysphere_user "gpg $@"
}
+# output just key fingerprint
+fingerprint_server_key() {
+ gpg_host --list-secret-keys --fingerprint \
+ --with-colons --fixed-list-mode 2> /dev/null | \
+ grep '^fpr:' | head -1 | cut -d: -f10
+}
+
+# output key information
+show_server_key() {
+ local fingerprint
+ fingerprint=$(fingerprint_server_key)
+ gpg_host --fingerprint --list-secret-key "$fingerprint"
+}
+
# update authorized_keys for users
update_users() {
if [ "$1" ] ; then
revoker=
# get options
- TEMP=$(getopt -o l:e:r: -l length:,expire:,revoker: -n "$PGRM" -- "$@")
+ TEMP=$(getopt -o e:l:r -l expire:,length:,revoker: -n "$PGRM" -- "$@")
if [ $? != 0 ] ; then
exit 1
# output the server fingerprint
fingerprint_server_key "=${userID}"
- # find the key fingerprint of the server primary key
- fingerprint=$(gpg_host --list-key --with-colons --with-fingerprint "=${userID}" | \
- grep '^fpr:' | head -1 | cut -d: -f10)
+ # find the key fingerprint of the newly generated key
+ fingerprint=$(fingerprint_server_key)
# export host ownertrust to authentication keyring
log "setting ultimate owner trust for server key..."
log "Private SSH host key output to file: ${VARLIB}/ssh_host_rsa_key"
}
-# gpg output key fingerprint
-fingerprint_server_key() {
- gpg_host --fingerprint --list-secret-keys
+# add hostname user ID to server key
+add_hostname() {
+ local userID
+ local fingerprint
+ local tmpuidMatch
+ local line
+ local adduidCommand
+
+ if [ -z "$1" ] ; then
+ failure "You must specify a hostname to add."
+ fi
+
+ userID="ssh://${1}"
+
+ fingerprint=$(fingerprint_server_key)
+
+ # 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
+ if line=$(gpg_host --list-keys --with-colons --fixed-list-mode "0x${fingerprint}!" \
+ | egrep '^(uid|uat):' | cut -f2,10 -d: | grep -n -x -F "$tmpuidMatch") ; then
+ failure "Host userID '$userID' already exists."
+ fi
+
+ echo "The following user ID will be added to the host key:"
+ echo " $userID"
+ read -p "Are you sure you would like to add this user ID? (y/N) " OK; OK=${OK:=N}
+ if [ ${OK/y/Y} != 'Y' ] ; then
+ failure "User ID not added."
+ fi
+
+ # edit-key script command to add user ID
+ adduidCommand=$(cat <<EOF
+adduid
+$userID
+
+
+save
+EOF
+ )
+
+ # execute edit-key script
+ if echo "$adduidCommand" | \
+ gpg_host --quiet --command-fd 0 --edit-key "0x${fingerprint}!" ; then
+ # update trust db
+ gpg_host --check-trustdb
+
+ show_server_key
+
+ echo "NOTE: User ID added to key, but key not published."
+ echo "Run '$PGRM publish-key' to publish the new user ID."
+ else
+ failure "Problem adding user ID."
+ fi
+}
+
+# revoke hostname user ID to server key
+revoke_hostname() {
+ local userID
+ local fingerprint
+ local tmpuidMatch
+ local line
+ local uidIndex
+ local message
+ local revuidCommand
+
+ if [ -z "$1" ] ; then
+ failure "You must specify a hostname to revoke."
+ fi
+
+ echo "WARNING: There is a known bug in this function."
+ echo "This function has been known to occasionally revoke the wrong user ID."
+ echo "Please see the following bug report for more information:"
+ echo "http://monkeysphere.info/bugs/revoke-hostname-revoking-wrong-userid/"
+ read -p "Are you sure you would like to proceed? (y/N) " OK; OK=${OK:=N}
+ if [ ${OK/y/Y} != 'Y' ] ; then
+ failure "aborting."
+ fi
+
+ userID="ssh://${1}"
+
+ fingerprint=$(fingerprint_server_key)
+
+ # 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
+ if line=$(gpg_host --list-keys --with-colons --fixed-list-mode "0x${fingerprint}!" \
+ | egrep '^(uid|uat):' | cut -f2,10 -d: | grep -n -x -F "$tmpuidMatch") ; then
+ uidIndex=${line%%:*}
+ else
+ failure "No non-revoked user ID '$userID' is found."
+ fi
+
+ echo "The following host key user ID will be revoked:"
+ echo " $userID"
+ read -p "Are you sure you would like to revoke this user ID? (y/N) " OK; OK=${OK:=N}
+ if [ ${OK/y/Y} != 'Y' ] ; then
+ failure "User ID not revoked."
+ fi
+
+ message="Hostname removed by monkeysphere-server $DATE"
+
+ # edit-key script command to revoke user ID
+ revuidCommand=$(cat <<EOF
+$uidIndex
+revuid
+y
+4
+$message
+
+y
+save
+EOF
+ )
+
+ # execute edit-key script
+ if echo "$revuidCommand" | \
+ gpg_host --quiet --command-fd 0 --edit-key "0x${fingerprint}!" ; then
+ # update trust db
+ gpg_host --check-trustdb
+
+ show_server_key
+
+ echo "NOTE: User ID revoked, but revocation not published."
+ echo "Run '$PGRM publish-key' to publish the revocation."
+ else
+ failure "Problem revoking user ID."
+ fi
}
# publish server key to keyserver
publish_server_key() {
- read -p "Really publish key to $KEYSERVER? (y/N) " OK; OK=${OK:=N}
+ read -p "Really publish host key to $KEYSERVER? (y/N) " OK; OK=${OK:=N}
if [ ${OK/y/Y} != 'Y' ] ; then
- failure "aborting."
+ failure "key not published."
fi
+ # find the key fingerprint
+ fingerprint=$(fingerprint_server_key)
+
# publish host key
- # FIXME: need to figure out better way to identify host key
- # dummy command so as not to publish fakes keys during testing
- # eventually:
- #gpg_authentication "--keyserver $KEYSERVER --send-keys $(hostname -f)"
- echo "NOT PUBLISHED (to avoid permanent publication errors during monkeysphere development)."
- echo "The following command should publish the key:"
- echo "monkeysphere-server gpg-authentication-cmd '--keyserver $KEYSERVER --send-keys $(hostname -f)'"
- exit 255
+ gpg_authentication "--keyserver $KEYSERVER --send-keys '0x${fingerprint}!'"
}
diagnostics() {
# * check on the status and validity of the key and public certificates
local seckey
local keysfound
- local keyexp
local curdate
local warnwindow
local warndate
+ local create
+ local expire
+ local uid
+ local fingerprint
+ local badhostkeys
+ local sshd_config
+ # FIXME: what's the correct, cross-platform answer?
+ sshd_config=/etc/ssh/sshd_config
seckey=$(gpg_host --list-secret-keys --with-colons --fixed-list-mode)
keysfound=$(echo "$seckey" | grep -c ^sec:)
curdate=$(date +%s)
warnwindow='2 months'
warndate=$(date +%s -d "$warnwindow")
+ echo "Checking host GPG key..."
if (( "$keysfound" < 1 )); then
- echo "No host key found!"
- echo "Recommendation: run 'monkeysphere-server gen-key'"
+ echo "! No host key found."
+ echo " - Recommendation: run 'monkeysphere-server gen-key'"
+ elif (( "$keysfound" > 1 )); then
+ echo "! More than one host key found?"
+ # FIXME: recommend a way to resolve this
else
- if (( "$keysfound" > 1 )); then
- echo "more than one host key found?"
- else
+ create=$(echo "$seckey" | grep ^sec: | cut -f6 -d:)
+ expire=$(echo "$seckey" | grep ^sec: | cut -f7 -d:)
+ fingerprint=$(echo "$seckey" | grep ^fpr: | head -n1 | cut -f10 -d:)
# check for key expiration:
- keyexp=$(echo "$seckey" | grep ^sec: | cut -f7 -d:)
- if (( "$keyexp" < "$curdate" )); then
- echo "Host key is expired!"
+ if [ "$expire" ]; then
+ if (( "$expire" < "$curdate" )); then
+ echo "! Host key is expired."
# FIXME: recommend a way to resolve this other than re-keying?
- elif (( "$keyexp" < "$warndate" )); then
- echo "Host key expires in less than $warnwindow"
+ elif (( "$expire" < "$warndate" )); then
+ echo "! Host key expires in less than $warnwindow:" $(date -d "$(( $expire - $curdate )) seconds" +%F)
# FIXME: recommend a way to resolve this?
fi
+ fi
+
# and weirdnesses:
- if (( $(echo "$seckey" | grep ^sec: | cut -f6 -d:) > "$curdate" )); then
- echo "Host key was created in the future(?!). Is your clock correct?"
- echo "Recommendation: Check clock ($(date +%F_%T)); use NTP?"
- fi
+ if [ "$create" ] && (( "$create" > "$curdate" )); then
+ echo "! Host key was created in the future(?!). Is your clock correct?"
+ echo " - Recommendation: Check clock ($(date +%F_%T)); use NTP?"
+ fi
# check for UserID expiration:
- echo "$seckey" | grep ^uid: | cut -d: -f6,7,10 | \
- while IFS=: read create expire uid ; do
- # FIXME: should we be doing any checking on the form
- # of the User ID? Should we be unmangling it somehow?
- if [ "$create" ] && (( "$create" > "$curdate" )); then
- echo "User ID '$uid' was created in the future(?!). Is your clock correct?"
- echo "Recommendation: Check clock ($(date +%F_%T)); use NTP?"
- fi
- if [ "$expire" ] ; then
- if (( "$expire" < "$curdate" )); then
- echo "User ID '$uid' is expired!"
- # FIXME: recommend a way to resolve this
- elif (( "$expire" < "$warndate" )); then
- echo "User ID '$uid' expires in less than $warnwindow"
+ echo "$seckey" | grep ^uid: | cut -d: -f6,7,10 | \
+ while IFS=: read create expire uid ; do
+ # FIXME: should we be doing any checking on the form
+ # of the User ID? Should we be unmangling it somehow?
+
+ if [ "$create" ] && (( "$create" > "$curdate" )); then
+ echo "! User ID '$uid' was created in the future(?!). Is your clock correct?"
+ echo " - Recommendation: Check clock ($(date +%F_%T)); use NTP?"
+ fi
+ if [ "$expire" ] ; then
+ if (( "$expire" < "$curdate" )); then
+ echo "! User ID '$uid' is expired."
# FIXME: recommend a way to resolve this
- fi
+ elif (( "$expire" < "$warndate" )); then
+ echo "! User ID '$uid' expires in less than $warnwindow:" $(date -d "$(( $expire - $curdate )) seconds" +%F)
+ # FIXME: recommend a way to resolve this
fi
- done
+ fi
+ done
# FIXME: verify that the host key is properly published to the
-# keyservers
+# keyservers (do this with the non-privileged user)
# FIXME: check that there are valid, non-expired certifying signatures
-# attached to the host key
+# attached to the host key after fetching from the public keyserver
+# (do this with the non-privileged user as well)
# FIXME: propose adding a revoker to the host key if none exist (do we
# have a way to do that after key generation?)
-# Ensure that the ssh_host_rsa_key file is present and non-empty:
- if [ ! -s "${VARLIB}/ssh_host_rsa_key" ] ; then
- echo "The host key as prepared for SSH (${VARLIB}/ssh_host_rsa_key) is missing or empty!"
- else
- if [ $(stat -c '%a' "${VARLIB}/ssh_host_rsa_key") != 600 ] ; then
- echo "Permissions seem wrong for ${VARLIB}/ssh_host_rsa_key -- should be 0600 !"
- fi
+ # Ensure that the ssh_host_rsa_key file is present and non-empty:
+ echo
+ echo "Checking host SSH key..."
+ if [ ! -s "${VARLIB}/ssh_host_rsa_key" ] ; then
+ echo "! The host key as prepared for SSH (${VARLIB}/ssh_host_rsa_key) is missing or empty."
+ else
+ if [ $(stat -c '%a' "${VARLIB}/ssh_host_rsa_key") != 600 ] ; then
+ echo "! Permissions seem wrong for ${VARLIB}/ssh_host_rsa_key -- should be 0600."
+ fi
- # propose changes needed for sshd_config (if any)
- if ! grep -q "^HostKey ${VARLIB}/ssh_host_rsa_key$" /etc/ssh/sshd_config; then
- echo "/etc/ssh/sshd_config does not point to the monkeysphere host key (${VARLIB}/ssh_host_rsa_key)."
- echo "Recommendation: add a line to /etc/ssh/sshd_config: 'HostKey ${VARLIB}/ssh_host_rsa_key'"
- fi
+ # propose changes needed for sshd_config (if any)
+ if ! grep -q "^HostKey[[:space:]]\+${VARLIB}/ssh_host_rsa_key$" "$sshd_config"; then
+ echo "! $sshd_config does not point to the monkeysphere host key (${VARLIB}/ssh_host_rsa_key)."
+ echo " - Recommendation: add a line to $sshd_config: 'HostKey ${VARLIB}/ssh_host_rsa_key'"
+ fi
+ if badhostkeys=$(grep -i '^HostKey' "$sshd_config" | grep -q -v "^HostKey[[:space:]]\+${VARLIB}/ssh_host_rsa_key$") ; then
+ echo "! $sshd_config refers to some non-monkeysphere host keys:"
+ echo "$badhostkeys"
+ echo " - Recommendation: remove the above HostKey lines from $sshd_config"
fi
fi
fi
# FIXME: make sure that at least one identity certifier exists
+ echo
+ echo "Checking for MonkeySphere-enabled public-key authentication for users ..."
+ # Ensure that User ID authentication is enabled:
+ if ! grep -q "^AuthorizedKeysFile[[:space:]]\+${VARLIB}/authorized_keys/%u$" "$sshd_config"; then
+ echo "! $sshd_config does not point to monkeysphere authorized keys."
+ echo " - Recommendation: add a line to $sshd_config: 'AuthorizedKeysFile ${VARLIB}/authorized_keys/%u'"
+ fi
+ if badauthorizedkeys=$(grep -i '^AuthorizedKeysFile' "$sshd_config" | grep -q -v "^AuthorizedKeysFile[[:space:]]\+${VARLIB}/authorized_keys/%u$") ; then
+ echo "! $sshd_config refers to non-monkeysphere authorized_keys files:"
+ echo "$badauthorizedkeys"
+ echo " - Recommendation: remove the above AuthorizedKeysFile lines from $sshd_config"
+ fi
}
# retrieve key from web of trust, import it into the host keyring, and
export keyID
# get the key from the key server
- gpg_authentication "--keyserver $KEYSERVER --recv-key '$keyID'"
+ gpg_authentication "--keyserver $KEYSERVER --recv-key '0x${keyID}!'"
# get the full fingerprint of a key ID
- fingerprint=$(gpg_authentication "--list-key --with-colons --with-fingerprint $keyID" | \
+ fingerprint=$(gpg_authentication "--list-key --with-colons --with-fingerprint 0x${keyID}!" | \
grep '^fpr:' | grep "$keyID" | cut -d: -f10)
+ if [ -z "$fingerprint" ] ; then
+ failure "Key '$keyID' not found."
+ fi
+
+ echo
echo "key found:"
- gpg_authentication "--fingerprint $fingerprint"
+ gpg_authentication "--fingerprint 0x${fingerprint}!"
- echo "Are you sure you want to add this key as a certifier of"
- read -p "users on this system? (y/N) " OK; OK=${OK:-N}
+ echo "Are you sure you want to add the above key as a"
+ read -p "certifier of users on this system? (y/N) " OK; OK=${OK:-N}
if [ "${OK/y/Y}" != 'Y' ] ; then
- failure "aborting."
+ failure "Identity certifier not added."
fi
# export the key to the host keyring
- gpg_authentication "--export $keyID" | gpg_host --import
+ gpg_authentication "--export 0x${fingerprint}!" | gpg_host --import
if [ "$trust" == marginal ]; then
trustval=1
elif [ "$trust" == full ]; then
trustval=2
else
- failure "trust value requested ('$trust') was unclear (only 'marginal' or 'full' are supported)"
+ failure "Trust value requested ('$trust') was unclear (only 'marginal' or 'full' are supported)."
fi
# ltsign command
)
# ltsign the key
- echo "$ltsignCommand" | gpg_host --quiet --command-fd 0 --edit-key "$fingerprint"
+ if echo "$ltsignCommand" | \
+ gpg_host --quiet --command-fd 0 --edit-key "0x${fingerprint}!" ; then
- # update the trustdb for the authentication keyring
- gpg_authentication "--check-trustdb"
+ # update the trustdb for the authentication keyring
+ gpg_authentication "--check-trustdb"
+
+ echo
+ echo "Identity certifier added."
+ else
+ failure "Problem adding identify certifier."
+ fi
}
# delete a certifiers key from the host keyring
failure "You must specify the key ID of a key to remove."
fi
- # delete the requested key (with prompting)
- gpg_host --delete-key "$keyID"
+ if gpg_authentication "--no-options --list-options show-uid-validity --keyring ${GNUPGHOME_AUTHENTICATION}/pubring.gpg --list-key 0x${keyID}!" ; then
+ read -p "Really remove above listed identity certifier? (y/N) " OK; OK=${OK:-N}
+ if [ "${OK/y/Y}" != 'Y' ] ; then
+ failure "Identity certifier not removed."
+ fi
+ else
+ failure
+ fi
- # update the trustdb for the authentication keyring
- gpg_authentication "--check-trustdb"
+ # delete the requested key
+ if gpg_authentication "--delete-key --batch --yes 0x${keyID}!" ; then
+ # delete key from host keyring as well
+ gpg_host --delete-key --batch --yes "0x${keyID}!"
+ # update the trustdb for the authentication keyring
+ gpg_authentication "--check-trustdb"
+
+ echo
+ echo "Identity certifier removed."
+ else
+ failure "Problem removing identity certifier."
+ fi
}
# list the host certifiers
list_certifiers() {
- gpg_host --list-keys
+ local keys
+ local key
+
+ # find trusted keys in authentication keychain
+ keys=$(gpg_authentication "--no-options --list-options show-uid-validity --keyring ${GNUPGHOME_AUTHENTICATION}/pubring.gpg --list-keys --with-colons --fingerprint" | \
+ grep ^pub: | cut -d: -f2,5 | egrep '^(u|f):' | cut -d: -f2)
+
+ # output keys
+ for key in $keys ; do
+ gpg_authentication "--no-options --list-options show-uid-validity --keyring ${GNUPGHOME_AUTHENTICATION}/pubring.gpg --list-key --fingerprint $key"
+ done
}
# issue command to gpg-authentication keyring
gen_key "$@"
;;
- 'show-fingerprint'|'f')
+ 'add-hostname'|'add-name'|'n+')
+ add_hostname "$@"
+ ;;
+
+ 'revoke-hostname'|'revoke-name'|'n-')
+ revoke_hostname "$@"
+ ;;
+
+ 'show-key'|'show'|'s')
+ show_server_key
+ ;;
+
+ 'show-fingerprint'|'fingerprint'|'f')
fingerprint_server_key
;;
- 'publish-key'|'p')
+ 'publish-key'|'publish'|'p')
publish_server_key
;;
diagnostics
;;
- 'add-identity-certifier'|'add-certifier'|'a')
- add_certifier "$1"
+ 'add-identity-certifier'|'add-id-certifier'|'add-certifier'|'c+')
+ add_certifier "$@"
;;
- 'remove-identity-certifier'|'remove-certifier'|'r')
- remove_certifier "$1"
+ 'remove-identity-certifier'|'remove-id-certifier'|'remove-certifier'|'c-')
+ remove_certifier "$@"
;;
- 'list-identity-certifiers'|'list-certifiers'|'list-certifier'|'l')
+ 'list-identity-certifiers'|'list-id-certifiers'|'list-certifiers'|'list-certifier'|'c')
list_certifiers "$@"
;;
gpg_authentication_cmd "$@"
;;
- 'help'|'h'|'?')
+ '--help'|'help'|'-h'|'h'|'?')
usage
;;
projects / monkeysphere.git / blobdiff