/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: 2022-04-23 20:36:45 UTC
  • Revision ID: teddy@recompile.se-20220423203645-ktjgbbuwsha3z5ym
Add comment about duration syntax to default clients.conf.

* clients.conf (timeout, interval, extended_timeout, approval_delay,
  approval_duration): Add comment about this being RFC 3339 syntax.

Show diffs side-by-side

added added

removed removed

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