/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: 2015-06-28 16:35:27 UTC
  • mto: This revision was merged to the branch mainline in revision 759.
  • Revision ID: teddy@recompile.se-20150628163527-cky0ec59zew7teua
Add a plugin helper directory, available to all plugins.

* Makefile (PLUGIN_HELPERS): New; list of plugin helpers.
  (CPROGS): Appended "$(PLUGIN_HELPERS)".
* initramfs-tools-hook: Create new plugin helper directory, and copy
                        plugin helpers provided by the system and/or
                        by the local administrator.
  (PLUGINHELPERDIR): New.
* plugin-runner.c: Take new --plugin-helper-dir option and provide
                   environment variable to all plugins.
  (PHDIR): New; set to "/lib/mandos/plugin-helpers".
  (main/pluginhelperdir): New.
  (main/options): New option "--plugin-helper-dir".
  (main/parse_opt, main/parse_opt_config_file): Accept new option.
  (main): Use new option to set MANDOSPLUGINHELPERDIR environment
          variable as if using --global-env MANDOSPLUGINHELPERDIR=...
* plugin-runner.xml: Document new --plugin-helper-dir option.
  (SYNOPSIS, OPTIONS): Add "--plugin-helper-dir" option.
  (PLUGINS/WRITING PLUGINS): Document new environment variable
                             available to plugins.
  (ENVIRONMENT): Document new environment variable
                 "MANDOSPLUGINHELPERDIR" affected by the new
                 --plugin-helper-dir option.

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 "2014-06-22">
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>
42
 
      <year>2020</year>
43
35
      <holder>Teddy Hogeborn</holder>
44
36
      <holder>Björn Påhlsson</holder>
45
37
    </copyright>
69
61
      The computers run a small client program in the initial RAM disk
70
62
      environment which will communicate with a server over a network.
71
63
      All network communication is encrypted using TLS.  The clients
72
 
      are identified by the server using a TLS public key; each client
 
64
      are identified by the server using an OpenPGP key; each client
73
65
      has one unique to it.  The server sends the clients an encrypted
74
66
      password.  The encrypted password is decrypted by the clients
75
 
      using a separate OpenPGP key, and the password is then used to
 
67
      using the same OpenPGP key, and the password is then used to
76
68
      unlock the root file system, whereupon the computers can
77
69
      continue booting normally.
78
70
    </para>
81
73
  <refsect1 id="introduction">
82
74
    <title>INTRODUCTION</title>
83
75
    <para>
84
 
      <!-- This paragraph is a combination and paraphrase of two
85
 
           quotes from the 1995 movie “The Usual Suspects”. -->
86
76
      You know how it is.  You’ve heard of it happening.  The Man
87
77
      comes and takes away your servers, your friends’ servers, the
88
78
      servers of everybody in the same hosting facility. The servers
132
122
    </para>
133
123
    <para>
134
124
      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.
 
125
      data over the network, decrypt it to get the password, use it to
 
126
      decrypt the root file, and continue booting.
138
127
    </para>
139
128
    <para>
140
129
      Now, of course the initial RAM disk image is not on the
146
135
      long, and will no longer give out the encrypted key.  The timing
147
136
      here is the only real weak point, and the method, frequency and
148
137
      timeout of the server’s checking can be adjusted to any desired
149
 
      level of paranoia.
 
138
      level of paranoia
150
139
    </para>
151
140
    <para>
152
141
      (The encrypted keys on the Mandos server is on its normal file
203
192
      <para>
204
193
        No.  The server only gives out the passwords to clients which
205
194
        have <emphasis>in the TLS handshake</emphasis> proven that
206
 
        they do indeed hold the private key corresponding to that
207
 
        client.
208
 
      </para>
209
 
    </refsect2>
210
 
    
211
 
    <refsect2 id="sniff">
212
 
      <title>How about sniffing the network traffic and decrypting it
213
 
      later by physically grabbing the Mandos client and using its
214
 
      key?</title>
215
 
      <para>
216
 
        We only use <acronym>PFS</acronym> (Perfect Forward Security)
217
 
        key exchange algorithms in TLS, which protects against this.
 
195
        they do indeed hold the OpenPGP private key corresponding to
 
196
        that client.
218
197
      </para>
219
198
    </refsect2>
220
199
    
385
364
      plugin requirements.
386
365
    </para>
387
366
  </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>
422
367
  
423
368
  <refsect1 id="see_also">
424
369
    <title>SEE ALSO</title>
435
380
      <manvolnum>8</manvolnum></citerefentry>,
436
381
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
437
382
      <manvolnum>8mandos</manvolnum></citerefentry>,
438
 
      <citerefentry><refentrytitle>password-agent</refentrytitle>
439
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
440
383
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
441
384
      <manvolnum>8mandos</manvolnum></citerefentry>,
442
385
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
455
398
    <variablelist>
456
399
      <varlistentry>
457
400
        <term>
458
 
          <ulink url="https://www.recompile.se/mandos">Mandos</ulink>
 
401
          <ulink url="http://www.recompile.se/mandos">Mandos</ulink>
459
402
        </term>
460
403
        <listitem>
461
404
          <para>