/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: 2014-07-12 13:13:28 UTC
  • Revision ID: teddy@recompile.se-20140712131328-gdkvcea7f9rov7bn
mandos-client: Fix minor memory leak on memory full or clock failure.

* plugins.d/mandos-client.c (add_server): On any errors, free
                                          new_server and its contents
                                          before returning.

Show diffs side-by-side

added added

removed removed

Lines of Context:
intro.xml
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
 
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
4
<!ENTITY TIMESTAMP "2014-06-22">
 
5
<!ENTITY % common SYSTEM "common.ent">
 
6
%common;
 
7
]>
 
8
 
 
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
10
   <refentryinfo>
 
11
    <title>Mandos Manual</title>
 
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
 
13
    <productname>Mandos</productname>
 
14
    <productnumber>&version;</productnumber>
 
15
    <date>&TIMESTAMP;</date>
 
16
    <authorgroup>
 
17
      <author>
 
18
        <firstname>Björn</firstname>
 
19
        <surname>Påhlsson</surname>
 
20
        <address>
 
21
          <email>belorn@recompile.se</email>
 
22
        </address>
 
23
      </author>
 
24
      <author>
 
25
        <firstname>Teddy</firstname>
 
26
        <surname>Hogeborn</surname>
 
27
        <address>
 
28
          <email>teddy@recompile.se</email>
 
29
        </address>
 
30
      </author>
 
31
    </authorgroup>
 
32
    <copyright>
 
33
      <year>2011</year>
 
34
      <year>2012</year>
 
35
      <holder>Teddy Hogeborn</holder>
 
36
      <holder>Björn Påhlsson</holder>
 
37
    </copyright>
 
38
    <xi:include href="legalnotice.xml"/>
 
39
  </refentryinfo>
 
40
  
 
41
  <refmeta>
 
42
    <refentrytitle>intro</refentrytitle>
 
43
    <manvolnum>8mandos</manvolnum>
 
44
  </refmeta>
 
45
  
 
46
  <refnamediv>
 
47
    <refname>intro</refname>
 
48
    <refpurpose>
 
49
      Introduction to the Mandos system
 
50
    </refpurpose>
 
51
  </refnamediv>
 
52
  
 
53
  <refsect1 id="description">
 
54
    <title>DESCRIPTION</title>
 
55
    <para>
 
56
      This is the the Mandos system, which allows computers to have
 
57
      encrypted root file systems and at the same time be capable of
 
58
      remote and/or unattended reboots.
 
59
    </para>
 
60
    <para>
 
61
      The computers run a small client program in the initial RAM disk
 
62
      environment which will communicate with a server over a network.
 
63
      All network communication is encrypted using TLS.  The clients
 
64
      are identified by the server using an OpenPGP key; each client
 
65
      has one unique to it.  The server sends the clients an encrypted
 
66
      password.  The encrypted password is decrypted by the clients
 
67
      using the same OpenPGP key, and the password is then used to
 
68
      unlock the root file system, whereupon the computers can
 
69
      continue booting normally.
 
70
    </para>
 
71
  </refsect1>
 
72
  
 
73
  <refsect1 id="introduction">
 
74
    <title>INTRODUCTION</title>
 
75
    <para>
 
76
      You know how it is.  You’ve heard of it happening.  The Man
 
77
      comes and takes away your servers, your friends’ servers, the
 
78
      servers of everybody in the same hosting facility. The servers
 
79
      of their neighbors, and their neighbors’ friends.  The servers
 
80
      of people who owe them money.  And like
 
81
      <emphasis>that</emphasis>, they’re gone.  And you doubt you’ll
 
82
      ever see them again.
 
83
    </para>
 
84
    <para>
 
85
      That is why your servers have encrypted root file systems.
 
86
      However, there’s a downside.  There’s no going around it:
 
87
      rebooting is a pain.  Dragging out that rarely-used keyboard and
 
88
      screen and unraveling cables behind your servers to plug them in
 
89
      to type in that password is messy, especially if you have many
 
90
      servers.  There are some people who do clever things like using
 
91
      serial line consoles and daisy-chain it to the next server, and
 
92
      keep all the servers connected in a ring with serial cables,
 
93
      which will work, if your servers are physically close enough.
 
94
      There are also other out-of-band management solutions, but with
 
95
      <emphasis>all</emphasis> these, you still have to be on hand and
 
96
      manually type in the password at boot time.  Otherwise the
 
97
      server just sits there, waiting for a password.
 
98
    </para>
 
99
    <para>
 
100
      Wouldn’t it be great if you could have the security of encrypted
 
