/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: 2016-11-26 23:18:55 UTC
  • Revision ID: teddy@recompile.se-20161126231855-vseam120ph8856a1
Add more PEP8 compliance (as per the "pycodestyle" tool).

* mandos: Add an empty line to be more PEP8 compliant.
* mandos-monitor: - '' -

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 "2019-08-04">
 
4
<!ENTITY TIMESTAMP "2016-03-22">
5
5
<!ENTITY % common SYSTEM "common.ent">
6
6
%common;
7
7
]>
36
36
      <year>2014</year>
37
37
      <year>2015</year>
38
38
      <year>2016</year>
39
 
      <year>2017</year>
40
 
      <year>2018</year>
41
 
      <year>2019</year>
42
39
      <holder>Teddy Hogeborn</holder>
43
40
      <holder>Björn Påhlsson</holder>
44
41
    </copyright>
68
65
      The computers run a small client program in the initial RAM disk
69
66
      environment which will communicate with a server over a network.
70
67
      All network communication is encrypted using TLS.  The clients
71
 
      are identified by the server using a TLS public key; each client
 
68
      are identified by the server using an OpenPGP key; each client
72
69
      has one unique to it.  The server sends the clients an encrypted
73
70
      password.  The encrypted password is decrypted by the clients
74
 
      using a separate OpenPGP key, and the password is then used to
 
71
      using the same OpenPGP key, and the password is then used to
75
72
      unlock the root file system, whereupon the computers can
76
73
      continue booting normally.
77
74
    </para>
80
77
  <refsect1 id="introduction">
81
78
    <title>INTRODUCTION</title>
82
79
    <para>
83
 
      <!-- This paragraph is a combination and paraphrase of two
84
 
           quotes from the 1995 movie “The Usual Suspects”. -->
85
80
      You know how it is.  You’ve heard of it happening.  The Man
86
81
      comes and takes away your servers, your friends’ servers, the
87
82
      servers of everybody in the same hosting facility. The servers
131
126
    </para>
132
127
    <para>
133
128
      So, at boot time, the Mandos client will ask for its encrypted
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.
 
129
      data over the network, decrypt it to get the password, use it to
 
130
      decrypt the root file, and continue booting.
137
131
    </para>
138
132
    <para>
139
133
      Now, of course the initial RAM disk image is not on the
145
139
      long, and will no longer give out the encrypted key.  The timing
146
140
      here is the only real weak point, and the method, frequency and
147
141
      timeout of the server’s checking can be adjusted to any desired
148
 
      level of paranoia.
 
142
      level of paranoia
149
143
    </para>
150
144
    <para>
151
145
      (The encrypted keys on the Mandos server is on its normal file
202
196
      <para>
203
197
        No.  The server only gives out the passwords to clients which
204
198
        have <emphasis>in the TLS handshake</emphasis> proven that
205
 
        they do indeed hold the private key corresponding to that
206
 
        client.
 
199
        they do indeed hold the OpenPGP private key corresponding to
 
200
        that client.
207
201
      </para>
208
202
    </refsect2>
209
203
    
384
378
      plugin requirements.
385
379
    </para>
386
380
  </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>
 
381
  
417
382
  <refsect1 id="bugs">
418
383
    <title>BUGS</title>
419
384
    <xi:include href="bugs.xml"/>
434
399
      <manvolnum>8</manvolnum></citerefentry>,
435
400
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
436
401
      <manvolnum>8mandos</manvolnum></citerefentry>,
437
 
      <citerefentry><refentrytitle>password-agent</refentrytitle>
438
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
439
402
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
440
403
      <manvolnum>8mandos</manvolnum></citerefentry>,
441
404
      <citerefentry><refentrytitle>password-prompt</refentrytitle>