/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 at recompile
  • Date: 2020-01-18 00:57:30 UTC
  • Revision ID: teddy@recompile.se-20200118005730-rysosg44wz5gyxf8
DBUS-API: Order properties alphabetically

In the documentation for the D-Bus API, list the client object
properties in alphabetical order.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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-03-08">
 
4
<!ENTITY TIMESTAMP "2019-08-04">
5
5
<!ENTITY % common SYSTEM "common.ent">
6
6
%common;
7
7
]>
32
32
    <copyright>
33
33
      <year>2011</year>
34
34
      <year>2012</year>
 
35
      <year>2013</year>
 
36
      <year>2014</year>
 
37
      <year>2015</year>
 
38
      <year>2016</year>
 
39
      <year>2017</year>
 
40
      <year>2018</year>
 
41
      <year>2019</year>
35
42
      <holder>Teddy Hogeborn</holder>
36
43
      <holder>Björn Påhlsson</holder>
37
44
    </copyright>
61
68
      The computers run a small client program in the initial RAM disk
62
69
      environment which will communicate with a server over a network.
63
70
      All network communication is encrypted using TLS.  The clients
64
 
      are identified by the server using an OpenPGP key; each client
 
71
      are identified by the server using a TLS public key; each client
65
72
      has one unique to it.  The server sends the clients an encrypted
66
73
      password.  The encrypted password is decrypted by the clients
67
 
      using the same OpenPGP key, and the password is then used to
 
74
      using a separate OpenPGP key, and the password is then used to
68
75
      unlock the root file system, whereupon the computers can
69
76
      continue booting normally.
70
77
    </para>
73
80
  <refsect1 id="introduction">
74
81
    <title>INTRODUCTION</title>
75
82
    <para>
 
83
      <!-- This paragraph is a combination and paraphrase of two
 
84
           quotes from the 1995 movie “The Usual Suspects”. -->
76
85
      You know how it is.  You’ve heard of it happening.  The Man
77
86
      comes and takes away your servers, your friends’ servers, the
78
87
      servers of everybody in the same hosting facility. The servers
122
131
    </para>
123
132
    <para>
124
133
      So, at boot time, the Mandos client will ask for its encrypted
125
 
      data over the network, decrypt it to get the password, use it to
126
 
      decrypt the root file, and continue booting.
 
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.
127
137
    </para>
128
138
    <para>
129
139
      Now, of course the initial RAM disk image is not on the
135
145
      long, and will no longer give out the encrypted key.  The timing
136
146
      here is the only real weak point, and the method, frequency and
137
147
      timeout of the server’s checking can be adjusted to any desired
138
 
      level of paranoia
 
148
      level of paranoia.
139
149
    </para>
140
150
    <para>
141
151
      (The encrypted keys on the Mandos server is on its normal file
192
202
      <para>
193
203
        No.  The server only gives out the passwords to clients which
194
204
        have <emphasis>in the TLS handshake</emphasis> proven that
195
 
        they do indeed hold the OpenPGP private key corresponding to
196
 
        that client.
 
205
        they do indeed hold the private key corresponding to that
 
206
        client.
197
207
      </para>
198
208
    </refsect2>
199
209
    
374
384
      plugin requirements.
375
385
    </para>
376
386
  </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://www.freedesktop.org/wiki/Software/systemd/PasswordAgents/"
 
407
      >Password Agents</ulink> system.  Mandos uses this via its
 
408
      <citerefentry><refentrytitle>password-agent</refentrytitle
 
409
      ><manvolnum>8mandos</manvolnum></citerefentry> program, which
 
410
      is 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>
 
417
  <refsect1 id="bugs">
 
418
    <title>BUGS</title>
 
419
    <xi:include href="bugs.xml"/>
 
420
  </refsect1>
377
421
  
378
422
  <refsect1 id="see_also">
379
423
    <title>SEE ALSO</title>
390
434
      <manvolnum>8</manvolnum></citerefentry>,
391
435
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
392
436
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
437
      <citerefentry><refentrytitle>password-agent</refentrytitle>
 
438
      <manvolnum>8mandos</manvolnum></citerefentry>,
393
439
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
394
440
      <manvolnum>8mandos</manvolnum></citerefentry>,
395
441
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
408
454
    <variablelist>
409
455
      <varlistentry>
410
456
        <term>
411
 
          <ulink url="http://www.recompile.se/mandos">Mandos</ulink>
 
457
          <ulink url="https://www.recompile.se/mandos">Mandos</ulink>
412
458
        </term>
413
459
        <listitem>
414
460
          <para>