src/monkeysphere-server

   1 #!/bin/bash
   2
   3 # monkeysphere-server: MonkeySphere server admin tool
   4 #
   5 # The monkeysphere scripts are written by:
   6 # Jameson Rollins <jrollins@fifthhorseman.net>
   7 # Jamie McClelland <jm@mayfirst.org>
   8 # Daniel Kahn Gillmor <dkg@fifthhorseman.net>
   9 #
  10 # They are Copyright 2008, and are all released under the GPL, version 3
  11 # or later.
  12
  13 ########################################################################
  14 PGRM=$(basename $0)
  15
  16 SHARE=${MONKEYSPHERE_SHARE:="/usr/share/monkeysphere"}
  17 export SHARE
  18 . "${SHARE}/common" || exit 1
  19
  20 VARLIB="/var/lib/monkeysphere"
  21 export VARLIB
  22
  23 # date in UTF format if needed
  24 DATE=$(date -u '+%FT%T')
  25
  26 # unset some environment variables that could screw things up
  27 unset GREP_OPTIONS
  28
  29 # default return code
  30 RETURN=0
  31
  32 ########################################################################
  33 # FUNCTIONS
  34 ########################################################################
  35
  36 usage() {
  37     cat <<EOF >&2
  38 usage: $PGRM <subcommand> [options] [args]
  39 MonkeySphere server admin tool.
  40
  41 subcommands:
  42  update-users (u) [USER]...          update user authorized_keys files
  43
  44  gen-key (g) [NAME[:PORT]]           generate gpg key for the server
  45    --length (-l) BITS                  key length in bits (2048)
  46    --expire (-e) EXPIRE                date to expire
  47    --revoker (-r) FINGERPRINT          add a revoker
  48  extend-key (e) EXPIRE               extend expiration to EXPIRE
  49  add-hostname (n+) NAME[:PORT]       add hostname user ID to server key
  50  revoke-hostname (n-) NAME[:PORT]    revoke hostname user ID
  51  show-key (s)                        output all server host key information
  52  publish-key (p)                     publish server host key to keyserver
  53  diagnostics (d)                     report on server monkeysphere status
  54
  55  add-id-certifier (c+) KEYID         import and tsign a certification key
  56    --domain (-n) DOMAIN                limit ID certifications to DOMAIN
  57    --trust (-t) TRUST                  trust level of certifier (full)
  58    --depth (-d) DEPTH                  trust depth for certifier (1)
  59  remove-id-certifier (c-) KEYID      remove a certification key
  60  list-id-certifiers (c)              list certification keys
  61
  62  gpg-authentication-cmd CMD          gnupg-authentication command
  63
  64  help (h,?)                          this help
  65
  66 EOF
  67 }
  68
  69 su_monkeysphere_user() {
  70     su --preserve-environment "$MONKEYSPHERE_USER" -- -c "$@"
  71 }
  72
  73 # function to interact with the host gnupg keyring
  74 gpg_host() {
  75     local returnCode
  76
  77     GNUPGHOME="$GNUPGHOME_HOST"
  78     export GNUPGHOME
  79
  80     # NOTE: we supress this warning because we need the monkeysphere
  81     # user to be able to read the host pubring.  we realize this might
  82     # be problematic, but it's the simplest solution, without too much
  83     # loss of security.
  84     gpg --no-permission-warning "$@"
  85     returnCode="$?"
  86
  87     # always reset the permissions on the host pubring so that the
  88     # monkeysphere user can read the trust signatures
  89     chgrp "$MONKEYSPHERE_USER" "${GNUPGHOME_HOST}/pubring.gpg"
  90     chmod g+r "${GNUPGHOME_HOST}/pubring.gpg"
  91
  92     return "$returnCode"
  93 }
  94
  95 # function to interact with the authentication gnupg keyring
  96 # FIXME: this function requires basically accepts only a single
  97 # argument because of problems with quote expansion.  this needs to be
  98 # fixed/improved.
  99 gpg_authentication() {
 100     GNUPGHOME="$GNUPGHOME_AUTHENTICATION"
 101     export GNUPGHOME
 102
 103     su_monkeysphere_user "gpg $@"
 104 }
 105
 106 # output just key fingerprint
 107 fingerprint_server_key() {
 108     gpg_host --list-secret-keys --fingerprint \
 109         --with-colons --fixed-list-mode 2> /dev/null | \
 110         grep '^fpr:' | head -1 | cut -d: -f10
 111 }
 112
 113 # output key information
 114 show_server_key() {
 115     local fingerprint
 116     local tmpkey
 117
 118     fingerprint=$(fingerprint_server_key)
 119     gpg_authentication "--fingerprint --list-key --list-options show-unusable-uids $fingerprint"
 120
 121     # dumping to a file named ' ' so that the ssh-keygen output
 122     # doesn't claim any potentially bogus hostname(s):
 123     tmpkey=$(mktemp -d)
 124     gpg_authentication "--export $fingerprint" | openpgp2ssh "$fingerprint" 2>/dev/null > "$tmpkey/ "
 125     echo -n "ssh fingerprint: "
 126     (cd "$tmpkey" && ssh-keygen -l -f ' ' | awk '{ print $2 }')
 127     rm -rf "$tmpkey"
 128     echo -n "OpenPGP fingerprint: "
 129     echo "$fingerprint"
 130 }
 131
 132 # update authorized_keys for users
 133 update_users() {
 134     if [ "$1" ] ; then
 135         # get users from command line
 136         unames="$@"
 137     else
 138         # or just look at all users if none specified
 139         unames=$(getent passwd | cut -d: -f1)
 140     fi
 141
 142     # set mode
 143     MODE="authorized_keys"
 144
 145     # set gnupg home
 146     GNUPGHOME="$GNUPGHOME_AUTHENTICATION"
 147
 148     # check to see if the gpg trust database has been initialized
 149     if [ ! -s "${GNUPGHOME}/trustdb.gpg" ] ; then
 150         failure "GNUPG trust database uninitialized.  Please see MONKEYSPHERE-SERVER(8)."
 151     fi
 152
 153     # make sure the authorized_keys directory exists
 154     mkdir -p "${VARLIB}/authorized_keys"
 155
 156     # loop over users
 157     for uname in $unames ; do
 158         # check all specified users exist
 159         if ! getent passwd "$uname" >/dev/null ; then
 160             log error "----- unknown user '$uname' -----"
 161             continue
 162         fi
 163
 164         # set authorized_user_ids and raw authorized_keys variables,
 165         # translating ssh-style path variables
 166         authorizedUserIDs=$(translate_ssh_variables "$uname" "$AUTHORIZED_USER_IDS")
 167         rawAuthorizedKeys=$(translate_ssh_variables "$uname" "$RAW_AUTHORIZED_KEYS")
 168
 169         # if neither is found, skip user
 170         if [ ! -s "$authorizedUserIDs" ] ; then
 171             if [ "$rawAuthorizedKeys" = '-' -o ! -s "$rawAuthorizedKeys" ] ; then
 172                 continue
 173             fi
 174         fi
 175
 176         log verbose "----- user: $uname -----"
 177
 178         # exit if the authorized_user_ids file is empty
 179         if ! check_key_file_permissions "$uname" "$AUTHORIZED_USER_IDS" ; then
 180             log error "Improper permissions on path '$AUTHORIZED_USER_IDS'."
 181             continue
 182         fi
 183
 184         # check permissions on the authorized_keys file path
 185         if ! check_key_file_permissions "$uname" "$RAW_AUTHORIZED_KEYS" ; then
 186             log error "Improper permissions on path '$RAW_AUTHORIZED_KEYS'."
 187             continue
 188         fi
 189
 190         # make temporary directory
 191         TMPDIR=$(mktemp -d)
 192
 193         # trap to delete temporary directory on exit
 194         trap "rm -rf $TMPDIR" EXIT
 195
 196         # create temporary authorized_user_ids file
 197         TMP_AUTHORIZED_USER_IDS="${TMPDIR}/authorized_user_ids"
 198         touch "$TMP_AUTHORIZED_USER_IDS"
 199
 200         # create temporary authorized_keys file
 201         AUTHORIZED_KEYS="${TMPDIR}/authorized_keys"
 202         touch "$AUTHORIZED_KEYS"
 203
 204         # set restrictive permissions on the temporary files
 205         # FIXME: is there a better way to do this?
 206         chmod 0700 "$TMPDIR"
 207         chmod 0600 "$AUTHORIZED_KEYS"
 208         chmod 0600 "$TMP_AUTHORIZED_USER_IDS"
 209         chown -R "$MONKEYSPHERE_USER" "$TMPDIR"
 210
 211         # if the authorized_user_ids file exists...
 212         if [ -s "$authorizedUserIDs" ] ; then
 213             # copy user authorized_user_ids file to temporary
 214             # location
 215             cat "$authorizedUserIDs" > "$TMP_AUTHORIZED_USER_IDS"
 216
 217             # export needed variables
 218             export AUTHORIZED_KEYS
 219             export TMP_AUTHORIZED_USER_IDS
 220
 221             # process authorized_user_ids file, as monkeysphere
 222             # user
 223             su_monkeysphere_user \
 224                 ". ${SHARE}/common; process_authorized_user_ids $TMP_AUTHORIZED_USER_IDS"
 225             RETURN="$?"
 226         fi
 227
 228         # add user-controlled authorized_keys file path if specified
 229         if [ "$rawAuthorizedKeys" != '-' -a -s "$rawAuthorizedKeys" ] ; then
 230             log verbose "adding raw authorized_keys file... "
 231             cat "$rawAuthorizedKeys" >> "$AUTHORIZED_KEYS"
 232         fi
 233
 234         # openssh appears to check the contents of the
 235         # authorized_keys file as the user in question, so the
 236         # file must be readable by that user at least.
 237         # FIXME: is there a better way to do this?
 238         chown root "$AUTHORIZED_KEYS"
 239         chgrp $(getent passwd "$uname" | cut -f4 -d:) "$AUTHORIZED_KEYS"
 240         chmod g+r "$AUTHORIZED_KEYS"
 241
 242         # move the resulting authorized_keys file into place
 243         mv -f "$AUTHORIZED_KEYS" "${VARLIB}/authorized_keys/${uname}"
 244
 245         # destroy temporary directory
 246         rm -rf "$TMPDIR"
 247     done
 248 }
 249
 250 # generate server gpg key
 251 gen_key() {
 252     local keyType
 253     local keyLength
 254     local keyUsage
 255     local keyExpire
 256     local revoker
 257     local hostName
 258     local userID
 259     local keyParameters
 260     local fingerprint
 261
 262     # set default key parameter values
 263     keyType="RSA"
 264     keyLength="2048"
 265     keyUsage="auth"
 266     keyExpire=
 267     revoker=
 268
 269     # get options
 270     TEMP=$(getopt -o e:l:r -l expire:,length:,revoker: -n "$PGRM" -- "$@")
 271
 272     if [ $? != 0 ] ; then
 273         exit 1
 274     fi
 275
 276     # Note the quotes around `$TEMP': they are essential!
 277     eval set -- "$TEMP"
 278
 279     while true ; do
 280         case "$1" in
 281             -l|--length)
 282                 keyLength="$2"
 283                 shift 2
 284                 ;;
 285             -e|--expire)
 286                 keyExpire="$2"
 287                 shift 2
 288                 ;;
 289             -r|--revoker)
 290                 revoker="$2"
 291                 shift 2
 292                 ;;
 293             --)
 294                 shift
 295                 ;;
 296             *)
 297                 break
 298                 ;;
 299         esac
 300     done
 301
 302     hostName=${1:-$(hostname --fqdn)}
 303     userID="ssh://${hostName}"
 304
 305     # check for presense of key with user ID
 306     if gpg_host --list-key ="$userID" > /dev/null 2>&1 ; then
 307         failure "Key for '$userID' already exists"
 308     fi
 309
 310     # prompt about key expiration if not specified
 311     keyExpire=$(get_gpg_expiration "$keyExpire")
 312
 313     # set key parameters
 314     keyParameters=$(cat <<EOF
 315 Key-Type: $keyType
 316 Key-Length: $keyLength
 317 Key-Usage: $keyUsage
 318 Name-Real: $userID
 319 Expire-Date: $keyExpire
 320 EOF
 321 )
 322
 323     # add the revoker field if specified
 324     # FIXME: the "1:" below assumes that $REVOKER's key is an RSA key.
 325     # FIXME: key is marked "sensitive"?  is this appropriate?
 326     if [ "$revoker" ] ; then
 327         keyParameters="${keyParameters}"$(cat <<EOF
 328 Revoker: 1:$revoker sensitive
 329 EOF
 330 )
 331     fi
 332
 333     echo "The following key parameters will be used for the host private key:"
 334     echo "$keyParameters"
 335
 336     read -p "Generate key? (Y/n) " OK; OK=${OK:=Y}
 337     if [ ${OK/y/Y} != 'Y' ] ; then
 338         failure "aborting."
 339     fi
 340
 341     # add commit command
 342     keyParameters="${keyParameters}"$(cat <<EOF
 343
 344 %commit
 345 %echo done
 346 EOF
 347 )
 348
 349     log verbose "generating server key..."
 350     echo "$keyParameters" | gpg_host --batch --gen-key
 351
 352     # output the server fingerprint
 353     fingerprint_server_key "=${userID}"
 354
 355     # find the key fingerprint of the newly generated key
 356     fingerprint=$(fingerprint_server_key)
 357
 358     # export host ownertrust to authentication keyring
 359     log verbose "setting ultimate owner trust for server key..."
 360     echo "${fingerprint}:6:" | gpg_authentication "--import-ownertrust"
 361
 362     # translate the private key to ssh format, and export to a file
 363     # for sshs usage.
 364     # NOTE: assumes that the primary key is the proper key to use
 365     (umask 077 && \
 366         gpg_host --export-secret-key "$fingerprint" | \
 367         openpgp2ssh "$fingerprint" > "${VARLIB}/ssh_host_rsa_key")
 368     log info "Private SSH host key output to file: ${VARLIB}/ssh_host_rsa_key"
 369 }
 370
 371 # extend the lifetime of a host key:
 372 extend_key() {
 373     local fpr=$(fingerprint_server_key)
 374     local extendTo="$1"
 375
 376     if [ -z "$fpr" ] ; then
 377         failure "You don't appear to have a MonkeySphere host key on this server.  Try 'monkeysphere-server gen-key' first."
 378     fi
 379
 380     # get the new expiration date
 381     extendTo=$(get_gpg_expiration "$extendTo")
 382
 383     gpg_host --quiet --command-fd 0 --edit-key "$fpr" <<EOF
 384 expire
 385 $extendTo
 386 save
 387 EOF
 388
 389     echo
 390     echo "NOTE: Host key expiration date adjusted, but not yet published."
 391     echo "Run '$PGRM publish-key' to publish the new expiration date."
 392 }
 393
 394 # add hostname user ID to server key
 395 add_hostname() {
 396     local userID
 397     local fingerprint
 398     local tmpuidMatch
 399     local line
 400     local adduidCommand
 401
 402     if [ -z "$1" ] ; then
 403         failure "You must specify a hostname to add."
 404     fi
 405
 406     userID="ssh://${1}"
 407
 408     fingerprint=$(fingerprint_server_key)
 409
 410     # match to only ultimately trusted user IDs
 411     tmpuidMatch="u:$(echo $userID | gpg_escape)"
 412
 413     # find the index of the requsted user ID
 414     # NOTE: this is based on circumstantial evidence that the order of
 415     # this output is the appropriate index
 416     if line=$(gpg_host --list-keys --with-colons --fixed-list-mode "0x${fingerprint}!" \
 417         | egrep '^(uid|uat):' | cut -f2,10 -d: | grep -n -x -F "$tmpuidMatch") ; then
 418         failure "Host userID '$userID' already exists."
 419     fi
 420
 421     echo "The following user ID will be added to the host key:"
 422     echo "  $userID"
 423     read -p "Are you sure you would like to add this user ID? (y/N) " OK; OK=${OK:=N}
 424     if [ ${OK/y/Y} != 'Y' ] ; then
 425         failure "User ID not added."
 426     fi
 427
 428     # edit-key script command to add user ID
 429     adduidCommand=$(cat <<EOF
 430 adduid
 431 $userID
 432
 433
 434 save
 435 EOF
 436         )
 437
 438     # execute edit-key script
 439     if echo "$adduidCommand" | \
 440         gpg_host --quiet --command-fd 0 --edit-key "0x${fingerprint}!" ; then
 441
 442         # update the trustdb for the authentication keyring
 443         gpg_authentication "--check-trustdb"
 444
 445         show_server_key
 446
 447         echo
 448         echo "NOTE: User ID added to key, but key not published."
 449         echo "Run '$PGRM publish-key' to publish the new user ID."
 450     else
 451         failure "Problem adding user ID."
 452     fi
 453 }
 454
 455 # revoke hostname user ID to server key
 456 revoke_hostname() {
 457     local userID
 458     local fingerprint
 459     local tmpuidMatch
 460     local line
 461     local uidIndex
 462     local message
 463     local revuidCommand
 464
 465     if [ -z "$1" ] ; then
 466         failure "You must specify a hostname to revoke."
 467     fi
 468
 469     echo "WARNING: There is a known bug in this function."
 470     echo "This function has been known to occasionally revoke the wrong user ID."
 471     echo "Please see the following bug report for more information:"
 472     echo "http://web.monkeysphere.info/bugs/revoke-hostname-revoking-wrong-userid/"
 473     read -p "Are you sure you would like to proceed? (y/N) " OK; OK=${OK:=N}
 474     if [ ${OK/y/Y} != 'Y' ] ; then
 475         failure "aborting."
 476     fi
 477
 478     userID="ssh://${1}"
 479
 480     fingerprint=$(fingerprint_server_key)
 481
 482     # match to only ultimately trusted user IDs
 483     tmpuidMatch="u:$(echo $userID | gpg_escape)"
 484
 485     # find the index of the requsted user ID
 486     # NOTE: this is based on circumstantial evidence that the order of
 487     # this output is the appropriate index
 488     if line=$(gpg_host --list-keys --with-colons --fixed-list-mode "0x${fingerprint}!" \
 489         | egrep '^(uid|uat):' | cut -f2,10 -d: | grep -n -x -F "$tmpuidMatch") ; then
 490         uidIndex=${line%%:*}
 491     else
 492         failure "No non-revoked user ID '$userID' is found."
 493     fi
 494
 495     echo "The following host key user ID will be revoked:"
 496     echo "  $userID"
 497     read -p "Are you sure you would like to revoke this user ID? (y/N) " OK; OK=${OK:=N}
 498     if [ ${OK/y/Y} != 'Y' ] ; then
 499         failure "User ID not revoked."
 500     fi
 501
 502     message="Hostname removed by monkeysphere-server $DATE"
 503
 504     # edit-key script command to revoke user ID
 505     revuidCommand=$(cat <<EOF
 506 $uidIndex
 507 revuid
 508 y
 509 4
 510 $message
 511
 512 y
 513 save
 514 EOF
 515         )
 516
 517     # execute edit-key script
 518     if echo "$revuidCommand" | \
 519         gpg_host --quiet --command-fd 0 --edit-key "0x${fingerprint}!" ; then
 520
 521         # update the trustdb for the authentication keyring
 522         gpg_authentication "--check-trustdb"
 523
 524         show_server_key
 525
 526         echo
 527         echo "NOTE: User ID revoked, but revocation not published."
 528         echo "Run '$PGRM publish-key' to publish the revocation."
 529     else
 530         failure "Problem revoking user ID."
 531     fi
 532 }
 533
 534 # publish server key to keyserver
 535 publish_server_key() {
 536     read -p "Really publish host key to $KEYSERVER? (y/N) " OK; OK=${OK:=N}
 537     if [ ${OK/y/Y} != 'Y' ] ; then
 538         failure "key not published."
 539     fi
 540
 541     # find the key fingerprint
 542     fingerprint=$(fingerprint_server_key)
 543
 544     # publish host key
 545     gpg_authentication "--keyserver $KEYSERVER --send-keys '0x${fingerprint}!'"
 546 }
 547
 548 diagnostics() {
 549 #  * check on the status and validity of the key and public certificates
 550     local seckey
 551     local keysfound
 552     local curdate
 553     local warnwindow
 554     local warndate
 555     local create
 556     local expire
 557     local uid
 558     local fingerprint
 559     local badhostkeys
 560     local sshd_config
 561
 562     # FIXME: what's the correct, cross-platform answer?
 563     sshd_config=/etc/ssh/sshd_config
 564     seckey=$(gpg_host --list-secret-keys --fingerprint --with-colons --fixed-list-mode)
 565     keysfound=$(echo "$seckey" | grep -c ^sec:)
 566     curdate=$(date +%s)
 567     # warn when anything is 2 months away from expiration
 568     warnwindow='2 months'
 569     warndate=$(date +%s -d "$warnwindow")
 570
 571     if ! id monkeysphere >/dev/null ; then
 572         echo "! No monkeysphere user found!  Please create a monkeysphere system user."
 573     fi
 574
 575     echo "Checking host GPG key..."
 576     if (( "$keysfound" < 1 )); then
 577         echo "! No host key found."
 578         echo " - Recommendation: run 'monkeysphere-server gen-key'"
 579     elif (( "$keysfound" > 1 )); then
 580         echo "! More than one host key found?"
 581         # FIXME: recommend a way to resolve this
 582     else
 583         create=$(echo "$seckey" | grep ^sec: | cut -f6 -d:)
 584         expire=$(echo "$seckey" | grep ^sec: | cut -f7 -d:)
 585         fingerprint=$(echo "$seckey" | grep ^fpr: | head -n1 | cut -f10 -d:)
 586         # check for key expiration:
 587         if [ "$expire" ]; then
 588             if (( "$expire"  < "$curdate" )); then
 589                 echo "! Host key is expired."
 590                 echo " - Recommendation: extend lifetime of key with 'monkeysphere-server extend-key'"
 591             elif (( "$expire" < "$warndate" )); then
 592                 echo "! Host key expires in less than $warnwindow:" $(date -d "$(( $expire - $curdate )) seconds" +%F)
 593                 echo " - Recommendation: extend lifetime of key with 'monkeysphere-server extend-key'"
 594             fi
 595         fi
 596
 597         # and weirdnesses:
 598         if [ "$create" ] && (( "$create" > "$curdate" )); then
 599             echo "! Host key was created in the future(?!). Is your clock correct?"
 600             echo " - Recommendation: Check clock ($(date +%F_%T)); use NTP?"
 601         fi
 602
 603         # check for UserID expiration:
 604         echo "$seckey" | grep ^uid: | cut -d: -f6,7,10 | \
 605         while IFS=: read create expire uid ; do
 606             # FIXME: should we be doing any checking on the form
 607             # of the User ID?  Should we be unmangling it somehow?
 608
 609             if [ "$create" ] && (( "$create" > "$curdate" )); then
 610                 echo "! User ID '$uid' was created in the future(?!).  Is your clock correct?"
 611                 echo " - Recommendation: Check clock ($(date +%F_%T)); use NTP?"
 612             fi
 613             if [ "$expire" ] ; then
 614                 if (( "$expire" < "$curdate" )); then
 615                     echo "! User ID '$uid' is expired."
 616                         # FIXME: recommend a way to resolve this
 617                 elif (( "$expire" < "$warndate" )); then
 618                     echo "! User ID '$uid' expires in less than $warnwindow:" $(date -d "$(( $expire - $curdate )) seconds" +%F)
 619                     # FIXME: recommend a way to resolve this
 620                 fi
 621             fi
 622         done
 623
 624 # FIXME: verify that the host key is properly published to the
 625 #   keyservers (do this with the non-privileged user)
 626
 627 # FIXME: check that there are valid, non-expired certifying signatures
 628 #   attached to the host key after fetching from the public keyserver
 629 #   (do this with the non-privileged user as well)
 630
 631 # FIXME: propose adding a revoker to the host key if none exist (do we
 632 #   have a way to do that after key generation?)
 633
 634         # Ensure that the ssh_host_rsa_key file is present and non-empty:
 635         echo
 636         echo "Checking host SSH key..."
 637         if [ ! -s "${VARLIB}/ssh_host_rsa_key" ] ; then
 638             echo "! The host key as prepared for SSH (${VARLIB}/ssh_host_rsa_key) is missing or empty."
 639         else
 640             if [ $(stat -c '%a' "${VARLIB}/ssh_host_rsa_key") != 600 ] ; then
 641                 echo "! Permissions seem wrong for ${VARLIB}/ssh_host_rsa_key -- should be 0600."
 642             fi
 643
 644             # propose changes needed for sshd_config (if any)
 645             if ! grep -q "^HostKey[[:space:]]\+${VARLIB}/ssh_host_rsa_key$" "$sshd_config"; then
 646                 echo "! $sshd_config does not point to the monkeysphere host key (${VARLIB}/ssh_host_rsa_key)."
 647                 echo " - Recommendation: add a line to $sshd_config: 'HostKey ${VARLIB}/ssh_host_rsa_key'"
 648             fi
 649             if badhostkeys=$(grep -i '^HostKey' "$sshd_config" | grep -q -v "^HostKey[[:space:]]\+${VARLIB}/ssh_host_rsa_key$") ; then
 650                 echo "! $sshd_config refers to some non-monkeysphere host keys:"
 651                 echo "$badhostkeys"
 652                 echo " - Recommendation: remove the above HostKey lines from $sshd_config"
 653             fi
 654         fi
 655     fi
 656
 657 # FIXME: look at the ownership/privileges of the various keyrings,
 658 #    directories housing them, etc (what should those values be?  can
 659 #    we make them as minimal as possible?)
 660
 661 # FIXME: look to see that the ownertrust rules are set properly on the
 662 #    authentication keyring
 663
 664 # FIXME:  make sure that at least one identity certifier exists
 665
 666     echo
 667     echo "Checking for MonkeySphere-enabled public-key authentication for users ..."
 668     # Ensure that User ID authentication is enabled:
 669     if ! grep -q "^AuthorizedKeysFile[[:space:]]\+${VARLIB}/authorized_keys/%u$" "$sshd_config"; then
 670         echo "! $sshd_config does not point to monkeysphere authorized keys."
 671         echo " - Recommendation: add a line to $sshd_config: 'AuthorizedKeysFile ${VARLIB}/authorized_keys/%u'"
 672     fi
 673     if badauthorizedkeys=$(grep -i '^AuthorizedKeysFile' "$sshd_config" | grep -q -v "^AuthorizedKeysFile[[:space:]]\+${VARLIB}/authorized_keys/%u$") ; then
 674         echo "! $sshd_config refers to non-monkeysphere authorized_keys files:"
 675         echo "$badauthorizedkeys"
 676         echo " - Recommendation: remove the above AuthorizedKeysFile lines from $sshd_config"
 677     fi
 678 }
 679
 680 # retrieve key from web of trust, import it into the host keyring, and
 681 # ltsign the key in the host keyring so that it may certify other keys
 682 add_certifier() {
 683     local domain
 684     local trust
 685     local depth
 686     local keyID
 687     local fingerprint
 688     local ltsignCommand
 689     local trustval
 690
 691     # set default values for trust depth and domain
 692     domain=
 693     trust=full
 694     depth=1
 695
 696     # get options
 697     TEMP=$(getopt -o n:t:d: -l domain:,trust:,depth: -n "$PGRM" -- "$@")
 698
 699     if [ $? != 0 ] ; then
 700         exit 1
 701     fi
 702
 703     # Note the quotes around `$TEMP': they are essential!
 704     eval set -- "$TEMP"
 705
 706     while true ; do
 707         case "$1" in
 708             -n|--domain)
 709                 domain="$2"
 710                 shift 2
 711                 ;;
 712             -t|--trust)
 713                 trust="$2"
 714                 shift 2
 715                 ;;
 716             -d|--depth)
 717                 depth="$2"
 718                 shift 2
 719                 ;;
 720             --)
 721                 shift
 722                 ;;
 723             *)
 724                 break
 725                 ;;
 726         esac
 727     done
 728
 729     keyID="$1"
 730     if [ -z "$keyID" ] ; then
 731         failure "You must specify the key ID of a key to add."
 732     fi
 733     export keyID
 734
 735     # get the key from the key server
 736     gpg_authentication "--keyserver $KEYSERVER --recv-key '0x${keyID}!'"
 737
 738     # get the full fingerprint of a key ID
 739     fingerprint=$(gpg_authentication "--list-key --with-colons --with-fingerprint 0x${keyID}!" | \
 740         grep '^fpr:' | grep "$keyID" | cut -d: -f10)
 741
 742     if [ -z "$fingerprint" ] ; then
 743         failure "Key '$keyID' not found."
 744     fi
 745
 746     echo
 747     echo "key found:"
 748     gpg_authentication "--fingerprint 0x${fingerprint}!"
 749
 750     echo "Are you sure you want to add the above key as a"
 751     read -p "certifier of users on this system? (y/N) " OK; OK=${OK:-N}
 752     if [ "${OK/y/Y}" != 'Y' ] ; then
 753         failure "Identity certifier not added."
 754     fi
 755
 756     # export the key to the host keyring
 757     gpg_authentication "--export 0x${fingerprint}!" | gpg_host --import
 758
 759     if [ "$trust" == marginal ]; then
 760         trustval=1
 761     elif [ "$trust" == full ]; then
 762         trustval=2
 763     else
 764         failure "Trust value requested ('$trust') was unclear (only 'marginal' or 'full' are supported)."
 765     fi
 766
 767     # ltsign command
 768     # NOTE: *all* user IDs will be ltsigned
 769     ltsignCommand=$(cat <<EOF
 770 ltsign
 771 y
 772 $trustval
 773 $depth
 774 $domain
 775 y
 776 save
 777 EOF
 778         )
 779
 780     # ltsign the key
 781     if echo "$ltsignCommand" | \
 782         gpg_host --quiet --command-fd 0 --edit-key "0x${fingerprint}!" ; then
 783
 784         # update the trustdb for the authentication keyring
 785         gpg_authentication "--check-trustdb"
 786
 787         echo
 788         echo "Identity certifier added."
 789     else
 790         failure "Problem adding identify certifier."
 791     fi
 792 }
 793
 794 # delete a certifiers key from the host keyring
 795 remove_certifier() {
 796     local keyID
 797     local fingerprint
 798
 799     keyID="$1"
 800     if [ -z "$keyID" ] ; then
 801         failure "You must specify the key ID of a key to remove."
 802     fi
 803
 804     if gpg_authentication "--no-options --list-options show-uid-validity --keyring ${GNUPGHOME_AUTHENTICATION}/pubring.gpg --list-key 0x${keyID}!" ; then
 805         read -p "Really remove above listed identity certifier? (y/N) " OK; OK=${OK:-N}
 806         if [ "${OK/y/Y}" != 'Y' ] ; then
 807             failure "Identity certifier not removed."
 808         fi
 809     else
 810         failure
 811     fi
 812
 813     # delete the requested key
 814     if gpg_authentication "--delete-key --batch --yes 0x${keyID}!" ; then
 815         # delete key from host keyring as well
 816         gpg_host --delete-key --batch --yes "0x${keyID}!"
 817
 818         # update the trustdb for the authentication keyring
 819         gpg_authentication "--check-trustdb"
 820
 821         echo
 822         echo "Identity certifier removed."
 823     else
 824         failure "Problem removing identity certifier."
 825     fi
 826 }
 827
 828 # list the host certifiers
 829 list_certifiers() {
 830     local keys
 831     local key
 832
 833     # find trusted keys in authentication keychain
 834     keys=$(gpg_authentication "--no-options --list-options show-uid-validity --keyring ${GNUPGHOME_AUTHENTICATION}/pubring.gpg --list-keys --with-colons --fingerprint" | \
 835         grep ^pub: | cut -d: -f2,5 | egrep '^(u|f):' | cut -d: -f2)
 836
 837     # output keys
 838     for key in $keys ; do
 839         gpg_authentication "--no-options --list-options show-uid-validity --keyring ${GNUPGHOME_AUTHENTICATION}/pubring.gpg --list-key --fingerprint $key"
 840     done
 841 }
 842
 843 # issue command to gpg-authentication keyring
 844 gpg_authentication_cmd() {
 845     gpg_authentication "$@"
 846 }
 847
 848 ########################################################################
 849 # MAIN
 850 ########################################################################
 851
 852 # unset variables that should be defined only in config file
 853 unset KEYSERVER
 854 unset AUTHORIZED_USER_IDS
 855 unset RAW_AUTHORIZED_KEYS
 856 unset MONKEYSPHERE_USER
 857
 858 # load configuration file
 859 [ -e ${MONKEYSPHERE_SERVER_CONFIG:="${ETC}/monkeysphere-server.conf"} ] && . "$MONKEYSPHERE_SERVER_CONFIG"
 860
 861 # set empty config variable with ones from the environment, or with
 862 # defaults
 863 LOG_LEVEL=${MONKEYSPHERE_LOG_LEVEL:=${LOG_LEVEL:="INFO"}}
 864 KEYSERVER=${MONKEYSPHERE_KEYSERVER:=${KEYSERVER:="subkeys.pgp.net"}}
 865 AUTHORIZED_USER_IDS=${MONKEYSPHERE_AUTHORIZED_USER_IDS:=${AUTHORIZED_USER_IDS:="%h/.monkeysphere/authorized_user_ids"}}
 866 RAW_AUTHORIZED_KEYS=${MONKEYSPHERE_RAW_AUTHORIZED_KEYS:=${RAW_AUTHORIZED_KEYS:="%h/.ssh/authorized_keys"}}
 867 MONKEYSPHERE_USER=${MONKEYSPHERE_MONKEYSPHERE_USER:=${MONKEYSPHERE_USER:="monkeysphere"}}
 868
 869 # other variables
 870 CHECK_KEYSERVER=${MONKEYSPHERE_CHECK_KEYSERVER:="true"}
 871 REQUIRED_USER_KEY_CAPABILITY=${MONKEYSPHERE_REQUIRED_USER_KEY_CAPABILITY:="a"}
 872 GNUPGHOME_HOST=${MONKEYSPHERE_GNUPGHOME_HOST:="${VARLIB}/gnupg-host"}
 873 GNUPGHOME_AUTHENTICATION=${MONKEYSPHERE_GNUPGHOME_AUTHENTICATION:="${VARLIB}/gnupg-authentication"}
 874
 875 # export variables needed in su invocation
 876 export DATE
 877 export MODE
 878 export MONKEYSPHERE_USER
 879 export LOG_LEVEL
 880 export KEYSERVER
 881 export CHECK_KEYSERVER
 882 export REQUIRED_USER_KEY_CAPABILITY
 883 export GNUPGHOME_HOST
 884 export GNUPGHOME_AUTHENTICATION
 885 export GNUPGHOME
 886
 887 # get subcommand
 888 COMMAND="$1"
 889 [ "$COMMAND" ] || failure "Type '$PGRM help' for usage."
 890 shift
 891
 892 case $COMMAND in
 893     'update-users'|'update-user'|'u')
 894         update_users "$@"
 895         ;;
 896
 897     'gen-key'|'g')
 898         gen_key "$@"
 899         ;;
 900
 901     'extend-key'|'e')
 902         extend_key "$@"
 903         ;;
 904
 905     'add-hostname'|'add-name'|'n+')
 906         add_hostname "$@"
 907         ;;
 908
 909     'revoke-hostname'|'revoke-name'|'n-')
 910         revoke_hostname "$@"
 911         ;;
 912
 913     'show-key'|'show'|'s')
 914         show_server_key
 915         ;;
 916
 917     'publish-key'|'publish'|'p')
 918         publish_server_key
 919         ;;
 920
 921     'diagnostics'|'d')
 922         diagnostics
 923         ;;
 924
 925     'add-identity-certifier'|'add-id-certifier'|'add-certifier'|'c+')
 926         add_certifier "$@"
 927         ;;
 928
 929     'remove-identity-certifier'|'remove-id-certifier'|'remove-certifier'|'c-')
 930         remove_certifier "$@"
 931         ;;
 932
 933     'list-identity-certifiers'|'list-id-certifiers'|'list-certifiers'|'list-certifier'|'c')
 934         list_certifiers "$@"
 935         ;;
 936
 937     'gpg-authentication-cmd')
 938         gpg_authentication_cmd "$@"
 939         ;;
 940
 941     '--help'|'help'|'-h'|'h'|'?')
 942         usage
 943         ;;
 944
 945     *)
 946         failure "Unknown command: '$COMMAND'
 947 Type '$PGRM help' for usage."
 948         ;;
 949 esac
 950
 951 exit "$RETURN"