/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 at recompile
  • Date: 2020-02-07 20:53:34 UTC
  • Revision ID: teddy@recompile.se-20200207205334-dp41p8c8vw0ytik5
Allow users to more easily alter mandos.service

The sysvinit script uses /etc/default/mandos as an environment file,
and supports adding additional server options to a DAEMON_ARGS
environment variable.  This should be supported by the systemd
service, too.

* mandos.service ([Service]/EnvironmentFile): New; set to
  "/etc/default/mandos ".
  ([Service]/ExecStart): Append "$DAEMON_ARGS".

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 "2011-08-08">
 
4
<!ENTITY TIMESTAMP "2019-08-04">
5
5
<!ENTITY % common SYSTEM "common.ent">
6
6
%common;
7
7
]>
18
18
        <firstname>Björn</firstname>
19
19
        <surname>Påhlsson</surname>
20
20
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
21
          <email>belorn@recompile.se</email>
22
22
        </address>
23
23
      </author>
24
24
      <author>
25
25
        <firstname>Teddy</firstname>
26
26
        <surname>Hogeborn</surname>
27
27
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
28
          <email>teddy@recompile.se</email>
29
29
        </address>
30
30
      </author>
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>
34
42
      <holder>Teddy Hogeborn</holder>
35
43
      <holder>Björn Påhlsson</holder>
36
44
    </copyright>
60
68
      The computers run a small client program in the initial RAM disk
61
69
      environment which will communicate with a server over a network.
62
70
      All network communication is encrypted using TLS.  The clients
63
 
      are identified by the server using an OpenPGP key; each client
 
71
      are identified by the server using a TLS public key; each client
64
72
      has one unique to it.  The server sends the clients an encrypted
65
73
      password.  The encrypted password is decrypted by the clients
66
 
      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
67
75
      unlock the root file system, whereupon the computers can
68
76
      continue booting normally.
69
77
    </para>
72
80
  <refsect1 id="introduction">
73
81
    <title>INTRODUCTION</title>
74
82
    <para>
 
83
      <!-- This paragraph is a combination and paraphrase of two
 
84
           quotes from the 1995 movie “The Usual Suspects”. -->
75
85
      You know how it is.  You’ve heard of it happening.  The Man
76
86
      comes and takes away your servers, your friends’ servers, the
77
87
      servers of everybody in the same hosting facility. The servers
121
131
    </para>
122
132
    <para>
123
133
      So, at boot time, the Mandos client will ask for its encrypted
124
 
      data over the network, decrypt it to get the password, use it to
125
 
      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.
126
137
    </para>
127
138
    <para>
128
139
      Now, of course the initial RAM disk image is not on the
134
145
      long, and will no longer give out the encrypted key.  The timing
135
146
      here is the only real weak point, and the method, frequency and
136
147
      timeout of the server’s checking can be adjusted to any desired
137
 
      level of paranoia
 
148
      level of paranoia.
138
149
    </para>
139
150
    <para>
140
151
      (The encrypted keys on the Mandos server is on its normal file
191
202
      <para>
192
203
        No.  The server only gives out the passwords to clients which
193
204
        have <emphasis>in the TLS handshake</emphasis> proven that
194
 
        they do indeed hold the OpenPGP private key corresponding to
195
 
        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.
196
217
      </para>
197
218
    </refsect2>
198
219
    
214
235
      </para>
215
236
    </refsect2>
216
237
    
217
 
    <refsect2 id="fakeping">
218
 
      <title>Faking ping replies?</title>
 
238
    <refsect2 id="fakecheck">
 
239
      <title>Faking checker results?</title>
219
240
      <para>
220
 
        The default for the server is to use
 
241
        If the Mandos client does not have an SSH server, the default
 
242
        is for the Mandos server to use
221
243
        <quote><literal>fping</literal></quote>, the replies to which
222
244
        could be faked to eliminate the timeout.  But this could
223
245
        easily be changed to any shell command, with any security
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.
 
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.
228
254
      </para>
229
255
    </refsect2>
230
256
  </refsect1>
358
384
      plugin requirements.
359
385
    </para>
360
386
  </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>
361
421
  
362
422
  <refsect1 id="see_also">
363
423
    <title>SEE ALSO</title>
374
434
      <manvolnum>8</manvolnum></citerefentry>,
375
435
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
376
436
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
437
      <citerefentry><refentrytitle>password-agent</refentrytitle>
 
438
      <manvolnum>8mandos</manvolnum></citerefentry>,
377
439
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
378
440
      <manvolnum>8mandos</manvolnum></citerefentry>,
379
441
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
392
454
    <variablelist>
393
455
      <varlistentry>
394
456
        <term>
395
 
          <ulink url="http://www.fukt.bsnet.se/mandos">Mandos</ulink>
 
457
          <ulink url="https://www.recompile.se/mandos">Mandos</ulink>
396
458
        </term>
397
459
        <listitem>
398
460
          <para>