/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: 2010-09-12 03:00:40 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100912030040-b0uopyennste9fdh
Documentation changes:

* DBUS-API: New file documenting the server D-Bus interface.

* clients.conf: Add examples of new approval settings.

* debian/mandos.docs: Added "DBUS-API".

* mandos-clients.conf.xml (OPTIONS): Added "approved_by_default",
                                     "approval_delay", and
                                     "approval_duration".
* mandos.xml (D-BUS INTERFACE): Refer to the "DBUS-API" file.
  (BUGS): Remove mention of lack of a remote query interface.

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">
5
4
<!ENTITY COMMANDNAME "mandos">
6
 
<!ENTITY OVERVIEW SYSTEM "overview.xml">
 
5
<!ENTITY TIMESTAMP "2010-09-11">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
7
8
]>
8
9
 
9
 
<refentry>
10
 
  <refentryinfo>
11
 
    <title>&COMMANDNAME;</title>
 
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
11
   <refentryinfo>
 
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>&COMMANDNAME;</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
14
    <productname>Mandos</productname>
 
15
    <productnumber>&version;</productnumber>
 
16
    <date>&TIMESTAMP;</date>
15
17
    <authorgroup>
16
18
      <author>
17
19
        <firstname>Björn</firstname>
30
32
    </authorgroup>
31
33
    <copyright>
32
34
      <year>2008</year>
 
35
      <year>2009</year>
33
36
      <holder>Teddy Hogeborn</holder>
34
37
      <holder>Björn Påhlsson</holder>
35
38
    </copyright>
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>
 
39
    <xi:include href="legalnotice.xml"/>
59
40
  </refentryinfo>
60
 
 
 
41
  
61
42
  <refmeta>
62
43
    <refentrytitle>&COMMANDNAME;</refentrytitle>
63
44
    <manvolnum>8</manvolnum>
66
47
  <refnamediv>
67
48
    <refname><command>&COMMANDNAME;</command></refname>
68
49
    <refpurpose>
69
 
      Sends encrypted passwords to authenticated Mandos clients
 
50
      Gives encrypted passwords to authenticated Mandos clients
70
51
    </refpurpose>
71
52
  </refnamediv>
72
 
 
 
53
  
73
54
  <refsynopsisdiv>
74
55
    <cmdsynopsis>
75
56
      <command>&COMMANDNAME;</command>
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>
 
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>
93
92
    </cmdsynopsis>
94
93
    <cmdsynopsis>
95
94
      <command>&COMMANDNAME;</command>
96
95
      <group choice="req">
97
 
        <arg choice="plain">-h</arg>
98
 
        <arg choice="plain">--help</arg>
 
96
        <arg choice="plain"><option>--help</option></arg>
 
97
        <arg choice="plain"><option>-h</option></arg>
99
98
      </group>
100
99
    </cmdsynopsis>
101
100
    <cmdsynopsis>
102
101
      <command>&COMMANDNAME;</command>
103
 
      <arg choice="plain">--version</arg>
 
102
      <arg choice="plain"><option>--version</option></arg>
104
103
    </cmdsynopsis>
105
104
    <cmdsynopsis>
106
105
      <command>&COMMANDNAME;</command>
107
 
      <arg choice="plain">--check</arg>
 
106
      <arg choice="plain"><option>--check</option></arg>
108
107
    </cmdsynopsis>
109
108
  </refsynopsisdiv>
110
 
 
 
109
  
111
110
  <refsect1 id="description">
112
111
    <title>DESCRIPTION</title>
113
112
    <para>
122
121
      Any authenticated client is then given the stored pre-encrypted
123
122
      password for that specific client.
124
123
    </para>
125
 
 
126
124
  </refsect1>
127
125
  
128
126
  <refsect1 id="purpose">
129
127
    <title>PURPOSE</title>
130
 
 
131
128
    <para>
132
129
      The purpose of this is to enable <emphasis>remote and unattended
