/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-29 16:53:41 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829165341-xzrp0xxxfrua5kzq
* mandos.xml (SYNOPSIS): Split <term> tags for the "--help" and
                         "--interface" options.

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 "2015-07-20">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-08-29">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
   <refentryinfo>
 
10
  <refentryinfo>
12
11
    <title>Mandos Manual</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
19
18
        <firstname>Björn</firstname>
20
19
        <surname>Påhlsson</surname>
21
20
        <address>
22
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
23
22
        </address>
24
23
      </author>
25
24
      <author>
26
25
        <firstname>Teddy</firstname>
27
26
        <surname>Hogeborn</surname>
28
27
        <address>
29
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
30
29
        </address>
31
30
      </author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2010</year>
37
 
      <year>2011</year>
38
 
      <year>2012</year>
39
 
      <year>2013</year>
40
34
      <holder>Teddy Hogeborn</holder>
41
35
      <holder>Björn Påhlsson</holder>
42
36
    </copyright>
43
 
    <xi:include href="legalnotice.xml"/>
 
37
    <legalnotice>
 
38
      <para>
 
39
        This manual page is free software: you can redistribute it
 
40
        and/or modify it under the terms of the GNU General Public
 
41
        License as published by the Free Software Foundation,
 
42
        either version 3 of the License, or (at your option) any
 
43
        later version.
 
44
      </para>
 
45
 
 
46
      <para>
 
47
        This manual page is distributed in the hope that it will
 
48
        be useful, but WITHOUT ANY WARRANTY; without even the
 
49
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
50
        PARTICULAR PURPOSE.  See the GNU General Public License
 
51
        for more details.
 
52
      </para>
 
53
 
 
54
      <para>
 
55
        You should have received a copy of the GNU General Public
 
56
        License along with this program; If not, see
 
57
        <ulink url="http://www.gnu.org/licenses/"/>.
 
58
      </para>
 
59
    </legalnotice>
44
60
  </refentryinfo>
45
 
  
 
61
 
46
62
  <refmeta>
47
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
48
64
    <manvolnum>8</manvolnum>
51
67
  <refnamediv>
52
68
    <refname><command>&COMMANDNAME;</command></refname>
53
69
    <refpurpose>
54
 
      Gives encrypted passwords to authenticated Mandos clients
 
70
      Sends encrypted passwords to authenticated Mandos clients
55
71
    </refpurpose>
56
72
  </refnamediv>
57
 
  
 
73
 
58
74
  <refsynopsisdiv>
59
75
    <cmdsynopsis>
60
76
      <command>&COMMANDNAME;</command>
61
 
      <group>
62
 
        <arg choice="plain"><option>--interface
63
 
        <replaceable>NAME</replaceable></option></arg>
64
 
        <arg choice="plain"><option>-i
65
 
        <replaceable>NAME</replaceable></option></arg>
66
 
      </group>
67
 
      <sbr/>
68
 
      <group>
69
 
        <arg choice="plain"><option>--address
70
 
        <replaceable>ADDRESS</replaceable></option></arg>
71
 
        <arg choice="plain"><option>-a
72
 
        <replaceable>ADDRESS</replaceable></option></arg>
73
 
      </group>
74
 
      <sbr/>
75
 
      <group>
76
 
        <arg choice="plain"><option>--port
77
 
        <replaceable>PORT</replaceable></option></arg>
78
 
        <arg choice="plain"><option>-p
79
 
        <replaceable>PORT</replaceable></option></arg>
80
 
      </group>
81
 
      <sbr/>
82
 
      <arg><option>--priority
83
 
      <replaceable>PRIORITY</replaceable></option></arg>
84
 
      <sbr/>
85
 
      <arg><option>--servicename
86
 
      <replaceable>NAME</replaceable></option></arg>
87
 
      <sbr/>
88
 
      <arg><option>--configdir
