/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-18 03:25:01 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818032501-2cl874fi3uvsqn1b
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
                         tags.  Also show the "-h" option.
  (OPTIONS): Note that failure to obey the "--interface" option is not
             considered critical.
  (ENVIRONMENT): New section to document the use of PATH by /bin/sh.
  (FILES): Added "/bin/sh".
  (BUGS): Add five bugs from the TODO file.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).
  (SERVER, CLIENTS): Added "id" attribute.
  (CLIENT): Document the security implications of one of the five
            bugs added to the BUGS section.

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 VERSION "1.0">
4
5
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2009-02-15">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY OVERVIEW SYSTEM "overview.xml">
8
7
]>
9
8
 
10
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
   <refentryinfo>
12
 
    <title>Mandos Manual</title>
 
9
<refentry>
 
10
  <refentryinfo>
 
11
    <title>&COMMANDNAME;</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
16
 
    <date>&TIMESTAMP;</date>
 
13
    <productname>&COMMANDNAME;</productname>
 
14
    <productnumber>&VERSION;</productnumber>
17
15
    <authorgroup>
18
16
      <author>
19
17
        <firstname>Björn</firstname>
32
30
    </authorgroup>
33
31
    <copyright>
34
32
      <year>2008</year>
35
 
      <year>2009</year>
36
33
      <holder>Teddy Hogeborn</holder>
37
34
      <holder>Björn Påhlsson</holder>
38
35
    </copyright>
39
 
    <xi:include href="legalnotice.xml"/>
 
36
    <legalnotice>
 
37
      <para>
 
38
        This manual page is free software: you can redistribute it
 
39
        and/or modify it under the terms of the GNU General Public
 
40
        License as published by the Free Software Foundation,
 
41
        either version 3 of the License, or (at your option) any
 
42
        later version.
 
43
      </para>
 
44
 
 
45
      <para>
 
46
        This manual page is distributed in the hope that it will
 
47
        be useful, but WITHOUT ANY WARRANTY; without even the
 
48
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
49
        PARTICULAR PURPOSE.  See the GNU General Public License
 
50
        for more details.
 
51
      </para>
 
52
 
 
53
      <para>
 
54
        You should have received a copy of the GNU General Public
 
55
        License along with this program; If not, see
 
56
        <ulink url="http://www.gnu.org/licenses/"/>.
 
57
      </para>
 
58
    </legalnotice>
40
59
  </refentryinfo>
41
 
  
 
60
 
42
61
  <refmeta>
43
62
    <refentrytitle>&COMMANDNAME;</refentrytitle>
44
63
    <manvolnum>8</manvolnum>
47
66
  <refnamediv>
48
67
    <refname><command>&COMMANDNAME;</command></refname>
49
68
    <refpurpose>
50
 
      Gives encrypted passwords to authenticated Mandos clients
 
69
      Sends encrypted passwords to authenticated Mandos clients
51
70
    </refpurpose>
52
71
  </refnamediv>
53
 
  
 
72
 
54
73
  <refsynopsisdiv>
55
74
    <cmdsynopsis>
56
75
      <command>&COMMANDNAME;</command>
57
 
      <group>
58
 
        <arg choice="plain"><option>--interface
59
 
        <replaceable>NAME</replaceable></option></arg>
60
 
        <arg choice="plain"><option>-i
61
 
        <replaceable>NAME</replaceable></option></arg>
62
 
      </group>
63
 
      <sbr/>
64
 
      <group>
65
 
        <arg choice="plain"><option>--address
66
 
        <replaceable>ADDRESS</replaceable></option></arg>
67
 
        <arg choice="plain"><option>-a
68
 
        <replaceable>ADDRESS</replaceable></option></arg>
69
 
      </group>
70
 
      <sbr/>
71
 
      <group>
72
 
        <arg choice="plain"><option>--port
73
 
        <replaceable>PORT</replaceable></option></arg>
74
 
        <arg choice="plain"><option>-p
75
 
        <replaceable>PORT</replaceable></option></arg>
76
 
      </group>
77
 
      <sbr/>
78
 
      <arg><option>--priority
79
 
      <replaceable>PRIORITY</replaceable></option></arg>
80
 
      <sbr/>
81
 
      <arg><option>--servicename
82
 
      <replaceable>NAME</replaceable></option></arg>
83
 
      <sbr/>
84
 
      <arg><option>--configdir
85
 
      <replaceable>DIRECTORY</replaceable></option></arg>
86
 
      <sbr/>