133
130
      rebooting</emphasis> of client host computer with an
134
131
      <emphasis>encrypted root file system</emphasis>.  See <xref
135
132
      linkend="overview"/> for details.
136
133
    </para>
137
 
 
138
134
  </refsect1>
139
135
  
140
136
  <refsect1 id="options">
141
137
    <title>OPTIONS</title>
142
 
 
143
138
    <variablelist>
144
139
      <varlistentry>
145
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
140
        <term><option>--help</option></term>
 
141
        <term><option>-h</option></term>
146
142
        <listitem>
147
143
          <para>
148
144
            Show a help message and exit
149
145
          </para>
150
146
        </listitem>
151
147
      </varlistentry>
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>
 
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>
198
181
        <listitem>
199
182
          <para>
200
183
            Run the server’s self-tests.  This includes any unit
202
185
          </para>
203
186
        </listitem>
204
187
      </varlistentry>
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>.  This only needs
241
 
            to be changed this if it, for some reason, is necessary to
242
 
            run more than one server on the same
243
 
            <emphasis>host</emphasis>, which would not normally be
244
 
            useful.  If there are name collisions on the same
245
 
            <emphasis>network</emphasis>, the newer server will
246
 
            automatically rename itself to <quote><literal>Mandos
247
 
            #2</literal></quote>, and so on; therefore, this option is
248
 
            not needed in that case.
249
 
          </para>
250
 
        </listitem>
251
 
      </varlistentry>
252
 
 
253
 
      <varlistentry>
254
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
255
 
        </literal></term>
 
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>
256
216
        <listitem>
257
217
          <para>
258
218
            Directory to search for configuration files.  Default is
264
224
          </para>
265
225
        </listitem>
266
226
      </varlistentry>
267
 
 
 
227
      
268
228
      <varlistentry>
269
 
        <term><literal>--version</literal></term>
 
229
        <term><option>--version</option></term>
270
230
        <listitem>
271
231
          <para>
272
232
            Prints the program version and exit.
273
233
          </para>
274
234
        </listitem>
275
235
      </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>
276
253
    </variablelist>
277
254
  </refsect1>
278
 
 
 
255
  
279
256
  <refsect1 id="overview">
280
257
    <title>OVERVIEW</title>
281
 
    &OVERVIEW;
 
258
    <xi:include href="overview.xml"/>
282
259
    <para>
283
260
      This program is the server part.  It is a normal server program
284
261
      and will run in a normal system environment, not in an initial
285
 
      RAM disk environment.
 
262
      <acronym>RAM</acronym> disk environment.
286
263
    </para>
287
264
  </refsect1>
288
 
 
 
265
  
289
266
  <refsect1 id="protocol">
290
267
    <title>NETWORK PROTOCOL</title>
291
268
    <para>
317
294
        <entry>-><!-- &rarr; --></entry>
318
295
      </row>
319
296
      <row>
320
 
        <entry><quote><literal>1\r\en</literal></quote></entry>
 
297
        <entry><quote><literal>1\r\n</literal></quote></entry>
321
298
        <entry>-><!-- &rarr; --></entry>
322
299
      </row>
323
300
      <row>
343
320
      </row>
344
321
    </tbody></tgroup></table>
345
322
  </refsect1>
346
 
 
 
323
  
347
324
  <refsect1 id="checking">
348
325
    <title>CHECKING</title>
349
326
    <para>
350
327
      The server will, by default, continually check that the clients
351
328
      are still up.  If a client has not been confirmed as being up
352
329
      for some time, the client is assumed to be compromised and is no
353
 
      longer eligible to receive the encrypted password.  The timeout,
 
330
      longer eligible to receive the encrypted password.  (Manual
 
331
      intervention is required to re-enable a client.)  The timeout,
354
332
      checker program, and interval between checks can be configured
355
333
      both globally and per client; see <citerefentry>
