/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 intro.xml

  • 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:
intro.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY TIMESTAMP "2014-06-22">
 
4
<!ENTITY TIMESTAMP "2019-04-10">
5
5
<!ENTITY % common SYSTEM "common.ent">
6
6
%common;
7
7
]>
32
32
    <copyright>
33
33
      <year>2011</year>
34
34
      <year>2012</year>
 
35
      <year>2013</year>
 
36
      <year>2014</year>
 
37
      <year>2015</year>
 
38
      <year>2016</year>
 
39
      <year>2017</year>
 
40
      <year>2018</year>
 
41
      <year>2019</year>
35
42
      <holder>Teddy Hogeborn</holder>
36
43
      <holder>Björn Påhlsson</holder>
37
44
    </copyright>
61
68
      The computers run a small client program in the initial RAM disk
62
69
      environment which will communicate with a server over a network.
63
70
      All network communication is encrypted using TLS.  The clients
64
 
      are identified by the server using an OpenPGP key; each client
 
71
      are identified by the server using a TLS public key; each client
65
72
      has one unique to it.  The server sends the clients an encrypted
66
73
      password.  The encrypted password is decrypted by the clients
67
 
      using the same OpenPGP key, and the password is then used to
 
74
      using a separate OpenPGP key, and the password is then used to
68
75
      unlock the root file system, whereupon the computers can
69
76
      continue booting normally.
70
77
    </para>
73
80
  <refsect1 id="introduction">
74
81
    <title>INTRODUCTION</title>
75
82
    <para>
 
83
      <!-- This paragraph is a combination and paraphrase of two
 
84
           quotes from the 1995 movie “The Usual Suspects”. -->
76
85
      You know how it is.  You’ve heard of it happening.  The Man
77
86
      comes and takes away your servers, your friends’ servers, the
78
87
      servers of everybody in the same hosting facility. The servers
122
131
    </para>
123
132
    <para>
124
133
      So, at boot time, the Mandos client will ask for its encrypted
125
 
      data over the network, decrypt it to get the password, use it to
126
 
      decrypt the root file, and continue booting.
 
134
      data over the network, decrypt the data to get the password, use
 
135
      the password to decrypt the root file system, and the client can
 
136
      then continue booting.
127
137
    </para>
128
138
    <para>
129
139
      Now, of course the initial RAM disk image is not on the
135
145
      long, and will no longer give out the encrypted key.  The timing
136
146
      here is the only real weak point, and the method, frequency and
137
147
      timeout of the server’s checking can be adjusted to any desired
138
 
      level of paranoia
 
148
      level of paranoia.
139
149
    </para>
140
150
    <para>
141
151
      (The encrypted keys on the Mandos server is on its normal file
192
202
      <para>
193
203
        No.  The server only gives out the passwords to clients which
194
204
        have <emphasis>in the TLS handshake</emphasis> proven that
195
 
        they do indeed hold the OpenPGP private key corresponding to
196
 
        that client.
 
205
        they do indeed hold the private key corresponding to that
 
206
        client.
 
207
      </para>
 
208
    </refsect2>
 
209
    
 
210
    <refsect2 id="sniff">
 
211
      <title>How about sniffing the network traffic and decrypting it
 
212
      later by physically grabbing the Mandos client and using its
 
213
      key?</title>
 
214
      <para>
 
215
        We only use <acronym>PFS</acronym> (Perfect Forward Security)
 
216
        key exchange algorithms in TLS, which protects against this.
197
217
      </para>
198
218
    </refsect2>
199
219
    
365
385
    </para>
366
386
  </refsect1>
367
387
  
 
388
  <refsect1 id="bugs">
 
389
    <title>BUGS</title>
 
390
    <xi:include href="bugs.xml"/>
 
391
  </refsect1>
 
392
  
368
393
  <refsect1 id="see_also">
369
394
    <title>SEE ALSO</title>
370
395
    <para>
398
423
    <variablelist>
399
424
      <varlistentry>
400
425
        <term>
401
 
          <ulink url="http://www.recompile.se/mandos">Mandos</ulink>
 
426
          <ulink url="https://www.recompile.se/mandos">Mandos</ulink>
402
427
        </term>
403
428
        <listitem>
404
429
          <para>