/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

merge

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 "2014-06-15">
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
 
      <year>2012</year>
39
 
      <year>2013</year>
40
32
      <holder>Teddy Hogeborn</holder>
41
33
      <holder>Björn Påhlsson</holder>
42
34
    </copyright>
43
 
    <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>
44
58
  </refentryinfo>
45
 
  
 
59
 
46
60
  <refmeta>
47
61
    <refentrytitle>&COMMANDNAME;</refentrytitle>
48
62
    <manvolnum>8</manvolnum>
51
65
  <refnamediv>
52
66
    <refname><command>&COMMANDNAME;</command></refname>
53
67
    <refpurpose>
54
 
      Gives encrypted passwords to authenticated Mandos clients
 
68
      Sends encrypted passwords to authenticated Mandos clients
55
69
    </refpurpose>
56
70
  </refnamediv>
57
 
  
 
71
 
58
72
  <refsynopsisdiv>
59
73
    <cmdsynopsis>
60
74
      <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>
 
75
      <arg>--interface<arg choice="plain">NAME</arg></arg>
 
76
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
 
77
      <arg>--port<arg choice="plain">PORT</arg></arg>
 
78
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
 
79
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
 
80
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
81
      <arg>--debug</arg>
 
82
    </cmdsynopsis>
 
83
    <cmdsynopsis>
 
84
      <command>&COMMANDNAME;</command>
 
85
      <arg>-i<arg choice="plain">NAME</arg></arg>
 
86
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
 
87
      <arg>-p<arg choice="plain">PORT</arg></arg>
 
88
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
 
89
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
 
90
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
91
      <arg>--debug</arg>
111
92
    </cmdsynopsis>
112
93
    <cmdsynopsis>
113
94
      <command>&COMMANDNAME;</command>
114
95
      <group choice="req">
115
 
        <arg choice="plain"><option>--help</option></arg>
116
 
        <arg choice="plain"><option>-h</option></arg>
 
96
        <arg choice="plain">-h</arg>
 
97
        <arg choice="plain">--help</arg>
117
98
      </group>
118
99
    </cmdsynopsis>
119
100
    <cmdsynopsis>
120
101
      <command>&COMMANDNAME;</command>
121
 
      <arg choice="plain"><option>--version</option></arg>
 
102
      <arg choice="plain">--version</arg>
122
103
    </cmdsynopsis>
123
104
    <cmdsynopsis>
124
105
      <command>&COMMANDNAME;</command>
125
 
      <arg choice="plain"><option>--check</option></arg>
 
106
      <arg choice="plain">--check</arg>
126
107
    </cmdsynopsis>
127
108
  </refsynopsisdiv>
128
 
  
 
109
 
129
110
  <refsect1 id="description">
130
111
    <title>DESCRIPTION</title>
131
112
    <para>
132
113
      <command>&COMMANDNAME;</command> is a server daemon which
133
114
      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.
 
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.
144
123
    </para>
 
124
 
145
125
  </refsect1>
146
126
  
147
127
  <refsect1 id="purpose">
148
128
    <title>PURPOSE</title>
 
129
 
149
130
    <para>
150
131
      The purpose of this is to enable <emphasis>remote and unattended
151
132
      rebooting</emphasis> of client host computer with an
152
133
      <emphasis>encrypted root file system</emphasis>.  See <xref
153
134
      linkend="overview"/> for details.
154
135
    </para>
 
136
 
155
137
  </refsect1>
156
138
  
157
139
  <refsect1 id="options">
158
140
    <title>OPTIONS</title>
 
141
 
159
142
    <variablelist>
160
143
      <varlistentry>
161
 
        <term><option>--help</option></term>
162
 
        <term><option>-h</option></term>
 
144
        <term><literal>-h</literal>, <literal>--help</literal></term>
163
145
        <listitem>
164
146
          <para>
165
147
            Show a help message and exit
166
148
          </para>
