3 # monkeysphere: Monkeysphere client 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, version 3
14 ########################################################################
19 SYSSHAREDIR=${MONKEYSPHERE_SYSSHAREDIR:-"/usr/share/monkeysphere"}
21 . "${SYSSHAREDIR}/defaultenv"
22 . "${SYSSHAREDIR}/common"
24 # sharedir for host functions
25 MSHAREDIR="${SYSSHAREDIR}/m"
27 # UTC date in ISO 8601 format if needed
28 DATE=$(date -u '+%FT%T')
30 # unset some environment variables that could screw things up
33 # set the file creation mask to be only owner rw
36 ########################################################################
38 ########################################################################
42 usage: $PGRM <subcommand> [options] [args]
43 Monkeysphere client tool.
46 update-known_hosts (k) [HOST]... update known_hosts file
47 update-authorized_keys (a) update authorized_keys file
48 ssh-proxycommand HOST [PORT] monkeysphere ssh ProxyCommand
49 --no-connect do not make TCP connection to host
50 subkey-to-ssh-agent (s) store authentication subkey in ssh-agent
51 sshfpr (f) KEYID output ssh fingerprint of gpg key
53 keys-for-userid (u) USERID output valid keys for user id literal
54 gen-subkey (g) [KEYID] generate an authentication subkey
55 --length (-l) BITS key length in bits (2048)
57 version (v) show version number
63 # user gpg command to define common options
65 gpg --no-greeting --quiet --no-tty "$@"
68 # output the ssh fingerprint of a gpg key
69 gpg_ssh_fingerprint() {
71 local tmpfile=$(msmktempfile)
73 # trap to remove tmp file if break
74 trap "rm -f $tmpfile" EXIT
76 # use temporary file, since ssh-keygen won't accept keys on stdin
77 gpg_user --export "$keyid" --no-armor | openpgp2ssh "$keyid" >"$tmpfile"
78 ssh-keygen -l -f "$tmpfile" | awk '{ print $1, $2, $4 }'
85 # take a secret key ID and check that only zero or one ID is provided,
86 # and that it corresponds to only a single secret key ID
87 check_gpg_sec_key_id() {
92 gpgSecOut=$(gpg_user --fixed-list-mode --list-secret-keys --with-colons 2>/dev/null | egrep '^sec:')
95 gpgSecOut=$(gpg_user --fixed-list-mode --list-secret-keys --with-colons "$1" | egrep '^sec:') || failure
98 failure "You must specify only a single primary key ID."
102 # check that only a single secret key was found
103 case $(echo "$gpgSecOut" | grep -c '^sec:') in
105 failure "No secret keys found. Create an OpenPGP key with the following command:
109 echo "$gpgSecOut" | cut -d: -f5
112 local seckeys=$(echo "$gpgSecOut" | cut -d: -f5)
113 failure "Multiple primary secret keys found:
115 Please specify which primary key to use."
120 # check that a valid authentication subkey does not already exist
121 check_gpg_authentication_subkey() {
131 # check that a valid authentication key does not already exist
133 for line in $(gpg_user --fixed-list-mode --list-keys --with-colons "$keyID") ; do
134 type=$(echo "$line" | cut -d: -f1)
135 validity=$(echo "$line" | cut -d: -f2)
136 usage=$(echo "$line" | cut -d: -f12)
139 if [ "$type" != 'pub' -a "$type" != 'sub' ] ; then
142 # check for authentication capability
143 if ! check_capability "$usage" 'a' ; then
146 # if authentication key is valid, prompt to continue
147 if [ "$validity" = 'u' ] ; then
148 echo "A valid authentication key already exists for primary key '$keyID'." 1>&2
149 if [ "$PROMPT" != "false" ] ; then
150 printf "Are you sure you would like to generate another one? (y/N) " >&2
152 if [ "${OK/y/Y}" != 'Y' ] ; then
163 ########################################################################
165 ########################################################################
167 # set unset default variables
168 GNUPGHOME=${GNUPGHOME:="${HOME}/.gnupg"}
169 KNOWN_HOSTS="${HOME}/.ssh/known_hosts"
170 HASH_KNOWN_HOSTS="true"
171 AUTHORIZED_KEYS="${HOME}/.ssh/authorized_keys"
173 # unset the check keyserver variable, since that needs to have
174 # different defaults for the different functions
175 unset CHECK_KEYSERVER
178 [ -r "${SYSCONFIGDIR}/monkeysphere.conf" ] \
179 && . "${SYSCONFIGDIR}/monkeysphere.conf"
181 # set monkeysphere home directory
182 MONKEYSPHERE_HOME=${MONKEYSPHERE_HOME:="${HOME}/.monkeysphere"}
183 mkdir -p -m 0700 "$MONKEYSPHERE_HOME"
186 [ -e ${MONKEYSPHERE_CONFIG:="${MONKEYSPHERE_HOME}/monkeysphere.conf"} ] \
187 && . "$MONKEYSPHERE_CONFIG"
189 # set empty config variables with ones from the environment
190 GNUPGHOME=${MONKEYSPHERE_GNUPGHOME:=$GNUPGHOME}
191 LOG_LEVEL=${MONKEYSPHERE_LOG_LEVEL:=$LOG_LEVEL}
192 KEYSERVER=${MONKEYSPHERE_KEYSERVER:=$KEYSERVER}
193 # if keyserver not specified in env or conf, then look in gpg.conf
194 if [ -z "$KEYSERVER" ] ; then
195 if [ -f "${GNUPGHOME}/gpg.conf" ] ; then
196 KEYSERVER=$(grep -e "^[[:space:]]*keyserver " "${GNUPGHOME}/gpg.conf" | tail -1 | awk '{ print $2 }')
199 PROMPT=${MONKEYSPHERE_PROMPT:=$PROMPT}
200 KNOWN_HOSTS=${MONKEYSPHERE_KNOWN_HOSTS:=$KNOWN_HOSTS}
201 HASH_KNOWN_HOSTS=${MONKEYSPHERE_HASH_KNOWN_HOSTS:=$HASH_KNOWN_HOSTS}
202 AUTHORIZED_KEYS=${MONKEYSPHERE_AUTHORIZED_KEYS:=$AUTHORIZED_KEYS}
203 STRICT_MODES=${MONKEYSPHERE_STRICT_MODES:=$STRICT_MODES}
205 # other variables not in config file
206 AUTHORIZED_USER_IDS=${MONKEYSPHERE_AUTHORIZED_USER_IDS:="${MONKEYSPHERE_HOME}/authorized_user_ids"}
207 REQUIRED_HOST_KEY_CAPABILITY=${MONKEYSPHERE_REQUIRED_HOST_KEY_CAPABILITY:="a"}
208 REQUIRED_USER_KEY_CAPABILITY=${MONKEYSPHERE_REQUIRED_USER_KEY_CAPABILITY:="a"}
209 # note that only using '=' instead of ':=' tests only if the variable
210 # in unset, not if it's "null"
211 LOG_PREFIX=${MONKEYSPHERE_LOG_PREFIX='ms: '}
213 # export GNUPGHOME and make sure gpg home exists with proper
216 mkdir -p -m 0700 "$GNUPGHOME"
220 if [ "$#" -eq 0 ] ; then
222 failure "Please supply a subcommand."
230 'update-known_hosts'|'update-known-hosts'|'k')
231 # whether or not to check keyservers
232 CHECK_KEYSERVER=${MONKEYSPHERE_CHECK_KEYSERVER:=${CHECK_KEYSERVER:="true"}}
234 # if hosts are specified on the command line, process just
237 update_known_hosts "$@"
239 # otherwise, if no hosts are specified, process every host
240 # in the user's known_hosts file
246 'update-authorized_keys'|'update-authorized-keys'|'a')
247 # whether or not to check keyservers
248 CHECK_KEYSERVER=${MONKEYSPHERE_CHECK_KEYSERVER:=${CHECK_KEYSERVER:="true"}}
250 # process authorized_user_ids file
251 process_authorized_user_ids "$AUTHORIZED_USER_IDS"
254 'import-subkey'|'import'|'i')
255 source "${MSHAREDIR}/import_subkey"
260 source "${MSHAREDIR}/gen_subkey"
264 'ssh-proxycommand'|'p')
265 source "${MSHAREDIR}/ssh_proxycommand"
266 ssh_proxycommand "$@"
269 'subkey-to-ssh-agent'|'s')
270 source "${MSHAREDIR}/subkey_to_ssh_agent"
271 subkey_to_ssh_agent "$@"
275 gpg_ssh_fingerprint "$@"
278 'keys-for-userid'|'u')
279 CHECK_KEYSERVER=${MONKEYSPHERE_CHECK_KEYSERVER:=${CHECK_KEYSERVER:="true"}}
284 echo "Warning: 'keys-from-userid' is deprecated. Please use 'keys-for-userid' instead." >&2
285 CHECK_KEYSERVER=${MONKEYSPHERE_CHECK_KEYSERVER:=${CHECK_KEYSERVER:="true"}}
289 'version'|'--version'|'v')
293 'help'|'--help'|'-h'|'h'|'?')
298 failure "Unknown command: '$COMMAND'
299 Try '$PGRM help' for usage."