87
 
      <arg><option>--debug</option></arg>
88
 
      <sbr/>
89
 
      <arg><option>--no-dbus</option></arg>
90
 
      <sbr/>
91
 
      <arg><option>--no-ipv6</option></arg>
 
76
      <arg>--interface<arg choice="plain">IF</arg></arg>
 
77
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
 
78
      <arg>--port<arg choice="plain">PORT</arg></arg>
 
79
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
 
80
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
 
81
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
82
      <arg>--debug</arg>
 
83
    </cmdsynopsis>
 
84
    <cmdsynopsis>
 
85
      <command>&COMMANDNAME;</command>
 
86
      <arg>-i<arg choice="plain">IF</arg></arg>
 
87
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
 
88
      <arg>-p<arg choice="plain">PORT</arg></arg>
 
89
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
 
90
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
 
91
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
92
      <arg>--debug</arg>
92
93
    </cmdsynopsis>
93
94
    <cmdsynopsis>
94
95
      <command>&COMMANDNAME;</command>
95
96
      <group choice="req">
96
 
        <arg choice="plain"><option>--help</option></arg>
97
 
        <arg choice="plain"><option>-h</option></arg>
 
97
        <arg choice="plain">-h</arg>
 
98
        <arg choice="plain">--help</arg>
98
99
      </group>
99
100
    </cmdsynopsis>
100
101
    <cmdsynopsis>
101
102
      <command>&COMMANDNAME;</command>
102
 
      <arg choice="plain"><option>--version</option></arg>
 
103
      <arg choice="plain">--version</arg>
103
104
    </cmdsynopsis>
104
105
    <cmdsynopsis>
105
106
      <command>&COMMANDNAME;</command>
106
 
      <arg choice="plain"><option>--check</option></arg>
 
107
      <arg choice="plain">--check</arg>
107
108
    </cmdsynopsis>
108
109
  </refsynopsisdiv>
109
 
  
 
110
 
110
111
  <refsect1 id="description">
111
112
    <title>DESCRIPTION</title>
112
113
    <para>
121
122
      Any authenticated client is then given the stored pre-encrypted
122
123
      password for that specific client.
123
124
    </para>
 
125
 
124
126
  </refsect1>
125
127
  
126
128
  <refsect1 id="purpose">
127
129
    <title>PURPOSE</title>
 
130
 
128
131
    <para>
129
132
      The purpose of this is to enable <emphasis>remote and unattended
130
133
      rebooting</emphasis> of client host computer with an
131
134
      <emphasis>encrypted root file system</emphasis>.  See <xref
132
135
      linkend="overview"/> for details.
133
136
    </para>
 
137
 
134
138
  </refsect1>
135
139
  
136
140
  <refsect1 id="options">
137
141
    <title>OPTIONS</title>
 
142
 
138
143
    <variablelist>
139
144
      <varlistentry>
140
 
        <term><option>--help</option></term>
141
 
        <term><option>-h</option></term>
 
145
        <term><literal>-h</literal>, <literal>--help</literal></term>
142
146
        <listitem>
143
147
          <para>
144
148
            Show a help message and exit
145
149
          </para>
146
150
        </listitem>
147
151
      </varlistentry>
148
 
      
149
 
      <varlistentry>
150
 
        <term><option>--interface</option>
151
 
        <replaceable>NAME</replaceable></term>
152
 
        <term><option>-i</option>
153
 
        <replaceable>NAME</replaceable></term>
154
 
        <listitem>
155
 
          <xi:include href="mandos-options.xml" xpointer="interface"/>
156
 
        </listitem>
157
 
      </varlistentry>
158
 
      
159
 
      <varlistentry>
160
 
        <term><option>--address
161
 
        <replaceable>ADDRESS</replaceable></option></term>
162
 
        <term><option>-a
163
 
        <replaceable>ADDRESS</replaceable></option></term>
164
 
        <listitem>
165
 
          <xi:include href="mandos-options.xml" xpointer="address"/>
166
 
        </listitem>
167
 
      </varlistentry>
168
 
      
169
 
      <varlistentry>
170
 
        <term><option>--port
171
 
        <replaceable>PORT</replaceable></option></term>
172
 
        <term><option>-p
173
 
        <replaceable>PORT</replaceable></option></term>
174
 
        <listitem>
175
 
          <xi:include href="mandos-options.xml" xpointer="port"/>
176
 
        </listitem>
177
 
      </varlistentry>
178
 
      
179
 
      <varlistentry>
180
 
        <term><option>--check</option></term>
 
