/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 mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-25 06:44:13 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080825064413-smqg5qwxfvhkeop4
* Makefile (DOCBOOKTOMAN): Only cd to one directory.

* mandos-options.xml (interface): Removed mention of a specific
                                  replaceable.
  (debug): Reworded slightly.

* mandos.conf.xml (OPTIONS): Renamed some replaceable names.

* mandos.xml (SYNOPSIS, OPTIONS): Renamed replaceable of "interface"
                                  from "IF" to "NAME".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.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 VERSION "1.0">
4
5
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2011-10-03">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
8
6
]>
9
7
 
10
8
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
   <refentryinfo>
12
 
    <title>Mandos Manual</title>
 
9
  <refentryinfo>
 
10
    <title>&COMMANDNAME;</title>
13
11
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
16
 
    <date>&TIMESTAMP;</date>
 
12
    <productname>&COMMANDNAME;</productname>
 
13
    <productnumber>&VERSION;</productnumber>
17
14
    <authorgroup>
18
15
      <author>
19
16
        <firstname>Björn</firstname>
20
17
        <surname>Påhlsson</surname>
21
18
        <address>
22
 
          <email>belorn@recompile.se</email>
 
19
          <email>belorn@fukt.bsnet.se</email>
23
20
        </address>
24
21
      </author>
25
22
      <author>
26
23
        <firstname>Teddy</firstname>
27
24
        <surname>Hogeborn</surname>
28
25
        <address>
29
 
          <email>teddy@recompile.se</email>
 
26
          <email>teddy@fukt.bsnet.se</email>
30
27
        </address>
31
28
      </author>
32
29
    </authorgroup>
33
30
    <copyright>
34
31
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2010</year>
37
 
      <year>2011</year>
38
32
      <holder>Teddy Hogeborn</holder>
39
33
      <holder>Björn Påhlsson</holder>
40
34
    </copyright>
41
 
    <xi:include href="legalnotice.xml"/>
 
35
    <legalnotice>
 
36
      <para>
 
37
        This manual page is free software: you can redistribute it
 
38
        and/or modify it under the terms of the GNU General Public
 
39
        License as published by the Free Software Foundation,
 
40
        either version 3 of the License, or (at your option) any
 
41
        later version.
 
42
      </para>
 
43
 
 
44
      <para>
 
45
        This manual page is distributed in the hope that it will
 
46
        be useful, but WITHOUT ANY WARRANTY; without even the
 
47
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
48
        PARTICULAR PURPOSE.  See the GNU General Public License
 
49
        for more details.
 
50
      </para>
 
51
 
 
52
      <para>
 
53
        You should have received a copy of the GNU General Public
 
54
        License along with this program; If not, see
 
55
        <ulink url="http://www.gnu.org/licenses/"/>.
 
56
      </para>
 
57
    </legalnotice>
42
58
  </refentryinfo>
43
 
  
 
59
 
44
60
  <refmeta>
45
61
    <refentrytitle>&COMMANDNAME;</refentrytitle>
46
62
    <manvolnum>8</manvolnum>
49
65
  <refnamediv>
50
66
    <refname><command>&COMMANDNAME;</command></refname>
51
67
    <refpurpose>
52
 
      Gives encrypted passwords to authenticated Mandos clients
 
68
      Sends encrypted passwords to authenticated Mandos clients
53
69
    </refpurpose>
54
70
  </refnamediv>
55
 
  
 
71
 
56
72
  <refsynopsisdiv>
57
73
    <cmdsynopsis>
58
74
      <command>&COMMANDNAME;</command>
59
 
      <group>
60
 
        <arg choice="plain"><option>--interface
61
 
        <replaceable>NAME</replaceable></option></arg>
62
 
        <arg choice="plain"><option>-i
63
 
        <replaceable>NAME</replaceable></option></arg>
64
 
      </group>
65
 
      <sbr/>
66
 
      <group>
67
 
        <arg choice="plain"><option>--address