89
 
      <replaceable>DIRECTORY</replaceable></option></arg>
90
 
      <sbr/>
91
 
      <arg><option>--debug</option></arg>
92
 
      <sbr/>
93
 
      <arg><option>--debuglevel
94
 
      <replaceable>LEVEL</replaceable></option></arg>
95
 
      <sbr/>
96
 
      <arg><option>--no-dbus</option></arg>
97
 
      <sbr/>
98
 
      <arg><option>--no-ipv6</option></arg>
99
 
      <sbr/>
100
 
      <arg><option>--no-restore</option></arg>
101
 
      <sbr/>
102
 
      <arg><option>--statedir
103
 
      <replaceable>DIRECTORY</replaceable></option></arg>
104
 
      <sbr/>
105
 
      <arg><option>--socket
106
 
      <replaceable>FD</replaceable></option></arg>
107
 
      <sbr/>
108
 
      <arg><option>--foreground</option></arg>
109
 
      <sbr/>
110
 
      <arg><option>--no-zeroconf</option></arg>
 
77
      <arg>--interface<arg choice="plain">NAME</arg></arg>
 
78
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
 
79
      <arg>--port<arg choice="plain">PORT</arg></arg>
 
80
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
 
81
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
 
82
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
83
      <arg>--debug</arg>
 
84
    </cmdsynopsis>
 
85
    <cmdsynopsis>
 
86
      <command>&COMMANDNAME;</command>
 
87
      <arg>-i<arg choice="plain">NAME</arg></arg>
 
88
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
 
89
      <arg>-p<arg choice="plain">PORT</arg></arg>
 
90
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
 
91
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
 
92
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
93
      <arg>--debug</arg>
111
94
    </cmdsynopsis>
112
95
    <cmdsynopsis>
113
96
      <command>&COMMANDNAME;</command>
114
97
      <group choice="req">
115
 
        <arg choice="plain"><option>--help</option></arg>
116
 
        <arg choice="plain"><option>-h</option></arg>
 
98
        <arg choice="plain">-h</arg>
 
99
        <arg choice="plain">--help</arg>
117
100
      </group>
118
101
    </cmdsynopsis>
119
102
    <cmdsynopsis>
120
103
      <command>&COMMANDNAME;</command>
121
 
      <arg choice="plain"><option>--version</option></arg>
 
104
      <arg choice="plain">--version</arg>
122
105
    </cmdsynopsis>
123
106
    <cmdsynopsis>
124
107
      <command>&COMMANDNAME;</command>
125
 
      <arg choice="plain"><option>--check</option></arg>
 
108
      <arg choice="plain">--check</arg>
126
109
    </cmdsynopsis>
127
110
  </refsynopsisdiv>
128
 
  
 
111
 
129
112
  <refsect1 id="description">
130
113
    <title>DESCRIPTION</title>
131
114
    <para>
132
115
      <command>&COMMANDNAME;</command> is a server daemon which
133
116
      handles incoming request for passwords for a pre-defined list of
134
 
      client host computers. For an introduction, see
135
 
      <citerefentry><refentrytitle>intro</refentrytitle>
136
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
137
 
      uses Zeroconf to announce itself on the local network, and uses
138
 
      TLS to communicate securely with and to authenticate the
139
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
140
 
      use IPv6 link-local addresses, since the clients will probably
141
 
      not have any other addresses configured (see <xref
142
 
      linkend="overview"/>).  Any authenticated client is then given
143
 
      the stored pre-encrypted password for that specific client.
 
117
      client host computers.  The Mandos server uses Zeroconf to
 
118
      announce itself on the local network, and uses TLS to
 
119
      communicate securely with and to authenticate the clients.  The
 
120
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
 
121
      link-local addresses, since the clients will probably not have
 
122
      any other addresses configured (see <xref linkend="overview"/>).
 
123
      Any authenticated client is then given the stored pre-encrypted
 
