/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

  • Committer: Teddy Hogeborn
  • Date: 2024-09-08 00:11:24 UTC
  • mto: This revision was merged to the branch mainline in revision 410.
  • Revision ID: teddy@recompile.se-20240908001124-nq0ja17503ua9nmw
Minor documentation improvements 

* TODO (mandos-applet): Add link.
* debian/mandos-client.README.Debian: Fix spelling.

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 "2015-03-08">
 
4
<!ENTITY TIMESTAMP "2020-09-16">
5
5
<!ENTITY % common SYSTEM "common.ent">
6
6
%common;
7
7
]>
32
32
    <copyright>
33
33
      <year>2011</year>
34
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>
35
43
      <holder>Teddy Hogeborn</holder>
36
44
      <holder>Björn Påhlsson</holder>
37
45
    </copyright>
61
69
      The computers run a small client program in the initial RAM disk
62
70
      environment which will communicate with a server over a network.
63
71
      All network communication is encrypted using TLS.  The clients
64
 
      are identified by the server using an OpenPGP key; each client
 
72
      are identified by the server using a TLS public key; each client
65
73
      has one unique to it.  The server sends the clients an encrypted
66
74
      password.  The encrypted password is decrypted by the clients
67
 
      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
68
76
      unlock the root file system, whereupon the computers can
69
77
      continue booting normally.
70
78
    </para>
73
81
  <refsect1 id="introduction">
74
82
    <title>INTRODUCTION</title>
75
83
    <para>
 
84
      <!-- This paragraph is a combination and paraphrase of two
 
85
           quotes from the 1995 movie “The Usual Suspects”. -->
76
86
      You know how it is.  You’ve heard of it happening.  The Man
77
87
      comes and takes away your servers, your friends’ servers, the
78
88
      servers of everybody in the same hosting facility. The servers
122
132
    </para>
123
133
    <para>
124
134
      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.
 
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.
127
138
    </para>
128
139
    <para>
129
140
      Now, of course the initial RAM disk image is not on the
135
146
      long, and will no longer give out the encrypted key.  The timing
136
147
      here is the only real weak point, and the method, frequency and
137
148
      timeout of the server’s checking can be adjusted to any desired
138
 
      level of paranoia
 
149
      level of paranoia.
139
150
    </para>
140
151
    <para>
141
152
      (The encrypted keys on the Mandos server is on its normal file
192
203
      <para>
193
204
        No.  The server only gives out the passwords to clients which
194
205
        have <emphasis>in the TLS handshake</emphasis> proven that
195
 
        they do indeed hold the OpenPGP private key corresponding to
196
 
        that client.
 
206
        they do indeed hold the private key corresponding to that
 
207
        client.
197
208
      </para>
198
209
    </refsect2>
199
210
    
374
385
      plugin requirements.
375
386
    </para>
376
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>
377
422
  
378
423
  <refsect1 id="see_also">
379
424
    <title>SEE ALSO</title>
390
435
      <manvolnum>8</manvolnum></citerefentry>,
391
436
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
392
437
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
438
      <citerefentry><refentrytitle>password-agent</refentrytitle>
 
439
      <manvolnum>8mandos</manvolnum></citerefentry>,
393
440
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
394
441
      <manvolnum>8mandos</manvolnum></citerefentry>,
395
442
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
408
455
    <variablelist>
409
456
      <varlistentry>
410
457
        <term>
411
 
          <ulink url="http://www.recompile.se/mandos">Mandos</ulink>
 
458
          <ulink url="https://www.recompile.se/mandos">Mandos</ulink>
412
459
        </term>
413
460
        <listitem>
414
461
          <para>