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