124
      password for that specific client.
144
125
    </para>
 
126
 
145
127
  </refsect1>
146
128
  
147
129
  <refsect1 id="purpose">
148
130
    <title>PURPOSE</title>
 
131
 
149
132
    <para>
150
133
      The purpose of this is to enable <emphasis>remote and unattended
151
134
      rebooting</emphasis> of client host computer with an
152
135
      <emphasis>encrypted root file system</emphasis>.  See <xref
153
136
      linkend="overview"/> for details.
154
137
    </para>
 
138
 
155
139
  </refsect1>
156
140
  
157
141
  <refsect1 id="options">
158
142
    <title>OPTIONS</title>
 
143
 
159
144
    <variablelist>
160
145
      <varlistentry>
 
146
        <term><option>-h</option></term>
161
147
        <term><option>--help</option></term>
162
 
        <term><option>-h</option></term>
163
148
        <listitem>
164
149
          <para>
165
150
            Show a help message and exit
166
151
          </para>
167
152
        </listitem>
168
153
      </varlistentry>
169
 
      
 
154
 
170
155
      <varlistentry>
 
156
        <term><option>-i</option>
 
157
        <replaceable>NAME</replaceable></term>
171
158
        <term><option>--interface</option>
172
159
        <replaceable>NAME</replaceable></term>
173
 
        <term><option>-i</option>
174
 
        <replaceable>NAME</replaceable></term>
175
160
        <listitem>
176
161
          <xi:include href="mandos-options.xml" xpointer="interface"/>
177
162
        </listitem>
178
163
      </varlistentry>
179
 
      
 
164
 
180
165
      <varlistentry>
181
 
        <term><option>--address
182
 
        <replaceable>ADDRESS</replaceable></option></term>
183
 
        <term><option>-a
184
 
        <replaceable>ADDRESS</replaceable></option></term>
 
166
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
167
        ADDRESS</replaceable></literal></term>
185
168
        <listitem>
186
169
          <xi:include href="mandos-options.xml" xpointer="address"/>
187
170
        </listitem>
188
171
      </varlistentry>
189
 
      
 
172
 
190
173
      <varlistentry>
191
 
        <term><option>--port
192
 
        <replaceable>PORT</replaceable></option></term>
193
 
        <term><option>-p
194
 
        <replaceable>PORT</replaceable></option></term>
 
174
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
175
        PORT</replaceable></literal></term>
195
176
        <listitem>
196
177
          <xi:include href="mandos-options.xml" xpointer="port"/>
197
178
        </listitem>
198
179
      </varlistentry>
199
 
      
 
180
 
200
181
      <varlistentry>
201
 
        <term><option>--check</option></term>
 
182
        <term><literal>--check</literal></term>
202
183
        <listitem>
203
184
          <para>
204
185
            Run the server’s self-tests.  This includes any unit
206
187
          </para>
207
188
        </listitem>
208
189
      </varlistentry>
209
 
      
 
190
 
210
191
      <varlistentry>
211
 
        <term><option>--debug</option></term>
 
192
        <term><literal>--debug</literal></term>
212
193
        <listitem>
213
194
          <xi:include href="mandos-options.xml" xpointer="debug"/>
214
195
        </listitem>
215
196
      </varlistentry>
216
 
      
217
 
      <varlistentry>
218
 
        <term><option>--debuglevel
219
 
        <replaceable>LEVEL</replaceable></option></term>
220
 
        <listitem>
221
 
          <para>
222
 
            Set the debugging log level.
223
 
            <replaceable>LEVEL</replaceable> is a string, one of
224
 
            <quote><literal>CRITICAL</literal></quote>,
225
 
            <quote><literal>ERROR</literal></quote>,
226
 
            <quote><literal>WARNING</literal></quote>,
227
 
            <quote><literal>INFO</literal></quote>, or
228
 
            <quote><literal>DEBUG</literal></quote>, in order of
