/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-09 04:24:39 UTC
  • Revision ID: teddy@recompile.se-20240909042439-j85mr20uli2hnyis
Eliminate compiler warnings

Many programs use nested functions, which now result in a linker
warning about executable stack.  Hide this warning.  Also, rewrite a
loop in the plymouth plugin to avoid warning about signed overflow.
This change also makes the plugin pick the alphabetically first
process entry instead of the last, in case many plymouth processes are
found (which should be unlikely).

* Makefile (plugin-runner, dracut-module/password-agent,
  plugins.d/password-prompt, plugins.d/mandos-client,
  plugins.d/plymouth): New target; set LDFLAGS to add "-Xlinker
  --no-warn-execstack".
* plugins.d/plymouth.c (get_pid): When no pid files are found, and we
  are looking through the process list, go though it from the start
  instead of from the end, i.e. in normal alphabetical order and not
  in reverse order.

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 "2015-07-20">
 
4
<!ENTITY TIMESTAMP "2020-09-16">
5
5
<!ENTITY % common SYSTEM "common.ent">
6
6
%common;
7
7
]>
35
35
      <year>2013</year>
36
36
      <year>2014</year>
37
37
      <year>2015</year>
 
38
      <year>2016</year>
 
39
      <year>2017</year>
 
40
      <year>2018</year>
 
41
      <year>2019</year>
 
42
      <year>2020</year>
38
43
      <holder>Teddy Hogeborn</holder>
39
44
      <holder>Björn Påhlsson</holder>
40
45
    </copyright>
64
69
      The computers run a small client program in the initial RAM disk
65
70
      environment which will communicate with a server over a network.
66
71
      All network communication is encrypted using TLS.  The clients
67
 
      are identified by the server using an OpenPGP key; each client
 
72
      are identified by the server using a TLS public key; each client
68
73
      has one unique to it.  The server sends the clients an encrypted
69
74
      password.  The encrypted password is decrypted by the clients
70
 
      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
71
76
      unlock the root file system, whereupon the computers can
72
77
      continue booting normally.
73
78
    </para>
76
81
  <refsect1 id="introduction">
77
82
    <title>INTRODUCTION</title>
78
83
    <para>
 
84
      <!-- This paragraph is a combination and paraphrase of two
 
85
           quotes from the 1995 movie “The Usual Suspects”. -->
79
86
      You know how it is.  You’ve heard of it happening.  The Man
80
87
      comes and takes away your servers, your friends’ servers, the
81
88
      servers of everybody in the same hosting facility. The servers
125
132
    </para>
126
133
    <para>
127
134
      So, at boot time, the Mandos client will ask for its encrypted
128
 
      data over the network, decrypt it to get the password, use it to
129
 
      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.
130
138
    </para>
131
139
    <para>
132
140
      Now, of course the initial RAM disk image is not on the
138
146
      long, and will no longer give out the encrypted key.  The timing
139
147
      here is the only real weak point, and the method, frequency and
140
148
      timeout of the server’s checking can be adjusted to any desired
141
 
      level of paranoia
 
149
      level of paranoia.
142
150
    </para>
143
151
    <para>
144
152
      (The encrypted keys on the Mandos server is on its normal file
195
203
      <para>
196
204
        No.  The server only gives out the passwords to clients which
197
205
        have <emphasis>in the TLS handshake</emphasis> proven that
198
 
        they do indeed hold the OpenPGP private key corresponding to
199
 
        that client.
 
206
        they do indeed hold the private key corresponding to that
 
207
        client.
200
208
      </para>
201
209
    </refsect2>
202
210
    
377
385
      plugin requirements.
378
386
    </para>
379
387
  </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>
 
418
  <refsect1 id="bugs">
 
419
    <title>BUGS</title>
 
420
    <xi:include href="bugs.xml"/>
 
421
  </refsect1>
380
422
  
381
423
  <refsect1 id="see_also">
382
424
    <title>SEE ALSO</title>
393
435
      <manvolnum>8</manvolnum></citerefentry>,
394
436
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
395
437
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
438
      <citerefentry><refentrytitle>password-agent</refentrytitle>
 
439
      <manvolnum>8mandos</manvolnum></citerefentry>,
396
440
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
397
441
      <manvolnum>8mandos</manvolnum></citerefentry>,
398
442
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
411
455
    <variablelist>
412
456
      <varlistentry>
413
457
        <term>
414
 
          <ulink url="http://www.recompile.se/mandos">Mandos</ulink>
 
458
          <ulink url="https://www.recompile.se/mandos">Mandos</ulink>
415
459
        </term>
416
460
        <listitem>
417
461
          <para>