/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

Hooks take new "modules" argument, and hook names can contain periods.

* debian/mandos-client.README.Debian: Adjust wording.
* debian/rules (binary-common): Exclude nework-hooks.d directory from
                                dh_fixperms.
* initramfs-tools-hook: Also create network hook directory.  Allow
                        periods in hook names.  Only run executable
                        files in hook directory.  Copy needed modules.
* network-hooks.d/bridge: Fix "/usr/bin/brctl" to "/usr/sbin/brctl".
                          Also take "modules" argument.
* plugins.d/mandos-client.xml (NETWORK HOOKS/REQUIREMENTS): Document
                                                            the
                                                            allowing
                                                            of periods
                                                            in hook
                                                            names.
  (NETWORK HOOKS/REQUIREMENTS/files): Adjust wording.
  (NETWORK HOOKS/REQUIREMENTS/modules): New.
  (NETWORK HOOKS/REQUIREMENTS/MANDOSNETHOOKDIR): Clarify.
  (NETWORK HOOKS/REQUIREMENTS/MODE): Add "modules".

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 "2021-02-03">
 
4
<!ENTITY TIMESTAMP "2011-10-03">
5
5
<!ENTITY % common SYSTEM "common.ent">
6
6
%common;
7
7
]>
31
31
    </authorgroup>
32
32
    <copyright>
33
33
      <year>2011</year>
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>
42
 
      <year>2020</year>
43
34
      <holder>Teddy Hogeborn</holder>
44
35
      <holder>Björn Påhlsson</holder>
45
36
    </copyright>
69
60
      The computers run a small client program in the initial RAM disk
70
61
      environment which will communicate with a server over a network.
71
62
      All network communication is encrypted using TLS.  The clients
72
 
      are identified by the server using a TLS public key; each client
 
63
      are identified by the server using an OpenPGP key; each client
73
64
      has one unique to it.  The server sends the clients an encrypted
74
65
      password.  The encrypted password is decrypted by the clients
75
 
      using a separate OpenPGP key, and the password is then used to
 
66
      using the same OpenPGP key, and the password is then used to
76
67
      unlock the root file system, whereupon the computers can
77
68
      continue booting normally.
78
69
    </para>
81
72
  <refsect1 id="introduction">
82
73
    <title>INTRODUCTION</title>
83
74
    <para>
84
 
      <!-- This paragraph is a combination and paraphrase of two
85
 
           quotes from the 1995 movie “The Usual Suspects”. -->
86
75
      You know how it is.  You’ve heard of it happening.  The Man
87
76
      comes and takes away your servers, your friends’ servers, the
88
77
      servers of everybody in the same hosting facility. The servers
132
121
    </para>
133
122
    <para>
134
123
      So, at boot time, the Mandos client will ask for its encrypted
135
 
      data over the network, decrypt the data to get the password, use
136
 
      the password to decrypt the root file system, and the client can
137
 
      then continue booting.
 
124
      data over the network, decrypt it to get the password, use it to
 
125
      decrypt the root file, and continue booting.
138
126
    </para>
139
127
    <para>
140
128
      Now, of course the initial RAM disk image is not on the
146
134
      long, and will no longer give out the encrypted key.  The timing
147
135
      here is the only real weak point, and the method, frequency and
148
136
      timeout of the server’s checking can be adjusted to any desired
149
 
      level of paranoia.
 
137
      level of paranoia
150
138
    </para>
151
139
    <para>