68
 
        <replaceable>ADDRESS</replaceable></option></arg>
69
 
        <arg choice="plain"><option>-a
70
 
        <replaceable>ADDRESS</replaceable></option></arg>
71
 
      </group>
72
 
      <sbr/>
73
 
      <group>
74
 
        <arg choice="plain"><option>--port
75
 
        <replaceable>PORT</replaceable></option></arg>
76
 
        <arg choice="plain"><option>-p
77
 
        <replaceable>PORT</replaceable></option></arg>
78
 
      </group>
79
 
      <sbr/>
80
 
      <arg><option>--priority
81
 
      <replaceable>PRIORITY</replaceable></option></arg>
82
 
      <sbr/>
83
 
      <arg><option>--servicename
84
 
      <replaceable>NAME</replaceable></option></arg>
85
 
      <sbr/>
86
 
      <arg><option>--configdir
87
 
      <replaceable>DIRECTORY</replaceable></option></arg>
88
 
      <sbr/>
89
 
      <arg><option>--debug</option></arg>
90
 
      <sbr/>
91
 
      <arg><option>--debuglevel
92
 
      <replaceable>LEVEL</replaceable></option></arg>
93
 
      <sbr/>
94
 
      <arg><option>--no-dbus</option></arg>
95
 
      <sbr/>
96
 
      <arg><option>--no-ipv6</option></arg>
 
75
      <arg>--interface<arg choice="plain">NAME</arg></arg>
 
76
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
 
77
      <arg>--port<arg choice="plain">PORT</arg></arg>
 
78
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
 
79
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
 
80
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
81
      <arg>--debug</arg>
 
82
    </cmdsynopsis>
 
83
    <cmdsynopsis>
 
84
      <command>&COMMANDNAME;</command>
 
85
      <arg>-i<arg choice="plain">NAME</arg></arg>
 
86
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
 
87
      <arg>-p<arg choice="plain">PORT</arg></arg>
 
88
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
 
89
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
 
90
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
91
      <arg>--debug</arg>
97
92
    </cmdsynopsis>
98
93
    <cmdsynopsis>
99
94
      <command>&COMMANDNAME;</command>
100
95
      <group choice="req">
101
 
        <arg choice="plain"><option>--help</option></arg>
102
 
        <arg choice="plain"><option>-h</option></arg>
 
96
        <arg choice="plain">-h</arg>
 
97
        <arg choice="plain">--help</arg>
103
98
      </group>
104
99
    </cmdsynopsis>
105
100
    <cmdsynopsis>
106
101
      <command>&COMMANDNAME;</command>
107
 
      <arg choice="plain"><option>--version</option></arg>
 
102
      <arg choice="plain">--version</arg>
108
103
    </cmdsynopsis>
109
104
    <cmdsynopsis>
110
105
      <command>&COMMANDNAME;</command>
111
 
      <arg choice="plain"><option>--check</option></arg>
 
106
      <arg choice="plain">--check</arg>
112
107
    </cmdsynopsis>
113
108
  </refsynopsisdiv>
114
 
  
 
109
 
115
110
  <refsect1 id="description">
116
111
    <title>DESCRIPTION</title>
117
112
    <para>
118
113
      <command>&COMMANDNAME;</command> is a server daemon which
119
114
      handles incoming request for passwords for a pre-defined list of
120
 
      client host computers. For an introduction, see
121
 
      <citerefentry><refentrytitle>intro</refentrytitle>
122
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
123
 
      uses Zeroconf to announce itself on the local network, and uses
124
 
      TLS to communicate securely with and to authenticate the
125
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
126
 
      use IPv6 link-local addresses, since the clients will probably
127
 
      not have any other addresses configured (see <xref
128
 
      linkend="overview"/>).  Any authenticated client is then given
129
 
      the stored pre-encrypted password for that specific client.
 
115
      client host computers.  The Mandos server uses Zeroconf to
 
