/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: 2017-08-20 16:20:54 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 360.
  • 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 "2020-09-16">
 
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
40
      <holder>Teddy Hogeborn</holder>
43
41
      <holder>Björn Påhlsson</holder>
44
42
    </copyright>
68
66
      The computers run a small client program in the initial RAM disk
69
67
      environment which will communicate with a server over a network.
70
68
      All network communication is encrypted using TLS.  The clients
71
 
      are identified by the server using a TLS public key; each client
 
69
      are identified by the server using an OpenPGP key; each client
72
70
      has one unique to it.  The server sends the clients an encrypted
73
71
      password.  The encrypted password is decrypted by the clients
74
 
      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
75
73
      unlock the root file system, whereupon the computers can
76
74
      continue booting normally.
77
75
    </para>
131
129
    </para>
132
130
    <para>
133
131
      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.
 
132
      data over the network, decrypt it to get the password, use it to
 
133
      decrypt the root file, and continue booting.
137
134
    </para>
138
135
    <para>
139
136
      Now, of course the initial RAM disk image is not on the
145
142
      long, and will no longer give out the encrypted key.  The timing
146
143
      here is the only real weak point, and the method, frequency and
147
144
      timeout of the server’s checking can be adjusted to any desired
148
 
      level of paranoia.
 
145
      level of paranoia
149
146
    </para>
150
147
    <para>
151
148
      (The encrypted keys on the Mandos server is on its normal file
202
199
      <para>
203
200
        No.  The server only gives out the passwords to clients which
204
201
        have <emphasis>in the TLS handshake</emphasis> proven that
205
 
        they do indeed hold the private key corresponding to that
206
 
        client.
 
202
        they do indeed hold the OpenPGP private key corresponding to
 
203
        that client.
207
204
      </para>
208
205
    </refsect2>
209
206
    
384
381
      plugin requirements.
385
382
    </para>
386
383
  </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://systemd.io/PASSWORD_AGENTS/">Password
407
 
      Agents</ulink> system.  Mandos uses this via its
408
 
      <citerefentry><refentrytitle>password-agent</refentrytitle
409
 
      ><manvolnum>8mandos</manvolnum></citerefentry> program, which is
410
 
      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>
 
384
  
417
385
  <refsect1 id="bugs">
418
386
    <title>BUGS</title>
419
387
    <xi:include href="bugs.xml"/>
434
402
      <manvolnum>8</manvolnum></citerefentry>,
435
403
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
436
404
      <manvolnum>8mandos</manvolnum></citerefentry>,
437
 
      <citerefentry><refentrytitle>password-agent</refentrytitle>
438
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
439
405
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
440
406
      <manvolnum>8mandos</manvolnum></citerefentry>,
441
407
      <citerefentry><refentrytitle>password-prompt</refentrytitle>