167
149
        </listitem>
168
150
      </varlistentry>
169
 
      
 
151
 
170
152
      <varlistentry>
171
 
        <term><option>--interface</option>
172
 
        <replaceable>NAME</replaceable></term>
173
 
        <term><option>-i</option>
174
 
        <replaceable>NAME</replaceable></term>
 
153
        <term><literal>-i</literal>, <literal>--interface <replaceable
 
154
        >NAME</replaceable></literal></term>
175
155
        <listitem>
176
156
          <xi:include href="mandos-options.xml" xpointer="interface"/>
177
157
        </listitem>
178
158
      </varlistentry>
179
 
      
 
159
 
180
160
      <varlistentry>
181
 
        <term><option>--address
182
 
        <replaceable>ADDRESS</replaceable></option></term>
183
 
        <term><option>-a
184
 
        <replaceable>ADDRESS</replaceable></option></term>
 
161
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
162
        ADDRESS</replaceable></literal></term>
185
163
        <listitem>
186
164
          <xi:include href="mandos-options.xml" xpointer="address"/>
187
165
        </listitem>
188
166
      </varlistentry>
189
 
      
 
167
 
190
168
      <varlistentry>
191
 
        <term><option>--port
192
 
        <replaceable>PORT</replaceable></option></term>
193
 
        <term><option>-p
194
 
        <replaceable>PORT</replaceable></option></term>
 
169
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
170
        PORT</replaceable></literal></term>
195
171
        <listitem>
196
172
          <xi:include href="mandos-options.xml" xpointer="port"/>
197
173
        </listitem>
198
174
      </varlistentry>
199
 
      
 
175
 
200
176
      <varlistentry>
201
 
        <term><option>--check</option></term>
 
177
        <term><literal>--check</literal></term>
202
178
        <listitem>
203
179
          <para>
204
180
            Run the server’s self-tests.  This includes any unit
206
182
          </para>
207
183
        </listitem>
208
184
      </varlistentry>
209
 
      
 
185
 
210
186
      <varlistentry>
211
 
        <term><option>--debug</option></term>
 
187
        <term><literal>--debug</literal></term>
212
188
        <listitem>
213
189
          <xi:include href="mandos-options.xml" xpointer="debug"/>
214
190
        </listitem>
215
191
      </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>
238
 
        <listitem>
239
 
          <xi:include href="mandos-options.xml"
240
 
                      xpointer="priority_compat"/>
241
 
        </listitem>
242
 
      </varlistentry>
243
 
      
244
 
      <varlistentry>
245
 
        <term><option>--servicename
246
 
        <replaceable>NAME</replaceable></option></term>
 
192
 
 
193
      <varlistentry>
 
194
        <term><literal>--priority <replaceable>
 
195
        PRIORITY</replaceable></literal></term>
 
196
        <listitem>
 
197
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
198
        </listitem>
 
199
      </varlistentry>
 
200
 
 
201
      <varlistentry>
 
202
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
203
        </literal></term>
247
204
        <listitem>
248
205
          <xi:include href="mandos-options.xml"
249
206
                      xpointer="servicename"/>
250
207
        </listitem>
251
208
      </varlistentry>
252
 
      
 
209
 
253
210
      <varlistentry>
254
 
        <term><option>--configdir
255
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
211
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
212
        </literal></term>
256
213
        <listitem>
257
214
          <para>
258
215
            Directory to search for configuration files.  Default is
264
221
          </para>
265
222
        </listitem>
266
223
      </varlistentry>
267
 
      
 
224
 
268
225
      <varlistentry>
269
 
        <term><option>--version</option></term>
 
226
        <term><literal>--version</literal></term>
270
227
        <listitem>
271
228
          <para>
272
229
            Prints the program version and exit.
273
230
          </para>
274
231
        </listitem>
275
232
      </varlistentry>
276
 
      
277
 
      <varlistentry>
