/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

* initramfs-tools-hook: Install network hooks (and any required files)
                        in the initramfs image.
* plugins.d/mandos-client.c (main): Also set MANDOSNETHOOKDIR for
                                    network hooks.
* plugins.d/mandos-client.xml (OPTIONS): Use <filename
                                         class="directory">, not
                                         <directory>.

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">
 
5
<!ENTITY TIMESTAMP "2011-10-03">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
6
8
]>
7
9
 
8
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
9
 
  <refentryinfo>
10
 
    <title>&COMMANDNAME;</title>
 
11
   <refentryinfo>
 
12
    <title>Mandos Manual</title>
11
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
12
 
    <productname>&COMMANDNAME;</productname>
13
 
    <productnumber>&VERSION;</productnumber>
 
14
    <productname>Mandos</productname>
 
15
    <productnumber>&version;</productnumber>
 
16
    <date>&TIMESTAMP;</date>
14
17
    <authorgroup>
15
18
      <author>
16
19
        <firstname>Björn</firstname>
17
20
        <surname>Påhlsson</surname>
18
21
        <address>
19
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
20
23
        </address>
21
24
      </author>
22
25
      <author>
23
26
        <firstname>Teddy</firstname>
24
27
        <surname>Hogeborn</surname>
25
28
        <address>
26
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
27
30
        </address>
28
31
      </author>
29
32
    </authorgroup>
30
33
    <copyright>
31
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
32
38
      <holder>Teddy Hogeborn</holder>
33
39
      <holder>Björn Påhlsson</holder>
34
40
    </copyright>
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>
 
41
    <xi:include href="legalnotice.xml"/>
58
42
  </refentryinfo>
59
 
 
 
43
  
60
44
  <refmeta>
61
45
    <refentrytitle>&COMMANDNAME;</refentrytitle>
62
46
    <manvolnum>8</manvolnum>
65
49
  <refnamediv>
66
50
    <refname><command>&COMMANDNAME;</command></refname>
67
51
    <refpurpose>
68
 
      Sends encrypted passwords to authenticated Mandos clients
 
52
      Gives encrypted passwords to authenticated Mandos clients
69
53
    </refpurpose>
70
54
  </refnamediv>
71
 
 
 
55
  
72
56
  <refsynopsisdiv>
73
57
    <cmdsynopsis>
74
58
      <command>&COMMANDNAME;</command>
75
 
      <arg>--interface<arg choice="plain">IF</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">IF</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>
 
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>
92
97
    </cmdsynopsis>
93
98
    <cmdsynopsis>
94
99
      <command>&COMMANDNAME;</command>
95
100
      <group choice="req">
96
 
        <arg choice="plain">-h</arg>
97
 
        <arg choice="plain">--help</arg>
 
101
        <arg choice="plain"><option>--help</option></arg>
 
102
        <arg choice="plain"><option>-h</option></arg>
98
103
      </group>
99
104
    </cmdsynopsis>
100
105
    <cmdsynopsis>
101
106
      <command>&COMMANDNAME;</command>
102
 
      <arg choice="plain">--version</arg>
 
107
      <arg choice="plain"><option>--version</option></arg>
103
108
    </cmdsynopsis>
104
109
    <cmdsynopsis>
105
110
      <command>&COMMANDNAME;</command>
106
 
      <arg choice="plain">--check</arg>
 
111
      <arg choice="plain"><option>--check</option></arg>
107
112
    </cmdsynopsis>
108
113
  </refsynopsisdiv>
109
 
 
 
114
  
110
115
  <refsect1 id="description">
111
116
    <title>DESCRIPTION</title>
112
117
    <para>
113
118
      <command>&COMMANDNAME;</command> is a server daemon which
114
119
      handles incoming request for passwords for a pre-defined list of
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.
 
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.
123
130
    </para>
124
 
 
125
131
  </refsect1>
126
132
  
127
133
  <refsect1 id="purpose">
128
134
    <title>PURPOSE</title>
129
 
 
130
135
    <para>
131
136
      The purpose of this is to enable <emphasis>remote and unattended
132
137
      rebooting</emphasis> of client host computer with an
133
138
      <emphasis>encrypted root file system</emphasis>.  See <xref
134
139
      linkend="overview"/> for details.
135
140
    </para>
136
 
 
137
141
  </refsect1>
138
142
  
139
143
  <refsect1 id="options">
140
144
    <title>OPTIONS</title>
141
 
 
142
145
    <variablelist>
143
146
      <varlistentry>
144
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
147
        <term><option>--help</option></term>
 
148
        <term><option>-h</option></term>
145
149
        <listitem>
146
150
          <para>
147
151
            Show a help message and exit
148
152
          </para>
149
153
        </listitem>
150
154
      </varlistentry>
151
 
 
 
155
      
152
156
      <varlistentry>
