/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-20 03:22:45 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080820032245-ue341vdvzqdsg68l
* mandos (string_to_delta): Accept a whitespace-separated sequence of
                            intervals and return the sum.  This allows
                            "5m 30s" to be valid.
  (main): Provide an empty default value for the "host" option for
          "clients.conf", making it no longer a required option.

* mandos-clients.conf.xml: Removed <?xml-stylesheet>.
  (DESCRIPTION): Improved text.
  (DEFAULTS): Renamed to "OPTIONS".  Improved text for "timeout" and
              "interval".
  (CLIENTS): Removed; content moved to "OPTIONS".
  (EXPANSION): New section; document %(foo)s and %%(foo)s expansion.
  (FILES): Moved to before "EXAMPLES".
  (BUGS): New section.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).  Renamed
              example section "example_client" to "foo".  Changed
              example "host" setting to a more reasonable example host
              name.  Added additional example client "bar".

* mandos-conf.xml: Removed OVERVIEW entity.

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-22">
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>
97
 
      <sbr/>
98
 
      <arg><option>--no-restore</option></arg>
 
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>
99
92
    </cmdsynopsis>
100
93
    <cmdsynopsis>
101
94
      <command>&COMMANDNAME;</command>
102
95
      <group choice="req">
103
 
        <arg choice="plain"><option>--help</option></arg>
104
 
        <arg choice="plain"><option>-h</option></arg>
 
96
        <arg choice="plain">-h</arg>
 
97
        <arg choice="plain">--help</arg>
105
98
      </group>
106
99
    </cmdsynopsis>
107
100
    <cmdsynopsis>
108
101
      <command>&COMMANDNAME;</command>
109
 
      <arg choice="plain"><option>--version</option></arg>
 
102
      <arg choice="plain">--version</arg>
110
103
    </cmdsynopsis>
111
104
    <cmdsynopsis>
112
105
      <command>&COMMANDNAME;</command>
113
 
      <arg choice="plain"><option>--check</option></arg>
 
106
      <arg choice="plain">--check</arg>
114
107
    </cmdsynopsis>
115
108
  </refsynopsisdiv>
116
 
  
 
109
 
117
110
  <refsect1 id="description">
118
111
    <title>DESCRIPTION</title>
119
112
    <para>
120
113
      <command>&COMMANDNAME;</command> is a server daemon which
121
114
      handles incoming request for passwords for a pre-defined list of
122
 
      client host computers. For an introduction, see
123
 
      <citerefentry><refentrytitle>intro</refentrytitle>
124
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
125
 
      uses Zeroconf to announce itself on the local network, and uses
126
 
      TLS to communicate securely with and to authenticate the
127
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
128
 
      use IPv6 link-local addresses, since the clients will probably
129
 
      not have any other addresses configured (see <xref
130
 
      linkend="overview"/>).  Any authenticated client is then given
131
 
      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.
132
123
    </para>
 
124
 
133
125
  </refsect1>
134
126
  
135
127
  <refsect1 id="purpose">
136
128
    <title>PURPOSE</title>
 
129
 
137
130
    <para>
138
131
      The purpose of this is to enable <emphasis>remote and unattended
139
132
      rebooting</emphasis> of client host computer with an
140
133
      <emphasis>encrypted root file system</emphasis>.  See <xref
141
134
      linkend="overview"/> for details.
142
135
    </para>
 
136
 
143
137
  </refsect1>
144
138
  
145
139
  <refsect1 id="options">
146
140
    <title>OPTIONS</title>
 
141
 
147
142
    <variablelist>
148
143
      <varlistentry>
149
 
        <term><option>--help</option></term>
150
 
        <term><option>-h</option></term>
 
144
        <term><literal>-h</literal>, <literal>--help</literal></term>
151
145
        <listitem>
152
146
          <para>
153
147
            Show a help message and exit
154
148
          </para>
155
149
        </listitem>
156
150
      </varlistentry>
157
 
      
 
151
 
158
152
      <varlistentry>
159
 
        <term><option>--interface</option>