278
 
        <term><option>--no-dbus</option></term>
279
 
        <listitem>
280
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
281
 
          <para>
282
 
            See also <xref linkend="dbus_interface"/>.
283
 
          </para>
284
 
        </listitem>
285
 
      </varlistentry>
286
 
      
287
 
      <varlistentry>
288
 
        <term><option>--no-ipv6</option></term>
289
 
        <listitem>
290
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
291
 
        </listitem>
292
 
      </varlistentry>
293
 
      
294
 
      <varlistentry>
295
 
        <term><option>--no-restore</option></term>
296
 
        <listitem>
297
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
298
 
          <para>
299
 
            See also <xref linkend="persistent_state"/>.
300
 
          </para>
301
 
        </listitem>
302
 
      </varlistentry>
303
 
      
304
 
      <varlistentry>
305
 
        <term><option>--statedir
306
 
        <replaceable>DIRECTORY</replaceable></option></term>
307
 
        <listitem>
308
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
309
 
        </listitem>
310
 
      </varlistentry>
311
 
      
312
 
      <varlistentry>
313
 
        <term><option>--socket
314
 
        <replaceable>FD</replaceable></option></term>
315
 
        <listitem>
316
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
317
 
        </listitem>
318
 
      </varlistentry>
319
 
      
320
 
      <varlistentry>
321
 
        <term><option>--foreground</option></term>
322
 
        <listitem>
323
 
          <xi:include href="mandos-options.xml"
324
 
                      xpointer="foreground"/>
325
 
        </listitem>
326
 
      </varlistentry>
327
 
      
328
 
      <varlistentry>
329
 
        <term><option>--no-zeroconf</option></term>
330
 
        <listitem>
331
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
332
 
        </listitem>
333
 
      </varlistentry>
334
 
      
335
233
    </variablelist>
336
234
  </refsect1>
337
 
  
 
235
 
338
236
  <refsect1 id="overview">
339
237
    <title>OVERVIEW</title>
340
238
    <xi:include href="overview.xml"/>
341
239
    <para>
342
240
      This program is the server part.  It is a normal server program
343
241
      and will run in a normal system environment, not in an initial
344
 
      <acronym>RAM</acronym> disk environment.
 
242
      RAM disk environment.
345
243
    </para>
346
244
  </refsect1>
347
 
  
 
245
 
348
246
  <refsect1 id="protocol">
349
247
    <title>NETWORK PROTOCOL</title>
350
248
    <para>
402
300
      </row>
403
301
    </tbody></tgroup></table>
404
302
  </refsect1>
405
 
  
 
303
 
406
304
  <refsect1 id="checking">
407
305
    <title>CHECKING</title>
408
306
    <para>
409
307
      The server will, by default, continually check that the clients
410
308
      are still up.  If a client has not been confirmed as being up
411
309
      for some time, the client is assumed to be compromised and is no
412
 
      longer eligible to receive the encrypted password.  (Manual
413
 
      intervention is required to re-enable a client.)  The timeout,
414
 
      extended timeout, checker program, and interval between checks
415
 
      can be configured both globally and per client; see
416
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
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-clients.conf</refentrytitle>
417
314
      <manvolnum>5</manvolnum></citerefentry>.
418
315
    </para>
419
316
  </refsect1>
420
 
  
421
 
  <refsect1 id="approval">
422
 
    <title>APPROVAL</title>
423
 
    <para>
424
 
      The server can be configured to require manual approval for a
425
 
      client before it is sent its secret.  The delay to wait for such
426
 
      approval and the default action (approve or deny) can be
427
 
      configured both globally and per client; see <citerefentry>
428
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
429
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
430
 
      will be approved immediately without delay.
431
 
    </para>
432
 
    <para>
433
 
      This can be used to deny a client its secret if not manually
434
 
      approved within a specified time.  It can also be used to make
435
 
      the server delay before giving a client its secret, allowing
436
 
      optional manual denying of this specific client.