116
      announce itself on the local network, and uses TLS to
 
117
      communicate securely with and to authenticate the clients.  The
 
118
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
 
119
      link-local addresses, since the clients will probably not have
 
120
      any other addresses configured (see <xref linkend="overview"/>).
 
121
      Any authenticated client is then given the stored pre-encrypted
 
122
      password for that specific client.
130
123
    </para>
 
124
 
131
125
  </refsect1>
132
126
  
133
127
  <refsect1 id="purpose">
134
128
    <title>PURPOSE</title>
 
129
 
135
130
    <para>
136
131
      The purpose of this is to enable <emphasis>remote and unattended
137
132
      rebooting</emphasis> of client host computer with an
138
133
      <emphasis>encrypted root file system</emphasis>.  See <xref
139
134
      linkend="overview"/> for details.
140
135
    </para>
 
136
 
141
137
  </refsect1>
142
138
  
143
139
  <refsect1 id="options">
144
140
    <title>OPTIONS</title>
 
141
 
145
142
    <variablelist>
146
143
      <varlistentry>
147
 
        <term><option>--help</option></term>
148
 
        <term><option>-h</option></term>
 
144
        <term><literal>-h</literal>, <literal>--help</literal></term>
149
145
        <listitem>
150
146
          <para>
151
147
            Show a help message and exit
152
148
          </para>
153
149
        </listitem>
154
150
      </varlistentry>
155
 
      
 
151
 
156
152
      <varlistentry>
157
 
        <term><option>--interface</option>
158
 
        <replaceable>NAME</replaceable></term>
159
 
        <term><option>-i</option>
160
 
        <replaceable>NAME</replaceable></term>
 
153
        <term><literal>-i</literal>, <literal>--interface <replaceable
 
154
        >NAME</replaceable></literal></term>
161
155
        <listitem>
162
156
          <xi:include href="mandos-options.xml" xpointer="interface"/>
163
157
        </listitem>
164
158
      </varlistentry>
165
 
      
 
159
 
166
160
      <varlistentry>
167
 
        <term><option>--address
168
 
        <replaceable>ADDRESS</replaceable></option></term>
169
 
        <term><option>-a
170
 
        <replaceable>ADDRESS</replaceable></option></term>
 
161
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
162
        ADDRESS</replaceable></literal></term>
171
163
        <listitem>
172
164
          <xi:include href="mandos-options.xml" xpointer="address"/>
173
165
        </listitem>
174
166
      </varlistentry>
175
 
      
 
167
 
176
168
      <varlistentry>
177
 
        <term><option>--port
178
 
        <replaceable>PORT</replaceable></option></term>
179
 
        <term><option>-p
180
 
        <replaceable>PORT</replaceable></option></term>
 
169
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
170
        PORT</replaceable></literal></term>
181
171
        <listitem>
182
172
          <xi:include href="mandos-options.xml" xpointer="port"/>
183
173
        </listitem>
184
174
      </varlistentry>
185
 
      
 
175
 
186
176
      <varlistentry>
187
 
        <term><option>--check</option></term>
 
177
        <term><literal>--check</literal></term>
188
178
        <listitem>
189
179
          <para>
190
180
            Run the server’s self-tests.  This includes any unit
192
182
          </para>
193
183
        </listitem>
194
184
      </varlistentry>
195
 
      
 
185
 
196
186
      <varlistentry>
197
 
        <term><option>--debug</option></term>
 
187
        <term><literal>--debug</literal></term>
198
188
        <listitem>
199
189
          <xi:include href="mandos-options.xml" xpointer="debug"/>
200
190
        </listitem>
201
191
      </varlistentry>
202
 
      
203
 
      <varlistentry>
204
 
        <term><option>--debuglevel
205
 
        <replaceable>LEVEL</replaceable></option></term>
206
 
        <listitem>
207
 
          <para>
208
 
            Set the debugging log level.
209
 
            <replaceable>LEVEL</replaceable> is a string, one of
