3 ### Common key management functions.
5 ### (c) 2011 Mark Wooding
8 ###----- Licensing notice ---------------------------------------------------
10 ### This file is part of the distorted.org.uk key management suite.
12 ### distorted-keys is free software; you can redistribute it and/or modify
13 ### it under the terms of the GNU General Public License as published by
14 ### the Free Software Foundation; either version 2 of the License, or
15 ### (at your option) any later version.
17 ### distorted-keys is distributed in the hope that it will be useful,
18 ### but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ### MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ### GNU General Public License for more details.
22 ### You should have received a copy of the GNU General Public License
23 ### along with distorted-keys; if not, write to the Free Software Foundation,
24 ### Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
28 ###--------------------------------------------------------------------------
29 ### Configuration variables.
31 ## Automatically configured pathnames.
32 PACKAGE="@PACKAGE@" VERSION="@VERSION@"
35 ## Read user configuration.
36 if [ -f $ETC/keys.conf ]; then . $ETC/keys.conf; fi
38 ## Maybe turn on debugging.
39 case "${KEYS_DEBUG+t}" in t) set -x ;; esac
41 ## Fake up caller credentials if not called via userv.
42 case "${USERV_USER+t}" in
44 *) USERV_USER=${LOGNAME-${USER-$(id -un)}} USERV_UID=$(id -u) ;;
46 case "${USERV_GROUP+t}" in
48 *) USERV_GROUP=$(id -Gn) USERV_GID=$(id -gn) ;;
51 ###--------------------------------------------------------------------------
55 cleanup () { cleanups=${cleanups+$cleanups }$1; }
56 runcleanups () { for i in $cleanups; do $i; done; }
57 trap 'rc=$?; runcleanups; exit $rc' EXIT
58 trap 'trap "" EXIT; runcleanups; exit 127' INT TERM
60 ###--------------------------------------------------------------------------
61 ### Utility functions.
64 ## Fail unless a safe directory is set.
66 err="$quis: (CONFIGURATION ERROR)"
69 *) echo >&2 "$err: no SAFE directory"; exit 1 ;;
71 if [ ! -d "$SAFE" ]; then
72 echo >&2 "$err: SAFE path \`$SAFE' isn't a directory"
76 [!/]* | *[][[:space:]*?]*)
77 echo >&2 "$err: SAFE path \`$SAFE' contains bad characters"
83 read perm _ user stuff
87 echo >&2 "$err: SAFE path \`$SAFE' has bad owner or permissions"
94 ## Temporary directory.
96 rmtmp () { case ${tmp+t} in t) cd /; rm -rf $tmp ;; esac; }
99 ## Make a temporary directory and store its name in `tmp'.
101 case "${tmp+t}" in t) return ;; esac
103 tmp="$SAFE/keys.tmp.$$"
109 ## Fail unless a temporary directory is set.
113 *) echo >&2 "$quis (INTERNAL): no tmp directory set"; exit 127 ;;
119 ## Parse the key label string KEY. Set `kdir' to the base path to use for
120 ## the key's storage, and `kowner' to the key owner's name.
123 *:*) kowner=${key%%:*} klabel=${key#*:} ;;
124 *) kowner=$USERV_USER klabel=$key ;;
126 checkword "key owner name" "$kowner"
127 checklabel "key" "$klabel"
128 kdir=$KEYS/store/$kowner/$klabel
129 knub=$KEYS/nub/$kowner/$klabel
132 ###--------------------------------------------------------------------------
133 ### Input validation functions.
138 ckwhat=$1 ckpat=$2 thing=$3
139 ## Verify that THING matches the (anchored, basic) regular expression
140 ## CKPAT. Since matching newlines is hard to do portably, also check that
141 ## THING doesn't contain any. If the checks fail, report an error and
146 *"$nl"*) validp=nil ;;
147 *) if ! expr >/dev/null "Q$thing" : "Q$ckpat\$"; then validp=nil; fi ;;
150 nil) echo >&2 "$quis: bad $ckwhat \`$thing'"; exit 1 ;;
154 ## Regular expressions for validating input.
155 R_IDENTCHARS="A-Za-z0-9_"
157 R_WORDCHARS="-$R_IDENTCHARS$R_GOODPUNCT"
158 R_IDENT="[$R_IDENTCHARS][$R_IDENTCHARS]*"
159 R_WORD="[$R_WORDCHARS][$R_WORDCHARS]*"
160 R_ACLCHARS="][$R_IDENTCHARS$R_GOODPUNCT*?:.#"
161 R_WORDSEQ="[$R_WORDCHARS[:space:]][$R_WORDCHARS[:space:]]*"
162 R_ACL="[$R_ACLCHARS[:space:]-][$R_ACLCHARS[:space:]-]*"
163 R_NUMERIC='\(\([1-9][0-9]*\)\{0,1\}0\{0,1\}\)'
164 R_LABEL="\($R_WORD\(/$R_WORD\)*\)"
167 ## Various validation functions.
168 checknumber () { check "$1" "$R_NUMERIC" "$2"; }
169 checkident () { check "$1" "$R_IDENT" "$2"; }
170 checkword () { check "$1" "$R_WORD" "$2"; }
171 checklabel () { check "$1 label" "$R_LABEL" "$2"; }
173 ###--------------------------------------------------------------------------
174 ### Key storage and properties.
178 ## Write the named system PROFILE to standard output.
180 $bindir/extract-profile "$profile" $ETC/profile.d/
184 what=$1 prefix=$2; shift 2
185 ## Set variables based on the NAME=VALUE assignments in the arguments. The
186 ## value for property NAME is stored in the shell variable PREFIX_NAME.
191 *\=*) name=${assg%%=*} value=${assg#*=} ;;
194 case "$goodp,$name" in t,*[!0-9A-Za-z_]*=*) goodp=nil ;; esac
196 nil) echo >&2 "$quis: bad $what assignment \`$assg'"; exit 1 ;;
198 eval "$prefix$name=\$value"
203 whatprop=$1 prefix=$2; shift 2
204 ## Check that property variables are set in accordance with the remaining
205 ## TABLE arguments. Each row of TABLE has the form
209 ## A table row is satisfied if there is a variable PREFIXNAME whose value
210 ## matces the (basic) regular expression PAT, or if the variable is unset
213 for table in "$@"; do
214 case "$table" in ?*) ;; *) continue ;; esac
215 while read -r name omit pat; do
216 eval foundp=\${$prefix$name+t}
217 case "$foundp,$omit" in
220 echo >&2 "$quis: missing $whatprop \`$name' required"
224 eval value=\$$prefix$name
225 check "value for $whatprop \`$name'" "$pat" "$value"
234 ## Define a properties table NAME.
240 defprops g_props <<EOF
242 recovery t $R_WORDSEQ
246 nub_random_bytes t $R_NUMERIC
256 ## Read a profile from a file. This doesn't check the form of the
257 ## filename, so it's not suitable for unchecked input. Properties are set
258 ## using `setprops' with prefix `kprop_'.
260 ## Parse the settings from the file.
263 case "$line" in "" | \#*) continue ;; esac
264 setprops "property" kprop_ "$line"
267 checkprops "property" kprop_ "$g_props"
269 ## Fetch the key-type handling library.
270 if [ ! -f $KEYSLIB/ktype.$kprop_type ]; then
271 echo >&2 "$quis: unknown key type \`$kprop_type'"
274 . $KEYSLIB/ktype.$kprop_type
275 checkprops "property" kprop_ "$k_props"
280 ## Read key metadata from KDIR.
282 { read profile; } <"$kdir"/meta
286 ## Generate a key nub in the default way, and write it to standard output.
287 ## The properties `random', `nub_random_bytes' and `nub_hash' are referred
291 if=/dev/${kprop_random-random} bs=1 count=${kprop_nub_random_bytes-64} |
292 openssl dgst -${kprop_nub_hash-sha256} -binary |
297 ## Compute a hash of the key nub in stdin, and write it to stdout in hex.
298 ## The property `nubid_hash' is used.
300 { echo "distorted-keys nubid"; cat -; } |
301 openssl dgst -${kprop_nubid_hash-sha256}
305 what=$1 templ=$2 prefix=$3 pat=$4
306 ## Substitute option values into the template TEMPL. Each occurrence of
307 ## %{VAR} is replaced by the value of the variable PREFIXVAR. Finally, an
308 ## error is reported unless the final value matches the regular expression
315 ## If there are no more markers to substitute, then finish.
316 case "$rest" in *"%{"*"}"*) ;; *) out=$out$rest; break ;; esac
318 ## Split the template into three parts.
319 left=${rest%%\%\{*} right=${rest#*\%\{}
320 var=${right%%\}*} rest=${right#*\}}
322 *-*) default=${var#*-} var=${var%%-*} defaultp=t ;;
326 ## Find the variable value.
327 checkident "template variable name" "$var"
328 eval foundp=\${$prefix$var+t}
329 case $foundp,$defaultp in
330 t,*) eval value=\$$prefix$var ;;
331 ,t) value=$default ;;
333 echo >&2 "$quis: option \`$var' unset, used in template \`$templ'"
338 ## Do the substitution.
342 ## Check the final result.
343 check "$what" "$pat" "$out"
351 ## Read property settings from a profile. The PROFILE name has the form
352 ## [USER:]LABEL; USER defaults to OWNER. Properties are set using
353 ## `setprops' with prefix `kprop_'.
358 label=${profile#:} uservp=nil
361 user=$kowner label=$profile uservp=t
364 user=${profile%%:*} label=${profile#*:} uservp=t
367 checkword "profile label" "$label"
369 ## Fetch the profile settings from the user.
373 checkword "profile user" "$user"
374 userv "$user" cryptop-profile "$label" >$tmp/profile
377 $bindir/extract-profile "$label" $ETC/profile.d/ >$tmp/profile
382 readprops $tmp/profile
385 ###--------------------------------------------------------------------------
386 ### General crypto operations.
389 profile=$1 kdir=$2 knub=$3 hook=$4; shift 4
390 ## Generate a key, and associate it with the named PROFILE (which is
391 ## assumed already to have been read!); store the main data in KDIR, and
392 ## the nub separately in the file KNUB; run HOOK after generation, passing
393 ## it the working key directory and nub file. Remaining arguments are
394 ## options to the key type.
396 ## Set options and check them.
397 setprops "option" kopt_ "$@"
398 checkprops "option" kopt_ "$k_genopts"
400 ## Create directory structure and start writing metadata.
402 mkdir -m755 -p "$kdir.new"
403 case "$knub" in */*) mkdir -m700 -p "${knub%/*}" ;; esac
404 cat >"$kdir.new/meta" <<EOF
409 umask=$(umask); umask 077; >"$knub.new"; umask $umask
410 k_generate "$kdir.new" "$knub.new"
411 $hook "$kdir.new" "$knub.new"
414 nubid <"$knub.new" >"$kdir.new/nubid"
416 ## Juggle everything into place. Doing this atomically is very difficult,
417 ## and requires more machinery than I can really justify here. If
418 ## something goes wrong halfway, it should always be possible to fix it,
419 ## either by backing out (if $kdir.new still exists) or pressing on
420 ## forwards (if not).
422 if [ -e "$kdir" ]; then mv "$kdir" "$kdir.old"; fi
423 mv "$kdir.new" "$kdir"
424 mv "$knub.new" "$knub"
428 c_encrypt () { k_encrypt "$@"; }
430 if k_decrypt "$@" >$tmp/plain; then cat $tmp/plain
434 c_sign () { k_sign "$@"; }
435 c_verify () { k_verify "$@"; }
437 ## Stub implementations.
438 notsupp () { op=$1; echo >&2 "$quis: operation \`$op' not supported"; }
440 k_encrypt () { notsupp encrypt; }
441 k_decrypt () { notsupp decrypt; }
442 k_sign () { notsupp sign; }
443 k_verify () { notsupp verify; }
447 ## Prepare for a crypto operation OP, using the KEY. This validates the
448 ## key label, reads the profile, and checks the access-control list. If OP
449 ## is `-' then allow the operation unconditionally.
451 ## Find the key properties.
452 parse_keylabel "$key"
453 if [ ! -d $kdir ]; then echo >&2 "$quis: unknown key \`$key'"; exit 1; fi
455 read_profile $kowner "$profile"
457 ## Check whether we're allowed to do this thing. This is annoyingly
459 case $op in -) return ;; esac
460 eval acl=\${kprop_acl_$op-!owner}
464 ## Remove leading whitespace.
467 [[:space:]]*) acl=${acl#?} ;;
472 ## If there's nothing left, leave.
473 case "$acl" in ?*) ;; *) break ;; esac
475 ## Split off the leading word.
477 *[[:space:]]*) word=${acl%%[[:space:]]*} acl=${acl#*[[:space:]]} ;;
478 *) word=$acl acl="" ;;
481 ## See what sense it has if it matches.
483 -*) sense=forbid rest=${word#-} ;;
484 *) sense=allow rest=$word ;;
487 ## See whether the calling user matches.
489 !owner) pat=$kowner list=$USERV_USER ;;
490 !*) echo >&2 "$quis: unknown ACL token \`$word'" ;;
491 %*) pat=${rest#%} list="$USERV_GROUP $USERV_GID" ;;
492 *) pat=$rest list="$USERV_USER $USERV_UID" ;;
495 for i in $list; do case "$i" in $pat) matchp=t; break ;; esac; done
496 case $matchp in t) verdict=$sense; break ;; esac
500 forbid) echo >&2 "$quis: $op access to key \`$key' forbidden"; exit 1 ;;
504 ###--------------------------------------------------------------------------
505 ### Crypto operations for infrastructure purposes.
509 ## Select the profile in FILE for future crypto operations.
511 unset $(set | sed -n '/^kprop_/s/=.*$//p')
513 getsysprofile "$profile" >$tmp/profile
514 readprops $tmp/profile
518 profile=$1 kdir=$2 knub=$3; shift 3
519 ## Generate a system key using PROFILE; store the data in KDIR and the nub
520 ## in KNUB. Remaining arguments are options.
522 c_sysprofile "$profile"
523 c_genkey "$profile" "$kdir" "$knub" : "$@"
529 c_sysprofile "$profile"
533 op=$1 kdir=$2; shift 1
538 c_sysencrypt () { c_sysop encrypt "$1" /dev/null; }
539 c_sysdecrypt () { c_sysop decrypt "$1" "$2"; }
540 c_syssign () { c_sysop sign "$1" "$2"; }
541 c_sysverify () { c_sysop verify "$1" /dev/null; }
543 ###--------------------------------------------------------------------------
544 ### Recovery operations.
548 ## Stash a copy of stdin encrypted under the recovery key RECOV, with a
550 checkword "recovery key label" "$recov"
551 checklabel "secret" "$label"
553 rdir=$KEYS/recov/$recov/current
554 if [ ! -d $rdir/store ]; then
555 echo >&2 "$quis: unknown recovery key \`$recov'"
558 case $label in */*) mkdir -m755 -p $rdir/${label%/*} ;; esac
559 (c_sysencrypt $rdir/store >$rdir/$label.new)
560 mv $rdir/$label.new $rdir/$label.recov
565 ## Recover a stashed secret, protected by RECOV and stored as LABEL, and
566 ## write it to stdout.
567 checkword "recovery key label" "$recov"
568 checklabel "secret" "$label"
570 rdir=$KEYS/recov/$recov/current
571 if [ ! -f $rdir/$label.recov ]; then
572 echo >&2 "$quis: no blob for \`$label' under recovery key \`$recov'"
576 nub=$SAFE/keys.reveal/$recov.current/nub
577 if [ ! -f $nub ]; then
578 echo >&2 "$quis: current recovery key \`$recov' not revealed"
582 c_sysdecrypt $rdir/store $nub <$rdir/$label.recov
585 ###--------------------------------------------------------------------------
590 usage="usage: $quis${umsg+ }$umsg"
592 case "$KEYS_HELP" in t) help; exit ;; esac
595 help () { showhelp; }
604 usage_err () { echo >&2 "$usage"; exit 1; }
606 ###--------------------------------------------------------------------------
607 ### Subcommand handling.
610 echo "$PACKAGE version $VERSION"
623 -h Show this help text.
624 -v Show the program version number.
629 for i in $prefix.*; do
630 if [ ! -x "$i" ]; then continue; fi
631 sed -n "/<<HELP/{n;s/^/ ${i#$prefix.} /;p;q;}" "$i"
637 if [ ! -x "$KEYSLIB/$prefix.$i" ]; then
638 echo >&2 "$quis: unrecognized command \`$i'"
641 elif ! KEYS_HELP=t "$KEYSLIB/$prefix.$i"; then
651 case $# in 0) echo >&2 "$usage"; exit 1 ;; esac
653 case "$cmd" in help) cmd_help "$@"; exit ;; esac
654 if [ ! -x "$KEYSLIB/$prefix.$cmd" ]; then
655 echo >&2 "$quis: unrecognized command \`$cmd'"
660 exec "$KEYSLIB/$prefix.$cmd" "$@"
663 ###----- That's all, folks --------------------------------------------------