356
 
      <refentrytitle>mandos.conf</refentrytitle>
357
 
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
358
334
      <refentrytitle>mandos-clients.conf</refentrytitle>
359
 
      <manvolnum>5</manvolnum></citerefentry>.
 
335
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
336
      receiving its password will also be treated as a successful
 
337
      checker run.
360
338
    </para>
361
339
  </refsect1>
362
 
 
 
340
  
363
341
  <refsect1 id="logging">
364
342
    <title>LOGGING</title>
365
343
    <para>
366
 
      The server will send log messaged with various severity levels
367
 
      to <filename>/dev/log</filename>.  With the
 
344
      The server will send log message with various severity levels to
 
345
      <filename>/dev/log</filename>.  With the
368
346
      <option>--debug</option> option, it will log even more messages,
369
347
      and also show them on the console.
370
348
    </para>
371
349
  </refsect1>
372
 
 
 
350
  
 
351
  <refsect1 id="dbus_interface">
 
352
    <title>D-BUS INTERFACE</title>
 
353
    <para>
 
354
      The server will by default provide a D-Bus system bus interface.
 
355
      This interface will only be accessible by the root user or a
 
356
      Mandos-specific user, if such a user exists.  For documentation
 
357
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
358
    </para>
 
359
  </refsect1>
 
360
  
373
361
  <refsect1 id="exit_status">
374
362
    <title>EXIT STATUS</title>
375
363
    <para>
377
365
      critical error is encountered.
378
366
    </para>
379
367
  </refsect1>
380
 
 
 
368
  
381
369
  <refsect1 id="environment">
382
370
    <title>ENVIRONMENT</title>
383
371
    <variablelist>
384
372
      <varlistentry>
385
 
        <term><varname>PATH</varname></term>
 
373
        <term><envar>PATH</envar></term>
386
374
        <listitem>
387
375
          <para>
388
376
            To start the configured checker (see <xref
391
379
            <varname>PATH</varname> to search for matching commands if
392
380
            an absolute path is not given.  See <citerefentry>
393
381
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
394
 
          </citerefentry>
 
382
            </citerefentry>.
395
383
          </para>
396
384
        </listitem>
397
385
      </varlistentry>
398
386
    </variablelist>
399
387
  </refsect1>
400
 
 
401
 
  <refsect1 id="file">
 
388
  
 
389
  <refsect1 id="files">
402
390
    <title>FILES</title>
403
391
    <para>
404
392
      Use the <option>--configdir</option> option to change where
427
415
        </listitem>
428
416
      </varlistentry>
429
417
      <varlistentry>
430
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
418
        <term><filename>/var/run/mandos.pid</filename></term>
431
419
        <listitem>
432
420
          <para>
433
421
            The file containing the process id of
465
453
      backtrace.  This could be considered a feature.
466
454
    </para>
467
455
    <para>
468
 
      Currently, if a client is declared <quote>invalid</quote> due to
469
 
      having timed out, the server does not record this fact onto
470
 
      permanent storage.  This has some security implications, see
471
 
      <xref linkend="CLIENTS"/>.
472
 
    </para>
473
 
    <para>
474
 
      There is currently no way of querying the server of the current
475
 
      status of clients, other than analyzing its <systemitem
476
 
      class="service">syslog</systemitem> output.
 
456
      Currently, if a client is disabled due to having timed out, the
 
457
      server does not record this fact onto permanent storage.  This
 
458
      has some security implications, see <xref linkend="clients"/>.
477
459
    </para>
478
460
    <para>
479
461
      There is no fine-grained control over logging and debug output.
482
464
      Debug mode is conflated with running in the foreground.
483
465
    </para>
484
466
    <para>
485
 
      The console log messages does not show a timestamp.
 
467
      The console log messages do not show a time stamp.
 
468
    </para>
 
469
    <para>
 
470
      This server does not check the expire time of clients’ OpenPGP
 
471
      keys.
486
472
    </para>
487
473
  </refsect1>
488
474
  
493
479
        Normal invocation needs no options:
494
480
      </para>
495
481
      <para>
496
 
        <userinput>mandos</userinput>
 
482
        <userinput>&COMMANDNAME;</userinput>
497
483
      </para>
498
484
    </informalexample>
499
485
    <informalexample>
506
492
      <para>
507
493
 
508
494
<!-- do not wrap this line -->
509
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
495
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
510
496
 
511
497
      </para>
512
498
    </informalexample>
518
504
      <para>
519
505
 
520
506
<!-- do not wrap this line -->
521
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
507
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
522
508
 
523
509
      </para>
524
510
    </informalexample>
525
511
  </refsect1>
526
 
 
 
512
  
527
513
  <refsect1 id="security">
528
514
    <title>SECURITY</title>
529
 
    <refsect2 id="SERVER">
 
515
    <refsect2 id="server">
530
516
      <title>SERVER</title>
531
517
      <para>
532
518
        Running this <command>&COMMANDNAME;</command> server program
533
519
        should not in itself present any security risk to the host
534
 
        computer running it.  The program does not need any special
535
 
        privileges to run, and is designed to run as a non-root user.
 
520
        computer running it.  The program switches to a non-root user
 
521
        soon after startup.
536
522
      </para>
537
523
    </refsect2>
538
 
    <refsect2 id="CLIENTS">
 
524
    <refsect2 id="clients">
539
525
      <title>CLIENTS</title>
540
526
      <para>
541
527
        The server only gives out its stored data to clients which
548
534
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
549
535
        <manvolnum>5</manvolnum></citerefentry>)