160
 
        <replaceable>NAME</replaceable></term>
161
 
        <term><option>-i</option>
162
 
        <replaceable>NAME</replaceable></term>
 
153
        <term><literal>-i</literal>, <literal>--interface <replaceable>
 
154
        IF</replaceable></literal></term>
163
155
        <listitem>
164
156
          <xi:include href="mandos-options.xml" xpointer="interface"/>
165
157
        </listitem>
166
158
      </varlistentry>
167
 
      
 
159
 
168
160
      <varlistentry>
169
 
        <term><option>--address
170
 
        <replaceable>ADDRESS</replaceable></option></term>
171
 
        <term><option>-a
172
 
        <replaceable>ADDRESS</replaceable></option></term>
 
161
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
162
        ADDRESS</replaceable></literal></term>
173
163
        <listitem>
174
164
          <xi:include href="mandos-options.xml" xpointer="address"/>
175
165
        </listitem>
176
166
      </varlistentry>
177
 
      
 
167
 
178
168
      <varlistentry>
179
 
        <term><option>--port
180
 
        <replaceable>PORT</replaceable></option></term>
181
 
        <term><option>-p
182
 
        <replaceable>PORT</replaceable></option></term>
 
169
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
170
        PORT</replaceable></literal></term>
183
171
        <listitem>
184
172
          <xi:include href="mandos-options.xml" xpointer="port"/>
185
173
        </listitem>
186
174
      </varlistentry>
187
 
      
 
175
 
188
176
      <varlistentry>
189
 
        <term><option>--check</option></term>
 
177
        <term><literal>--check</literal></term>
190
178
        <listitem>
191
179
          <para>
192
180
            Run the server’s self-tests.  This includes any unit
194
182
          </para>
195
183
        </listitem>
196
184
      </varlistentry>
197
 
      
 
185
 
198
186
      <varlistentry>
199
 
        <term><option>--debug</option></term>
 
187
        <term><literal>--debug</literal></term>
200
188
        <listitem>
201
189
          <xi:include href="mandos-options.xml" xpointer="debug"/>
202
190
        </listitem>
203
191
      </varlistentry>
204
 
      
205
 
      <varlistentry>
206
 
        <term><option>--debuglevel
207
 
        <replaceable>LEVEL</replaceable></option></term>
208
 
        <listitem>
209
 
          <para>
210
 
            Set the debugging log level.
211
 
            <replaceable>LEVEL</replaceable> is a string, one of
212
 
            <quote><literal>CRITICAL</literal></quote>,
213
 
            <quote><literal>ERROR</literal></quote>,
214
 
            <quote><literal>WARNING</literal></quote>,
215
 
            <quote><literal>INFO</literal></quote>, or
216
 
            <quote><literal>DEBUG</literal></quote>, in order of
217
 
            increasing verbosity.  The default level is
218
 
            <quote><literal>WARNING</literal></quote>.
219
 
          </para>
220
 
        </listitem>
221
 
      </varlistentry>
222
 
      
223
 
      <varlistentry>
224
 
        <term><option>--priority <replaceable>
225
 
        PRIORITY</replaceable></option></term>
 
192
 
 
193
      <varlistentry>
 
194
        <term><literal>--priority <replaceable>
 
195
        PRIORITY</replaceable></literal></term>
226
196
        <listitem>
227
197
          <xi:include href="mandos-options.xml" xpointer="priority"/>
228
198
        </listitem>
229
199
      </varlistentry>
230
 
      
 
200
 
231
201
      <varlistentry>
232
 
        <term><option>--servicename
233
 
        <replaceable>NAME</replaceable></option></term>
 
202
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
203
        </literal></term>
234
204
        <listitem>
235
205
          <xi:include href="mandos-options.xml"
236
206
                      xpointer="servicename"/>
237
207
        </listitem>
238
208
      </varlistentry>
239
 
      
 
209
 
240
210
      <varlistentry>
241
 
        <term><option>--configdir
242
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
211
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
212
        </literal></term>
243
213
        <listitem>
