/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to intro.xml

Convert some programs to use the exit codes from <sysexits.h>.  Change
all programs using the "argp" parsing functions to use them correctly;
checking return value, using argp_error() to report parse errors etc.

* plugin-runner.c: Use <sysexits.h> exit codes.  Always use fallback,
                   even on option errors, except for "--help", etc.
  (getplugin): Make sure "errno" is set correctly on return.
  (main): Declare our own "--help", "--usage", and "--version"
          options which do not cause the fallback to be invoked.
          In all other options, use fallback on any error.
  (parse_opt, parse_opt_config_file): Reset errno at start and return
                                      errno.  No need to check "arg"
                                      for NULL.  New "--help",
                                      "--usage", and "--version"
                                      options.
  (parse_opt): Accept empty string as global option.  Do not print
               errors which will be detected and reported later.  Do
               "argp_error()" on parse error or empty plugin names.
* plugins.d/mandos-client.c: Use <sysexits.h> exit codes.  Do not
                             return successful exit code on "--help",
                             etc. since this would give the wrong
                             message to "plugin-runner".
  (main): Declare our own "--help", "--usage", and "--version"
          options which do not return a successful exit code.
  (parse_opt): Reset errno at start and return errno.  Do
               "argp_error()" on parse errors.  New "--help",
               "--usage", and "--version" options.
* plugins.d/password-prompt.c: Use exit codes from <sysexits.h>.  Do
                               not return successful exit code on
                               "--help", etc. since this would give
                               the wrong message to "plugin-runner".
  (main): Declare our own "--help", "--usage", and "--version" options
          which do not return a successful exit code.  Do
          close(STDOUT_FILENO) after writing to check its return code.
  (parse_opt): Reset errno at start and return errno.

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 "2012-01-01">
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="fakeping">
219
 
      <title>Faking ping replies?</title>
220
 
      <para>
221
 
        The default for the server is to use
222
 
        <quote><literal>fping</literal></quote>, the replies to which
223
 
        could be faked to eliminate the timeout.  But this could
224
 
        easily be changed to any shell command, with any security
225
 
        measures you like.  It could, for instance, be changed to an
226
 
        SSH command with strict keychecking, which could not be faked.
227
 
        Or IPsec could be used for the ping packets, making them
228
 
        secure.
229
 
      </para>
230
 
    </refsect2>
231
 
  </refsect1>
232
 
  
233
 
  <refsect1 id="security">
234
 
    <title>SECURITY</title>
235
 
    <para>
236
 
      So, in summary:  The only weakness in the Mandos system is from
237
 
      people who have:
238
 
    </para>
239
 
    <orderedlist>
240
 
      <listitem>
241
 
        <para>
242
 
          The power to come in and physically take your servers,
243
 
          <emphasis>and</emphasis>
244
 
        </para>
245
 
      </listitem>
246
 
      <listitem>
247
 
        <para>
248
 
          The cunning and patience to do it carefully, one at a time,
249
 
          and <emphasis>quickly</emphasis>, faking Mandos
250
 
          client/server responses for each one before the timeout.
251
 
        </para>
252
 
      </listitem>
253
 
    </orderedlist>
254
 
    <para>
255
 
      While there are some who may be threatened by people who have
256
 
      <emphasis>both</emphasis> these attributes, they do not,
257
 
      probably, constitute the majority.
258
 
    </para>
259
 
    <para>
260
 
      If you <emphasis>do</emphasis> face such opponents, you must
261
 
      figure that they could just as well open your servers and read
262
 
      the file system keys right off the memory by running wires to
263
 
      the memory bus.
264
 
    </para>
265
 
    <para>
266
 
      What Mandos is designed to protect against is
267
 
      <emphasis>not</emphasis> such determined, focused, and competent
268
 
      attacks, but against the early morning knock on your door and
269
 
      the sudden absence of all the servers in your server room.
270
 
      Which it does nicely.
271
 
    </para>
272
 
  </refsect1>
273
 
  
274
 
  <refsect1 id="plugins">
275
 
    <title>PLUGINS</title>
276
 
    <para>
277
 
      In the early designs, the
278
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle
279
 
      ><manvolnum>8mandos</manvolnum></citerefentry> program (which
280
 
      retrieves a password from the Mandos server) also prompted for a
281
 
      password on the terminal, in case a Mandos server could not be
282
 
      found.  Other ways of retrieving a password could easily be
283
 
      envisoned, but this multiplicity of purpose was seen to be too
284
 
      complex to be a viable way to continue.  Instead, the original
285
 
      program was separated into <citerefentry><refentrytitle
286
 
      >mandos-client</refentrytitle><manvolnum>8mandos</manvolnum
287
 
      ></citerefentry> and <citerefentry><refentrytitle
288
 
      >password-prompt</refentrytitle><manvolnum>8mandos</manvolnum
