3 # monkeysphere-server: MonkeySphere server admin tool
5 # The monkeysphere scripts are written by:
6 # Jameson Rollins <jrollins@fifthhorseman.net>
8 # They are Copyright 2008, and are all released under the GPL, version 3
11 ########################################################################
14 SHARE=${MONKEYSPHERE_SHARE:="/usr/share/monkeysphere"}
16 . "${SHARE}/common" || exit 1
18 VARLIB="/var/lib/monkeysphere"
21 # date in UTF format if needed
22 DATE=$(date -u '+%FT%T')
24 # unset some environment variables that could screw things up
30 ########################################################################
32 ########################################################################
36 usage: $PGRM <subcommand> [options] [args]
37 MonkeySphere server admin tool.
40 update-users (u) [USER]... update user authorized_keys files
42 gen-key (g) [HOSTNAME] generate gpg key for the server
43 -l|--length BITS key length in bits (2048)
44 -e|--expire EXPIRE date to expire
45 -r|--revoker FINGERPRINT add a revoker
46 show-fingerprint (f) show server's host key fingerprint
47 publish-key (p) publish server's host key to keyserver
49 add-identity-certifier (a) KEYID import and tsign a certification key
50 -n|--domain DOMAIN limit ID certifications to IDs in DOMAIN ()
51 -t|--trust TRUST trust level of certifier (full)
52 -d|--depth DEPTH trust depth for certifier (1)
53 remove-identity-certifier (r) KEYID remove a certification key
54 list-identity-certifiers (l) list certification keys
56 gpg-authentication-cmd CMD gnupg-authentication command
63 su_monkeysphere_user() {
64 su --preserve-environment "$MONKEYSPHERE_USER" -- -c "$@"
67 # function to interact with the host gnupg keyring
71 GNUPGHOME="$GNUPGHOME_HOST"
74 # NOTE: we supress this warning because we need the monkeysphere
75 # user to be able to read the host pubring. we realize this might
76 # be problematic, but it's the simplest solution, without too much
78 gpg --no-permission-warning "$@"
81 # always reset the permissions on the host pubring so that the
82 # monkeysphere user can read the trust signatures
83 chgrp "$MONKEYSPHERE_USER" "${GNUPGHOME_HOST}/pubring.gpg"
84 chmod g+r "${GNUPGHOME_HOST}/pubring.gpg"
89 # function to interact with the authentication gnupg keyring
90 # FIXME: this function requires basically accepts only a single
91 # argument because of problems with quote expansion. this needs to be
93 gpg_authentication() {
94 GNUPGHOME="$GNUPGHOME_AUTHENTICATION"
97 su_monkeysphere_user "gpg $@"
100 # update authorized_keys for users
103 # get users from command line
106 # or just look at all users if none specified
107 unames=$(getent passwd | cut -d: -f1)
111 MODE="authorized_keys"
114 GNUPGHOME="$GNUPGHOME_AUTHENTICATION"
116 # check to see if the gpg trust database has been initialized
117 if [ ! -s "${GNUPGHOME}/trustdb.gpg" ] ; then
118 failure "GNUPG trust database uninitialized. Please see MONKEYSPHERE-SERVER(8)."
121 # make sure the authorized_keys directory exists
122 mkdir -p "${VARLIB}/authorized_keys"
125 for uname in $unames ; do
126 # check all specified users exist
127 if ! getent passwd "$uname" >/dev/null ; then
128 log "----- unknown user '$uname' -----"
132 # set authorized_user_ids and raw authorized_keys variables,
133 # translating ssh-style path variables
134 authorizedUserIDs=$(translate_ssh_variables "$uname" "$AUTHORIZED_USER_IDS")
135 rawAuthorizedKeys=$(translate_ssh_variables "$uname" "$RAW_AUTHORIZED_KEYS")
137 # if neither is found, skip user
138 if [ ! -s "$authorizedUserIDs" ] ; then
139 if [ "$rawAuthorizedKeys" = '-' -o ! -s "$rawAuthorizedKeys" ] ; then
144 log "----- user: $uname -----"
146 if ! check_key_file_permissions "$uname" "$AUTHORIZED_USER_IDS" ; then
147 log "Improper permissions on authorized_user_ids file."
151 if ! check_key_file_permissions "$uname" "$RAW_AUTHORIZED_KEYS" ; then
152 log "Improper permissions on authorized_keys file."
156 # make temporary directory
159 # trap to delete temporary directory on exit
160 trap "rm -rf $TMPDIR" EXIT
162 # create temporary authorized_user_ids file
163 TMP_AUTHORIZED_USER_IDS="${TMPDIR}/authorized_user_ids"
164 touch "$TMP_AUTHORIZED_USER_IDS"
166 # create temporary authorized_keys file
167 AUTHORIZED_KEYS="${TMPDIR}/authorized_keys"
168 touch "$AUTHORIZED_KEYS"
170 # set restrictive permissions on the temporary files
171 # FIXME: is there a better way to do this?
173 chmod 0600 "$AUTHORIZED_KEYS"
174 chmod 0600 "$TMP_AUTHORIZED_USER_IDS"
175 chown -R "$MONKEYSPHERE_USER" "$TMPDIR"
177 # if the authorized_user_ids file exists...
178 if [ -s "$authorizedUserIDs" ] ; then
179 # copy user authorized_user_ids file to temporary
181 cat "$authorizedUserIDs" > "$TMP_AUTHORIZED_USER_IDS"
183 # export needed variables
184 export AUTHORIZED_KEYS
185 export TMP_AUTHORIZED_USER_IDS
187 # process authorized_user_ids file, as monkeysphere
189 su_monkeysphere_user \
190 ". ${SHARE}/common; process_authorized_user_ids $TMP_AUTHORIZED_USER_IDS"
194 # add user-controlled authorized_keys file path if specified
195 if [ "$rawAuthorizedKeys" != '-' -a -s "$rawAuthorizedKeys" ] ; then
196 log -n "adding raw authorized_keys file... "
197 cat "$rawAuthorizedKeys" >> "$AUTHORIZED_KEYS"
201 # openssh appears to check the contents of the
202 # authorized_keys file as the user in question, so the
203 # file must be readable by that user at least.
204 # FIXME: is there a better way to do this?
205 chown root "$AUTHORIZED_KEYS"
206 chgrp $(getent passwd "$uname" | cut -f4 -d:) "$AUTHORIZED_KEYS"
207 chmod g+r "$AUTHORIZED_KEYS"
209 # if the resulting authorized_keys file is not empty, move
211 mv -f "$AUTHORIZED_KEYS" "${VARLIB}/authorized_keys/${uname}"
213 # destroy temporary directory
218 # generate server gpg key
230 # set default key parameter values
238 TEMP=$(getopt -o l:e:r: -l length:,expire:,revoker: -n "$PGRM" -- "$@")
240 if [ $? != 0 ] ; then
244 # Note the quotes around `$TEMP': they are essential!
270 hostName=${1:-$(hostname --fqdn)}
271 userID="ssh://${hostName}"
273 # check for presense of key with user ID
274 if gpg_host --list-key ="$userID" > /dev/null 2>&1 ; then
275 failure "Key for '$userID' already exists"
278 # prompt about key expiration if not specified
279 if [ -z "$keyExpire" ] ; then
281 Please specify how long the key should be valid.
282 0 = key does not expire
283 <n> = key expires in n days
284 <n>w = key expires in n weeks
285 <n>m = key expires in n months
286 <n>y = key expires in n years
288 while [ -z "$keyExpire" ] ; do
289 read -p "Key is valid for? (0) " keyExpire
290 if ! test_gpg_expire ${keyExpire:=0} ; then
295 elif ! test_gpg_expire "$keyExpire" ; then
296 failure "invalid key expiration value '$keyExpire'."
300 keyParameters=$(cat <<EOF
302 Key-Length: $keyLength
305 Expire-Date: $keyExpire
309 # add the revoker field if specified
310 # FIXME: the "1:" below assumes that $REVOKER's key is an RSA key.
311 # FIXME: key is marked "sensitive"? is this appropriate?
312 if [ "$revoker" ] ; then
313 keyParameters="${keyParameters}"$(cat <<EOF
314 Revoker: 1:$revoker sensitive
319 echo "The following key parameters will be used for the host private key:"
320 echo "$keyParameters"
322 read -p "Generate key? (Y/n) " OK; OK=${OK:=Y}
323 if [ ${OK/y/Y} != 'Y' ] ; then
328 keyParameters="${keyParameters}"$(cat <<EOF
335 log "generating server key..."
336 echo "$keyParameters" | gpg_host --batch --gen-key
338 # output the server fingerprint
339 fingerprint_server_key "=${userID}"
341 # find the key fingerprint of the server primary key
342 fingerprint=$(gpg_host --list-key --with-colons --with-fingerprint "=${userID}" | \
343 grep '^fpr:' | head -1 | cut -d: -f10)
345 # export host ownertrust to authentication keyring
346 log "setting ultimate owner trust for server key..."
347 echo "${fingerprint}:6:" | gpg_authentication "--import-ownertrust"
349 # translate the private key to ssh format, and export to a file
351 # NOTE: assumes that the primary key is the proper key to use
353 gpg_host --export-secret-key "$fingerprint" | \
354 openpgp2ssh "$fingerprint" > "${VARLIB}/ssh_host_rsa_key")
355 log "Private SSH host key output to file: ${VARLIB}/ssh_host_rsa_key"
358 # gpg output key fingerprint
359 fingerprint_server_key() {
360 gpg_host --fingerprint --list-secret-keys
363 # publish server key to keyserver
364 publish_server_key() {
365 read -p "Really publish key to $KEYSERVER? (y/N) " OK; OK=${OK:=N}
366 if [ ${OK/y/Y} != 'Y' ] ; then
371 # FIXME: need to figure out better way to identify host key
372 # dummy command so as not to publish fakes keys during testing
374 #gpg_authentication "--keyserver $KEYSERVER --send-keys $(hostname -f)"
375 echo "NOT PUBLISHED (to avoid permanent publication errors during monkeysphere development)."
376 echo "The following command should publish the key:"
377 echo "monkeysphere-server gpg-authentication-cmd '--keyserver $KEYSERVER --send-keys $(hostname -f)'"
381 # retrieve key from web of trust, import it into the host keyring, and
382 # ltsign the key in the host keyring so that it may certify other keys
392 # set default values for trust depth and domain
398 TEMP=$(getopt -o n:t:d: -l domain:,trust:,depth: -n "$PGRM" -- "$@")
400 if [ $? != 0 ] ; then
404 # Note the quotes around `$TEMP': they are essential!
431 if [ -z "$keyID" ] ; then
432 failure "You must specify the key ID of a key to add."
436 # get the key from the key server
437 gpg_authentication "--keyserver $KEYSERVER --recv-key '$keyID'"
439 # get the full fingerprint of a key ID
440 fingerprint=$(gpg_authentication "--list-key --with-colons --with-fingerprint $keyID" | \
441 grep '^fpr:' | grep "$keyID" | cut -d: -f10)
444 gpg_authentication "--fingerprint $fingerprint"
446 echo "Are you sure you want to add this key as a certifier of"
447 read -p "users on this system? (y/N) " OK; OK=${OK:-N}
448 if [ "${OK/y/Y}" != 'Y' ] ; then
452 # export the key to the host keyring
453 gpg_authentication "--export $keyID" | gpg_host --import
455 if [ "$trust" == marginal ]; then
457 elif [ "$trust" == full ]; then
460 failure "trust value requested ('$trust') was unclear (only 'marginal' or 'full' are supported)"
464 # NOTE: *all* user IDs will be ltsigned
465 ltsignCommand=$(cat <<EOF
477 echo "$ltsignCommand" | gpg_host --quiet --command-fd 0 --edit-key "$fingerprint"
479 # update the trustdb for the authentication keyring
480 gpg_authentication "--check-trustdb"
483 # delete a certifiers key from the host keyring
489 if [ -z "$keyID" ] ; then
490 failure "You must specify the key ID of a key to remove."
493 # delete the requested key (with prompting)
494 gpg_host --delete-key "$keyID"
496 # update the trustdb for the authentication keyring
497 gpg_authentication "--check-trustdb"
500 # list the host certifiers
505 # issue command to gpg-authentication keyring
506 gpg_authentication_cmd() {
507 gpg_authentication "$@"
510 ########################################################################
512 ########################################################################
514 # unset variables that should be defined only in config file
516 unset AUTHORIZED_USER_IDS
517 unset RAW_AUTHORIZED_KEYS
518 unset MONKEYSPHERE_USER
520 # load configuration file
521 [ -e ${MONKEYSPHERE_SERVER_CONFIG:="${ETC}/monkeysphere-server.conf"} ] && . "$MONKEYSPHERE_SERVER_CONFIG"
523 # set empty config variable with ones from the environment, or with
525 KEYSERVER=${MONKEYSPHERE_KEYSERVER:=${KEYSERVER:="subkeys.pgp.net"}}
526 AUTHORIZED_USER_IDS=${MONKEYSPHERE_AUTHORIZED_USER_IDS:=${AUTHORIZED_USER_IDS:="%h/.config/monkeysphere/authorized_user_ids"}}
527 RAW_AUTHORIZED_KEYS=${MONKEYSPHERE_RAW_AUTHORIZED_KEYS:=${RAW_AUTHORIZED_KEYS:="%h/.ssh/authorized_keys"}}
528 MONKEYSPHERE_USER=${MONKEYSPHERE_MONKEYSPHERE_USER:=${MONKEYSPHERE_USER:="monkeysphere"}}
531 CHECK_KEYSERVER=${MONKEYSPHERE_CHECK_KEYSERVER:="true"}
532 REQUIRED_USER_KEY_CAPABILITY=${MONKEYSPHERE_REQUIRED_USER_KEY_CAPABILITY:="a"}
533 GNUPGHOME_HOST=${MONKEYSPHERE_GNUPGHOME_HOST:="${VARLIB}/gnupg-host"}
534 GNUPGHOME_AUTHENTICATION=${MONKEYSPHERE_GNUPGHOME_AUTHENTICATION:="${VARLIB}/gnupg-authentication"}
536 # export variables needed in su invocation
539 export MONKEYSPHERE_USER
541 export CHECK_KEYSERVER
542 export REQUIRED_USER_KEY_CAPABILITY
543 export GNUPGHOME_HOST
544 export GNUPGHOME_AUTHENTICATION
549 [ "$COMMAND" ] || failure "Type '$PGRM help' for usage."
553 'update-users'|'update-user'|'u')
561 'show-fingerprint'|'f')
562 fingerprint_server_key
569 'add-identity-certifier'|'add-certifier'|'a')
573 'remove-identity-certifier'|'remove-certifier'|'r')
574 remove_certifier "$1"
577 'list-identity-certifiers'|'list-certifiers'|'list-certifier'|'l')
581 'gpg-authentication-cmd')
582 gpg_authentication_cmd "$@"
590 failure "Unknown command: '$COMMAND'
591 Type '$PGRM help' for usage."