244
214
          <para>
245
215
            Directory to search for configuration files.  Default is
251
221
          </para>
252
222
        </listitem>
253
223
      </varlistentry>
254
 
      
 
224
 
255
225
      <varlistentry>
256
 
        <term><option>--version</option></term>
 
226
        <term><literal>--version</literal></term>
257
227
        <listitem>
258
228
          <para>
259
229
            Prints the program version and exit.
260
230
          </para>
261
231
        </listitem>
262
232
      </varlistentry>
263
 
      
264
 
      <varlistentry>
265
 
        <term><option>--no-dbus</option></term>
266
 
        <listitem>
267
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
268
 
          <para>
269
 
            See also <xref linkend="dbus_interface"/>.
270
 
          </para>
271
 
        </listitem>
272
 
      </varlistentry>
273
 
      
274
 
      <varlistentry>
275
 
        <term><option>--no-ipv6</option></term>
276
 
        <listitem>
277
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
278
 
        </listitem>
279
 
      </varlistentry>
280
 
      
281
 
      <varlistentry>
282
 
        <term><option>--no-restore</option></term>
283
 
        <listitem>
284
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
285
 
        </listitem>
286
 
      </varlistentry>
287
233
    </variablelist>
288
234
  </refsect1>
289
 
  
 
235
 
290
236
  <refsect1 id="overview">
291
237
    <title>OVERVIEW</title>
292
238
    <xi:include href="overview.xml"/>
293
239
    <para>
294
240
      This program is the server part.  It is a normal server program
295
241
      and will run in a normal system environment, not in an initial
296
 
      <acronym>RAM</acronym> disk environment.
 
242
      RAM disk environment.
297
243
    </para>
298
244
  </refsect1>
299
 
  
 
245
 
300
246
  <refsect1 id="protocol">
301
247
    <title>NETWORK PROTOCOL</title>
302
248
    <para>
354
300
      </row>
355
301
    </tbody></tgroup></table>
356
302
  </refsect1>
357
 
  
 
303
 
358
304
  <refsect1 id="checking">
359
305
    <title>CHECKING</title>
360
306
    <para>
361
307
      The server will, by default, continually check that the clients
362
308
      are still up.  If a client has not been confirmed as being up
363
309
      for some time, the client is assumed to be compromised and is no
364
 
      longer eligible to receive the encrypted password.  (Manual
365
 
      intervention is required to re-enable a client.)  The timeout,
366
 
      extended timeout, checker program, and interval between checks
367
 
      can be configured both globally and per client; see
368
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
369
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
370
 
      receiving its password will also be treated as a successful
371
 
      checker run.
372
 
    </para>
373
 
  </refsect1>
374
 
  
375
 
  <refsect1 id="approval">
376
 
    <title>APPROVAL</title>
377
 
    <para>
378
 
      The server can be configured to require manual approval for a
379
 
      client before it is sent its secret.  The delay to wait for such
380
 
      approval and the default action (approve or deny) can be
381
 
      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>
382
313
      <refentrytitle>mandos-clients.conf</refentrytitle>
383
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
384
 
      will be approved immediately without delay.
385
 
    </para>
386
 
    <para>
387
 
      This can be used to deny a client its secret if not manually
388
 
      approved within a specified time.  It can also be used to make
389
 
      the server delay before giving a client its secret, allowing
390
 
      optional manual denying of this specific client.
391
 
    </para>
392
 
    
 
314
      <manvolnum>5</manvolnum></citerefentry>.
 
315
    </para>
393
316
  </refsect1>
394
 
  
 
317
 
395
318
  <refsect1 id="logging">
396
319
    <title>LOGGING</title>
397
320
    <para>
401
324
      and also show them on the console.
402
325
    </para>
403
326
  </refsect1>
404
 
  
405
 
  <refsect1 id="dbus_interface">
406
 
    <title>D-BUS INTERFACE</title>
407
 
    <para>
408
 
      The server will by default provide a D-Bus system bus interface.
409
 
      This interface will only be accessible by the root user or a
