/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 INSTALL

  • 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:
2
2
 
3
3
* Prerequisites
4
4
  
5
 
  Debian 5.0 "lenny" or Ubuntu 8.04 "Hardy Heron".
6
 
  
7
 
  The following libraries and packages are needed.  (It is possible
8
 
  that it might work with older versions of some of these, but these
9
 
  versions are confirmed to work.  Newer versions are almost certainly
10
 
  OK.)
11
 
  
12
 
** Documentation
13
 
   These are required to build the manual pages for both the server
14
 
   and client:
15
 
   
16
 
   + DocBook 4.5          http://www.docbook.org/
17
 
   + DocBook XSL stylesheets 1.71.0
18
 
                   http://wiki.docbook.org/topic/DocBookXslStylesheets
19
 
  
20
 
** Mandos Server
21
 
   + GnuTLS 2.4           http://www.gnu.org/software/gnutls/
22
 
   + Avahi 0.6.16         http://www.avahi.org/
23
 
   + Python 2.4           http://www.python.org/
24
 
   + Python-GnuTLS 1.1.5  http://pypi.python.org/pypi/python-gnutls/
25
 
   + dbus-python 0.82.4   http://dbus.freedesktop.org/doc/dbus-python/
26
 
   + python-ctypes 1.0.0  http://pypi.python.org/pypi/ctypes
27
 
   
28
 
   Strongly recommended:
29
 
   + fping 2.4b2-to-ipv6  http://www.fping.com/
30
 
  
31
 
** Mandos Client
32
 
   + initramfs-tools 0.85i
33
 
                  http://packages.qa.debian.org/i/initramfs-tools.html
34
 
   + GnuTLS 2.4           http://www.gnu.org/software/gnutls/
35
 
   + Avahi 0.6.16         http://www.avahi.org/
36
 
   + GnuPG 1.4.9          http://www.gnupg.org/
37
 
   + GPGME 1.1.6          http://www.gnupg.org/related_software/gpgme/
 
5
** Operating System
 
6
   
 
7
   Debian 8.0 "jessie" or Ubuntu 15.10 "Wily Werewolf" (or later).
 
8
   
 
9
   This is mostly for the support scripts which make sure that the
 
10
   client is installed and started in the initial RAM disk environment
 
11
   and that the initial RAM file system image file is automatically
 
12
   made unreadable.  The server and client programs themselves *could*
 
13
   be run in other distributions, but they *are* specific to GNU/Linux
 
14
   systems, and are not written with portabillity to other Unixes in
 
15
   mind.
 
16
   
 
17
** Libraries
 
18
   
 
19
   The following libraries and packages are needed.  (It is possible
 
20
   that it might work with older versions of some of these, but these
 
21
   versions are confirmed to work.  Newer versions are almost
 
22
   certainly OK.)
 
23
   
 
24
*** Documentation
 
25
    These are required to build the manual pages for both the server
 
26
    and client:
 
27
    
 
28
    + DocBook 4.5         http://www.docbook.org/
 
29
      Note: DocBook 5.0 is not compatible.
 
30
    + DocBook XSL stylesheets 1.71.0
 
31
                         http://wiki.docbook.org/DocBookXslStylesheets
 
32
    
 
33
    Package names:
 
34
    docbook docbook-xsl
 
35
    
 
36
    To build just the documentation, run the command "make doc".  Then
 
37
    the manual page "mandos.8", for example, can be read by running
 
38
    "man -l mandos.8".
 
39
    
 
40
*** Mandos Server
 
41
    + GnuTLS 3.3          https://www.gnutls.org/
 
42
      (but not 3.6.0 or later, until 3.6.6, which works)
 
43
    + Avahi 0.6.16        https://www.avahi.org/
 
44
    + Python 2.7          https://www.python.org/
 
45
    + dbus-python 0.82.4 https://dbus.freedesktop.org/doc/dbus-python/
 
46
    + PyGObject 3.7.1     https://wiki.gnome.org/Projects/PyGObject
 
47
    + pkg-config https://www.freedesktop.org/wiki/Software/pkg-config/
 
48
    + Urwid 1.0.1         http://urwid.org/
 
49
      (Only needed by the "mandos-monitor" tool.)
 
50
    
 
51
    Strongly recommended:
 
52
    + fping 2.4b2-to-ipv6      http://www.fping.org/
 
53
    + ssh-keyscan from OpenSSH http://www.openssh.com/
 
54
    
 
55
    Package names:
 
56
    avahi-daemon python python-dbus python-gi python-urwid pkg-config
 
57
    fping ssh-client
 
58
    
 
59
*** Mandos Client
 
60
    + GNU C Library 2.17 https://gnu.org/software/libc/
 
61
    + GnuTLS 3.3        https://www.gnutls.org/
 
62
      (but not 3.6.0 or later, until 3.6.6 which works)
 
63
    + Avahi 0.6.16      https://www.avahi.org/
 
64
    + GnuPG 1.4.9       https://www.gnupg.org/
 
65
    + GPGME 1.1.6       https://www.gnupg.org/related_software/gpgme/
 
66
    + pkg-config https://www.freedesktop.org/wiki/Software/pkg-config/
 
