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-2010, 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}/defaultenv"
25 . "${SYSSHAREDIR}/common"
27 SYSDATADIR=${MONKEYSPHERE_SYSDATADIR:-"/var/lib/monkeysphere"}
30 # sharedir for host functions
31 MHSHAREDIR="${SYSSHAREDIR}/mh"
33 # datadir for host functions
34 MHDATADIR="${SYSDATADIR}/host"
37 HOST_KEY_FILE="${SYSDATADIR}/host_keys.pub.pgp"
39 # UTC date in ISO 8601 format if needed
40 DATE=$(date -u '+%FT%T')
42 # unset some environment variables that could screw things up
45 ########################################################################
47 ########################################################################
51 usage: $PGRM <subcommand> [options] [args]
52 Monkeysphere host admin tool.
55 import-key (i) FILE SERVICENAME import PEM-encoded key from file
56 show-keys (s) [KEYID ...] output host key information
57 publish-keys (p) [KEYID ...] publish key(s) to keyserver
58 set-expire (e) EXPIRE [KEYID] set key expiration
59 add-servicename (n+) SERVICENAME [KEYID]
60 add a service name to key
61 revoke-servicename (n-) SERVICENAME [KEYID]
62 revoke a service name from key
63 add-revoker (r+) REVOKER_KEYID|FILE [KEYID]
65 revoke-key [KEYID] generate and/or publish revocation
68 version (v) show version number
71 See ${PGRM}(8) for more info.
75 # function to interact with the gpg keyring
77 GNUPGHOME="$GNUPGHOME_HOST" gpg --no-greeting --quiet --no-tty "$@"
80 # list the info about the a key, in colon format, to stdout
81 gpg_host_list_keys() {
83 gpg_host --list-keys --with-colons --fixed-list-mode \
84 --with-fingerprint --with-fingerprint \
87 gpg_host --list-keys --with-colons --fixed-list-mode \
88 --with-fingerprint --with-fingerprint
92 # edit key scripts, takes scripts on stdin, and keyID as first input
94 gpg_host --command-fd 0 --edit-key "$@"
97 # export the monkeysphere OpenPGP pub key file
98 update_pgp_pub_file() {
99 log debug "updating openpgp public key file '$HOST_KEY_FILE'..."
100 gpg_host --export --armor --export-options export-minimal \
101 $(gpg_host --list-secret-keys --with-colons --fingerprint | grep ^fpr | cut -f10 -d:) \
105 # check that the service name is well formed. we assume that the
106 # service name refers to a host; DNS labels for host names are limited
107 # to a very small range of characters (see RFC 1912, section 2.1).
109 # FIXME: i'm failing to check here for label components that are
110 # all-number (e.g. ssh://666.666), which are technically not allowed
111 # (though some exist on the 'net, apparently)
113 check_service_name() {
121 failure "You must supply a service name to check"
123 printf '%s' "$name" | perl -n -e '($str = $_) =~ s/\s//g ; exit !(lc($str) eq $_);' || \
124 failure "Not a valid service name: '$name'
126 Service names should be canonicalized to all lower-case,
129 [[ "$name" =~ ^[a-z0-9./:-]+$ ]] || \
130 failure "Not a valid service name: '$name'
132 Service names should contain only lower-case ASCII letters
133 numbers, dots (.), hyphens (-), slashes (/), and a colon (:).
134 If you are using non-ASCII characters (e.g. IDN), you should
135 use the canonicalized ASCII (NAMEPREP -> Punycode) representation
138 [[ "$name" =~ \. ]] || \
139 failure "Not a valid service name: '$name'
141 Service names should use fully-qualified domain names (FQDN), but the
142 domain name you chose appears to only have the local part. For
143 example: don't use 'ssh://foo' ; use 'ssh://foo.example.com' instead."
145 [[ "$name" =~ ^[a-z]([a-z0-9-]*[a-z0-9])?://[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.|((\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)+))(:[1-9][0-9]{0,4})?$ ]] || \
146 failure "Not a valid service name: '$name'
148 Service names look like <scheme>://full.example.com[:<portnumber>],
149 where <scheme> is something like ssh or https, and <portnumber> is
150 a decimal number (supplied only if the service is on a non-standard
153 scheme=$(cut -f1 -d: <<<"$name")
154 port=$(cut -f3 -d: <<<"$name")
156 # check that the scheme name is found in the system services
158 available_=$(get_port_for_service "$scheme") || \
159 log error "Error looking up service scheme named '%s'" "$scheme"
161 # FIXME: if the service isn't found, or does not have a port, what
162 # should we do? at the moment, we're just warning.
164 if [ -n "$port" ]; then
165 # check that the port number is a legitimate port number (> 0, < 65536)
166 [ "$port" -gt 0 ] && [ "$port" -lt 65536 ] || \
167 failure "The given port number should be greater than 0 and
168 less than 65536. '$port' is not OK"
170 # if the port number is given, and the scheme is in the services
171 # database, check that the port number does *not* match the
173 if (printf '%s' "$assigned_ports" | grep -q -F -x "$port" ) ; then
174 failure $(printf "The scheme %s uses port number %d by default.
175 You should leave off the port number if it is the default" "$scheme" "$port")
181 # fail if host key not present
183 [ -s "$HOST_KEY_FILE" ] \
184 || failure "You don't appear to have a Monkeysphere host key on this server.
185 Please run 'monkeysphere-host import-key' import a key."
188 # key input to functions, outputs full fingerprint of specified key if
192 # array of fingerprints
193 local fprs=($(list_primary_fingerprints <"$HOST_KEY_FILE"))
197 failure "You don't appear to have any Monkeysphere host keys.
198 Please run 'monkeysphere-host import-key' to import a key."
204 if [ -z "$keyID" ] ; then
205 failure "Your host keyring contains multiple keys.
206 Please specify one to act on (see 'monkeysphere-host show-keys')."
210 printf '%s\n' "${fprs[@]}" | grep "${keyID}$" \
211 || failure "Host key '$keyID' not found."
214 # return 0 if user ID was found.
215 # return 1 if user ID not found.
221 # match to only "unknown" user IDs (host has no need for ultimate trust)
222 tmpuidMatch="uid:-:$(echo $userID | gpg_escape)"
224 # See whether the requsted user ID is present
225 gpg_host_list_keys "$keyID" | cut -f1,2,10 -d: | \
226 grep -q -x -F "$tmpuidMatch" 2>/dev/null
229 prompt_userid_exists() {
234 if gpgOut=$(gpg_host_list_keys "=${userID}" 2>/dev/null) ; then
235 fingerprint=$(echo "$gpgOut" | grep '^fpr:' | cut -d: -f10)
236 if [ "$PROMPT" != "false" ] ; then
237 printf "Service name '%s' is already being used by key '%s'.\nAre you sure you want to use it again? (y/N) " "$fingerprint" "$userID" >&2
239 if [ "${OK/y/Y}" != 'Y' ] ; then
240 failure "Service name not added."
243 log info "Key '%s' is already using the service name '%s'." "$fingerprint" "$userID" >&2
248 # run command looped over keys
254 local fprs=($(list_primary_fingerprints <"$HOST_KEY_FILE"))
259 if [[ -z "$1" || "$1" == '--all' ]] ; then
263 for key in $keys ; do
264 if (( i++ > 0 )) ; then
265 echo "##############################"
271 # show info about the a key
280 export GNUPGHOME=$(msmktempdir)
282 # trap to remove tmp dir if break
283 trap "rm -rf $GNUPGHOME" EXIT
285 # import the host key into the tmp dir
286 gpg --quiet --import <"$HOST_KEY_FILE"
288 # get the gpg fingerprint
289 if gpg --quiet --list-keys \
290 --with-colons --with-fingerprint "$id" \
291 | grep '^fpr:' | cut -d: -f10 > "$GNUPGHOME"/fingerprint ; then
292 fingerprint=$(cat "$GNUPGHOME"/fingerprint)
294 failure "ID '$id' not found."
298 tmpssh="$GNUPGHOME"/ssh_host_key_rsa_pub
299 gpg --export "$fingerprint" 2>/dev/null \
300 | openpgp2ssh 2>/dev/null >"$tmpssh"
302 # list the host key info
303 # FIXME: make no-show-keyring work so we don't have to do the grep'ing
304 # FIXME: can we show uid validity somehow?
305 gpg --list-keys --list-options show-unusable-uids "$fingerprint" 2>/dev/null \
306 | grep -v "^${GNUPGHOME}/pubring.gpg$" \
309 # list revokers, if there are any
310 revokers=$(gpg --list-keys --with-colons --fixed-list-mode "$fingerprint" \
311 | awk -F: '/^rvk:/{ print $10 }' )
312 if [ "$revokers" ] ; then
313 echo "The following keys are allowed to revoke this host key:"
314 for key in $revokers ; do
320 # list the pgp fingerprint
321 echo "OpenPGP fingerprint: $fingerprint"
323 # list the ssh fingerprint
324 echo -n "ssh fingerprint: "
325 ssh-keygen -l -f "$tmpssh" | awk '{ print $1, $2, $4 }'
327 # remove the tmp file
332 ########################################################################
334 ########################################################################
336 # load configuration file
337 [ -e ${MONKEYSPHERE_HOST_CONFIG:="${SYSCONFIGDIR}/monkeysphere-host.conf"} ] \
338 && . "$MONKEYSPHERE_HOST_CONFIG"
340 # set empty config variable with ones from the environment, or with
342 LOG_LEVEL=${MONKEYSPHERE_LOG_LEVEL:=$LOG_LEVEL}
343 KEYSERVER=${MONKEYSPHERE_KEYSERVER:=$KEYSERVER}
344 CHECK_KEYSERVER=${MONKEYSPHERE_CHECK_KEYSERVER:=$CHECK_KEYSERVER}
345 MONKEYSPHERE_USER=${MONKEYSPHERE_MONKEYSPHERE_USER:=$MONKEYSPHERE_USER}
346 MONKEYSPHERE_GROUP=$(get_primary_group "$MONKEYSPHERE_USER")
347 PROMPT=${MONKEYSPHERE_PROMPT:=$PROMPT}
350 GNUPGHOME_HOST=${MONKEYSPHERE_GNUPGHOME_HOST:="${MHDATADIR}"}
351 LOG_PREFIX=${MONKEYSPHERE_LOG_PREFIX:='ms: '}
353 # export variables needed in su invocation
357 export CHECK_KEYSERVER
358 export MONKEYSPHERE_USER
359 export MONKEYSPHERE_GROUP
361 export GNUPGHOME_HOST
363 export HOST_FINGERPRINT
366 if [ "$#" -eq 0 ] ; then
368 failure "Please supply a subcommand."
377 source "${MHSHAREDIR}/import_key"
381 'show-keys'|'show-key'|'show'|'s')
382 multi_key show_key "$@"
385 'set-expire'|'extend-key'|'e')
386 source "${MHSHAREDIR}/set_expire"
390 'add-servicename'|'add-hostname'|'add-name'|'n+')
391 source "${MHSHAREDIR}/add_name"
395 'revoke-servicename'|'revoke-hostname'|'revoke-name'|'n-')
396 source "${MHSHAREDIR}/revoke_name"
401 source "${MHSHAREDIR}/add_revoker"
406 source "${MHSHAREDIR}/revoke_key"
410 'publish-keys'|'publish-key'|'publish'|'p')
411 source "${MHSHAREDIR}/publish_key"
412 multi_key publish_key "$@"
416 source "${MHSHAREDIR}/diagnostics"
420 'update-pgp-pub-file')
428 '--help'|'help'|'-h'|'h'|'?')
433 failure "Unknown command: '$COMMAND'
434 Try '$PGRM help' for usage."