101
      root file systems and still have servers that could boot up
 
102
      automatically if there was a short power outage while you were
 
103
      asleep?  That you could reboot at will, without having someone
 
104
      run over to the server to type in the password?
 
105
    </para>
 
106
    <para>
 
107
      Well, with Mandos, you (almost) can!  The gain in convenience
 
108
      will only be offset by a small loss in security.  The setup is
 
109
      as follows:
 
110
    </para>
 
111
    <para>
 
112
      The server will still have its encrypted root file system.  The
 
113
      password to this file system will be stored on another computer
 
114
      (henceforth known as the Mandos server) on the same local
 
115
      network.  The password will <emphasis>not</emphasis> be stored
 
116
      in plaintext, but encrypted with OpenPGP.  To decrypt this
 
117
      password, a key is needed.  This key (the Mandos client key)
 
118
      will not be stored there, but back on the original server
 
119
      (henceforth known as the Mandos client) in the initial RAM disk
 
120
      image.  Oh, and all network Mandos client/server communications
 
121
      will be encrypted, using TLS (SSL).
 
122
    </para>
 
123
    <para>
 
124
      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.
 
127
    </para>
 
128
    <para>
 
129
      Now, of course the initial RAM disk image is not on the
 
130
      encrypted root file system, so anyone who had physical access
 
131
      could take the Mandos client computer offline and read the disk
 
132
      with their own tools to get the authentication keys used by a
 
133
      client.  <emphasis>But</emphasis>, by then the Mandos server
 
134
      should notice that the original server has been offline for too
 
135
      long, and will no longer give out the encrypted key.  The timing
 
136
      here is the only real weak point, and the method, frequency and
 
137
      timeout of the server’s checking can be adjusted to any desired
 
138
      level of paranoia
 
139
    </para>
 
140
    <para>
 
141
      (The encrypted keys on the Mandos server is on its normal file
 
142
      system, so those are safe, provided the root file system of
 
143
      <emphasis>that</emphasis> server is encrypted.)
 
144
    </para>
 
145
  </refsect1>
 
146
  
 
147
  <refsect1 id="faq">
 
148
    <title>FREQUENTLY ASKED QUESTIONS</title>
 
149
    <para>
 
150
      Couldn’t the security be defeated by…
 
151
    </para>
 
152
    <refsect2 id="quick">
 
153
      <title>Grabbing the Mandos client key from the
 
154
      initrd <emphasis>really quickly</emphasis>?</title>
 
155
    <para>
 
156
      This, as mentioned above, is the only real weak point.  But if
 
157
      you set the timing values tight enough, this will be really
 
158
      difficult to do.  An attacker would have to physically
 
159
      disassemble the client computer, extract the key from the
 
160
      initial RAM disk image, and then connect to a <emphasis>still
 
161
      online</emphasis> Mandos server to get the encrypted key, and do
 
162
      all this <emphasis>before</emphasis> the Mandos server timeout
 
163
      kicks in and the Mandos server refuses to give out the key to
 
164
      anyone.
 
165
    </para>
 
166
    <para>
 
167
      Now, as the typical procedure seems to be to barge in and turn
 
168
      off and grab <emphasis>all</emphasis> computers, to maybe look
 
169
      at them months later, this is not likely.  If someone does that,
 
170
      the whole system <emphasis>will</emphasis> lock itself up
 
171
      completely, since Mandos servers are no longer running.
 
172
    </para>
 
173
    <para>
 
174
      For sophisticated attackers who <emphasis>could</emphasis> do
 
175
      the clever thing, <emphasis>and</emphasis> had physical access
 
176
      to the server for enough time, it would be simpler to get a key
 
177
      for an encrypted file system by using hardware memory scanners
 
178
      and reading it right off the memory bus.
 
179
    </para>
 
180
    </refsect2>
 
181
    
 
182
    <refsect2 id="replay">
 
183
      <title>Replay attacks?</title>
 
184
      <para>
 
185
        Nope, the network stuff is all done over TLS, which provides
 
186
        protection against that.
 
187
      </para>
 
188
    </refsect2>
 
189
    
 
190
    <refsect2 id="mitm">
 
191
      <title>Man-in-the-middle?</title>
 
192
      <para>
 
193
        No.  The server only gives out the passwords to clients which
 
194
        have <emphasis>in the TLS handshake</emphasis> proven that
 
195
        they do indeed hold the OpenPGP private key corresponding to
 
196
        that client.
 
197
      </para>
 
198
    </refsect2>
 
199
    
 
200
    <refsect2 id="physgrab">
 