229
 
            increasing verbosity.  The default level is
230
 
            <quote><literal>WARNING</literal></quote>.
231
 
          </para>
232
 
        </listitem>
233
 
      </varlistentry>
234
 
      
235
 
      <varlistentry>
236
 
        <term><option>--priority <replaceable>
237
 
        PRIORITY</replaceable></option></term>
 
197
 
 
198
      <varlistentry>
 
199
        <term><literal>--priority <replaceable>
 
200
        PRIORITY</replaceable></literal></term>
238
201
        <listitem>
239
202
          <xi:include href="mandos-options.xml" xpointer="priority"/>
240
203
        </listitem>
241
204
      </varlistentry>
242
 
      
 
205
 
243
206
      <varlistentry>
244
 
        <term><option>--servicename
245
 
        <replaceable>NAME</replaceable></option></term>
 
207
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
208
        </literal></term>
246
209
        <listitem>
247
210
          <xi:include href="mandos-options.xml"
248
211
                      xpointer="servicename"/>
249
212
        </listitem>
250
213
      </varlistentry>
251
 
      
 
214
 
252
215
      <varlistentry>
253
 
        <term><option>--configdir
254
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
216
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
217
        </literal></term>
255
218
        <listitem>
256
219
          <para>
257
220
            Directory to search for configuration files.  Default is
263
226
          </para>
264
227
        </listitem>
265
228
      </varlistentry>
266
 
      
 
229
 
267
230
      <varlistentry>
268
 
        <term><option>--version</option></term>
 
231
        <term><literal>--version</literal></term>
269
232
        <listitem>
270
233
          <para>
271
234
            Prints the program version and exit.
272
235
          </para>
273
236
        </listitem>
274
237
      </varlistentry>
275
 
      
276
 
      <varlistentry>
277
 
        <term><option>--no-dbus</option></term>
278
 
        <listitem>
279
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
280
 
          <para>
281
 
            See also <xref linkend="dbus_interface"/>.
282
 
          </para>
283
 
        </listitem>
284
 
      </varlistentry>
285
 
      
286
 
      <varlistentry>
287
 
        <term><option>--no-ipv6</option></term>
288
 
        <listitem>
289
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
290
 
        </listitem>
291
 
      </varlistentry>
292
 
      
293
 
      <varlistentry>
294
 
        <term><option>--no-restore</option></term>
295
 
        <listitem>
296
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
297
 
          <para>
298
 
            See also <xref linkend="persistent_state"/>.
299
 
          </para>
300
 
        </listitem>
301
 
      </varlistentry>
302
 
      
303
 
      <varlistentry>
304
 
        <term><option>--statedir
305
 
        <replaceable>DIRECTORY</replaceable></option></term>
306
 
        <listitem>
307
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
308
 
        </listitem>
309
 
      </varlistentry>
310
 
      
311
 
      <varlistentry>
312
 
        <term><option>--socket
313
 
        <replaceable>FD</replaceable></option></term>
314
 
        <listitem>
315
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
316
 
        </listitem>
317
 
      </varlistentry>
318
 
      
319
 
      <varlistentry>
320
 
        <term><option>--foreground</option></term>
321
 
        <listitem>
322
 
          <xi:include href="mandos-options.xml"
323
 
                      xpointer="foreground"/>
324
 
        </listitem>
325
 
      </varlistentry>
326
 
      
327
 
      <varlistentry>
328
 
        <term><option>--no-zeroconf</option></term>
329
 
        <listitem>
330
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
331
 
        </listitem>
332
 
      </varlistentry>
333
 
      
334
238
    </variablelist>
335
239
  </refsect1>
336
 
  
 
240
 
337
241
  <refsect1 id="overview">
338
242
    <title>OVERVIEW</title>
339
243
    <xi:include href="overview.xml"/>
340
244
    <para>
341
245
      This program is the server part.  It is a normal server program
