/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos-to-cryptroot-unlock

  • Committer: Teddy Hogeborn
  • Date: 2019-07-27 10:11:45 UTC
  • Revision ID: teddy@recompile.se-20190727101145-jnpbpf8220gldbcd
Add dracut(8) support

Add support for the dracut(8) system for generating initramfs image
files; dracut is an alternative to the "initramfs-tools" package.

* .bzrignore (dracut-module/password-agent): Ignore new binary file.
* dracut-module: New directory for the dracut module.
* INSTALL (Prerequisites/Libraries/Mandos Client): Add dracut as an
                                                   alternative to
                                                   initramfs-tools,
                                                   and also add GLib.
* Makefile (DRACUTMODULE, GLIB_CFLAGS, GLIB_LIBS): New.
  (CPROGS): Add "dracut-module/password-agent".
  (DOCS): Add "dracut-module/password-agent.8mandos".
  (dracut-module/password-agent.8mandos): New.
  (dracut-module/password-agent.8mandos.xhtml): - '' -
  (dracut-module/password-agent): - '' -
  (check): Add command to run tests of password-agent(8mandos).
  (install-client-nokey): Also install the dracut module directory,
                          its files, and the password-agent(8mandos)
                          manual page.
  (install-client): To update the initramfs image file, run
                    update-initramfs or dracut depending on what is
                    installed.
  (uninstall-client): - '' - and also uninstall the the files in the
                      dracut module directory, that directory itself,
                      and the password-agent(8mandos) manual page.
* debian/control (Build-Depends): Add "libglib2.0-dev (>=2.40)".
  (Package: mandos-client/Depends): Add "dracut (>= 044+241-3)" as an
                                    alternative dependency to
                                    initramfs-tools.
  (Package: mandos-client/Conflicts): New; set to
                                      "dracut-config-generic".
  (debian/mandos-client.README.Debian): Document alternative commands
                                        to update the initramfs image
                                        for when dracut is used.
* debian/mandos-client.postinst (update_initramfs): Use alternative
                                                    commands to update
                                                    the initramfs
                                                    image for when
                                                    dracut is used.
* debian/tests/control (password-agent, password-agent-suid): Add two
                                                              new tests.
* dracut-module/ask-password-mandos.path: New.
* dracut-module/ask-password-mandos.service: - '' -
* dracut-module/cmdline-mandos.sh: - '' -
* dracut-module/module-setup.sh: - '' -
* dracut-module/password-agent.c: - '' -
* dracut-module/password-agent.xml: - '' -
* initramfs-unpack: Use the dracut "skipcpio" command, if available.
                    Also be more flexible and try hard to detect where
                    compressed data starts.
* plugins.d/mandos-client.xml (SECURITY): Be more precise that the
                                          mandos-client binary might
                                          not always be setuid, but
                                          that the program assumes
                                          that it has been started
                                          that way.
* plugins.d/password-prompt.c: Add new "--prompt" option.
  (conflict_detection): First try to detect the new PID file of
                        plymouth.
  (main): Define and use new "prompt" variable.
* plugins.d/password-prompt.xml (SYNOPSIS): Show new --prompt option.
  (DESCRIPTION): Describe new behavior of looking for plymouth PID
                 file.
  (OPTIONS): Document new "--prompt" option.
  (ENVIRONMENT): Clarify that the CRYPTTAB_SOURCE and CRYPTTAB_NAME
                 environment variables are not used if the --prompt
                 option is used.  Remove unnecessarily specific
                 details about where the CRYPTTAB_SOURCE and
                 CRYPTTAB_NAME comes from, since this can now be
                 either initramfs-tools or dracut.
  (SEE ALSO): Remove superfluous crypttab(5) reference, and add commas
              to separate the other references.
* plugins.d/plymouth.c: Add new "--prompt" and "--debug" options.
  (debug): New global flag.
  (fprintf_plus): New function, used for debug output.
  (exec_and_wait): Add extra "const" to "argv" argument.
  (main): Define and use new "prompt" variable.  Add debug output.
  (main/options, main/parse_opt): New; used to parse options.
* plugins.d/plymouth.xml (SYNOPSIS): Show new options.
  (OPTIONS): Document new options.
  (ENVIRONMENT): Clarify that the cryptsource and crypttarget
                 environment variables are not used if the --prompt
                 option is used.  Remove unnecessarily specific
                 details about where the cryptsource and crypttarget
                 comes from, since this can now be either
                 initramfs-tools or dracut.
  (EXAMPLE): Add an example using an option.
  (SEE ALSO): Remove superfluous crypttab(5) reference.