67
    + libnl-route 3     https://www.infradead.org/~tgr/libnl/
 
68
    + GLib 2.40         http://www.gtk.org/
 
69
    
 
70
    One of:
 
71
    + initramfs-tools 0.85i
 
72
                        https://tracker.debian.org/pkg/initramfs-tools
 
73
    + dracut 044+241
 
74
         http://www.kernel.org/pub/linux/utils/boot/dracut/dracut.html
 
75
    
 
76
    Strongly recommended:
 
77
    + OpenSSH           http://www.openssh.com/
 
78
    
 
79
    Package names:
 
80
    initramfs-tools dracut libgnutls-dev gnutls-bin libavahi-core-dev
 
81
    gnupg libgpgme11-dev pkg-config ssh libnl-route-3-dev
 
82
    libglib2.0-dev
38
83
 
39
84
* Installing the Mandos server
40
85
  
41
 
  + Do "make doc".
 
86
  1. Do "make doc".
42
87
  
43
 
  + On the computer to run as a Mandos server, run the following
44
 
    command: "sudo make install-server".
45
 
    
46
 
    (This creates a configuration without any clients configured; we
47
 
    need an actually configured client to do that; see below.)
 
88
  2. On the computer to run as a Mandos server, run the following
 
89
     command:
 
90
     For Debian: su -c 'make install-server'
 
91
     For Ubuntu: sudo make install-server
 
92
     
 
93
     (This creates a configuration without any clients configured; you
 
94
     need an actually configured client to do that; see below.)
48
95
 
49
96
* Installing the Mandos client.
50
97
  
51
 
  + Do "make all doc".
52
 
  
53
 
  + On the computer to run as a Mandos server, run the following
54
 
    command: "sudo make install-client".  This will also create an
55
 
    OpenPGP key, which will take some time and entropy, so either wait
56
 
    patiently or frob your mouse until it's done.
57
 
  
58
 
  + Run "mandos-keygen --password".  When prompted, enter the
59
 
    password/passphrase for the encrypted root file system on this
60
 
    client computer.  It will output a section of text, starting with
61
 
    a [section header].  Copy and paste this into the
62
 
    "/etc/mandos/clients.conf" file *on the server computer*.
63
 
  
64
 
  + On the server computer, start the server by running the command
65
 
    "invoke-rc.d mandos start".
 
98
  1. Do "make all doc".
 
99
  
 
100
  2. On the computer to run as a Mandos client, run the following
 
101
     command:
 
102
     For Debian: su -c 'make install-client'
 
103
     For Ubuntu: sudo make install-client
 
104
     
 
105
     This will also create an OpenPGP key, which will take some time
 
106
     and entropy, so be patient.
 
107
  
 
108
  3. Run the following command:
 
109
     For Debian: su -c 'mandos-keygen --password'
 
110
     For Ubuntu: sudo mandos-keygen --password
 
111
     
 
112
     When prompted, enter the password/passphrase for the encrypted
 
113
     root file system on this client computer.  The command will
 
114
     output a section of text, starting with a [section header].  Copy
 
115
     and append this to the file "/etc/mandos/clients.conf" *on the
 
116
     server computer*.
 
117
  
 
118
  4. Configure the client to use any special configuration needed for
 
119
     your local system.  Note: This is not necessary if the server is
 
120
     present on the same wired local network as the client.  If you do
 
121
     make changes to /etc/mandos/plugin-runner.conf, the initrd.img
 
122
     file must be updated, possibly using the following command:
 
123
     
 
124
        # update-initramfs -k all -u
 
125
  
 
126
  5. On the server computer, start the server by running the command
 
127
     For Debian: su -c 'invoke-rc.d mandos start'
 
128
     For Ubuntu: sudo service mandos start
 
129
     
 
130
     At this point, it is possible to verify that the correct password
 
131
     will be received by the client by running the command:
 
132
     
 
133
        # /usr/lib/mandos/plugins.d/mandos-client \
 
134
                --pubkey=/etc/keys/mandos/pubkey.txt \
 
135
                --seckey=/etc/keys/mandos/seckey.txt \
 
136
                --tls-privkey=/etc/keys/mandos/tls-privkey.pem \
 
137
                --tls-pubkey=/etc/keys/mandos/tls-pubkey.pem; echo
 
138
     
 
139
     This command should retrieve the password from the server,
 
140
     decrypt it, and output it to standard output.
 
141
     
 
142
     After this, the client computer should be able to reboot without
 
143
     needing a password entered on the console, as long as it does not
 
144
     take more than five minutes to reboot.
66
145
 
67
146
* Further customizations
68
147
  
69
148
  You may want to tighten or loosen the timeouts in the server
70
149
  configuration files; see mandos.conf(5) and mandos-clients.conf(5).
71
 
  Is IPsec is not used, it is suggested that a more cryptographically
72
 
  secure checker program is used and configured, since without IPsec
73
 
  ping packets can be faked.
 
150
  If IPsec is not used and SSH is not installed, it is suggested that
 
151
  a more cryptographically secure checker program is used and
 
152
  configured, since, without IPsec, ping packets can be faked.
 
153
 
 
154
#+STARTUP: showall