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 #
   8 # They are Copyright 2008, and are all released under the GPL, version 3
   9 # or later.
  10
  11 ########################################################################
  12 PGRM=$(basename $0)
  13
  14 SHAREDIR=${SHAREDIR:-"/usr/share/monkeysphere"}
  15 export SHAREDIR
  16 . "${SHAREDIR}/common"
  17
  18 # date in UTF format if needed
  19 DATE=$(date -u '+%FT%T')
  20
  21 # unset some environment variables that could screw things up
  22 GREP_OPTIONS=
  23
  24 ########################################################################
  25 # FUNCTIONS
  26 ########################################################################
  27
  28 usage() {
  29 cat <<EOF
  30 usage: $PGRM <subcommand> [args]
  31 MonkeySphere server admin tool.
  32
  33 subcommands:
  34   update-users (s) [USER]...            update users authorized_keys files
  35   gen-key (g) [HOSTNAME]                generate gpg key for the server
  36   publish-key (p)                       publish server key to keyserver
  37   trust-keys (t) KEYID...               mark keyids as trusted
  38   update-user-userids (u) USER UID...   add/update user IDs for a user
  39   remove-user-userids (r) USER UID...   remove user IDs for a user
  40   help (h,?)                            this help
  41
  42 EOF
  43 }
  44
  45 # generate server gpg key
  46 gen_key() {
  47     local hostName
  48
  49     hostName=${1:-$(hostname --fqdn)}
  50
  51     # set key defaults
  52     KEY_TYPE=${KEY_TYPE:-"RSA"}
  53     KEY_LENGTH=${KEY_LENGTH:-"2048"}
  54     KEY_USAGE=${KEY_USAGE:-"auth,encrypt"}
  55     cat <<EOF
  56 Please specify how long the key should be valid.
  57          0 = key does not expire
  58       <n>  = key expires in n days
  59       <n>w = key expires in n weeks
  60       <n>m = key expires in n months
  61       <n>y = key expires in n years
  62 EOF
  63     read -p "Key is valid for? ($EXPIRE) " EXPIRE; EXPIRE=${EXPIRE:-"0"}
  64
  65     SERVICE=${SERVICE:-"ssh"}
  66     USERID=${USERID:-"$SERVICE"://"$hostName"}
  67
  68     # set key parameters
  69     keyParameters=$(cat <<EOF
  70 Key-Type: $KEY_TYPE
  71 Key-Length: $KEY_LENGTH
  72 Key-Usage: $KEY_USAGE
  73 Name-Real: $USERID
  74 Expire-Date: $EXPIRE
  75 EOF
  76 )
  77
  78     # add the revoker field if requested
  79     if [ "$REVOKER" ] ; then
  80         keyParameters="${keyParameters}"$(cat <<EOF
  81
  82 Revoker: 1:$REVOKER sensitive
  83 EOF
  84 )
  85     fi
  86
  87     echo "The following key parameters will be used:"
  88     echo "$keyParameters"
  89
  90     read -p "generate key? [Y|n]: " OK; OK=${OK:=Y}
  91     if [ ${OK/y/Y} != 'Y' ] ; then
  92         failure "aborting."
  93     fi
  94
  95     if gpg --list-key ="$USERID" > /dev/null 2>&1 ; then
  96         failure "key for '$USERID' already exists"
  97     fi
  98
  99     # add commit command
 100     keyParameters="${keyParameters}"$(cat <<EOF
 101
 102 %commit
 103 %echo done
 104 EOF
 105 )
 106
 107     log -n "generating server key... "
 108     echo "$keyParameters" | gpg --batch --gen-key
 109     loge "done."
 110 }
 111
 112 ########################################################################
 113 # MAIN
 114 ########################################################################
 115
 116 COMMAND="$1"
 117 [ "$COMMAND" ] || failure "Type '$PGRM help' for usage."
 118 shift
 119
 120 # set ms home directory
 121 MS_HOME=${MS_HOME:-"$ETC"}
 122
 123 # load configuration file
 124 MS_CONF=${MS_CONF:-"$MS_HOME"/monkeysphere-server.conf}
 125 [ -e "$MS_CONF" ] && . "$MS_CONF"
 126
 127 # set empty config variable with defaults
 128 GNUPGHOME=${GNUPGHOME:-"${MS_HOME}/gnupg"}
 129 KEYSERVER=${KEYSERVER:-"subkeys.pgp.net"}
 130 CHECK_KEYSERVER=${CHECK_KEYSERVER:="true"}
 131 REQUIRED_USER_KEY_CAPABILITY=${REQUIRED_USER_KEY_CAPABILITY:-"a"}
 132 USER_CONTROLLED_AUTHORIZED_KEYS=${USER_CONTROLLED_AUTHORIZED_KEYS:-"%h/.ssh/authorized_keys"}
 133
 134 export GNUPGHOME
 135
 136 # make sure the monkeysphere home directory exists
 137 mkdir -p "${MS_HOME}/authorized_user_ids"
 138 # make sure gpg home exists with proper permissions
 139 mkdir -p -m 0700 "$GNUPGHOME"
 140 # make sure the authorized_keys directory exists
 141 mkdir -p "${CACHE}/authorized_keys"
 142
 143 case $COMMAND in
 144     'update-users'|'update-user'|'s')
 145         if [ "$1" ] ; then
 146             unames="$@"
 147         else
 148             unames=$(ls -1 "${MS_HOME}/authorized_user_ids")
 149         fi
 150
 151         for uname in $unames ; do
 152             MODE="authorized_keys"
 153
 154             log "----- user: $uname -----"
 155
 156             # set variables for the user
 157             AUTHORIZED_USER_IDS="${MS_HOME}/authorized_user_ids/${uname}"
 158             # temporary authorized_keys file
 159             AUTHORIZED_KEYS="${CACHE}/authorized_keys/${uname}.tmp"
 160
 161             # make sure user's authorized_user_ids file exists
 162             touch "$AUTHORIZED_USER_IDS"
 163             # make sure the authorized_keys file exists and is clear
 164             > "$AUTHORIZED_KEYS"
 165
 166             # skip if the user's authorized_user_ids file is empty
 167             if [ ! -s "$AUTHORIZED_USER_IDS" ] ; then
 168                 log "authorized_user_ids file for '$uname' is empty."
 169                 continue
 170             fi
 171
 172             # process authorized_user_ids file
 173             log "processing authorized_user_ids file..."
 174             process_authorized_user_ids
 175
 176             # add user-controlled authorized_keys file path if specified
 177             if [ "$USER_CONTROLLED_AUTHORIZED_KEYS" != '-' ] ; then
 178                 userHome=$(getent passwd "$uname" | cut -d: -f6)
 179                 userAuthorizedKeys=${USER_CONTROLLED_AUTHORIZED_KEYS/\%h/"$userHome"}
 180                 log -n "adding user's authorized_keys file... "
 181                 cat "$userAuthorizedKeys" >> "$AUTHORIZED_KEYS"
 182                 loge "done."
 183             fi
 184
 185             # move the temp authorized_keys file into place
 186             mv -f "${CACHE}/authorized_keys/${uname}.tmp" "${CACHE}/authorized_keys/${uname}"
 187
 188             log "authorized_keys file updated."
 189         done
 190
 191         log "----- done. -----"
 192         ;;
 193
 194     'gen-key'|'g')
 195         gen_key "$1"
 196         ;;
 197
 198     'publish-key'|'p')
 199         publish_server_key
 200         ;;
 201
 202     'trust-keys'|'trust-key'|'t')
 203         if [ -z "$1" ] ; then
 204             failure "You must specify at least one key to trust."
 205         fi
 206
 207         # process key IDs
 208         for keyID ; do
 209             trust_key "$keyID"
 210         done
 211         ;;
 212
 213     'update-user-userids'|'update-user-userid'|'u')
 214         uname="$1"
 215         shift
 216         if [ -z "$uname" ] ; then
 217             failure "You must specify user."
 218         fi
 219         if [ -z "$1" ] ; then
 220             failure "You must specify at least one user ID."
 221         fi
 222
 223         # set variables for the user
 224         AUTHORIZED_USER_IDS="$MS_HOME"/authorized_user_ids/"$uname"
 225
 226         # make sure user's authorized_user_ids file exists
 227         touch "$AUTHORIZED_USER_IDS"
 228
 229         # process the user IDs
 230         for userID ; do
 231             update_userid "$userID"
 232         done
 233
 234         log "Run the following to update user's authorized_keys file:"
 235         log "$PGRM update-users $uname"
 236         ;;
 237
 238     'remove-user-userids'|'remove-user-userid'|'r')
 239         uname="$1"
 240         shift
 241         if [ -z "$uname" ] ; then
 242             failure "You must specify user."
 243         fi
 244         if [ -z "$1" ] ; then
 245             failure "You must specify at least one user ID."
 246         fi
 247
 248         # set variables for the user
 249         AUTHORIZED_USER_IDS="$MS_HOME"/authorized_user_ids/"$uname"
 250
 251         # make sure user's authorized_user_ids file exists
 252         touch "$AUTHORIZED_USER_IDS"
 253
 254         # process the user IDs
 255         for userID ; do
 256             remove_userid "$userID"
 257         done
 258
 259         log "Run the following to update user's authorized_keys file:"
 260         log "$PGRM update-users $uname"
 261         ;;
 262
 263     'help'|'h'|'?')
 264         usage
 265         ;;
 266
 267     *)
 268         failure "Unknown command: '$COMMAND'
 269 Type '$PGRM help' for usage."
 270         ;;
 271 esac