210
 
            <quote><literal>CRITICAL</literal></quote>,
211
 
            <quote><literal>ERROR</literal></quote>,
212
 
            <quote><literal>WARNING</literal></quote>,
213
 
            <quote><literal>INFO</literal></quote>, or
214
 
            <quote><literal>DEBUG</literal></quote>, in order of
215
 
            increasing verbosity.  The default level is
216
 
            <quote><literal>WARNING</literal></quote>.
217
 
          </para>
218
 
        </listitem>
219
 
      </varlistentry>
220
 
      
221
 
      <varlistentry>
222
 
        <term><option>--priority <replaceable>
223
 
        PRIORITY</replaceable></option></term>
 
192
 
 
193
      <varlistentry>
 
194
        <term><literal>--priority <replaceable>
 
195
        PRIORITY</replaceable></literal></term>
224
196
        <listitem>
225
197
          <xi:include href="mandos-options.xml" xpointer="priority"/>
226
198
        </listitem>
227
199
      </varlistentry>
228
 
      
 
200
 
229
201
      <varlistentry>
230
 
        <term><option>--servicename
231
 
        <replaceable>NAME</replaceable></option></term>
 
202
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
203
        </literal></term>
232
204
        <listitem>
233
205
          <xi:include href="mandos-options.xml"
234
206
                      xpointer="servicename"/>
235
207
        </listitem>
236
208
      </varlistentry>
237
 
      
 
209
 
238
210
      <varlistentry>
239
 
        <term><option>--configdir
240
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
211
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
212
        </literal></term>
241
213
        <listitem>
242
214
          <para>
243
215
            Directory to search for configuration files.  Default is
249
221
          </para>
250
222
        </listitem>
251
223
      </varlistentry>
252
 
      
 
224
 
253
225
      <varlistentry>
254
 
        <term><option>--version</option></term>
 
226
        <term><literal>--version</literal></term>
255
227
        <listitem>
256
228
          <para>
257
229
            Prints the program version and exit.
258
230
          </para>
259
231
        </listitem>
260
232
      </varlistentry>
261
 
      
262
 
      <varlistentry>
263
 
        <term><option>--no-dbus</option></term>
264
 
        <listitem>
265
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
266
 
          <para>
267
 
            See also <xref linkend="dbus_interface"/>.
268
 
          </para>
269
 
        </listitem>
270
 
      </varlistentry>
271
 
      
272
 
      <varlistentry>
273
 
        <term><option>--no-ipv6</option></term>
274
 
        <listitem>
275
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
276
 
        </listitem>
277
 
      </varlistentry>
278
233
    </variablelist>
279
234
  </refsect1>
280
 
  
 
235
 
281
236
  <refsect1 id="overview">
282
237
    <title>OVERVIEW</title>
283
238
    <xi:include href="overview.xml"/>
284
239
    <para>
285
240
      This program is the server part.  It is a normal server program
286
241
      and will run in a normal system environment, not in an initial
287
 
      <acronym>RAM</acronym> disk environment.
 
242
      RAM disk environment.
288
243
    </para>
289
244
  </refsect1>
290
 
  
 
245
 
291
246
  <refsect1 id="protocol">
292
247
    <title>NETWORK PROTOCOL</title>
293
248
    <para>
345
300
      </row>
346
301
    </tbody></tgroup></table>
347
302
  </refsect1>
348
 
  
 
303
 
349
304
  <refsect1 id="checking">
350
305
    <title>CHECKING</title>
351
306
    <para>
352
307
      The server will, by default, continually check that the clients
353
308
      are still up.  If a client has not been confirmed as being up
354
309
      for some time, the client is assumed to be compromised and is no
355
 
      longer eligible to receive the encrypted password.  (Manual
356
 
      intervention is required to re-enable a client.)  The timeout,
357
 
      extended timeout, checker program, and interval between checks
358
 
      can be configured both globally and per client; see
