[pkg-cryptsetup-devel] Bug#898516: cryptroot: verbosity of keyfile copy operation

[Stefan Tauner]

Package: cryptsetup
Version: 2:2.0.2-1

Hi,

it took me quite some time to figure out how to set up my initrd to
include the correct key file. The documentation is actually quite clear
*when* one finds the correct bits (search engines find way too many
outdated tutorials instead unfortunately... due to
https://anonscm.debian.org/robots.txt).

One thing that could have saved me some time (and looking into the
actual source code of the cryptroot hook) would be a clear indication
when key files are copied like it is done for other operations in
initramfs scripts. I have expected something like
"Adding keyfile ${KEYFILE} as /cryptroot-keyfiles/${node}.key"
or similar when updating the initramfs using -v. I would have sent a
patch, however, I am not entirely sure how to add a message to
add_device() properly since it uses stdout/echo to return required
kernel modules. I guess the best would be to refactor the function and
use the generic copy_file() function of the hook-functions library
that prints a suitable message?

Also, since the name and destination directory of the key files are
chosen by the script and not influenced by the source name/user it might
be nice to document the (naming) scheme.

The problem exists since the code was added in r1044 (cf. bug #786578):
https://anonscm.debian.org/viewvc/pkg-cryptsetup/cryptsetup/trunk/debian/initramfs/cryptroot-hook?r1=1043&r2=1044&pathrev=1044&

-- 
Kind regards/Mit freundlichen Grüßen, Stefan Tauner