437
 
    </para>
438
 
    
439
 
  </refsect1>
440
 
  
 
317
 
441
318
  <refsect1 id="logging">
442
319
    <title>LOGGING</title>
443
320
    <para>
444
321
      The server will send log message with various severity levels to
445
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
322
      <filename>/dev/log</filename>.  With the
446
323
      <option>--debug</option> option, it will log even more messages,
447
324
      and also show them on the console.
448
325
    </para>
449
326
  </refsect1>
450
 
  
451
 
  <refsect1 id="persistent_state">
452
 
    <title>PERSISTENT STATE</title>
453
 
    <para>
454
 
      Client settings, initially read from
455
 
      <filename>clients.conf</filename>, are persistent across
456
 
      restarts, and run-time changes will override settings in
457
 
      <filename>clients.conf</filename>.  However, if a setting is
458
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
459
 
      <filename>clients.conf</filename>, this will take precedence.
460
 
    </para>
461
 
  </refsect1>
462
 
  
463
 
  <refsect1 id="dbus_interface">
464
 
    <title>D-BUS INTERFACE</title>
465
 
    <para>
466
 
      The server will by default provide a D-Bus system bus interface.
467
 
      This interface will only be accessible by the root user or a
468
 
      Mandos-specific user, if such a user exists.  For documentation
469
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
470
 
    </para>
471
 
  </refsect1>
472
 
  
 
327
 
473
328
  <refsect1 id="exit_status">
474
329
    <title>EXIT STATUS</title>
475
330
    <para>
477
332
      critical error is encountered.
478
333
    </para>
479
334
  </refsect1>
480
 
  
 
335
 
481
336
  <refsect1 id="environment">
482
337
    <title>ENVIRONMENT</title>
483
338
    <variablelist>
484
339
      <varlistentry>
485
 
        <term><envar>PATH</envar></term>
 
340
        <term><varname>PATH</varname></term>
486
341
        <listitem>
487
342
          <para>