359
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
360
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
361
 
      receiving its password will also be treated as a successful
362
 
      checker run.
363
 
    </para>
364
 
  </refsect1>
365
 
  
366
 
  <refsect1 id="approval">
367
 
    <title>APPROVAL</title>
368
 
    <para>
369
 
      The server can be configured to require manual approval for a
370
 
      client before it is sent its secret.  The delay to wait for such
371
 
      approval and the default action (approve or deny) can be
372
 
      configured both globally and per client; see <citerefentry>
 
310
      longer eligible to receive the encrypted password.  The timeout,
 
311
      checker program, and interval between checks can be configured
 
312
      both globally and per client; see <citerefentry>
373
313
      <refentrytitle>mandos-clients.conf</refentrytitle>
374
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
375
 
      will be approved immediately without delay.
376
 
    </para>
377
 
    <para>
378
 
      This can be used to deny a client its secret if not manually
379
 
      approved within a specified time.  It can also be used to make
380
 
      the server delay before giving a client its secret, allowing
381
 
      optional manual denying of this specific client.
382
 
    </para>
383
 
    
 
314
      <manvolnum>5</manvolnum></citerefentry>.
 
315
    </para>
384
316
  </refsect1>
385
 
  
 
317
 
386
318
  <refsect1 id="logging">
387
319
    <title>LOGGING</title>
388
320
    <para>
392
324
      and also show them on the console.
393
325
    </para>
394
326
  </refsect1>
395
 
  
396
 
  <refsect1 id="dbus_interface">
397
 
    <title>D-BUS INTERFACE</title>
398
 
    <para>
399
 
      The server will by default provide a D-Bus system bus interface.
400
 
      This interface will only be accessible by the root user or a
401
 
      Mandos-specific user, if such a user exists.  For documentation
402
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
403
 
    </para>
404
 
  </refsect1>
405
 
  
 
327
 
406
328
  <refsect1 id="exit_status">
407
329
    <title>EXIT STATUS</title>
408
330
    <para>
410
332
      critical error is encountered.
411
333
    </para>
412
334
  </refsect1>
413
 
  
 
335
 
414
336
  <refsect1 id="environment">
415
337
    <title>ENVIRONMENT</title>
416
338
    <variablelist>
417
339
      <varlistentry>
418
 
        <term><envar>PATH</envar></term>
 
340
        <term><varname>PATH</varname></term>
419
341
        <listitem>
420
342
          <para>