342
246
      and will run in a normal system environment, not in an initial
343
 
      <acronym>RAM</acronym> disk environment.
 
247
      RAM disk environment.
344
248
    </para>
345
249
  </refsect1>
346
 
  
 
250
 
347
251
  <refsect1 id="protocol">
348
252
    <title>NETWORK PROTOCOL</title>
349
253
    <para>
401
305
      </row>
402
306
    </tbody></tgroup></table>
403
307
  </refsect1>
404
 
  
 
308
 
405
309
  <refsect1 id="checking">
406
310
    <title>CHECKING</title>
407
311
    <para>
408
312
      The server will, by default, continually check that the clients
409
313
      are still up.  If a client has not been confirmed as being up
410
314
      for some time, the client is assumed to be compromised and is no
411
 
      longer eligible to receive the encrypted password.  (Manual
412
 
      intervention is required to re-enable a client.)  The timeout,
413
 
      extended timeout, checker program, and interval between checks
414
 
      can be configured both globally and per client; see
415
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
315
      longer eligible to receive the encrypted password.  The timeout,
 
316
      checker program, and interval between checks can be configured
 
317
      both globally and per client; see <citerefentry>
 
318
      <refentrytitle>mandos-clients.conf</refentrytitle>
416
319
      <manvolnum>5</manvolnum></citerefentry>.
417
320
    </para>
418
321
  </refsect1>
419
 
  
420
 
  <refsect1 id="approval">
421
 
    <title>APPROVAL</title>
422
 
    <para>
423
 
      The server can be configured to require manual approval for a
424
 
      client before it is sent its secret.  The delay to wait for such
425
 
      approval and the default action (approve or deny) can be
426
 
      configured both globally and per client; see <citerefentry>
427
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
428
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
429
 
      will be approved immediately without delay.
430
 
    </para>
431
 
    <para>
432
 
      This can be used to deny a client its secret if not manually
433
 
      approved within a specified time.  It can also be used to make
434
 
      the server delay before giving a client its secret, allowing
435
 
      optional manual denying of this specific client.
436
 
    </para>
437
 
    
438
 
  </refsect1>
439
 
  
 
322
 
440
323
  <refsect1 id="logging">
441
324
    <title>LOGGING</title>
442
325
    <para>
443
326
      The server will send log message with various severity levels to
444
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
327
      <filename>/dev/log</filename>.  With the
445
328
      <option>--debug</option> option, it will log even more messages,
446
329
      and also show them on the console.
447
330
    </para>
448
331
  </refsect1>
449
 
  
450
 
  <refsect1 id="persistent_state">
451
 
    <title>PERSISTENT STATE</title>
452
 
    <para>
453
 
      Client settings, initially read from
454
 
      <filename>clients.conf</filename>, are persistent across
455
 
      restarts, and run-time changes will override settings in
456
 
      <filename>clients.conf</filename>.  However, if a setting is
457
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
458
 
      <filename>clients.conf</filename>, this will take precedence.
459
 
    </para>
460
 
  </refsect1>
461
 
  
462
 
  <refsect1 id="dbus_interface">
463
 
    <title>D-BUS INTERFACE</title>
464
 
    <para>
465
 
      The server will by default provide a D-Bus system bus interface.
466
 
      This interface will only be accessible by the root user or a
467
 
      Mandos-specific user, if such a user exists.  For documentation
468
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
469
 
    </para>
470
 
  </refsect1>
471
 
  
 
332
 
472
333
  <refsect1 id="exit_status">
473
334
    <title>EXIT STATUS</title>
474
335
    <para>
476
337
      critical error is encountered.
477
338
    </para>
478
339
  </refsect1>
479
 
  
 
340
 
480
341
  <refsect1 id="environment">
481
342
    <title>ENVIRONMENT</title>
482
343
    <variablelist>
483
344
      <varlistentry>