410
 
      Mandos-specific user, if such a user exists.  For documentation
411
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
412
 
    </para>
413
 
  </refsect1>
414
 
  
 
327
 
415
328
  <refsect1 id="exit_status">
416
329
    <title>EXIT STATUS</title>
417
330
    <para>
419
332
      critical error is encountered.
420
333
    </para>
421
334
  </refsect1>
422
 
  
 
335
 
423
336
  <refsect1 id="environment">
424
337
    <title>ENVIRONMENT</title>
425
338
    <variablelist>
426
339
      <varlistentry>
427
 
        <term><envar>PATH</envar></term>
 
340
        <term><varname>PATH</varname></term>
428
341
        <listitem>
429
342
          <para>
430
343
            To start the configured checker (see <xref
439
352
      </varlistentry>
440
353
    </variablelist>
441
354
  </refsect1>
442
 
  
443
 
  <refsect1 id="files">
 
355
 
 
356
  <refsect1 id="file">
444
357
    <title>FILES</title>
445
358
    <para>
446
359
      Use the <option>--configdir</option> option to change where
469
382
        </listitem>
470
383
      </varlistentry>
471
384
      <varlistentry>
472
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
385
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
473
386
        <listitem>
474
387
          <para>
475
 
            The file containing the process id of the
476
 
            <command>&COMMANDNAME;</command> process started last.
 
388
            The file containing the process id of
 
389
            <command>&COMMANDNAME;</command>.
477
390
          </para>
478
391
        </listitem>
479
392
      </varlistentry>
507
420
      backtrace.  This could be considered a feature.
508
421
    </para>
509
422
    <para>
510
 
      Currently, if a client is disabled due to having timed out, the
511
 
      server does not record this fact onto permanent storage.  This
512
 
      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.
513
432
    </para>
514
433
    <para>
515
434
      There is no fine-grained control over logging and debug output.
518
437
      Debug mode is conflated with running in the foreground.
519
438
    </para>
520
439
    <para>
521
 
      This server does not check the expire time of clients’ OpenPGP
522
 
      keys.
 
440
      The console log messages does not show a timestamp.
523
441
    </para>
524
442
  </refsect1>
525
443
  
530
448
        Normal invocation needs no options:
531
449
      </para>
532
450
      <para>
533
 
        <userinput>&COMMANDNAME;</userinput>
 
451
        <userinput>mandos</userinput>
534
452
      </para>
535
453
    </informalexample>
536
454
    <informalexample>
543
461
      <para>
544
462
 
545
463
<!-- do not wrap this line -->
546
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
464
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
547
465
 
548
466
      </para>
549
467
    </informalexample>
555
473
      <para>
556
474
 
557
475
<!-- do not wrap this line -->
558
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
476
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
559
477
 
560
478
      </para>
561
479
    </informalexample>
562
480
  </refsect1>
563
 
  
 
481
 
564
482
  <refsect1 id="security">
565
483
    <title>SECURITY</title>
566
 
    <refsect2 id="server">
 
484
    <refsect2 id="SERVER">
567
485
      <title>SERVER</title>
568
486
      <para>
569
487
        Running this <command>&COMMANDNAME;</command> server program
570
488
        should not in itself present any security risk to the host
571
 
        computer running it.  The program switches to a non-root user
572
 
        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.
573
491
      </para>
574
492
    </refsect2>
575
 
    <refsect2 id="clients">
 
493
    <refsect2 id="CLIENTS">
576
494
      <title>CLIENTS</title>
577
495
      <para>
578
496
        The server only gives out its stored data to clients which
585
503
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
586
504
        <manvolnum>5</manvolnum></citerefentry>)
587
505
        <emphasis>must</emphasis> be made non-readable by anyone
588
 
        except the user starting the server (usually root).
 
506
        except the user running the server.
589
507
      </para>
590
508
      <para>
591
509
        As detailed in <xref linkend="checking"/>, the status of all
594
512
      </para>
595
513
      <para>
596
514
        If a client is compromised, its downtime should be duly noted