201
      <title>Physically grabbing the Mandos server computer?</title>
 
202
      <para>
 
203
        You could protect <emphasis>that</emphasis> computer the
 
204
        old-fashioned way, with a must-type-in-the-password-at-boot
 
205
        method.  Or you could have two computers be the Mandos server
 
206
        for each other.
 
207
      </para>
 
208
      <para>
 
209
        Multiple Mandos servers can coexist on a network without any
 
210
        trouble.  They do not clash, and clients will try all
 
211
        available servers.  This means that if just one reboots then
 
212
        the other can bring it back up, but if both reboot at the same
 
213
        time they will stay down until someone types in the password
 
214
        on one of them.
 
215
      </para>
 
216
    </refsect2>
 
217
    
 
218
    <refsect2 id="fakecheck">
 
219
      <title>Faking checker results?</title>
 
220
      <para>
 
221
        If the Mandos client does not have an SSH server, the default
 
222
        is for the Mandos server to use
 
223
        <quote><literal>fping</literal></quote>, the replies to which
 
224
        could be faked to eliminate the timeout.  But this could
 
225
        easily be changed to any shell command, with any security
 
226
        measures you like.  If the Mandos client
 
227
        <emphasis>has</emphasis> an SSH server, the default
 
228
        configuration (as generated by
 
229
        <command>mandos-keygen</command> with the
 
230
        <option>--password</option> option) is for the Mandos server
 
231
        to use an <command>ssh-keyscan</command> command with strict
 
232
        keychecking, which can not be faked.  Alternatively, IPsec
 
233
        could be used for the ping packets, making them secure.
 
234
      </para>
 
235
    </refsect2>
 
236
  </refsect1>
 
237
  
 
238
  <refsect1 id="security">
 
239
    <title>SECURITY</title>
 
240
    <para>
 
241
      So, in summary:  The only weakness in the Mandos system is from
 
242
      people who have:
 
243
    </para>
 
244
    <orderedlist>
 
245
      <listitem>
 
246
        <para>
 
247
          The power to come in and physically take your servers,
 
248
          <emphasis>and</emphasis>
 
249
        </para>
 
250
      </listitem>
 
251
      <listitem>
 
252
        <para>
 
253
          The cunning and patience to do it carefully, one at a time,
 
254
          and <emphasis>quickly</emphasis>, faking Mandos
 
255
          client/server responses for each one before the timeout.
 
256
        </para>
 
257
      </listitem>
 
258
    </orderedlist>
 
259
    <para>
 
260
      While there are some who may be threatened by people who have
 
261
      <emphasis>both</emphasis> these attributes, they do not,
 
262
      probably, constitute the majority.
 
263
    </para>
 
264
    <para>
 
265
      If you <emphasis>do</emphasis> face such opponents, you must
 
266
      figure that they could just as well open your servers and read
 
267
      the file system keys right off the memory by running wires to
 
268
      the memory bus.
 
269
    </para>
 
270
    <para>
 
271
      What Mandos is designed to protect against is
 
272
      <emphasis>not</emphasis> such determined, focused, and competent
 
273
      attacks, but against the early morning knock on your door and
 
274
      the sudden absence of all the servers in your server room.
 
275
      Which it does nicely.
 
276
    </para>
 
277
  </refsect1>
 
278
  
 
279
  <refsect1 id="plugins">
 
280
    <title>PLUGINS</title>
 
281
    <para>
 
282
      In the early designs, the
 
283
      <citerefentry><refentrytitle>mandos-client</refentrytitle
 
284
      ><manvolnum>8mandos</manvolnum></citerefentry> program (which
 
285
      retrieves a password from the Mandos server) also prompted for a
 
286
      password on the terminal, in case a Mandos server could not be
 
287
      found.  Other ways of retrieving a password could easily be
 
288
      envisoned, but this multiplicity of purpose was seen to be too
 
289
      complex to be a viable way to continue.  Instead, the original
 
290
      program was separated into <citerefentry><refentrytitle
 
291
      >mandos-client</refentrytitle><manvolnum>8mandos</manvolnum
 
292
      ></citerefentry> and <citerefentry><refentrytitle
 
293
      >password-prompt</refentrytitle><manvolnum>8mandos</manvolnum
 
294
      ></citerefentry>, and a <citerefentry><refentrytitle
 
295
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum
 
296
      ></citerefentry> exist to run them both in parallel, allowing
 
297
      the first successful plugin to provide the password.  This
 
298
      opened up for any number of additional plugins to run, all
 
299
      competing to be the first to find a password and provide it to
 
