/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: 2019-07-18 00:02:43 UTC
  • Revision ID: teddy@recompile.se-20190718000243-okz4s9xao1r1tfnx
Document bug in mandos-keygen which strips white space from passwords

Passwords, as read by mandos-keygen when given the --password or -p
options, are stripped of white space from the start and from the end
of the password.  This is because mandos-keygen is a shell script, and
the Bourne Shell "read" builtin does not seem to have a way to avoid
this.  Document this bug.

* manods-keygen.xml (OPTIONS): Document the white space-stripping
                               nature of the --password/-p option, and
                               also note in the description of
                               --passfile and -F that they avoid this
                               behavior.
  (BUGS): Again mention the problem with the --password and -p
          options, and suggest --passfile as a possible workaround.

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 "2019-04-10">
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>
38
42
      <holder>Teddy Hogeborn</holder>
39
43
      <holder>Björn Påhlsson</holder>
40
44
    </copyright>
64
68
      The computers run a small client program in the initial RAM disk
65
69
      environment which will communicate with a server over a network.
66
70
      All network communication is encrypted using TLS.  The clients
67
 
      are identified by the server using an OpenPGP key; each client
 
71
      are identified by the server using a TLS public key; each client
68
72
      has one unique to it.  The server sends the clients an encrypted
69
73
      password.  The encrypted password is decrypted by the clients
70
 
      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
71
75
      unlock the root file system, whereupon the computers can
72
76
      continue booting normally.
73
77
    </para>
76
80
  <refsect1 id="introduction">
77
81
    <title>INTRODUCTION</title>
78
82
    <para>
 
83
      <!-- This paragraph is a combination and paraphrase of two
 
84
           quotes from the 1995 movie “The Usual Suspects”. -->
79
85
      You know how it is.  You’ve heard of it happening.  The Man
80
86
      comes and takes away your servers, your friends’ servers, the
81
87
      servers of everybody in the same hosting facility. The servers
125
131
    </para>
126
132
    <para>
127
133
      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.
 
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.
130
137
    </para>
131
138
    <para>
132
139
      Now, of course the initial RAM disk image is not on the
138
145
      long, and will no longer give out the encrypted key.  The timing
139
146
      here is the only real weak point, and the method, frequency and
140
147
      timeout of the server’s checking can be adjusted to any desired
141
 
      level of paranoia
 
148
      level of paranoia.
142
149
    </para>
143
150
    <para>
144
151
      (The encrypted keys on the Mandos server is on its normal file
195
202
      <para>
196
203
        No.  The server only gives out the passwords to clients which
197
204
        have <emphasis>in the TLS handshake</emphasis> proven that
198
 
        they do indeed hold the OpenPGP private key corresponding to
199
 
        that client.
 
205
        they do indeed hold the private key corresponding to that
 
206
        client.
200
207
      </para>
201
208
    </refsect2>
202
209
    
378
385
    </para>
379
386
  </refsect1>
380
387
  
 
388
  <refsect1 id="bugs">
 
389
    <title>BUGS</title>
 
390
    <xi:include href="bugs.xml"/>
 
391
  </refsect1>
 
392
  
381
393
  <refsect1 id="see_also">
382
394
    <title>SEE ALSO</title>
383
395
    <para>
411
423
    <variablelist>
412
424
      <varlistentry>
413
425
        <term>
414
 
          <ulink url="http://www.recompile.se/mandos">Mandos</ulink>
 
426
          <ulink url="https://www.recompile.se/mandos">Mandos</ulink>
415
427
        </term>
416
428
        <listitem>
417
429
          <para>