152
 
 
153
      <varlistentry>
 
154
        <term><literal>-i</literal>, <literal>--interface <replaceable>
 
155
        IF</replaceable></literal></term>
 
156
        <listitem>
 
157
          <para>
 
158
            Only announce the server and listen to requests on network
 
159
            interface <replaceable>IF</replaceable>.  Default is to
 
160
            use all available interfaces.  <emphasis>Note:</emphasis>
 
161
            a failure to bind to the specified interface is not
 
162
            considered critical, and the server does not exit.
 
163
          </para>
 
164
        </listitem>
 
165
      </varlistentry>
 
166
 
 
167
      <varlistentry>
 
168
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
169
        ADDRESS</replaceable></literal></term>
 
170
        <listitem>
 
171
          <para>
 
172
            If this option is used, the server will only listen to a
 
173
            specific address.  This must currently be an IPv6 address;
 
174
            an IPv4 address can be specified using the
 
175
            <quote><literal>::FFFF:192.0.2.3</literal></quote> syntax.
 
176
            Also, if a link-local address is specified, an interface
 
177
            should be set, since a link-local address is only valid on
 
178
            a single interface.  By default, the server will listen to
 
179
            all available addresses.
 
180
          </para>
 
181
        </listitem>
 
182
      </varlistentry>
 
183
 
 
184
      <varlistentry>
 
185
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
186
        PORT</replaceable></literal></term>
 
187
        <listitem>
 
188
          <para>
 
189
            If this option is used, the server to bind to that
 
190
            port. By default, the server will listen to an arbitrary
 
191
            port given by the operating system.
 
192
          </para>
 
193
        </listitem>
 
194
      </varlistentry>
 
195
 
 
196
      <varlistentry>
 
197
        <term><literal>--check</literal></term>
181
198
        <listitem>
182
199
          <para>
183
200
            Run the server’s self-tests.  This includes any unit
185
202
          </para>
186
203
        </listitem>
187
204
      </varlistentry>
188
 
      
189
 
      <varlistentry>
190
 
        <term><option>--debug</option></term>
191
 
        <listitem>
192
 
          <xi:include href="mandos-options.xml" xpointer="debug"/>
193
 
        </listitem>
194
 
      </varlistentry>
195
 
      
196
 
      <varlistentry>
197
 
        <term><option>--priority <replaceable>
198
 
        PRIORITY</replaceable></option></term>
199
 
        <listitem>
200
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
201
 
        </listitem>
202
 
      </varlistentry>
203
 
      
204
 
      <varlistentry>
205
 
        <term><option>--servicename
206
 
        <replaceable>NAME</replaceable></option></term>
207
 
        <listitem>
208
 
          <xi:include href="mandos-options.xml"
209
 
                      xpointer="servicename"/>
210
 
        </listitem>
211
 
      </varlistentry>
212
 
      
213
 
      <varlistentry>
214
 
        <term><option>--configdir
215
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
205
 
 
206
      <varlistentry>
 
207
        <term><literal>--debug</literal></term>
 
208
        <listitem>
 
209
          <para>
 
210
            If the server is run in debug mode, it will run in the
 
211
            foreground and print a lot of debugging information.  The
 
212
            default is <emphasis>not</emphasis> to run in debug mode.
 
213
          </para>
 
214
        </listitem>
 
215
      </varlistentry>
 
216
 
 
217
      <varlistentry>
 
218
        <term><literal>--priority <replaceable>
 
219
        PRIORITY</replaceable></literal></term>
 
220
        <listitem>
 
221
          <para>
 
222
            GnuTLS priority string for the TLS handshake with the
 
223
            clients.  The default is
 
224
            <quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.
 
225
            See <citerefentry><refentrytitle>gnutls_priority_init
 
226
            </refentrytitle><manvolnum>3</manvolnum></citerefentry>
 
227
            for the syntax.  <emphasis>Warning</emphasis>: changing
 
228
            this may make the TLS handshake fail, making communication
 
229
            with clients impossible.
 
230
          </para>
 
231
        </listitem>
 
232
      </varlistentry>
 
233
 
 
234
      <varlistentry>
 
235
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
236
        </literal></term>
 
237
        <listitem>
 
238
          <para>
 
239
            Zeroconf service name.  The default is
 
240
            <quote><literal>Mandos</literal></quote>.  You only need
 
241
            to change this if you for some reason want to run more
 
242
            than one server on the same <emphasis>host</emphasis>,
 
243
            which would not normally be useful.  If there are name
 