153
 
        <term><literal>-i</literal>, <literal>--interface <replaceable>
154
 
        IF</replaceable></literal></term>
 
157
        <term><option>--interface</option>
 
158
        <replaceable>NAME</replaceable></term>
 
159
        <term><option>-i</option>
 
160
        <replaceable>NAME</replaceable></term>
155
161
        <listitem>
156
162
          <xi:include href="mandos-options.xml" xpointer="interface"/>
157
163
        </listitem>
158
164
      </varlistentry>
159
 
 
 
165
      
160
166
      <varlistentry>
161
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
162
 
        ADDRESS</replaceable></literal></term>
 
167
        <term><option>--address
 
168
        <replaceable>ADDRESS</replaceable></option></term>
 
169
        <term><option>-a
 
170
        <replaceable>ADDRESS</replaceable></option></term>
163
171
        <listitem>
164
172
          <xi:include href="mandos-options.xml" xpointer="address"/>
165
173
        </listitem>
166
174
      </varlistentry>
167
 
 
 
175
      
168
176
      <varlistentry>
169
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
170
 
        PORT</replaceable></literal></term>
 
177
        <term><option>--port
 
178
        <replaceable>PORT</replaceable></option></term>
 
179
        <term><option>-p
 
180
        <replaceable>PORT</replaceable></option></term>
171
181
        <listitem>
172
182
          <xi:include href="mandos-options.xml" xpointer="port"/>
173
183
        </listitem>
174
184
      </varlistentry>
175
 
 
 
185
      
176
186
      <varlistentry>
177
 
        <term><literal>--check</literal></term>
 
187
        <term><option>--check</option></term>
178
188
        <listitem>
179
189
          <para>
180
190
            Run the server’s self-tests.  This includes any unit
182
192
          </para>
183
193
        </listitem>
184
194
      </varlistentry>
185
 
 
 
195
      
186
196
      <varlistentry>
187
 
        <term><literal>--debug</literal></term>
 
197
        <term><option>--debug</option></term>
188
198
        <listitem>
189
199
          <xi:include href="mandos-options.xml" xpointer="debug"/>
190
200
        </listitem>
191
201
      </varlistentry>
192
 
 
193
 
      <varlistentry>
194
 
        <term><literal>--priority <replaceable>
195
 
        PRIORITY</replaceable></literal></term>
 
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>
196
224
        <listitem>
197
225
          <xi:include href="mandos-options.xml" xpointer="priority"/>
198
226
        </listitem>
199
227
      </varlistentry>
200
 
 
 
228
      
201
229
      <varlistentry>
202
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
203
 
        </literal></term>
 
230
        <term><option>--servicename
 
231
        <replaceable>NAME</replaceable></option></term>
204
232
        <listitem>
205
233
          <xi:include href="mandos-options.xml"
206
234
                      xpointer="servicename"/>
207
235
        </listitem>
208
236
      </varlistentry>
209
 
 
 
237
      
210
238
      <varlistentry>
211
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
212
 
        </literal></term>
 
239
        <term><option>--configdir
 
240
        <replaceable>DIRECTORY</replaceable></option></term>
213
241
        <listitem>
214
242
          <para>
215
243
            Directory to search for configuration files.  Default is
221
249
          </para>
222
250
        </listitem>
223
251
      </varlistentry>
224
 
 
 
252
      
225
253
      <varlistentry>
226
 
        <term><literal>--version</literal></term>
 
254
        <term><option>--version</option></term>
227
255
        <listitem>
228
256
          <para>
229
257
            Prints the program version and exit.
230
258
          </para>
231
259
        </listitem>
232
260
      </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>
233
278
    </variablelist>
234
279
  </refsect1>
235
 
 
 
280
  
236
281
  <refsect1 id="overview">
237
282
    <title>OVERVIEW</title>
238
283
    <xi:include href="overview.xml"/>
239
284
    <para>
240
285
      This program is the server part.  It is a normal server program
241
286
      and will run in a normal system environment, not in an initial
242
 
      RAM disk environment.
 
287
      <acronym>RAM</acronym> disk environment.
243
288
    </para>
244
289
  </refsect1>
245
 
 
 
290
  
246
291
  <refsect1 id="protocol">
247
292
    <title>NETWORK PROTOCOL</title>
248
293
    <para>
274
319
        <entry>-><!-- &rarr; --></entry>
275
320
      </row>
276
321
      <row>
277
 
        <entry><quote><literal>1\r\en</literal></quote></entry>
 
322
        <entry><quote><literal>1\r\n</literal></quote></entry>
278
323
        <entry>-><!-- &rarr; --></entry>
279
324
      </row>
280
325
      <row>
300
345
      </row>
301
346
    </tbody></tgroup></table>
302
347
  </refsect1>
303
 
 
 
348
  
304
349
  <refsect1 id="checking">
