/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: 2017-08-20 16:20:54 UTC
  • Revision ID: teddy@recompile.se-20170820162054-jwig602syxx2k4l0
Alter copyright notices slightly.  Actual license is unchanged!

This alters all copyright notices to use the Free Software
Foundation's recommendations for license notices; from
<https://www.gnu.org/licenses/gpl-howto.html>:

  For programs that are more than one file, it is better to replace
  “this program” with the name of the program, and begin the statement
  with a line saying “This file is part of NAME”.

* DBUS-API: Use program name "Mandos" explicitly in license notice.
* debian/copyright: - '' -
* initramfs-unpack: - '' -
* legalnotice.xml: - '' -
* mandos: - '' -
* mandos-ctl: - '' -
* mandos-keygen: - '' -
* mandos-monitor: - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: - '' -
* plugin-runner.c: - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/plymouth.c: - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/usplash.c: - '' -

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 "2021-02-03">
 
4
<!ENTITY TIMESTAMP "2017-02-23">
5
5
<!ENTITY % common SYSTEM "common.ent">
6
6
%common;
7
7
]>
37
37
      <year>2015</year>
38
38
      <year>2016</year>
39
39
      <year>2017</year>
40
 
      <year>2018</year>
41
 
      <year>2019</year>
42
 
      <year>2020</year>
43
40
      <holder>Teddy Hogeborn</holder>
44
41
      <holder>Björn Påhlsson</holder>
45
42
    </copyright>
69
66
      The computers run a small client program in the initial RAM disk
70
67
      environment which will communicate with a server over a network.
71
68
      All network communication is encrypted using TLS.  The clients
72
 
      are identified by the server using a TLS public key; each client
 
69
      are identified by the server using an OpenPGP key; each client
73
70
      has one unique to it.  The server sends the clients an encrypted
74
71
      password.  The encrypted password is decrypted by the clients
75
 
      using a separate OpenPGP key, and the password is then used to
 
72
      using the same OpenPGP key, and the password is then used to
76
73
      unlock the root file system, whereupon the computers can
77
74
      continue booting normally.
78
75
    </para>
132
129
    </para>
133
130
    <para>
134
131
      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.
 
132
      data over the network, decrypt it to get the password, use it to
 
133
      decrypt the root file, and continue booting.
138
134
    </para>
139
135
    <para>
140
136
      Now, of course the initial RAM disk image is not on the
146
142
      long, and will no longer give out the encrypted key.  The timing
147
143
      here is the only real weak point, and the method, frequency and
148
144
      timeout of the server’s checking can be adjusted to any desired
149
 
      level of paranoia.
 
145
      level of paranoia
150
146
    </para>
151
147
    <para>
152
148
      (The encrypted keys on the Mandos server is on its normal file
203
199
      <para>
204
200
        No.  The server only gives out the passwords to clients which
205
201
        have <emphasis>in the TLS handshake</emphasis> proven that
206
 
        they do indeed hold the private key corresponding to that
207
 
        client.
 
202
        they do indeed hold the OpenPGP private key corresponding to
 
203
        that client.
208
204
      </para>
209
205
    </refsect2>
210
206
    
385
381
      plugin requirements.
386
382
    </para>
387
383
  </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>
 
384
  
418
385
  <refsect1 id="bugs">
419
386
    <title>BUGS</title>
420
387
    <xi:include href="bugs.xml"/>
435
402
      <manvolnum>8</manvolnum></citerefentry>,
436
403
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
437
404
      <manvolnum>8mandos</manvolnum></citerefentry>,
438
 
      <citerefentry><refentrytitle>password-agent</refentrytitle>
439
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
440
405
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
441
406
      <manvolnum>8mandos</manvolnum></citerefentry>,
442
407
      <citerefentry><refentrytitle>password-prompt</refentrytitle>