244
            collisions on the same <emphasis>network</emphasis>, the
 
245
            newer server will automatically rename itself to
 
246
            <quote><literal>Mandos #2</literal></quote>, and so on;
 
247
            therefore, this option is not needed in that case.
 
248
          </para>
 
249
        </listitem>
 
250
      </varlistentry>
 
251
 
 
252
      <varlistentry>
 
253
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
254
        </literal></term>
216
255
        <listitem>
217
256
          <para>
218
257
            Directory to search for configuration files.  Default is
224
263
          </para>
225
264
        </listitem>
226
265
      </varlistentry>
227
 
      
 
266
 
228
267
      <varlistentry>
229
 
        <term><option>--version</option></term>
 
268
        <term><literal>--version</literal></term>
230
269
        <listitem>
231
270
          <para>
232
271
            Prints the program version and exit.
233
272
          </para>
234
273
        </listitem>
235
274
      </varlistentry>
236
 
      
237
 
      <varlistentry>
238
 
        <term><option>--no-dbus</option></term>
239
 
        <listitem>
240
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
241
 
          <para>
242
 
            See also <xref linkend="dbus_interface"/>.
243
 
          </para>
244
 
        </listitem>
245
 
      </varlistentry>
246
 
      
247
 
      <varlistentry>
248
 
        <term><option>--no-ipv6</option></term>
249
 
        <listitem>
250
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
251
 
        </listitem>
252
 
      </varlistentry>
253
275
    </variablelist>
254
276
  </refsect1>
255
 
  
 
277
 
256
278
  <refsect1 id="overview">
257
279
    <title>OVERVIEW</title>
258
 
    <xi:include href="overview.xml"/>
 
280
    &OVERVIEW;
259
281
    <para>
260
282
      This program is the server part.  It is a normal server program
261
283
      and will run in a normal system environment, not in an initial
262
 
      <acronym>RAM</acronym> disk environment.
 
284
      RAM disk environment.
263
285
    </para>
264
286
  </refsect1>
265
 
  
 
287
 
266
288
  <refsect1 id="protocol">
267
289
    <title>NETWORK PROTOCOL</title>
268
290
    <para>
294
316
        <entry>-><!-- &rarr; --></entry>
295
317
      </row>
296
318
      <row>
297
 
        <entry><quote><literal>1\r\n</literal></quote></entry>
 
319
        <entry><quote><literal>1\r\en</literal></quote></entry>
298
320
        <entry>-><!-- &rarr; --></entry>
299
321
      </row>
300
322
      <row>
320
342
      </row>
321
343
    </tbody></tgroup></table>
322
344
  </refsect1>
323
 
  
 
345
 
324
346
  <refsect1 id="checking">
325
347
    <title>CHECKING</title>
326
348
    <para>
330
352
      longer eligible to receive the encrypted password.  The timeout,
331
353
      checker program, and interval between checks can be configured
332
354
      both globally and per client; see <citerefentry>
 
355
      <refentrytitle>mandos.conf</refentrytitle>
 
356
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
333
357
      <refentrytitle>mandos-clients.conf</refentrytitle>
334
358
      <manvolnum>5</manvolnum></citerefentry>.
335
359
    </para>
336
360
  </refsect1>
337
 
  
 
361
 
338
362
  <refsect1 id="logging">
339
363
    <title>LOGGING</title>
340
364
    <para>
341
 
      The server will send log message with various severity levels to
342
 
      <filename>/dev/log</filename>.  With the
 
365
      The server will send log messaged with various severity levels
 
366
      to <filename>/dev/log</filename>.  With the
343
367
      <option>--debug</option> option, it will log even more messages,
344
368
      and also show them on the console.
345
369
    </para>
346
370
  </refsect1>
347
 
  
348
 
  <refsect1 id="dbus_interface">
349
 
    <title>D-BUS INTERFACE</title>
350
 
    <para>
351
 
      The server will by default provide a D-Bus system bus interface.
352
 
      This interface will only be accessible by the root user or a
353
 
      Mandos-specific user, if such a user exists.
354
 
      <!-- XXX -->
355
 
    </para>
356
 
  </refsect1>
357
 
  
 
371
 
358
372
  <refsect1 id="exit_status">
359
373
    <title>EXIT STATUS</title>
360
374
    <para>
362
376
      critical error is encountered.
363
377
    </para>
364
378
  </refsect1>
365
 
  
 
379
 
366
380
  <refsect1 id="environment">
367
381
    <title>ENVIRONMENT</title>