597
 
        by the server which would therefore disable the client.  But
598
 
        if the server was ever restarted, it would re-read its client
599
 
        list from its configuration file and again regard all clients
600
 
        therein as enabled, and hence eligible to receive their
601
 
        passwords.  Therefore, be careful when restarting servers if
602
 
        it is suspected that a client has, in fact, been compromised
603
 
        by parties who may now be running a fake Mandos client with
604
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
605
 
        image of the client host.  What should be done in that case
606
 
        (if restarting the server program really is necessary) is to
607
 
        stop the server program, edit the configuration file to omit
608
 
        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.
609
528
      </para>
610
529
      <para>
611
530
        For more details on client-side security, see
612
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
531
        <citerefentry><refentrytitle>password-request</refentrytitle>
613
532
        <manvolnum>8mandos</manvolnum></citerefentry>.
614
533
      </para>
615
534
    </refsect2>
616
535
  </refsect1>
617
 
  
 
536
 
618
537
  <refsect1 id="see_also">
619
538
    <title>SEE ALSO</title>
620
539
    <para>
621
 
      <citerefentry><refentrytitle>intro</refentrytitle>
622
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
623
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
624
 
      <manvolnum>5</manvolnum></citerefentry>,
625
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
626
 
      <manvolnum>5</manvolnum></citerefentry>,
627
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
628
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
629
 
      <citerefentry><refentrytitle>sh</refentrytitle>
630
 
      <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>
631
549
    </para>
632
550
    <variablelist>
633
551
      <varlistentry>
654
572
      </varlistentry>
655
573
      <varlistentry>
656
574
        <term>
657
 
          <ulink url="http://www.gnu.org/software/gnutls/"
658
 
          >GnuTLS</ulink>
 
575
          <ulink
 
576
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
659
577
        </term>
660
578
      <listitem>
661
579
        <para>
667
585
      </varlistentry>
668
586
      <varlistentry>
669
587
        <term>
670
 
          RFC 4291: <citetitle>IP Version 6 Addressing
671
 
          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>
672
591
        </term>
673
592
        <listitem>
674
 
          <variablelist>
675
 
            <varlistentry>
676
 
              <term>Section 2.2: <citetitle>Text Representation of
677
 
              Addresses</citetitle></term>
678
 
              <listitem><para/></listitem>
679
 
            </varlistentry>
680
 
            <varlistentry>
681
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
682
 
              Address</citetitle></term>
683
 
              <listitem><para/></listitem>
684
 
            </varlistentry>
685
 
            <varlistentry>
686
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
687
 
            Addresses</citetitle></term>
688
 
            <listitem>
689
 
              <para>
690
 
                The clients use IPv6 link-local addresses, which are
691
 
                immediately usable since a link-local addresses is
692
 
                automatically assigned to a network interfaces when it
693
 
                is brought up.
694
 
              </para>
695
 
            </listitem>
696
 
            </varlistentry>
697
 
          </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>
698
599
        </listitem>
699
600
      </varlistentry>
700
601
      <varlistentry>
701
602
        <term>
702
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
703
 
          Protocol Version 1.1</citetitle>
 
603
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
604
          (TLS) Protocol Version 1.1</citetitle></citation>
704
605
        </term>
705
606
      <listitem>
706
607
        <para>
710
611
      </varlistentry>
711
612
      <varlistentry>
712
613
        <term>
713
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
614
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
615
          Format</citetitle></citation>
714
616
        </term>
715
617
      <listitem>
716
618
        <para>
720
622
      </varlistentry>
721
623
      <varlistentry>
722
624
        <term>
723
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
724
 
          Security</citetitle>
 
625
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
626
          Transport Layer Security</citetitle></citation>
725
627
        </term>
726
628
      <listitem>
727
629
        <para>
733
635
    </variablelist>
734
636
  </refsect1>
735
637
</refentry>
736
 
<!-- Local Variables: -->
737
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
738
 
<!-- time-stamp-end: "[\"']>" -->
739
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
740
 
<!-- End: -->