484
 
        <term><envar>PATH</envar></term>
 
345
        <term><varname>PATH</varname></term>
485
346
        <listitem>
486
347
          <para>
487
348
            To start the configured checker (see <xref
496
357
      </varlistentry>
497
358
    </variablelist>
498
359
  </refsect1>
499
 
  
500
 
  <refsect1 id="files">
 
360
 
 
361
  <refsect1 id="file">
501
362
    <title>FILES</title>
502
363
    <para>
503
364
      Use the <option>--configdir</option> option to change where
526
387
        </listitem>
527
388
      </varlistentry>
528
389
      <varlistentry>
529
 
        <term><filename>/run/mandos.pid</filename></term>
530
 
        <listitem>
531
 
          <para>
532
 
            The file containing the process id of the
533
 
            <command>&COMMANDNAME;</command> process started last.
534
 
            <emphasis >Note:</emphasis> If the <filename
535
 
            class="directory">/run</filename> directory does not
536
 
            exist, <filename>/var/run/mandos.pid</filename> will be
537
 
            used instead.
538
 
          </para>
539
 
        </listitem>
540
 
      </varlistentry>
541
 
      <varlistentry>
542
 
        <term><filename class="devicefile">/dev/log</filename></term>
543
 
      </varlistentry>
544
 
      <varlistentry>
545
 
        <term><filename
546
 
        class="directory">/var/lib/mandos</filename></term>
547
 
        <listitem>
548
 
          <para>
549
 
            Directory where persistent state will be saved.  Change
550
 
            this with the <option>--statedir</option> option.  See
551
 
            also the <option>--no-restore</option> option.
 
390
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
391
        <listitem>
 
392
          <para>
 
393
            The file containing the process id of
 
394
            <command>&COMMANDNAME;</command>.
552
395
          </para>
553
396
        </listitem>
554
397
      </varlistentry>
582
425
      backtrace.  This could be considered a feature.
583
426
    </para>
584
427
    <para>
 
428
      Currently, if a client is declared <quote>invalid</quote> due to
 
429
      having timed out, the server does not record this fact onto
 
430
      permanent storage.  This has some security implications, see
 
431
      <xref linkend="CLIENTS"/>.
 
432
    </para>
 
433
    <para>
 
434
      There is currently no way of querying the server of the current
 
435
      status of clients, other than analyzing its <systemitem
 
436
      class="service">syslog</systemitem> output.
 
437
    </para>
 
438
    <para>
585
439
      There is no fine-grained control over logging and debug output.
586
440
    </para>
587
441
    <para>
588
 
      This server does not check the expire time of clients’ OpenPGP
589
 
      keys.
 
442
      Debug mode is conflated with running in the foreground.
 
443
    </para>
 
444
    <para>
 
445
      The console log messages does not show a timestamp.
590
446
    </para>
591
447
  </refsect1>
592
448
  
603
459
    <informalexample>
604
460
      <para>
605
461
        Run the server in debug mode, read configuration files from
606
 
        the <filename class="directory">~/mandos</filename> directory,
607
 
        and use the Zeroconf service name <quote>Test</quote> to not
608
 
        collide with any other official Mandos server on this host:
 
462
        the <filename>~/mandos</filename> directory, and use the
 
463
        Zeroconf service name <quote>Test</quote> to not collide with
 
464
        any other official Mandos server on this host:
609
465
      </para>
610
466
      <para>
611
467
 
627
483
      </para>
628
484
    </informalexample>
629
485
  </refsect1>
630
 
  
 
486
 
631
487
  <refsect1 id="security">
632
488
    <title>SECURITY</title>
633
 
    <refsect2 id="server">
 
489
    <refsect2 id="SERVER">
634
490
      <title>SERVER</title>
635
491
      <para>
636
492
        Running this <command>&COMMANDNAME;</command> server program
637
493
        should not in itself present any security risk to the host
638
 
        computer running it.  The program switches to a non-root user
639
 
        soon after startup.
 
494
        computer running it.  The program does not need any special
 
495
        privileges to run, and is designed to run as a non-root user.
640
496
      </para>
641
497
    </refsect2>
642
 
    <refsect2 id="clients">
 
498
    <refsect2 id="CLIENTS">
643
499
      <title>CLIENTS</title>
644
500
      <para>
645
501
        The server only gives out its stored data to clients which
652
508
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
653
509
        <manvolnum>5</manvolnum></citerefentry>)