289
 
      ></citerefentry>, and a <citerefentry><refentrytitle
290
 
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum
291
 
      ></citerefentry> exist to run them both in parallel, allowing
292
 
      the first successful plugin to provide the password.  This
293
 
      opened up for any number of additional plugins to run, all
294
 
      competing to be the first to find a password and provide it to
295
 
      the plugin runner.
296
 
    </para>
297
 
    <para>
298
 
      Four additional plugins are provided:
299
 
    </para>
300
 
    <variablelist>
301
 
      <varlistentry>
302
 
        <term>
303
 
          <citerefentry><refentrytitle>plymouth</refentrytitle>
304
 
          <manvolnum>8mandos</manvolnum></citerefentry>
305
 
        </term>
306
 
        <listitem>
307
 
          <para>
308
 
            This prompts for a password when using <citerefentry>
309
 
            <refentrytitle>plymouth</refentrytitle><manvolnum
310
 
            >8</manvolnum></citerefentry>.
311
 
          </para>
312
 
        </listitem>
313
 
      </varlistentry>
314
 
      <varlistentry>
315
 
        <term>
316
 
          <citerefentry><refentrytitle>usplash</refentrytitle>
317
 
          <manvolnum>8mandos</manvolnum></citerefentry>
318
 
        </term>
319
 
        <listitem>
320
 
          <para>
321
 
            This prompts for a password when using <citerefentry>
322
 
            <refentrytitle>usplash</refentrytitle><manvolnum
323
 
            >8</manvolnum></citerefentry>.
324
 
          </para>
325
 
        </listitem>
326
 
      </varlistentry>
327
 
      <varlistentry>
328
 
        <term>
329
 
          <citerefentry><refentrytitle>splashy</refentrytitle>
330
 
          <manvolnum>8mandos</manvolnum></citerefentry>
331
 
        </term>
332
 
        <listitem>
333
 
          <para>
334
 
            This prompts for a password when using <citerefentry>
335
 
            <refentrytitle>splashy</refentrytitle><manvolnum
336
 
            >8</manvolnum></citerefentry>.
337
 
          </para>
338
 
        </listitem>
339
 
      </varlistentry>
340
 
      <varlistentry>
341
 
        <term>
342
 
          <citerefentry><refentrytitle>askpass-fifo</refentrytitle>
343
 
          <manvolnum>8mandos</manvolnum></citerefentry>
344
 
        </term>
345
 
        <listitem>
346
 
          <para>
347
 
            To provide compatibility with the "askpass" program from
348
 
            cryptsetup, this plugin listens to the same FIFO as
349
 
            askpass would do.
350
 
          </para>
351
 
        </listitem>
352
 
      </varlistentry>
353
 
    </variablelist>
354
 
    <para>
355
 
      More plugins can easily be written and added by the system
356
 
      administrator; see the section called "WRITING PLUGINS" in
357
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
358
 
      <manvolnum>8mandos</manvolnum></citerefentry> to learn the
359
 
      plugin requirements.
360
 
    </para>
361
 
  </refsect1>
362
 
  
363
 
  <refsect1 id="see_also">
364
 
    <title>SEE ALSO</title>
365
 
    <para>
366
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
367
 
      <manvolnum>8</manvolnum></citerefentry>,
368
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
369
 
      <manvolnum>5</manvolnum></citerefentry>,
370
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
371
 
      <manvolnum>5</manvolnum></citerefentry>,
372
 
      <citerefentry><refentrytitle>mandos-ctl</refentrytitle>
373
 
      <manvolnum>8</manvolnum></citerefentry>,
374
 
      <citerefentry><refentrytitle>mandos-monitor</refentrytitle>
375
 
      <manvolnum>8</manvolnum></citerefentry>,
376
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
377
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
378
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
379
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
380
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
381
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
382
 
      <citerefentry><refentrytitle>plymouth</refentrytitle>
383
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
384
 
      <citerefentry><refentrytitle>usplash</refentrytitle>
385
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
386
 
      <citerefentry><refentrytitle>splashy</refentrytitle>
387
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
388
 
      <citerefentry><refentrytitle>askpass-fifo</refentrytitle>
389
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
390
 
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
391
 
      <manvolnum>8</manvolnum></citerefentry>
392
 
    </para>
393
 
    <variablelist>
394
 
      <varlistentry>
395
 
        <term>
396
 
          <ulink url="http://www.recompile.se/mandos">Mandos</ulink>
397
 
        </term>
398
 
        <listitem>
399
 
          <para>
400
 
            The Mandos home page.
401
 
          </para>
402
 
        </listitem>
403
 
      </varlistentry>
404
 
    </variablelist>
405
 
  </refsect1>
406
 
</refentry>
407
 
<!-- Local Variables: -->
408
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
409
 
<!-- time-stamp-end: "[\"']>" -->
410
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
411
 
<!-- End: -->