421
343
            To start the configured checker (see <xref
430
352
      </varlistentry>
431
353
    </variablelist>
432
354
  </refsect1>
433
 
  
434
 
  <refsect1 id="files">
 
355
 
 
356
  <refsect1 id="file">
435
357
    <title>FILES</title>
436
358
    <para>
437
359
      Use the <option>--configdir</option> option to change where
460
382
        </listitem>
461
383
      </varlistentry>
462
384
      <varlistentry>
463
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
385
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
464
386
        <listitem>
465
387
          <para>
466
 
            The file containing the process id of the
467
 
            <command>&COMMANDNAME;</command> process started last.
 
388
            The file containing the process id of
 
389
            <command>&COMMANDNAME;</command>.
468
390
          </para>
469
391
        </listitem>
470
392
      </varlistentry>
498
420
      backtrace.  This could be considered a feature.
499
421
    </para>
500
422
    <para>
501
 
      Currently, if a client is disabled due to having timed out, the
502
 
      server does not record this fact onto permanent storage.  This
503
 
      has some security implications, see <xref linkend="clients"/>.
 
423
      Currently, if a client is declared <quote>invalid</quote> due to
 
424
      having timed out, the server does not record this fact onto
 
425
      permanent storage.  This has some security implications, see
 
426
      <xref linkend="CLIENTS"/>.
 
427
    </para>
 
428
    <para>
 
429
      There is currently no way of querying the server of the current
 
430
      status of clients, other than analyzing its <systemitem
 
431
      class="service">syslog</systemitem> output.
504
432
    </para>
505
433
    <para>
506
434
      There is no fine-grained control over logging and debug output.
509
437
      Debug mode is conflated with running in the foreground.
510
438
    </para>
511
439
    <para>
512
 
      The console log messages do not show a time stamp.
513
 
    </para>
514
 
    <para>
515
 
      This server does not check the expire time of clients’ OpenPGP
516
 
      keys.
 
440
      The console log messages does not show a timestamp.
517
441
    </para>
518
442
  </refsect1>
519
443
  
524
448
        Normal invocation needs no options:
525
449
      </para>
526
450
      <para>
527
 
        <userinput>&COMMANDNAME;</userinput>
 
451
        <userinput>mandos</userinput>
528
452
      </para>
529
453
    </informalexample>
530
454
    <informalexample>
537
461
      <para>
538
462
 
539
463
<!-- do not wrap this line -->
540
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
464
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
541
465
 
542
466
      </para>
543
467
    </informalexample>
549
473
      <para>
550
474
 
551
475
<!-- do not wrap this line -->
552
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
476
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
553
477
 
554
478
      </para>
555
479
    </informalexample>
556
480
  </refsect1>
557
 
  
 
481
 
558
482
  <refsect1 id="security">
559
483
    <title>SECURITY</title>
560
 
    <refsect2 id="server">
 
484
    <refsect2 id="SERVER">
561
485
      <title>SERVER</title>
562
486
      <para>
563
487
        Running this <command>&COMMANDNAME;</command> server program
564
488
        should not in itself present any security risk to the host
565
 
        computer running it.  The program switches to a non-root user
566
 
        soon after startup.
 
489
        computer running it.  The program does not need any special
 
490
        privileges to run, and is designed to run as a non-root user.
567
491
      </para>
568
492
    </refsect2>
569
 
    <refsect2 id="clients">
 
493
    <refsect2 id="CLIENTS">
570
494
      <title>CLIENTS</title>
571
495
      <para>
572
496
        The server only gives out its stored data to clients which
579
503
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
580
504
        <manvolnum>5</manvolnum></citerefentry>)
581
505
        <emphasis>must</emphasis> be made non-readable by anyone
582
 
        except the user starting the server (usually root).
 
506
        except the user running the server.
583
507
      </para>
584
508
      <para>
585
509
        As detailed in <xref linkend="checking"/>, the status of all
588
512
      </para>
589
513
      <para>
590
514
        If a client is compromised, its downtime should be duly noted
591
 
        by the server which would therefore disable the client.  But
592
 
        if the server was ever restarted, it would re-read its client
593
 
        list from its configuration file and again regard all clients
594
 
        therein as enabled, and hence eligible to receive their
595
 
        passwords.  Therefore, be careful when restarting servers if
596
 
        it is suspected that a client has, in fact, been compromised
597
 
        by parties who may now be running a fake Mandos client with
598
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
599
 
        image of the client host.  What should be done in that case
600
 
        (if restarting the server program really is necessary) is to
601
 
        stop the server program, edit the configuration file to omit
602
 
        any suspect clients, and restart the server program.
 
515
        by the server which would therefore declare the client
 
516
        invalid.  But if the server was ever restarted, it would
 
517
        re-read its client list from its configuration file and again
 
518
        regard all clients therein as valid, and hence eligible to
 
519
        receive their passwords.  Therefore, be careful when
 
520
        restarting servers if it is suspected that a client has, in
 
521
        fact, been compromised by parties who may now be running a
 
522
        fake Mandos client with the keys from the non-encrypted
 
523
        initial RAM image of the client host.  What should be done in
 
524
        that case (if restarting the server program really is
 
525
        necessary) is to stop the server program, edit the
 
526
        configuration file to omit any suspect clients, and restart
 
527
        the server program.
603
528
      </para>
604
529
      <para>
605
530
        For more details on client-side security, see
