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 # FIXME: this will probably misbehave if raw IP addresses are provided,
114 # either IPv4 or IPv6 using the bracket notation.
116 # FIXME: this doesn't address the use of hashed User IDs.
118 check_service_name() {
126 failure "You must supply a service name to check"
128 printf '%s' "$name" | perl -n -e '($str = $_) =~ s/\s//g ; exit !(lc($str) eq $_);' || \
129 failure "Not a valid service name: '$name'
131 Service names should be canonicalized to all lower-case,
134 [[ "$name" =~ ^[a-z0-9./:-]+$ ]] || \
135 failure "Not a valid service name: '$name'
137 Service names should contain only lower-case ASCII letters
138 numbers, dots (.), hyphens (-), slashes (/), and a colon (:).
139 If you are using non-ASCII characters (e.g. IDN), you should
140 use the canonicalized ASCII (NAMEPREP -> Punycode) representation
143 [[ "$name" =~ \. ]] || \
144 failure "Not a valid service name: '$name'
146 Service names should use fully-qualified domain names (FQDN), but the
147 domain name you chose appears to only have the local part. For
148 example: don't use 'ssh://foo' ; use 'ssh://foo.example.com' instead."
150 [[ "$name" =~ ^[a-z0-9]([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})?$ ]] || \
151 failure "Not a valid service name: '$name'
153 Service names look like <scheme>://full.example.com[:<portnumber>],
154 where <scheme> is something like ssh or https, and <portnumber> is
155 a decimal number (supplied only if the service is on a non-standard
158 scheme=$(cut -f1 -d: <<<"$name")
159 port=$(cut -f3 -d: <<<"$name")
161 # check that the scheme name is found in the system services
163 available_=$(get_port_for_service "$scheme") || \
164 log error "Error looking up service scheme named '%s'" "$scheme"
166 # FIXME: if the service isn't found, or does not have a port, what
167 # should we do? at the moment, we're just warning.
169 if [ -n "$port" ]; then
170 # check that the port number is a legitimate port number (> 0, < 65536)
171 [ "$port" -gt 0 ] && [ "$port" -lt 65536 ] || \
172 failure "The given port number should be greater than 0 and
173 less than 65536. '$port' is not OK"
175 # if the port number is given, and the scheme is in the services
176 # database, check that the port number does *not* match the
178 if (printf '%s' "$assigned_ports" | grep -q -F -x "$port" ) ; then
179 failure $(printf "The scheme %s uses port number %d by default.
180 You should leave off the port number if it is the default" "$scheme" "$port")
186 # fail if host key not present
188 [ -s "$HOST_KEY_FILE" ] \
189 || failure "You don't appear to have a Monkeysphere host key on this server.
190 Please run 'monkeysphere-host import-key' import a key."
193 # key input to functions, outputs full fingerprint of specified key if
197 # array of fingerprints
198 local fprs=($(list_primary_fingerprints <"$HOST_KEY_FILE"))
202 failure "You don't appear to have any Monkeysphere host keys.
203 Please run 'monkeysphere-host import-key' to import a key."
209 if [ -z "$keyID" ] ; then
210 failure "Your host keyring contains multiple keys.
211 Please specify one to act on (see 'monkeysphere-host show-keys')."
215 printf '%s\n' "${fprs[@]}" | grep "${keyID}$" \
216 || failure "Host key '$keyID' not found."
219 # return 0 if user ID was found.
220 # return 1 if user ID not found.
226 # match to only "unknown" user IDs (host has no need for ultimate trust)
227 tmpuidMatch="uid:-:$(echo $userID | gpg_escape)"
229 # See whether the requsted user ID is present
230 gpg_host_list_keys "$keyID" | cut -f1,2,10 -d: | \
231 grep -q -x -F "$tmpuidMatch" 2>/dev/null
234 prompt_userid_exists() {
239 if gpgOut=$(gpg_host_list_keys "=${userID}" 2>/dev/null) ; then
240 fingerprint=$(echo "$gpgOut" | grep '^fpr:' | cut -d: -f10)
241 if [ "$PROMPT" != "false" ] ; then
242 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
244 if [ "${OK/y/Y}" != 'Y' ] ; then
245 failure "Service name not added."
248 log info "Key '%s' is already using the service name '%s'." "$fingerprint" "$userID" >&2
253 # run command looped over keys
263 local fprs=($(list_primary_fingerprints <"$HOST_KEY_FILE"))
265 if [[ -z "$1" || "$1" == '--all' ]] ; then
269 for key in $keys ; do
270 if (( i++ > 0 )) ; then
271 echo "##############################"
277 # show info about the a key
286 export GNUPGHOME=$(msmktempdir)
288 # trap to remove tmp dir if break
289 trap "rm -rf $GNUPGHOME" EXIT
291 # import the host key into the tmp dir
292 gpg --quiet --import <"$HOST_KEY_FILE"
294 # get the gpg fingerprint
295 if gpg --quiet --list-keys \
296 --with-colons --with-fingerprint "$id" \
297 | grep '^fpr:' | cut -d: -f10 > "$GNUPGHOME"/fingerprint ; then
298 fingerprint=$(cat "$GNUPGHOME"/fingerprint)
300 failure "ID '$id' not found."
304 tmpssh="$GNUPGHOME"/ssh_host_key_rsa_pub
305 gpg --export --no-armor "$fingerprint" 2>/dev/null \
306 | openpgp2ssh 2>/dev/null >"$tmpssh"
308 # list the host key info
309 # FIXME: make no-show-keyring work so we don't have to do the grep'ing
310 # FIXME: can we show uid validity somehow?
311 gpg --list-keys --list-options show-unusable-uids "$fingerprint" 2>/dev/null \
312 | grep -v "^${GNUPGHOME}/pubring.gpg$" \
315 # list revokers, if there are any
316 revokers=$(gpg --list-keys --with-colons --fixed-list-mode "$fingerprint" \
317 | awk -F: '/^rvk:/{ print $10 }' )
318 if [ "$revokers" ] ; then
319 echo "The following keys are allowed to revoke this host key:"
320 for key in $revokers ; do
326 # list the pgp fingerprint
327 echo "OpenPGP fingerprint: $fingerprint"
329 # list the ssh fingerprint
330 echo -n "ssh fingerprint: "
331 ssh-keygen -l -f "$tmpssh" | awk '{ print $1, $2, $4 }'
333 # remove the tmp file
338 ########################################################################
340 ########################################################################
342 # load configuration file
343 [ -e ${MONKEYSPHERE_HOST_CONFIG:="${SYSCONFIGDIR}/monkeysphere-host.conf"} ] \
344 && . "$MONKEYSPHERE_HOST_CONFIG"
346 # set empty config variable with ones from the environment, or with
348 LOG_LEVEL=${MONKEYSPHERE_LOG_LEVEL:=$LOG_LEVEL}
349 KEYSERVER=${MONKEYSPHERE_KEYSERVER:=$KEYSERVER}
350 CHECK_KEYSERVER=${MONKEYSPHERE_CHECK_KEYSERVER:=$CHECK_KEYSERVER}
351 MONKEYSPHERE_USER=${MONKEYSPHERE_MONKEYSPHERE_USER:=$MONKEYSPHERE_USER}
352 MONKEYSPHERE_GROUP=$(get_primary_group "$MONKEYSPHERE_USER")
353 PROMPT=${MONKEYSPHERE_PROMPT:=$PROMPT}
356 GNUPGHOME_HOST=${MONKEYSPHERE_GNUPGHOME_HOST:="${MHDATADIR}"}
357 LOG_PREFIX=${MONKEYSPHERE_LOG_PREFIX:='ms: '}
359 # export variables needed in su invocation
363 export CHECK_KEYSERVER
364 export MONKEYSPHERE_USER
365 export MONKEYSPHERE_GROUP
367 export GNUPGHOME_HOST
369 export HOST_FINGERPRINT
372 if [ "$#" -eq 0 ] ; then
374 failure "Please supply a subcommand."
382 'import-key'|'import'|'i')
383 source "${MHSHAREDIR}/import_key"
387 'show-keys'|'show-key'|'show'|'s')
388 multi_key show_key "$@"
391 'set-expire'|'extend-key'|'extend'|'e')
392 source "${MHSHAREDIR}/set_expire"
396 'add-servicename'|'add-hostname'|'add-name'|'n+')
397 source "${MHSHAREDIR}/add_name"
401 'revoke-servicename'|'revoke-hostname'|'revoke-name'|'n-')
402 source "${MHSHAREDIR}/revoke_name"
407 source "${MHSHAREDIR}/add_revoker"
412 source "${MHSHAREDIR}/revoke_key"
416 'publish-keys'|'publish-key'|'publish'|'p')
417 source "${MHSHAREDIR}/publish_key"
418 multi_key publish_key "$@"
422 source "${MHSHAREDIR}/diagnostics"
426 'update-pgp-pub-file')
430 'version'|'--version'|'v')
434 '--help'|'help'|'-h'|'h'|'?')
439 failure "Unknown command: '$COMMAND'
440 Try '$PGRM help' for usage."