152
140
      (The encrypted keys on the Mandos server is on its normal file
203
191
      <para>
204
192
        No.  The server only gives out the passwords to clients which
205
193
        have <emphasis>in the TLS handshake</emphasis> proven that
206
 
        they do indeed hold the private key corresponding to that
207
 
        client.
208
 
      </para>
209
 
    </refsect2>
210
 
    
211
 
    <refsect2 id="sniff">
212
 
      <title>How about sniffing the network traffic and decrypting it
213
 
      later by physically grabbing the Mandos client and using its
214
 
      key?</title>
215
 
      <para>
216
 
        We only use <acronym>PFS</acronym> (Perfect Forward Security)
217
 
        key exchange algorithms in TLS, which protects against this.
 
194
        they do indeed hold the OpenPGP private key corresponding to
 
195
        that client.
218
196
      </para>
219
197
    </refsect2>
220
198
    
236
214
      </para>
237
215
    </refsect2>
238
216
    
239
 
    <refsect2 id="fakecheck">
240
 
      <title>Faking checker results?</title>
 
217
    <refsect2 id="fakeping">
 
218
      <title>Faking ping replies?</title>
241
219
      <para>
242
 
        If the Mandos client does not have an SSH server, the default
243
 
        is for the Mandos server to use
 
220
        The default for the server is to use
244
221
        <quote><literal>fping</literal></quote>, the replies to which
245
222
        could be faked to eliminate the timeout.  But this could
246
223
        easily be changed to any shell command, with any security
247
 
        measures you like.  If the Mandos client
248
 
        <emphasis>has</emphasis> an SSH server, the default
249
 
        configuration (as generated by
250
 
        <command>mandos-keygen</command> with the
251
 
        <option>--password</option> option) is for the Mandos server
252
 
        to use an <command>ssh-keyscan</command> command with strict
253
 
        keychecking, which can not be faked.  Alternatively, IPsec
254
 
        could be used for the ping packets, making them secure.
 
224
        measures you like.  It could, for instance, be changed to an
 
225
        SSH command with strict keychecking, which could not be faked.
 
226
        Or IPsec could be used for the ping packets, making them
 
227
        secure.
255
228
      </para>
256
229
    </refsect2>
257
230
  </refsect1>
385
358
      plugin requirements.
386
359
    </para>
387
360
  </refsect1>
388
 
 
389
 
  <refsect1 id="systemd">
390
 
    <title>SYSTEMD</title>
391
 
    <para>
392
 
      More advanced startup systems like <citerefentry><refentrytitle
393
 
      >systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
394
 
      already have their own plugin-like mechanisms for allowing
395
 
      multiple agents to independently retrieve a password and deliver
396
 
      it to the subsystem requesting a password to unlock the root
397
 
      file system.  On these systems, it would make no sense to run
398
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle
399
 
      ><manvolnum>8mandos</manvolnum></citerefentry>, the plugins of
400
 
      which would largely duplicate the work of (and conflict with)
401
 
      the existing systems prompting for passwords.
402
 
    </para>
403
 
    <para>
404
 
      As for <citerefentry><refentrytitle>systemd</refentrytitle
405
 
      ><manvolnum>1</manvolnum></citerefentry> in particular, it has
406
 
      its own <ulink
407
 
      url="https://systemd.io/PASSWORD_AGENTS/">Password
408
 
      Agents</ulink> system.  Mandos uses this via its
409
 
      <citerefentry><refentrytitle>password-agent</refentrytitle
410
 
      ><manvolnum>8mandos</manvolnum></citerefentry> program, which is
411
 
      run instead of <citerefentry><refentrytitle
412
 
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum
413
 
      ></citerefentry> when <citerefentry><refentrytitle
414
 
      >systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
415
 
      is used during system startup.
416
 
    </para>
417
 
  </refsect1>
418
 
  <refsect1 id="bugs">
419
 
    <title>BUGS</title>
420
 
    <xi:include href="bugs.xml"/>
421
 
  </refsect1>
422
361
  
423
362
  <refsect1 id="see_also">
424
363
    <title>SEE ALSO</title>
435
374
      <manvolnum>8</manvolnum></citerefentry>,
436
375
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
437
376
      <manvolnum>8mandos</manvolnum></citerefentry>,
438
 
      <citerefentry><refentrytitle>password-agent</refentrytitle>
439
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
440
377
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
441
378
      <manvolnum>8mandos</manvolnum></citerefentry>,
442
379
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
455
392
    <variablelist>
456
393
      <varlistentry>
457
394
        <term>
458
 
          <ulink url="https://www.recompile.se/mandos">Mandos</ulink>
 
395
          <ulink url="http://www.recompile.se/mandos">Mandos</ulink>
459
396
        </term>
460
397
        <listitem>
461
398
          <para>