* plugins.d/splashy.xml (ENVIRONMENT): Clarify that the cryptsource
                                       and crypttarget environment
                                       variables are not used if the
                                       --prompt option is used.
                                       Remove unnecessarily specific
                                       details about where the
                                       cryptsource and crypttarget
                                       comes from, since this can now
                                       be either initramfs-tools or
                                       dracut.
  (SEE ALSO): Remove superfluous crypttab(5) reference.
* plugins.d/usplash.xml (ENVIRONMENT): Clarify that the cryptsource
                                       and crypttarget environment
                                       variables are not used if the
                                       --prompt option is used.
                                       Remove unnecessarily specific
                                       details about where the
                                       cryptsource and crypttarget
                                       comes from, since this can now
                                       be either initramfs-tools or
                                       dracut.
  (SEE ALSO): Remove superfluous crypttab(5) reference.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-to-cryptroot-unlock
 
1
#!/bin/sh
 
2
# 
 
3
# Script to get password from plugin-runner to cryptroot-unlock
 
4
# 
 
5
# Copyright © 2018 Teddy Hogeborn
 
6
# Copyright © 2018 Björn Påhlsson
 
7
# 
 
8
# This file is part of Mandos.
 
9
# 
 
10
# Mandos is free software: you can redistribute it and/or modify it
 
11
# under the terms of the GNU General Public License as published by
 
12
# the Free Software Foundation, either version 3 of the License, or
 
13
# (at your option) any later version.
 
14
# 
 
15
#     Mandos is distributed in the hope that it will be useful, but
 
16
#     WITHOUT ANY WARRANTY; without even the implied warranty of
 
17
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
18
#     GNU General Public License for more details.
 
19
# 
 
20
# You should have received a copy of the GNU General Public License
 
21
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
22
# 
 
23
# Contact the authors at <mandos@recompile.se>.
 
24
 
 
25
# This script is made to run in the initramfs, and must not be run in
 
26
# the normal system environment.
 
27
 
 
28
# Temporary file for the password
 
29
passfile=$(mktemp -p /run -t mandos.XXXXXX)
 
30
trap "rm -f -- $passfile 2>/dev/null" EXIT
 
31
 
 
32
# Disable the plugins which conflict with "askpass" as distributed by
 
33
# cryptsetup.
 
34
cat <<-EOF >>/conf/conf.d/mandos/plugin-runner.conf
 
35
 
 
36
        --disable=askpass-fifo
 
37
        --disable=password-prompt
 
38
        --disable=plymouth
 
39
EOF
 
40
 
 
41
# In case a password is retrieved by other means than by plugin-runner
 
42
# (such as typing it on the console into the prompt given by the
 
43
# "askpass" program), this dummy plugin will be made to exit
 
44
# successfully, thereby forcing plugin-runner to stop all its plugins
 
45
# and also exit itself.
 
46
cat <<-EOF > /lib/mandos/plugins.d/dummy
 
47
        #!/bin/sh
 
48
        
 
49
        while [ -e /run/mandos-keep-running ]; do
 
50
            sleep 1
 
51
        done
 
52
        
 
53
        # exit successfully to force plugin-runner to finish
 
54
        exit 0
 
55
EOF
 
56
chmod u=rwx,go=rx /lib/mandos/plugins.d/dummy
 
57
 
 
58
# This file is the flag which keeps the dummy plugin running
 
59
touch /run/mandos-keep-running
 
60
 
 
61
# Keep running plugin-runner and trying any password, until either a
 
62
# password is accepted by cryptroot-unlock, or plugin-runner fails, or
 
63
# the file /run/mandos-keep-running has been removed.
 
64
while command -v cryptroot-unlock >/dev/null 2>&1; do
 
65
    /lib/mandos/plugin-runner > "$passfile" &
 
66
    echo $! > /run/mandos-plugin-runner.pid
 
67
    wait %% || break
 
68
 
 
69
    # Try this password ten times (or ten seconds)
 
70
    for loop in 1 2 3 4 5 6 7 8 9 10; do
 
71
        if [ -e /run/mandos-keep-running ]; then
 
72
            cryptroot-unlock < "$passfile" >/dev/null 2>&1 && break 2
 
73
            sleep 1
 
74
        else
 
75
            break 2
 
76
        fi
 
77
    done
 
78
done
 
79
 
 
80
exec >/dev/null 2>&1
 
81
 
 
82
rm -f /run/mandos-plugin-runner.pid /run/mandos-keep-running