606
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
531
        <citerefentry><refentrytitle>password-request</refentrytitle>
607
532
        <manvolnum>8mandos</manvolnum></citerefentry>.
608
533
      </para>
609
534
    </refsect2>
610
535
  </refsect1>
611
 
  
 
536
 
612
537
  <refsect1 id="see_also">
613
538
    <title>SEE ALSO</title>
614
539
    <para>
615
 
      <citerefentry><refentrytitle>intro</refentrytitle>
616
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
617
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
618
 
      <manvolnum>5</manvolnum></citerefentry>,
619
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
620
 
      <manvolnum>5</manvolnum></citerefentry>,
621
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
622
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
623
 
      <citerefentry><refentrytitle>sh</refentrytitle>
624
 
      <manvolnum>1</manvolnum></citerefentry>
 
540
      <citerefentry>
 
541
        <refentrytitle>mandos.conf</refentrytitle>
 
542
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
543
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
544
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
545
        <refentrytitle>password-request</refentrytitle>
 
546
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
547
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
548
      </citerefentry>
625
549
    </para>
626
550
    <variablelist>
627
551
      <varlistentry>
648
572
      </varlistentry>
649
573
      <varlistentry>
650
574
        <term>
651
 
          <ulink url="http://www.gnu.org/software/gnutls/"
652
 
          >GnuTLS</ulink>
 
575
          <ulink
 
576
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
653
577
        </term>
654
578
      <listitem>
655
579
        <para>
661
585
      </varlistentry>
662
586
      <varlistentry>
663
587
        <term>
664
 
          RFC 4291: <citetitle>IP Version 6 Addressing
665
 
          Architecture</citetitle>
 
588
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
 
589
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
 
590
          Unicast Addresses</citation>
666
591
        </term>
667
592
        <listitem>
668
 
          <variablelist>
669
 
            <varlistentry>
670
 
              <term>Section 2.2: <citetitle>Text Representation of
671
 
              Addresses</citetitle></term>
672
 
              <listitem><para/></listitem>
673
 
            </varlistentry>
674
 
            <varlistentry>
675
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
676
 
              Address</citetitle></term>
677
 
              <listitem><para/></listitem>
678
 
            </varlistentry>
679
 
            <varlistentry>
680
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
681
 
            Addresses</citetitle></term>
682
 
            <listitem>
683
 
              <para>
684
 
                The clients use IPv6 link-local addresses, which are
685
 
                immediately usable since a link-local addresses is
686
 
                automatically assigned to a network interfaces when it
687
 
                is brought up.
688
 
              </para>
689
 
            </listitem>
690
 
            </varlistentry>
691
 
          </variablelist>
 
593
          <para>
 
594
            The clients use IPv6 link-local addresses, which are
 
595
            immediately usable since a link-local addresses is
 
596
            automatically assigned to a network interfaces when it is
 
597
            brought up.
 
598
          </para>
692
599
        </listitem>
693
600
      </varlistentry>
694
601
      <varlistentry>
695
602
        <term>
696
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
697
 
          Protocol Version 1.1</citetitle>
 
603
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
604
          (TLS) Protocol Version 1.1</citetitle></citation>
698
605
        </term>
699
606
      <listitem>
700
607
        <para>
704
611
      </varlistentry>
705
612
      <varlistentry>
706
613
        <term>
707
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
614
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
615
          Format</citetitle></citation>
708
616
        </term>
709
617
      <listitem>
710
618
        <para>
714
622
      </varlistentry>
715
623
      <varlistentry>
716
624
        <term>
717
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
718
 
          Security</citetitle>
 
625
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
626
          Transport Layer Security</citetitle></citation>
719
627
        </term>
720
628
      <listitem>
721
629
        <para>
727
635
    </variablelist>
728
636
  </refsect1>
729
637
</refentry>
730
 
<!-- Local Variables: -->
731
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
732
 
<!-- time-stamp-end: "[\"']>" -->
733
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
734
 
<!-- End: -->