305
350
    <title>CHECKING</title>
306
351
    <para>
307
352
      The server will, by default, continually check that the clients
308
353
      are still up.  If a client has not been confirmed as being up
309
354
      for some time, the client is assumed to be compromised and is no
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>
313
 
      <refentrytitle>mandos.conf</refentrytitle>
314
 
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
 
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>
315
373
      <refentrytitle>mandos-clients.conf</refentrytitle>
316
 
      <manvolnum>5</manvolnum></citerefentry>.
317
 
    </para>
 
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
    
318
384
  </refsect1>
319
 
 
 
385
  
320
386
  <refsect1 id="logging">
321
387
    <title>LOGGING</title>
322
388
    <para>
323
 
      The server will send log messaged with various severity levels
324
 
      to <filename>/dev/log</filename>.  With the
 
389
      The server will send log message with various severity levels to
 
390
      <filename>/dev/log</filename>.  With the
325
391
      <option>--debug</option> option, it will log even more messages,
326
392
      and also show them on the console.
327
393
    </para>
328
394
  </refsect1>
329
 
 
 
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
  
330
406
  <refsect1 id="exit_status">
331
407
    <title>EXIT STATUS</title>
332
408
    <para>
334
410
      critical error is encountered.
335
411
    </para>
336
412
  </refsect1>
337
 
 
 
413
  
338
414
  <refsect1 id="environment">
339
415
    <title>ENVIRONMENT</title>
340
416
    <variablelist>
341
417
      <varlistentry>
342
 
        <term><varname>PATH</varname></term>
 
418
        <term><envar>PATH</envar></term>
343
419
        <listitem>
344
420
          <para>
345
421
            To start the configured checker (see <xref
348
424
            <varname>PATH</varname> to search for matching commands if
349
425
            an absolute path is not given.  See <citerefentry>
350
426
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
351
 
          </citerefentry>
 
427
            </citerefentry>.
352
428
          </para>
353
429
        </listitem>
354
430
      </varlistentry>
355
431
    </variablelist>
356
432
  </refsect1>
357
 
 
358
 
  <refsect1 id="file">
 
433
  
 
434
  <refsect1 id="files">
359
435
    <title>FILES</title>
360
436
    <para>
361
437
      Use the <option>--configdir</option> option to change where
384
460
        </listitem>
385
461
      </varlistentry>
386
462
      <varlistentry>
387
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
463
        <term><filename>/var/run/mandos.pid</filename></term>
388
464
        <listitem>
389
465
          <para>
390
 
            The file containing the process id of
391
 
            <command>&COMMANDNAME;</command>.
 
466
            The file containing the process id of the
 
467
            <command>&COMMANDNAME;</command> process started last.
392
468
          </para>
393
469
        </listitem>
394
470
      </varlistentry>
422
498
      backtrace.  This could be considered a feature.
423
499
    </para>
424
500
    <para>
425
 
      Currently, if a client is declared <quote>invalid</quote> due to
426
 
      having timed out, the server does not record this fact onto
427
 
      permanent storage.  This has some security implications, see
428
 
      <xref linkend="CLIENTS"/>.
429
 
    </para>
430
 
    <para>
431
 
      There is currently no way of querying the server of the current
432
 
      status of clients, other than analyzing its <systemitem
433
 
      class="service">syslog</systemitem> output.
 
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"/>.
434
504
    </para>
435
505
    <para>
436
506
      There is no fine-grained control over logging and debug output.
439
509
      Debug mode is conflated with running in the foreground.
440
510
    </para>
441
511
    <para>
442
 
      The console log messages does not show a timestamp.
 
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.
443
517
    </para>
444
518
  </refsect1>
445
519
  
450
524
        Normal invocation needs no options:
451
525
      </para>
452
526
      <para>
453
 
        <userinput>mandos</userinput>
 
527
        <userinput>&COMMANDNAME;</userinput>
454
528
      </para>
455
529
    </informalexample>
456
530
    <informalexample>
463
537
      <para>
464
538
 
465
539
<!-- do not wrap this line -->
466
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
540
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
467
541
 
468
542
      </para>
469
543
    </informalexample>
475
549
      <para>
476
550
 
477
551
<!-- do not wrap this line -->
478
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
552
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
479
553
 
480
554
      </para>
481
555
    </informalexample>
482
556
  </refsect1>
483
 
 
 
557
  
484
558
  <refsect1 id="security">
485
559
    <title>SECURITY</title>
486
 
    <refsect2 id="SERVER">
 
560
    <refsect2 id="server">
487
561
      <title>SERVER</title>
488
562
      <para>
489
563
        Running this <command>&COMMANDNAME;</command> server program
490
564
        should not in itself present any security risk to the host
491
 
        computer running it.  The program does not need any special
492
 
        privileges to run, and is designed to run as a non-root user.
 
565
        computer running it.  The program switches to a non-root user
 
566
        soon after startup.
493
567
      </para>
494
568
    </refsect2>
495
 
    <refsect2 id="CLIENTS">
 
569
    <refsect2 id="clients">
496
570
      <title>CLIENTS</title>
497
571
      <para>
498
572
        The server only gives out its stored data to clients which
505
579
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
506
580
        <manvolnum>5</manvolnum></citerefentry>)
