/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: 2024-09-08 00:08:15 UTC
  • Revision ID: teddy@recompile.se-20240908000815-x3gr5xion3kyyoio
Improve documentation

* mandos.conf.xml (DESCRIPTION): Remove the unnecessary word "simple".
* plugin-runner.xml (PLUGINS): Remove the unnecessary word "simply",
  and add the "executable" qualifier to the description of plugins.
* mandos-client.xml (DESCRIPTION, OPTIONS): Do not refer to
  "plugin-runner"; instead refer to the section "OVERVIEW".
  (OVERVIEW): Don't only describe plugin-runner; also describe
  how password-agent can start mandos-client.
  (EXAMPLE): Do not refer to "plugin-runner"; instead refer to the
  section "OVERVIEW".
  (SEE ALSO): Replace reference to "password-prompt" with
  "password-agent".

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