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"
36 HOST_KEY_FILE="${SYSDATADIR}/ssh_host_rsa_key.pub.gpg"
38 # UTC date in ISO 8601 format if needed
39 DATE=$(date -u '+%FT%T')
41 # unset some environment variables that could screw things up
47 ########################################################################
49 ########################################################################
53 usage: $PGRM <subcommand> [options] [args]
54 Monkeysphere host admin tool.
57 show-key (s) output all host key information
58 set-expire (e) EXPIRE set host key expiration
59 add-hostname (n+) NAME[:PORT] add hostname user ID to host key
60 revoke-hostname (n-) NAME[:PORT] revoke hostname user ID
61 add-revoker (o) FINGERPRINT add a revoker to the host key
62 revoke-key (r) revoke host key
63 publish-key (p) publish host key to keyserver
65 import-key (i) [NAME[:PORT]] import existing ssh key to gpg
67 version (v) show version number
70 See ${PGRM}(8) for more info.
74 # function to interact with the gpg keyring
76 GNUPGHOME="$GNUPGHOME_HOST" gpg --no-greeting --quiet --no-tty "$@"
79 # command to list the info about the host key, in colon format, to
82 gpg_host --list-keys --with-colons --fixed-list-mode \
83 --with-fingerprint --with-fingerprint \
84 "0x${HOST_FINGERPRINT}!"
88 # command for edit key scripts, takes scripts on stdin
89 # FIXME: should we supress all the edit script spew? or pipe it
92 gpg_host --command-fd 0 --edit-key "0x${HOST_FINGERPRINT}!" "$@"
95 # export the host public key to the monkeysphere gpg pub key file
96 update_gpg_pub_file() {
97 log debug "updating openpgp public key file '$HOST_KEY_FILE'..."
98 gpg_host --export --armor --export-options export-minimal \
99 "0x${HOST_FINGERPRINT}!" > "$HOST_KEY_FILE"
102 # load the host fingerprint into the fingerprint variable, using the
103 # export gpg pub key file
104 # FIXME: this seems much less than ideal, with all this temp keyring
105 # stuff. is there a way we can do this without having to create temp
106 # files? what if we stored the fingerprint in MHDATADIR/fingerprint?
108 if [ -f "$HOST_KEY_FILE" ] ; then
109 HOST_FINGERPRINT=$( \
110 (FUBAR=$(mktemp -d) && export GNUPGHOME="$FUBAR" \
111 && gpg --quiet --import \
112 && gpg --quiet --list-keys --with-colons --with-fingerprint \
113 && rm -rf "$FUBAR") <"$HOST_KEY_FILE" \
114 | grep '^fpr:' | cut -d: -f10 )
120 # load the host fingerprint into the fingerprint variable, using the
121 # gpg host secret key
122 load_fingerprint_secret() {
123 HOST_FINGERPRINT=$( \
124 gpg_host --list-secret-key --with-colons --with-fingerprint \
125 | grep '^fpr:' | cut -d: -f10 )
128 # fail if host key present
130 [ ! -s "$HOST_KEY_FILE" ] \
131 || failure "An OpenPGP host key already exists."
134 # fail if host key not present
135 check_host_no_key() {
136 [ -s "$HOST_KEY_FILE" ] \
137 || failure "You don't appear to have a Monkeysphere host key on this server.
138 Please run 'monkeysphere-host import-key...' first."
141 # output the index of a user ID on the host key
142 # return 1 if user ID not found
148 # match to only ultimately trusted user IDs
149 tmpuidMatch="u:$(echo $userID | gpg_escape)"
151 # find the index of the requsted user ID
152 # NOTE: this is based on circumstantial evidence that the order of
153 # this output is the appropriate index
154 line=$(gpg_host_list | egrep '^(uid|uat):' | cut -f2,10 -d: | \
155 grep -n -x -F "$tmpuidMatch" 2>/dev/null)
157 if [ "$line" ] ; then
165 # show info about the host key
170 export GNUPGHOME=$(msmktempdir)
172 # trap to remove tmp dir if break
173 trap "rm -rf $GNUPGHOME" EXIT
175 # import the host key into the tmp dir
176 gpg --quiet --import <"$HOST_KEY_FILE"
178 HOST_FINGERPRINT=$(gpg --quiet --list-keys --with-colons --with-fingerprint \
179 | grep '^fpr:' | cut -d: -f10 )
181 # list the host key info
182 # FIXME: make no-show-keyring work so we don't have to do the grep'ing
183 # FIXME: can we show uid validity somehow?
184 gpg --list-keys --fingerprint \
185 --list-options show-unusable-uids 2>/dev/null \
186 | grep -v "^${GNUPGHOME}/pubring.gpg$" \
189 # list the pgp fingerprint
190 echo "OpenPGP fingerprint: $HOST_FINGERPRINT"
192 # list the ssh fingerprint
193 echo -n "ssh fingerprint: "
194 ssh-keygen -l -f /dev/stdin \
195 <<<$(openpgp2ssh <"$HOST_KEY_FILE" 2>/dev/null) \
196 | awk '{ print $1, $2, $4 }'
198 # remove the tmp file
203 ########################################################################
205 ########################################################################
207 # unset variables that should be defined only in config file or in
208 # MONKEYSPHERE_ variables
211 unset MONKEYSPHERE_USER
214 # load configuration file
215 [ -e ${MONKEYSPHERE_HOST_CONFIG:="${SYSCONFIGDIR}/monkeysphere-host.conf"} ] && . "$MONKEYSPHERE_HOST_CONFIG"
217 # set empty config variable with ones from the environment, or with
219 LOG_LEVEL=${MONKEYSPHERE_LOG_LEVEL:=${LOG_LEVEL:="INFO"}}
220 KEYSERVER=${MONKEYSPHERE_KEYSERVER:=${KEYSERVER:="pool.sks-keyservers.net"}}
221 MONKEYSPHERE_USER=${MONKEYSPHERE_MONKEYSPHERE_USER:=${MONKEYSPHERE_USER:="monkeysphere"}}
222 PROMPT=${MONKEYSPHERE_PROMPT:=${PROMPT:="true"}}
225 CHECK_KEYSERVER=${MONKEYSPHERE_CHECK_KEYSERVER:="true"}
226 GNUPGHOME_HOST=${MONKEYSPHERE_GNUPGHOME_HOST:="${MHDATADIR}"}
228 # export variables needed in su invocation
233 export MONKEYSPHERE_USER
235 export CHECK_KEYSERVER
236 export GNUPGHOME_HOST
238 export HOST_FINGERPRINT=
242 [ "$COMMAND" ] || failure "Type '$PGRM help' for usage."
246 'show-key'|'show'|'s')
251 'set-expire'|'extend-key'|'e')
254 source "${MHSHAREDIR}/set_expire"
258 'add-hostname'|'add-name'|'n+')
261 source "${MHSHAREDIR}/add_hostname"
265 'revoke-hostname'|'revoke-name'|'n-')
268 source "${MHSHAREDIR}/revoke_hostname"
275 source "${MHSHAREDIR}/add_revoker"
282 source "${MHSHAREDIR}/revoke_key"
286 'publish-key'|'publish'|'p')
289 source "${MHSHAREDIR}/publish_key"
295 source "${MHSHAREDIR}/import_key"
301 source "${MHSHAREDIR}/diagnostics"
309 '--help'|'help'|'-h'|'h'|'?')
314 failure "Unknown command: '$COMMAND'
315 Type '$PGRM help' for usage."