368
382
    <variablelist>
369
383
      <varlistentry>
370
 
        <term><envar>PATH</envar></term>
 
384
        <term><varname>PATH</varname></term>
371
385
        <listitem>
372
386
          <para>
373
387
            To start the configured checker (see <xref
376
390
            <varname>PATH</varname> to search for matching commands if
377
391
            an absolute path is not given.  See <citerefentry>
378
392
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
379
 
            </citerefentry>.
 
393
          </citerefentry>
380
394
          </para>
381
395
        </listitem>
382
396
      </varlistentry>
383
397
    </variablelist>
384
398
  </refsect1>
385
 
  
386
 
  <refsect1 id="files">
 
399
 
 
400
  <refsect1 id="file">
387
401
    <title>FILES</title>
388
402
    <para>
389
403
      Use the <option>--configdir</option> option to change where
412
426
        </listitem>
413
427
      </varlistentry>
414
428
      <varlistentry>
415
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
429
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
416
430
        <listitem>
417
431
          <para>
418
432
            The file containing the process id of
453
467
      Currently, if a client is declared <quote>invalid</quote> due to
454
468
      having timed out, the server does not record this fact onto
455
469
      permanent storage.  This has some security implications, see
456
 
      <xref linkend="clients"/>.
 
470
      <xref linkend="CLIENTS"/>.
457
471
    </para>
458
472
    <para>
459
473
      There is currently no way of querying the server of the current
467
481
      Debug mode is conflated with running in the foreground.
468
482
    </para>
469
483
    <para>
470
 
      The console log messages do not show a time stamp.
471
 
    </para>
472
 
    <para>
473
 
      This server does not check the expire time of clients’ OpenPGP
474
 
      keys.
 
484
      The console log messages does not show a timestamp.
475
485
    </para>
476
486
  </refsect1>
477
487
  
482
492
        Normal invocation needs no options:
483
493
      </para>
484
494
      <para>
485
 
        <userinput>&COMMANDNAME;</userinput>
 
495
        <userinput>mandos</userinput>
486
496
      </para>
487
497
    </informalexample>
488
498
    <informalexample>
495
505
      <para>
496
506
 
497
507
<!-- do not wrap this line -->
498
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
508
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
499
509
 
500
510
      </para>
501
511
    </informalexample>
507
517
      <para>
508
518
 
509
519
<!-- do not wrap this line -->
510
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
520
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
511
521
 
512
522
      </para>
513
523
    </informalexample>
514
524
  </refsect1>
515
 
  
 
525
 
516
526
  <refsect1 id="security">
517
527
    <title>SECURITY</title>
518
 
    <refsect2 id="server">
 
528
    <refsect2 id="SERVER">
519
529
      <title>SERVER</title>
520
530
      <para>
521
531
        Running this <command>&COMMANDNAME;</command> server program
522
532
        should not in itself present any security risk to the host
523
 
        computer running it.  The program switches to a non-root user
524
 
        soon after startup.
 
533
        computer running it.  The program does not need any special
 
534
        privileges to run, and is designed to run as a non-root user.
525
535
      </para>
526
536
    </refsect2>
527
 
    <refsect2 id="clients">
 
537
    <refsect2 id="CLIENTS">
528
538
      <title>CLIENTS</title>
529
539
      <para>
530
540
        The server only gives out its stored data to clients which
537
547
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
538
548
        <manvolnum>5</manvolnum></citerefentry>)
539
549
        <emphasis>must</emphasis> be made non-readable by anyone
540
 
        except the user starting the server (usually root).
 
550
        except the user running the server.
541
551
      </para>
542
552
      <para>
543
553
        As detailed in <xref linkend="checking"/>, the status of all
551
561
        re-read its client list from its configuration file and again
552
562
        regard all clients therein as valid, and hence eligible to
553
563
        receive their passwords.  Therefore, be careful when
554
 
        restarting servers if it is suspected that a client has, in
555
 
        fact, been compromised by parties who may now be running a
556
 
        fake Mandos client with the keys from the non-encrypted
557
 
        initial <acronym>RAM</acronym> image of the client host.  What
558
 
        should be done in that case (if restarting the server program
559
 
        really is necessary) is to stop the server program, edit the
560
 
        configuration file to omit any suspect clients, and restart
561
 
        the server program.
 
564
        restarting servers if you suspect that a client has, in fact,
 
565
        been compromised by parties who may now be running a fake
 
566
        Mandos client with the keys from the non-encrypted initial RAM
 
567
        image of the client host.  What should be done in that case
 