550
536
        <emphasis>must</emphasis> be made non-readable by anyone
551
 
        except the user running the server.
 
537
        except the user starting the server (usually root).
552
538
      </para>
553
539
      <para>
554
540
        As detailed in <xref linkend="checking"/>, the status of all
557
543
      </para>
558
544
      <para>
559
545
        If a client is compromised, its downtime should be duly noted
560
 
        by the server which would therefore declare the client
561
 
        invalid.  But if the server was ever restarted, it would
562
 
        re-read its client list from its configuration file and again
563
 
        regard all clients therein as valid, and hence eligible to
564
 
        receive their passwords.  Therefore, be careful when
565
 
        restarting servers if it is suspected that a client has, in
566
 
        fact, been compromised by parties who may now be running a
567
 
        fake Mandos client with the keys from the non-encrypted
568
 
        initial RAM image of the client host.  What should be done in
569
 
        that case (if restarting the server program really is
570
 
        necessary) is to stop the server program, edit the
571
 
        configuration file to omit any suspect clients, and restart
572
 
        the server program.
 
546
        by the server which would therefore disable the client.  But
 
547
        if the server was ever restarted, it would re-read its client
 
548
        list from its configuration file and again regard all clients
 
549
        therein as enabled, and hence eligible to receive their
 
550
        passwords.  Therefore, be careful when restarting servers if
 
551
        it is suspected that a client has, in fact, been compromised
 
552
        by parties who may now be running a fake Mandos client with
 
553
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
554
        image of the client host.  What should be done in that case
 
555
        (if restarting the server program really is necessary) is to
 
556
        stop the server program, edit the configuration file to omit
 
557
        any suspect clients, and restart the server program.
573
558
      </para>
574
559
      <para>
575
560
        For more details on client-side security, see
576
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
561
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
577
562
        <manvolnum>8mandos</manvolnum></citerefentry>.
578
563
      </para>
579
564
    </refsect2>
580
565
  </refsect1>
581
 
 
 
566
  
582
567
  <refsect1 id="see_also">
583
568
    <title>SEE ALSO</title>
 
569
    <para>
 
570
      <citerefentry>
 
571
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
572
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
573
        <refentrytitle>mandos.conf</refentrytitle>
 