507
581
        <emphasis>must</emphasis> be made non-readable by anyone
508
 
        except the user running the server.
 
582
        except the user starting the server (usually root).
509
583
      </para>
510
584
      <para>
511
585
        As detailed in <xref linkend="checking"/>, the status of all
514
588
      </para>
515
589
      <para>
516
590
        If a client is compromised, its downtime should be duly noted
517
 
        by the server which would therefore declare the client
518
 
        invalid.  But if the server was ever restarted, it would
519
 
        re-read its client list from its configuration file and again
520
 
        regard all clients therein as valid, and hence eligible to
521
 
        receive their passwords.  Therefore, be careful when
522
 
        restarting servers if it is suspected that a client has, in
523
 
        fact, been compromised by parties who may now be running a
524
 
        fake Mandos client with the keys from the non-encrypted
525
 
        initial RAM image of the client host.  What should be done in
526
 
        that case (if restarting the server program really is
527
 
        necessary) is to stop the server program, edit the
528
 
        configuration file to omit any suspect clients, and restart
529
 
        the server program.
 
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.
530
603
      </para>
531
604
      <para>
532
605
        For more details on client-side security, see
533
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
606
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
534
607
        <manvolnum>8mandos</manvolnum></citerefentry>.
535
608
      </para>
536
609
    </refsect2>
537
610
  </refsect1>
538
 
 
 
611
  
539
612
  <refsect1 id="see_also">
540
613
    <title>SEE ALSO</title>
 
614
    <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>
 
625
    </para>
541
626
    <variablelist>
542
627
      <varlistentry>
543
628
        <term>
544
 
          <citerefentry>
545
 
            <refentrytitle>password-request</refentrytitle>
546
 
            <manvolnum>8mandos</manvolnum>
547
 
          </citerefentry>
548
 
        </term>
549
 
        <listitem>
550
 
          <para>
551
 
            This is the actual program which talks to this server.
552
 
            Note that it is normally not invoked directly, and is only
553
 
            run in the initial RAM disk environment, and not on a
554
 
            fully started system.
555
 
          </para>
556
 
        </listitem>
557
 
      </varlistentry>
558
 
      <varlistentry>
559
 
        <term>
560
629
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
561
630
        </term>
562
631
        <listitem>
579
648
      </varlistentry>
580
649
      <varlistentry>
581
650
        <term>
582
 
          <ulink
583
 
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
651
          <ulink url="http://www.gnu.org/software/gnutls/"
 
652
          >GnuTLS</ulink>
584
653
        </term>
585
654
      <listitem>
586
655
        <para>
592
661
      </varlistentry>
593
662
      <varlistentry>
594
663
        <term>
595
 
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
596
 
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
597
 
          Unicast Addresses</citation>
 
664
          RFC 4291: <citetitle>IP Version 6 Addressing
 
665
          Architecture</citetitle>
598
666
        </term>
599
667
        <listitem>
600
 
          <para>
601
 
            The clients use IPv6 link-local addresses, which are
602
 
            immediately usable since a link-local addresses is
603
 
            automatically assigned to a network interfaces when it is
604
 
            brought up.
605
 
          </para>
 
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>
606
692
        </listitem>
607
693
      </varlistentry>
608
694
      <varlistentry>
609
695
        <term>
610
 
          <citation>RFC 4346: <citetitle>The Transport Layer Security
611
 
          (TLS) Protocol Version 1.1</citetitle></citation>
 
696
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
697
          Protocol Version 1.1</citetitle>
612
698
        </term>
613
699
      <listitem>
614
700
        <para>
618
704
      </varlistentry>
619
705
      <varlistentry>
620
706
        <term>
621
 
          <citation>RFC 4880: <citetitle>OpenPGP Message
622
 
          Format</citetitle></citation>
 
707
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
623
708
        </term>
624
709
      <listitem>
625
710
        <para>
629
714
      </varlistentry>
630
715
      <varlistentry>
631
716
        <term>
632
 
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
633
 
          Transport Layer Security</citetitle></citation>
 
717
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
718
          Security</citetitle>
634
719
        </term>
635
720
      <listitem>
636
721
        <para>
642
727
    </variablelist>
643
728
  </refsect1>
644
729
</refentry>
 
730
<!-- Local Variables: -->
 
731
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
732
<!-- time-stamp-end: "[\"']>" -->
 
733
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
734
<!-- End: -->