654
510
        <emphasis>must</emphasis> be made non-readable by anyone
655
 
        except the user starting the server (usually root).
 
511
        except the user running the server.
656
512
      </para>
657
513
      <para>
658
514
        As detailed in <xref linkend="checking"/>, the status of all
660
516
        compromised if they are gone for too long.
661
517
      </para>
662
518
      <para>
 
519
        If a client is compromised, its downtime should be duly noted
 
520
        by the server which would therefore declare the client
 
521
        invalid.  But if the server was ever restarted, it would
 
522
        re-read its client list from its configuration file and again
 
523
        regard all clients therein as valid, and hence eligible to
 
524
        receive their passwords.  Therefore, be careful when
 
525
        restarting servers if it is suspected that a client has, in
 
526
        fact, been compromised by parties who may now be running a
 
527
        fake Mandos client with the keys from the non-encrypted
 
528
        initial RAM image of the client host.  What should be done in
 
529
        that case (if restarting the server program really is
 
530
        necessary) is to stop the server program, edit the
 
531
        configuration file to omit any suspect clients, and restart
 
532
        the server program.
 
533
      </para>
 
534
      <para>
663
535
        For more details on client-side security, see
664
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
536
        <citerefentry><refentrytitle>password-request</refentrytitle>
665
537
        <manvolnum>8mandos</manvolnum></citerefentry>.
666
538
      </para>
667
539
    </refsect2>
668
540
  </refsect1>
669
 
  
 
541
 
670
542
  <refsect1 id="see_also">
671
543
    <title>SEE ALSO</title>
672
544
    <para>
673
 
      <citerefentry><refentrytitle>intro</refentrytitle>
674
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
675
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
676
 
      <manvolnum>5</manvolnum></citerefentry>,
677
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
678
 
      <manvolnum>5</manvolnum></citerefentry>,
679
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
680
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
681
 
      <citerefentry><refentrytitle>sh</refentrytitle>
682
 
      <manvolnum>1</manvolnum></citerefentry>
 
545
      <citerefentry>
 
546
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
547
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
548
        <refentrytitle>mandos.conf</refentrytitle>
 
549
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
550
        <refentrytitle>password-request</refentrytitle>
 
551
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
552
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
553
      </citerefentry>
683
554
    </para>
684
555
    <variablelist>
685
556
      <varlistentry>
706
577
      </varlistentry>
707
578
      <varlistentry>
708
579
        <term>
709
 
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
 
580
          <ulink url="http://www.gnu.org/software/gnutls/"
 
581
          >GnuTLS</ulink>
710
582
        </term>
711
583
      <listitem>
712
584
        <para>
750
622
      </varlistentry>
751
623
      <varlistentry>
752
624
        <term>
753
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
 
          Protocol Version 1.2</citetitle>
 
625
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
626
          Protocol Version 1.1</citetitle>
755
627
        </term>
756
628
      <listitem>
757
629
        <para>
758
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
630
          TLS 1.1 is the protocol implemented by GnuTLS.
759
631
        </para>
760
632
      </listitem>
761
633
      </varlistentry>
771
643
      </varlistentry>
772
644
      <varlistentry>
773
645
        <term>
774
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
775
 
          Security (TLS) Authentication</citetitle>
 
646
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
647
          Security</citetitle>
776
648
        </term>
777
649
      <listitem>
778
650
        <para>