3 # monkeysphere-host: Monkeysphere host admin tool
5 # The monkeysphere scripts are written by:
6 # Jameson Rollins <jrollins@finestructure.net>
7 # Jamie McClelland <jm@mayfirst.org>
8 # Daniel Kahn Gillmor <dkg@fifthhorseman.net>
9 # Micah Anderson <micah@riseup.net>
11 # They are Copyright 2008-2009, and are all released under the GPL,
14 ########################################################################
17 # set the pipefail option so pipelines fail on first command failure
22 SYSSHAREDIR=${MONKEYSPHERE_SYSSHAREDIR:-"/usr/share/monkeysphere"}
24 . "${SYSSHAREDIR}/common" || exit 1
26 SYSDATADIR=${MONKEYSPHERE_SYSDATADIR:-"/var/lib/monkeysphere"}
29 # sharedir for host functions
30 MHSHAREDIR="${SYSSHAREDIR}/mh"
32 # datadir for host functions
33 MHDATADIR="${SYSDATADIR}/host"
35 # temp directory for temp gnupghome directories for add_revoker
36 MHTMPDIR="${MHDATADIR}/tmp"
40 HOST_KEY_FILE="${SYSDATADIR}/ssh_host_rsa_key.pub.gpg"
42 # UTC date in ISO 8601 format if needed
43 DATE=$(date -u '+%FT%T')
45 # unset some environment variables that could screw things up
51 ########################################################################
53 ########################################################################
57 usage: $PGRM <subcommand> [options] [args]
58 Monkeysphere host admin tool.
61 show-key (s) output all host key information
62 set-expire (e) EXPIRE set host key expiration
63 add-hostname (n+) NAME[:PORT] add hostname user ID to host key
64 revoke-hostname (n-) NAME[:PORT] revoke hostname user ID
65 add-revoker (o) FINGERPRINT add a revoker to the host key
66 revoke-key (r) revoke host key
67 publish-key (p) publish host key to keyserver
69 import-key (i) [NAME[:PORT]] import existing ssh key to gpg
71 version (v) show version number
74 See ${PGRM}(8) for more info.
78 # function to interact with the gpg keyring
80 GNUPGHOME="$GNUPGHOME_HOST" gpg "$@"
83 # command to list the info about the host key, in colon format, to
86 gpg_host --list-keys --with-colons --fixed-list-mode \
87 --with-fingerprint --with-fingerprint \
88 "0x${HOST_FINGERPRINT}!"
92 # command for edit key scripts, takes scripts on stdin
93 # FIXME: should we supress all the edit script spew? or pipe it
96 gpg_host --no-greeting --quiet \
97 --command-fd 0 --no-tty --edit-key \
98 "0x${HOST_FINGERPRINT}!" "$@" 2>&1 | log debug
101 # export the host public key to the monkeysphere gpg pub key file
102 update_gpg_pub_file() {
103 log debug "updating openpgp public key file '$HOST_KEY_FILE'..."
104 gpg_host --export --armor --export-options export-minimal \
105 "0x${HOST_FINGERPRINT}!" > "$HOST_KEY_FILE"
108 # load the host fingerprint into the fingerprint variable, using the
109 # export gpg pub key file
110 # FIXME: this seems much less than ideal, with all this temp keyring
111 # stuff. is there a way we can do this without having to create temp
112 # files? what if we stored the fingerprint in MHDATADIR/fingerprint?
114 if [ -f "$HOST_KEY_FILE" ] ; then
115 HOST_FINGERPRINT=$( \
116 (FUBAR=$(mktemp -d) && export GNUPGHOME="$FUBAR" \
117 && gpg --quiet --import \
118 && gpg --quiet --list-keys --with-colons --with-fingerprint \
119 && rm -rf "$FUBAR") <"$HOST_KEY_FILE" \
120 | grep '^fpr:' | cut -d: -f10 )
126 # load the host fingerprint into the fingerprint variable, using the
127 # gpg host secret key
128 load_fingerprint_secret() {
129 HOST_FINGERPRINT=$( \
130 gpg_host --quiet --list-secret-key \
131 --with-colons --with-fingerprint \
132 | grep '^fpr:' | cut -d: -f10 )
135 # fail if host key present
137 [ ! -s "$HOST_KEY_FILE" ] \
138 || failure "An OpenPGP host key already exists."
141 # fail if host key not present
142 check_host_no_key() {
143 [ -s "$HOST_KEY_FILE" ] \
144 || failure "You don't appear to have a Monkeysphere host key on this server.
145 Please run 'monkeysphere-host import-key' first."
148 # output the index of a user ID on the host key
149 # return 1 if user ID not found
155 # match to only ultimately trusted user IDs
156 tmpuidMatch="u:$(echo $userID | gpg_escape)"
158 # find the index of the requsted user ID
159 # NOTE: this is based on circumstantial evidence that the order of
160 # this output is the appropriate index
161 line=$(gpg_host_list | egrep '^(uid|uat):' | cut -f2,10 -d: | \
162 grep -n -x -F "$tmpuidMatch" 2>/dev/null)
164 if [ "$line" ] ; then
172 # show info about the host key
177 export GNUPGHOME=$(mktemp -d)
179 # trap to remove tmp dir if break
180 trap "rm -rf $GNUPGHOME" EXIT
182 # import the host key into the tmp dir
183 gpg --quiet --import <"$HOST_KEY_FILE"
185 HOST_FINGERPRINT=$(gpg --quiet --list-keys --with-colons --with-fingerprint \
186 | grep '^fpr:' | cut -d: -f10 )
188 # list the host key info
189 # FIXME: make no-show-keyring work so we don't have to do the grep'ing
190 # FIXME: can we show uid validity somehow?
191 gpg --list-keys --fingerprint \
192 --list-options show-unusable-uids 2>/dev/null \
193 | grep -v "^${GNUPGHOME}/pubring.gpg$" \
196 # list the pgp fingerprint
197 echo "OpenPGP fingerprint: $HOST_FINGERPRINT"
199 # list the ssh fingerprint
200 echo -n "ssh fingerprint: "
201 ssh-keygen -l -f /dev/stdin \
202 <<<$(openpgp2ssh <"$HOST_KEY_FILE" 2>/dev/null) \
203 | awk '{ print $1, $2, $4 }'
205 # remove the tmp file
210 ########################################################################
212 ########################################################################
214 # unset variables that should be defined only in config file or in
215 # MONKEYSPHERE_ variables
218 unset MONKEYSPHERE_USER
221 # load configuration file
222 [ -e ${MONKEYSPHERE_HOST_CONFIG:="${SYSCONFIGDIR}/monkeysphere-host.conf"} ] && . "$MONKEYSPHERE_HOST_CONFIG"
224 # set empty config variable with ones from the environment, or with
226 LOG_LEVEL=${MONKEYSPHERE_LOG_LEVEL:=${LOG_LEVEL:="INFO"}}
227 KEYSERVER=${MONKEYSPHERE_KEYSERVER:=${KEYSERVER:="pool.sks-keyservers.net"}}
228 MONKEYSPHERE_USER=${MONKEYSPHERE_MONKEYSPHERE_USER:=${MONKEYSPHERE_USER:="monkeysphere"}}
229 PROMPT=${MONKEYSPHERE_PROMPT:=${PROMPT:="true"}}
232 CHECK_KEYSERVER=${MONKEYSPHERE_CHECK_KEYSERVER:="true"}
233 GNUPGHOME_HOST=${MONKEYSPHERE_GNUPGHOME_HOST:="${MHDATADIR}"}
235 # export variables needed in su invocation
240 export MONKEYSPHERE_USER
242 export CHECK_KEYSERVER
243 export GNUPGHOME_HOST
245 export HOST_FINGERPRINT=
249 [ "$COMMAND" ] || failure "Type '$PGRM help' for usage."
253 'show-key'|'show'|'s')
258 'set-expire'|'extend-key'|'e')
261 source "${MHSHAREDIR}/set_expire"
265 'add-hostname'|'add-name'|'n+')
268 source "${MHSHAREDIR}/add_hostname"
272 'revoke-hostname'|'revoke-name'|'n-')
275 source "${MHSHAREDIR}/revoke_hostname"
282 source "${MHSHAREDIR}/add_revoker"
289 source "${MHSHAREDIR}/revoke_key"
293 'publish-key'|'publish'|'p')
296 source "${MHSHAREDIR}/publish_key"
302 source "${MHSHAREDIR}/import_key"
308 source "${MHSHAREDIR}/diagnostics"
316 '--help'|'help'|'-h'|'h'|'?')
321 failure "Unknown command: '$COMMAND'
322 Type '$PGRM help' for usage."