3 # monkeysphere: Monkeysphere client tool
5 # The monkeysphere scripts are written by:
6 # Jameson Rollins <jrollins@fifthhorseman.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 ########################################################################
17 SYSSHAREDIR=${MONKEYSPHERE_SYSSHAREDIR:-"/usr/share/monkeysphere"}
19 . "${SYSSHAREDIR}/common" || exit 1
21 # sharedir for host functions
22 MSHAREDIR="${SYSSHAREDIR}/m"
24 # UTC date in ISO 8601 format if needed
25 DATE=$(date -u '+%FT%T')
27 # 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 gen-subkey (g) [KEYID] generate an authentication subkey
49 --length (-l) BITS key length in bits (2048)
50 ssh-proxycommand monkeysphere ssh ProxyCommand
51 subkey-to-ssh-agent (s) store authentication subkey in ssh-agent
52 version (v) show version number
58 # user gpg command to define common options
60 gpg --no-greeting --quiet --no-tty "$@"
63 # take a secret key ID and check that only zero or one ID is provided,
64 # and that it corresponds to only a single secret key ID
65 check_gpg_sec_key_id() {
70 gpgSecOut=$(gpg_user --fixed-list-mode --list-secret-keys --with-colons 2>/dev/null | egrep '^sec:')
73 gpgSecOut=$(gpg_user --fixed-list-mode --list-secret-keys --with-colons "$keyID" | egrep '^sec:') || failure
76 failure "You must specify only a single primary key ID."
80 # check that only a single secret key was found
81 case $(echo "$gpgSecOut" | grep -c '^sec:') in
83 failure "No secret keys found. Create an OpenPGP key with the following command:
87 echo "$gpgSecOut" | cut -d: -f5
90 echo "Multiple primary secret keys found:" | log error
91 echo "$gpgSecOut" | cut -d: -f5 | log error
92 echo "Please specify which primary key to use." | log error
98 # check that a valid authentication subkey does not already exist
99 check_gpg_authentication_subkey() {
109 # check that a valid authentication key does not already exist
111 for line in $(gpg_user --fixed-list-mode --list-keys --with-colons "$keyID") ; do
112 type=$(echo "$line" | cut -d: -f1)
113 validity=$(echo "$line" | cut -d: -f2)
114 usage=$(echo "$line" | cut -d: -f12)
117 if [ "$type" != 'pub' -a "$type" != 'sub' ] ; then
120 # check for authentication capability
121 if ! check_capability "$usage" 'a' ; then
124 # if authentication key is valid, prompt to continue
125 if [ "$validity" = 'u' ] ; then
126 echo "A valid authentication key already exists for primary key '$keyID'."
127 if [ "$PROMPT" = "true" ] ; then
128 read -p "Are you sure you would like to generate another one? (y/N) " OK; OK=${OK:N}
129 if [ "${OK/y/Y}" != 'Y' ] ; then
140 ########################################################################
142 ########################################################################
144 # set unset default variables
145 GNUPGHOME=${GNUPGHOME:="${HOME}/.gnupg"}
146 KNOWN_HOSTS="${HOME}/.ssh/known_hosts"
147 HASH_KNOWN_HOSTS="true"
148 AUTHORIZED_KEYS="${HOME}/.ssh/authorized_keys"
150 # unset the check keyserver variable, since that needs to have
151 # different defaults for the different functions
152 unset CHECK_KEYSERVER
155 [ -r "${SYSCONFIGDIR}/monkeysphere.conf" ] \
156 && . "${SYSCONFIGDIR}/monkeysphere.conf"
158 # set monkeysphere home directory
159 MONKEYSPHERE_HOME=${MONKEYSPHERE_HOME:="${HOME}/.monkeysphere"}
160 mkdir -p -m 0700 "$MONKEYSPHERE_HOME"
163 [ -e ${MONKEYSPHERE_CONFIG:="${MONKEYSPHERE_HOME}/monkeysphere.conf"} ] \
164 && . "$MONKEYSPHERE_CONFIG"
166 # set empty config variables with ones from the environment
167 GNUPGHOME=${MONKEYSPHERE_GNUPGHOME:=$GNUPGHOME}
168 LOG_LEVEL=${MONKEYSPHERE_LOG_LEVEL:=$LOG_LEVEL}
169 KEYSERVER=${MONKEYSPHERE_KEYSERVER:=$KEYSERVER}
170 # if keyserver not specified in env or conf, then look in gpg.conf
171 if [ -z "$KEYSERVER" ] ; then
172 if [ -f "${GNUPGHOME}/gpg.conf" ] ; then
173 KEYSERVER=$(grep -e "^[[:space:]]*keyserver " "${GNUPGHOME}/gpg.conf" | tail -1 | awk '{ print $2 }')
176 PROMPT=${MONKEYSPHERE_PROMPT:=$PROMPT}
177 KNOWN_HOSTS=${MONKEYSPHERE_KNOWN_HOSTS:=$KNOWN_HOSTS}
178 HASH_KNOWN_HOSTS=${MONKEYSPHERE_HASH_KNOWN_HOSTS:=$HASH_KNOWN_HOSTS}
179 AUTHORIZED_KEYS=${MONKEYSPHERE_AUTHORIZED_KEYS:=$AUTHORIZED_KEYS}
181 # other variables not in config file
182 AUTHORIZED_USER_IDS=${MONKEYSPHERE_AUTHORIZED_USER_IDS:="${MONKEYSPHERE_HOME}/authorized_user_ids"}
183 REQUIRED_HOST_KEY_CAPABILITY=${MONKEYSPHERE_REQUIRED_HOST_KEY_CAPABILITY:="a"}
184 REQUIRED_USER_KEY_CAPABILITY=${MONKEYSPHERE_REQUIRED_USER_KEY_CAPABILITY:="a"}
186 # export GNUPGHOME and make sure gpg home exists with proper
189 mkdir -p -m 0700 "$GNUPGHOME"
194 [ "$COMMAND" ] || failure "Type '$PGRM help' for usage."
198 'update-known_hosts'|'update-known-hosts'|'k')
199 # whether or not to check keyservers
200 CHECK_KEYSERVER=${MONKEYSPHERE_CHECK_KEYSERVER:=${CHECK_KEYSERVER:="true"}}
202 # if hosts are specified on the command line, process just
205 update_known_hosts "$@"
208 # otherwise, if no hosts are specified, process every host
209 # in the user's known_hosts file
216 'update-authorized_keys'|'update-authorized-keys'|'a')
217 # whether or not to check keyservers
218 CHECK_KEYSERVER=${MONKEYSPHERE_CHECK_KEYSERVER:=${CHECK_KEYSERVER:="true"}}
220 # process authorized_user_ids file
221 process_authorized_user_ids "$AUTHORIZED_USER_IDS"
226 source "${MSHAREDIR}/import_subkey"
231 source "${MSHAREDIR}/gen_subkey"
235 'ssh-proxycommand'|'p')
236 source "${MSHAREDIR}/ssh_proxycommand"
237 ssh_proxycommand "$@"
240 'subkey-to-ssh-agent'|'s')
241 source "${MSHAREDIR}/subkey_to_ssh_agent"
242 subkey_to_ssh_agent "$@"
249 '--help'|'help'|'-h'|'h'|'?')
254 failure "Unknown command: '$COMMAND'
255 Type '$PGRM help' for usage."