574
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
575
        <refentrytitle>mandos-client</refentrytitle>
 
576
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
577
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
578
      </citerefentry>
 
579
    </para>
584
580
    <variablelist>
585
581
      <varlistentry>
586
582
        <term>
587
 
          <citerefentry>
588
 
            <refentrytitle>password-request</refentrytitle>
589
 
            <manvolnum>8mandos</manvolnum>
590
 
          </citerefentry>
591
 
        </term>
592
 
        <listitem>
593
 
          <para>
594
 
            This is the actual program which talks to this server.
595
 
            Note that it is normally not invoked directly, and is only
596
 
            run in the initial RAM disk environment, and not on a
597
 
            fully started system.
598
 
          </para>
599
 
        </listitem>
600
 
      </varlistentry>
601
 
      <varlistentry>
602
 
        <term>
603
583
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
604
584
        </term>
605
585
        <listitem>
622
602
      </varlistentry>
623
603
      <varlistentry>
624
604
        <term>
625
 
          <ulink
626
 
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
605
          <ulink url="http://www.gnu.org/software/gnutls/"
 
606
          >GnuTLS</ulink>
627
607
        </term>
628
608
      <listitem>
629
609
        <para>
635
615
      </varlistentry>
636
616
      <varlistentry>
637
617
        <term>
638
 
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
639
 
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
640
 
          Unicast Addresses</citation>
 
618
          RFC 4291: <citetitle>IP Version 6 Addressing
 
619
          Architecture</citetitle>
641
620
        </term>
642
621
        <listitem>
643
 
          <para>
644
 
            The clients use IPv6 link-local addresses, which are
645
 
            immediately usable since a link-local addresses is
646
 
            automatically assigned to a network interfaces when it is
647
 
            brought up.
648
 
          </para>
 
622
          <variablelist>
 
623
            <varlistentry>
 
624
              <term>Section 2.2: <citetitle>Text Representation of
 
625
              Addresses</citetitle></term>
 
626
              <listitem><para/></listitem>
 
627
            </varlistentry>
 
628
            <varlistentry>
 
629
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
630
              Address</citetitle></term>
 
631
              <listitem><para/></listitem>
 
632
            </varlistentry>
 
633
            <varlistentry>
 
634
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
635
            Addresses</citetitle></term>
 
636
            <listitem>
 
637
              <para>
 
638
                The clients use IPv6 link-local addresses, which are
 
639
                immediately usable since a link-local addresses is
 
640
                automatically assigned to a network interfaces when it
 
641
                is brought up.
 
642
              </para>
 
643
            </listitem>
 
644
            </varlistentry>
 
645
          </variablelist>
649
646
        </listitem>
650
647
      </varlistentry>
651
648
      <varlistentry>
652
649
        <term>
653
 
          <citation>RFC 4346: <citetitle>The Transport Layer Security
654
 
          (TLS) Protocol Version 1.1</citetitle></citation>
 
650
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
651
          Protocol Version 1.1</citetitle>
655
652
        </term>
656
653
      <listitem>
657
654
        <para>
661
658
      </varlistentry>
662
659
      <varlistentry>
663
660
        <term>
664
 
          <citation>RFC 4880: <citetitle>OpenPGP Message
665
 
          Format</citetitle></citation>
 
661
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
666
662
        </term>
667
663
      <listitem>
668
664
        <para>
672
668
      </varlistentry>
673
669
      <varlistentry>
674
670
        <term>
675
 
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
676
 
          Transport Layer Security</citetitle></citation>
 
671
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
672
          Security</citetitle>
677
673
        </term>
678
674
      <listitem>
679
675
        <para>
685
681
    </variablelist>
686
682
  </refsect1>
687
683
</refentry>
 
684
<!-- Local Variables: -->
 
685
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
686
<!-- time-stamp-end: "[\"']>" -->
 
687
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
688
<!-- End: -->