568
        (if restarting the server program really is necessary) is to
 
569
        stop the server program, edit the configuration file to omit
 
570
        any suspect clients, and restart the server program.
562
571
      </para>
563
572
      <para>
564
573
        For more details on client-side security, see
565
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
574
        <citerefentry><refentrytitle>password-request</refentrytitle>
566
575
        <manvolnum>8mandos</manvolnum></citerefentry>.
567
576
      </para>
568
577
    </refsect2>
569
578
  </refsect1>
570
 
  
 
579
 
571
580
  <refsect1 id="see_also">
572
581
    <title>SEE ALSO</title>
573
 
    <para>
574
 
      <citerefentry>
575
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
576
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
577
 
        <refentrytitle>mandos.conf</refentrytitle>
578
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
579
 
        <refentrytitle>mandos-client</refentrytitle>
580
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
581
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
582
 
      </citerefentry>
583
 
    </para>
584
582
    <variablelist>
585
583
      <varlistentry>
586
584
        <term>
 
585
          <citerefentry>
 
586
            <refentrytitle>password-request</refentrytitle>
 
587
            <manvolnum>8mandos</manvolnum>
 
588
          </citerefentry>
 
589
        </term>
 
590
        <listitem>
 
591
          <para>
 
592
            This is the actual program which talks to this server.
 
593
            Note that it is normally not invoked directly, and is only
 
594
            run in the initial RAM disk environment, and not on a
 
595
            fully started system.
 
596
          </para>
 
597
        </listitem>
 
598
      </varlistentry>
 
599
      <varlistentry>
 
600
        <term>
587
601
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
588
602
        </term>
589
603
        <listitem>
606
620
      </varlistentry>
607
621
      <varlistentry>
608
622
        <term>
609
 
          <ulink url="http://www.gnu.org/software/gnutls/"
610
 
          >GnuTLS</ulink>
 
623
          <ulink
 
624
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
611
625
        </term>
612
626
      <listitem>
613
627
        <para>
619
633
      </varlistentry>
620
634
      <varlistentry>
621
635
        <term>
622
 
          RFC 4291: <citetitle>IP Version 6 Addressing
623
 
          Architecture</citetitle>
 
636
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
 
637
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
 
638
          Unicast Addresses</citation>
624
639
        </term>
625
640
        <listitem>
626
 
          <variablelist>
627
 
            <varlistentry>
628
 
              <term>Section 2.2: <citetitle>Text Representation of
629
 
              Addresses</citetitle></term>
630
 
              <listitem><para/></listitem>
631
 
            </varlistentry>
632
 
            <varlistentry>
633
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
634
 
              Address</citetitle></term>
635
 
              <listitem><para/></listitem>
636
 
            </varlistentry>
637
 
            <varlistentry>
638
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
639
 
            Addresses</citetitle></term>
640
 
            <listitem>
641
 
              <para>
642
 
                The clients use IPv6 link-local addresses, which are
643
 
                immediately usable since a link-local addresses is
644
 
                automatically assigned to a network interfaces when it
645
 
                is brought up.
646
 
              </para>
647
 
            </listitem>
648
 
            </varlistentry>
649
 
          </variablelist>
 
641
          <para>
 
642
            The clients use IPv6 link-local addresses, which are
 
643
            immediately usable since a link-local addresses is
 
644
            automatically assigned to a network interfaces when it is
 
645
            brought up.
 
646
          </para>
650
647
        </listitem>
651
648
      </varlistentry>
652
649
      <varlistentry>
653
650
        <term>
654
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
655
 
          Protocol Version 1.1</citetitle>
 
651
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
652
          (TLS) Protocol Version 1.1</citetitle></citation>
656
653
        </term>
657
654
      <listitem>
658
655
        <para>
662
659
      </varlistentry>
663
660
      <varlistentry>
664
661
        <term>
665
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
662
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
663
          Format</citetitle></citation>
666
664
        </term>
667
665
      <listitem>
668
666
        <para>
672
670
      </varlistentry>
673
671
      <varlistentry>
674
672
        <term>
675
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
676
 
          Security</citetitle>
 
673
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
674
          Transport Layer Security</citetitle></citation>
677
675
        </term>
678
676
      <listitem>
679
677
        <para>
685
683
    </variablelist>
686
684
  </refsect1>
687
685
</refentry>
688
 
<!-- Local Variables: -->
689
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
690
 
<!-- time-stamp-end: "[\"']>" -->
691
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
692
 
<!-- End: -->