488
343
            To start the configured checker (see <xref
497
352
      </varlistentry>
498
353
    </variablelist>
499
354
  </refsect1>
500
 
  
501
 
  <refsect1 id="files">
 
355
 
 
356
  <refsect1 id="file">
502
357
    <title>FILES</title>
503
358
    <para>
504
359
      Use the <option>--configdir</option> option to change where
527
382
        </listitem>
528
383
      </varlistentry>
529
384
      <varlistentry>
530
 
        <term><filename>/run/mandos.pid</filename></term>
531
 
        <listitem>
532
 
          <para>
533
 
            The file containing the process id of the
534
 
            <command>&COMMANDNAME;</command> process started last.
535
 
            <emphasis >Note:</emphasis> If the <filename
536
 
            class="directory">/run</filename> directory does not
537
 
            exist, <filename>/var/run/mandos.pid</filename> will be
538
 
            used instead.
539
 
          </para>
540
 
        </listitem>
541
 
      </varlistentry>
542
 
      <varlistentry>
543
 
        <term><filename class="devicefile">/dev/log</filename></term>
544
 
      </varlistentry>
545
 
      <varlistentry>
546
 
        <term><filename
547
 
        class="directory">/var/lib/mandos</filename></term>
548
 
        <listitem>
549
 
          <para>
550
 
            Directory where persistent state will be saved.  Change
551
 
            this with the <option>--statedir</option> option.  See
552
 
            also the <option>--no-restore</option> option.
 
385
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
386
        <listitem>
 
387
          <para>
 
388
            The file containing the process id of
 
389
            <command>&COMMANDNAME;</command>.
553
390
          </para>
554
391
        </listitem>
555
392
      </varlistentry>
583
420
      backtrace.  This could be considered a feature.
584
421
    </para>
585
422
    <para>
 
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.
 
432
    </para>
 
433
    <para>
586
434
      There is no fine-grained control over logging and debug output.
587
435
    </para>
588
436
    <para>
589
 
      This server does not check the expire time of clients’ OpenPGP
590
 
      keys.
 
437
      Debug mode is conflated with running in the foreground.
 
438
    </para>
 
439
    <para>
 
440
      The console log messages does not show a timestamp.
591
441
    </para>
592
442
  </refsect1>
593
443
  
598
448
        Normal invocation needs no options:
599
449
      </para>
600
450
      <para>
601
 
        <userinput>&COMMANDNAME;</userinput>
 
451
        <userinput>mandos</userinput>
602
452
      </para>
603
453
    </informalexample>
604
454
    <informalexample>
605
455
      <para>
606
456
        Run the server in debug mode, read configuration files from
607
 
        the <filename class="directory">~/mandos</filename> directory,
608
 
        and use the Zeroconf service name <quote>Test</quote> to not
609
 
        collide with any other official Mandos server on this host:
 
457
        the <filename>~/mandos</filename> directory, and use the
 
458
        Zeroconf service name <quote>Test</quote> to not collide with
 
459
        any other official Mandos server on this host:
610
460
      </para>
611
461
      <para>
612
462
 
613
463
<!-- do not wrap this line -->
614
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
464
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
615
465
 
616
466
      </para>
617
467
    </informalexample>
623
473
      <para>
624
474
 
625
475
<!-- do not wrap this line -->
626
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
476
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
627
477
 
628
478
      </para>
629
479
    </informalexample>
630
480
  </refsect1>
631
 
  
 
481
 
632
482
  <refsect1 id="security">
633
483
    <title>SECURITY</title>
634
 
    <refsect2 id="server">
 
484
    <refsect2 id="SERVER">
635
485
      <title>SERVER</title>
636
486
      <para>
637
487
        Running this <command>&COMMANDNAME;</command> server program
638
488
        should not in itself present any security risk to the host
639
 
        computer running it.  The program switches to a non-root user
640
 
        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.
641
491
      </para>
642
492
    </refsect2>
643
 
    <refsect2 id="clients">
 
493
    <refsect2 id="CLIENTS">
644
494
      <title>CLIENTS</title>
645
495
      <para>
646
496
        The server only gives out its stored data to clients which
653
503
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
654
504
        <manvolnum>5</manvolnum></citerefentry>)
655
505
        <emphasis>must</emphasis> be made non-readable by anyone
656
 
        except the user starting the server (usually root).
 
506
        except the user running the server.
657
507
      </para>
658
508
      <para>
659
509
        As detailed in <xref linkend="checking"/>, the status of all
661
511
        compromised if they are gone for too long.
662
512
      </para>
663
513
      <para>
 
514
        If a client is compromised, its downtime should be duly noted
 
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.
 
528
      </para>
 
529
      <para>
664
530
        For more details on client-side security, see
665
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
531
        <citerefentry><refentrytitle>password-request</refentrytitle>
666
532
        <manvolnum>8mandos</manvolnum></citerefentry>.
667
533
      </para>
668
534
    </refsect2>
669
535
  </refsect1>
670
 
  
 
536
 
671
537
  <refsect1 id="see_also">
672
538
    <title>SEE ALSO</title>
673
539
    <para>
674
 
      <citerefentry><refentrytitle>intro</refentrytitle>
675
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
676
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
677
 
      <manvolnum>5</manvolnum></citerefentry>,
678
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
679
 
      <manvolnum>5</manvolnum></citerefentry>,
680
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
681
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
682
 
      <citerefentry><refentrytitle>sh</refentrytitle>
683
 
      <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>
684
549
    </para>
685
550
    <variablelist>
686
551
      <varlistentry>
786
651
    </variablelist>
787
652
  </refsect1>
788
653
</refentry>
789
 
<!-- Local Variables: -->
790
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
791
 
<!-- time-stamp-end: "[\"']>" -->
792
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
793
 
<!-- End: -->