300
      the plugin runner.
 
301
    </para>
 
302
    <para>
 
303
      Four additional plugins are provided:
 
304
    </para>
 
305
    <variablelist>
 
306
      <varlistentry>
 
307
        <term>
 
308
          <citerefentry><refentrytitle>plymouth</refentrytitle>
 
309
          <manvolnum>8mandos</manvolnum></citerefentry>
 
310
        </term>
 
311
        <listitem>
 
312
          <para>
 
313
            This prompts for a password when using <citerefentry>
 
314
            <refentrytitle>plymouth</refentrytitle><manvolnum
 
315
            >8</manvolnum></citerefentry>.
 
316
          </para>
 
317
        </listitem>
 
318
      </varlistentry>
 
319
      <varlistentry>
 
320
        <term>
 
321
          <citerefentry><refentrytitle>usplash</refentrytitle>
 
322
          <manvolnum>8mandos</manvolnum></citerefentry>
 
323
        </term>
 
324
        <listitem>
 
325
          <para>
 
326
            This prompts for a password when using <citerefentry>
 
327
            <refentrytitle>usplash</refentrytitle><manvolnum
 
328
            >8</manvolnum></citerefentry>.
 
329
          </para>
 
330
        </listitem>
 
331
      </varlistentry>
 
332
      <varlistentry>
 
333
        <term>
 
334
          <citerefentry><refentrytitle>splashy</refentrytitle>
 
335
          <manvolnum>8mandos</manvolnum></citerefentry>
 
336
        </term>
 
337
        <listitem>
 
338
          <para>
 
339
            This prompts for a password when using <citerefentry>
 
340
            <refentrytitle>splashy</refentrytitle><manvolnum
 
341
            >8</manvolnum></citerefentry>.
 
342
          </para>
 
343
        </listitem>
 
344
      </varlistentry>
 
345
      <varlistentry>
 
346
        <term>
 
347
          <citerefentry><refentrytitle>askpass-fifo</refentrytitle>
 
348
          <manvolnum>8mandos</manvolnum></citerefentry>
 
349
        </term>
 
350
        <listitem>
 
351
          <para>
 
352
            To provide compatibility with the "askpass" program from
 
353
            cryptsetup, this plugin listens to the same FIFO as
 
354
            askpass would do.
 
355
          </para>
 
356
        </listitem>
 
357
      </varlistentry>
 
358
    </variablelist>
 
359
    <para>
 
360
      More plugins can easily be written and added by the system
 
361
      administrator; see the section called "WRITING PLUGINS" in
 
362
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
363
      <manvolnum>8mandos</manvolnum></citerefentry> to learn the
 
364
      plugin requirements.
 
365
    </para>
 
366
  </refsect1>
 
367
  
 
368
  <refsect1 id="see_also">
 
369
    <title>SEE ALSO</title>
 
370
    <para>
 
371
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
372
      <manvolnum>8</manvolnum></citerefentry>,
 
373
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
374
      <manvolnum>5</manvolnum></citerefentry>,
 
375
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
376
      <manvolnum>5</manvolnum></citerefentry>,
 
377
      <citerefentry><refentrytitle>mandos-ctl</refentrytitle>
 
378
      <manvolnum>8</manvolnum></citerefentry>,
 
379
      <citerefentry><refentrytitle>mandos-monitor</refentrytitle>
 
380
      <manvolnum>8</manvolnum></citerefentry>,
 
381
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
382
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
383
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
384
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
385
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
386
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
387
      <citerefentry><refentrytitle>plymouth</refentrytitle>
 
388
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
389
      <citerefentry><refentrytitle>usplash</refentrytitle>
 
390
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
391
      <citerefentry><refentrytitle>splashy</refentrytitle>
 
392
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
393
      <citerefentry><refentrytitle>askpass-fifo</refentrytitle>
 
394
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
395
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
 
396
      <manvolnum>8</manvolnum></citerefentry>
 
397
    </para>
 
398
    <variablelist>
 
399
      <varlistentry>
 
400
        <term>
 
401
          <ulink url="http://www.recompile.se/mandos">Mandos</ulink>
 
402
        </term>
 
403
        <listitem>
 
404
          <para>
 
405
            The Mandos home page.
 
406
          </para>
 
407
        </listitem>
 
408
      </varlistentry>
 
409
    </variablelist>
 
410
  </refsect1>
 
411
</refentry>
 
412
<!-- Local Variables: -->
 
413
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
414
<!-- time-stamp-end: "[\"']>" -->
 
415
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
416
<!-- End: -->