/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: 2016-06-22 04:42:23 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 346.
  • Revision ID: teddy@recompile.se-20160622044223-ew442xmt3c3bg76n
Client: Do not install intro(8mandos) manual page

When installing client, do not include the intro(8mandos) manual page
to avoid a conflict with the files from a server install.
  
* Makefile (install-client-nokey): Do not install intro.8mandos.

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