/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-25 06:44:13 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080825064413-smqg5qwxfvhkeop4
* Makefile (DOCBOOKTOMAN): Only cd to one directory.

* mandos-options.xml (interface): Removed mention of a specific
                                  replaceable.
  (debug): Reworded slightly.

* mandos.conf.xml (OPTIONS): Renamed some replaceable names.

* mandos.xml (SYNOPSIS, OPTIONS): Renamed replaceable of "interface"
                                  from "IF" to "NAME".

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 "2016-03-05">
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
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
32
      <holder>Teddy Hogeborn</holder>
44
33
      <holder>Björn Påhlsson</holder>
45
34
    </copyright>
46
 
    <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>
47
58
  </refentryinfo>
48
 
  
 
59
 
49
60
  <refmeta>
50
61
    <refentrytitle>&COMMANDNAME;</refentrytitle>
51
62
    <manvolnum>8</manvolnum>
54
65
  <refnamediv>
55
66
    <refname><command>&COMMANDNAME;</command></refname>
56
67
    <refpurpose>
57
 
      Gives encrypted passwords to authenticated Mandos clients
 
68
      Sends encrypted passwords to authenticated Mandos clients
58
69
    </refpurpose>
59
70
  </refnamediv>
60
 
  
 
71
 
61
72
  <refsynopsisdiv>
62
73
    <cmdsynopsis>
63
74
      <command>&COMMANDNAME;</command>
64
 
      <group>
65
 
        <arg choice="plain"><option>--interface
66
 
        <replaceable>NAME</replaceable></option></arg>
67
 
        <arg choice="plain"><option>-i
68
 
        <replaceable>NAME</replaceable></option></arg>
69
 
      </group>
70
 
      <sbr/>
71
 
      <group>
72
 
        <arg choice="plain"><option>--address
73
 
        <replaceable>ADDRESS</replaceable></option></arg>
74
 
        <arg choice="plain"><option>-a
75
 
        <replaceable>ADDRESS</replaceable></option></arg>
76
 
      </group>
77
 
      <sbr/>
78
 
      <group>
79
 
        <arg choice="plain"><option>--port
80
 
        <replaceable>PORT</replaceable></option></arg>
81
 
        <arg choice="plain"><option>-p
82
 
        <replaceable>PORT</replaceable></option></arg>
83
 
      </group>
84
 
      <sbr/>
85
 
      <arg><option>--priority
86
 
      <replaceable>PRIORITY</replaceable></option></arg>
87
 
      <sbr/>
88
 
      <arg><option>--servicename
89
 
      <replaceable>NAME</replaceable></option></arg>
90
 
      <sbr/>
91
 
      <arg><option>--configdir
92
 
      <replaceable>DIRECTORY</replaceable></option></arg>
93
 
      <sbr/>
94
 
      <arg><option>--debug</option></arg>
95
 
      <sbr/>
96
 
      <arg><option>--debuglevel
97
 
      <replaceable>LEVEL</replaceable></option></arg>
98
 
      <sbr/>
99
 
      <arg><option>--no-dbus</option></arg>
100
 
      <sbr/>
101
 
      <arg><option>--no-ipv6</option></arg>
102
 
      <sbr/>
103
 
      <arg><option>--no-restore</option></arg>
104
 
      <sbr/>
105
 
      <arg><option>--statedir
106
 
      <replaceable>DIRECTORY</replaceable></option></arg>
107
 
      <sbr/>
108
 
      <arg><option>--socket
109
 
      <replaceable>FD</replaceable></option></arg>
110
 
      <sbr/>
111
 
      <arg><option>--foreground</option></arg>
112
 
      <sbr/>
113
 
      <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>
114
92
    </cmdsynopsis>
115
93
    <cmdsynopsis>
116
94
      <command>&COMMANDNAME;</command>
117
95
      <group choice="req">
118
 
        <arg choice="plain"><option>--help</option></arg>
119
 
        <arg choice="plain"><option>-h</option></arg>
 
96
        <arg choice="plain">-h</arg>
 
97
        <arg choice="plain">--help</arg>
120
98
      </group>
121
99
    </cmdsynopsis>
122
100
    <cmdsynopsis>
123
101
      <command>&COMMANDNAME;</command>
124
 
      <arg choice="plain"><option>--version</option></arg>
 
102
      <arg choice="plain">--version</arg>
125
103
    </cmdsynopsis>
126
104
    <cmdsynopsis>
127
105
      <command>&COMMANDNAME;</command>
128
 
      <arg choice="plain"><option>--check</option></arg>
 
106
      <arg choice="plain">--check</arg>
129
107
    </cmdsynopsis>
130
108
  </refsynopsisdiv>
131
 
  
 
109
 
132
110
  <refsect1 id="description">
133
111
    <title>DESCRIPTION</title>
134
112
    <para>
135
113
      <command>&COMMANDNAME;</command> is a server daemon which
136
114
      handles incoming request for passwords for a pre-defined list of
137
 
      client host computers. For an introduction, see
138
 
      <citerefentry><refentrytitle>intro</refentrytitle>
139
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
140
 
      uses Zeroconf to announce itself on the local network, and uses
141
 
      TLS to communicate securely with and to authenticate the
142
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
143
 
      use IPv6 link-local addresses, since the clients will probably
144
 
      not have any other addresses configured (see <xref
145
 
      linkend="overview"/>).  Any authenticated client is then given
146
 
      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.
147
123
    </para>
 
124
 
148
125
  </refsect1>
149
126
  
150
127
  <refsect1 id="purpose">
151
128
    <title>PURPOSE</title>
 
129
 
152
130
    <para>
153
131
      The purpose of this is to enable <emphasis>remote and unattended
154
132
      rebooting</emphasis> of client host computer with an
155
133
      <emphasis>encrypted root file system</emphasis>.  See <xref
156
134
      linkend="overview"/> for details.
157
135
    </para>
 
136
 
158
137
  </refsect1>
159
138
  
160
139
  <refsect1 id="options">
161
140
    <title>OPTIONS</title>
 
141
 
162
142
    <variablelist>
163
143
      <varlistentry>
164
 
        <term><option>--help</option></term>
165
 
        <term><option>-h</option></term>
 
144
        <term><literal>-h</literal>, <literal>--help</literal></term>
166
145
        <listitem>
167
146
          <para>
168
147
            Show a help message and exit
169
148
          </para>
170
149
        </listitem>
171
150
      </varlistentry>
172
 
      
 
151
 
173
152
      <varlistentry>
174
 
        <term><option>--interface</option>
175
 
        <replaceable>NAME</replaceable></term>
176
 
        <term><option>-i</option>
177
 
        <replaceable>NAME</replaceable></term>
 
153
        <term><literal>-i</literal>, <literal>--interface <replaceable
 
154
        >NAME</replaceable></literal></term>
178
155
        <listitem>
179
156
          <xi:include href="mandos-options.xml" xpointer="interface"/>
180
157
        </listitem>
181
158
      </varlistentry>
182
 
      
 
159
 
183
160
      <varlistentry>
184
 
        <term><option>--address
185
 
        <replaceable>ADDRESS</replaceable></option></term>
186
 
        <term><option>-a
187
 
        <replaceable>ADDRESS</replaceable></option></term>
 
161
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
162
        ADDRESS</replaceable></literal></term>
188
163
        <listitem>
189
164
          <xi:include href="mandos-options.xml" xpointer="address"/>
190
165
        </listitem>
191
166
      </varlistentry>
192
 
      
 
167
 
193
168
      <varlistentry>
194
 
        <term><option>--port
195
 
        <replaceable>PORT</replaceable></option></term>
196
 
        <term><option>-p
197
 
        <replaceable>PORT</replaceable></option></term>
 
169
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
170
        PORT</replaceable></literal></term>
198
171
        <listitem>
199
172
          <xi:include href="mandos-options.xml" xpointer="port"/>
200
173
        </listitem>
201
174
      </varlistentry>
202
 
      
 
175
 
203
176
      <varlistentry>
204
 
        <term><option>--check</option></term>
 
177
        <term><literal>--check</literal></term>
205
178
        <listitem>
206
179
          <para>
207
180
            Run the server’s self-tests.  This includes any unit
209
182
          </para>
210
183
        </listitem>
211
184
      </varlistentry>
212
 
      
 
185
 
213
186
      <varlistentry>
214
 
        <term><option>--debug</option></term>
 
187
        <term><literal>--debug</literal></term>
215
188
        <listitem>
216
189
          <xi:include href="mandos-options.xml" xpointer="debug"/>
217
190
        </listitem>
218
191
      </varlistentry>
219
 
      
220
 
      <varlistentry>
221
 
        <term><option>--debuglevel
222
 
        <replaceable>LEVEL</replaceable></option></term>
223
 
        <listitem>
224
 
          <para>
225
 
            Set the debugging log level.
226
 
            <replaceable>LEVEL</replaceable> is a string, one of
227
 
            <quote><literal>CRITICAL</literal></quote>,
228
 
            <quote><literal>ERROR</literal></quote>,
229
 
            <quote><literal>WARNING</literal></quote>,
230
 
            <quote><literal>INFO</literal></quote>, or
231
 
            <quote><literal>DEBUG</literal></quote>, in order of
232
 
            increasing verbosity.  The default level is
233
 
            <quote><literal>WARNING</literal></quote>.
234
 
          </para>
235
 
        </listitem>
236
 
      </varlistentry>
237
 
      
238
 
      <varlistentry>
239
 
        <term><option>--priority <replaceable>
240
 
        PRIORITY</replaceable></option></term>
 
192
 
 
193
      <varlistentry>
 
194
        <term><literal>--priority <replaceable>
 
195
        PRIORITY</replaceable></literal></term>
241
196
        <listitem>
242
197
          <xi:include href="mandos-options.xml" xpointer="priority"/>
243
198
        </listitem>
244
199
      </varlistentry>
245
 
      
 
200
 
246
201
      <varlistentry>
247
 
        <term><option>--servicename
248
 
        <replaceable>NAME</replaceable></option></term>
 
202
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
203
        </literal></term>
249
204
        <listitem>
250
205
          <xi:include href="mandos-options.xml"
251
206
                      xpointer="servicename"/>
252
207
        </listitem>
253
208
      </varlistentry>
254
 
      
 
209
 
255
210
      <varlistentry>
256
 
        <term><option>--configdir
257
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
211
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
212
        </literal></term>
258
213
        <listitem>
259
214
          <para>
260
215
            Directory to search for configuration files.  Default is
266
221
          </para>
267
222
        </listitem>
268
223
      </varlistentry>
269
 
      
 
224
 
270
225
      <varlistentry>
271
 
        <term><option>--version</option></term>
 
226
        <term><literal>--version</literal></term>
272
227
        <listitem>
273
228
          <para>
274
229
            Prints the program version and exit.
275
230
          </para>
276
231
        </listitem>
277
232
      </varlistentry>
278
 
      
279
 
      <varlistentry>
280
 
        <term><option>--no-dbus</option></term>
281
 
        <listitem>
282
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
283
 
          <para>
284
 
            See also <xref linkend="dbus_interface"/>.
285
 
          </para>
286
 
        </listitem>
287
 
      </varlistentry>
288
 
      
289
 
      <varlistentry>
290
 
        <term><option>--no-ipv6</option></term>
291
 
        <listitem>
292
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
293
 
        </listitem>
294
 
      </varlistentry>
295
 
      
296
 
      <varlistentry>
297
 
        <term><option>--no-restore</option></term>
298
 
        <listitem>
299
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
300
 
          <para>
301
 
            See also <xref linkend="persistent_state"/>.
302
 
          </para>
303
 
        </listitem>
304
 
      </varlistentry>
305
 
      
306
 
      <varlistentry>
307
 
        <term><option>--statedir
308
 
        <replaceable>DIRECTORY</replaceable></option></term>
309
 
        <listitem>
310
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
311
 
        </listitem>
312
 
      </varlistentry>
313
 
      
314
 
      <varlistentry>
315
 
        <term><option>--socket
316
 
        <replaceable>FD</replaceable></option></term>
317
 
        <listitem>
318
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
319
 
        </listitem>
320
 
      </varlistentry>
321
 
      
322
 
      <varlistentry>
323
 
        <term><option>--foreground</option></term>
324
 
        <listitem>
325
 
          <xi:include href="mandos-options.xml"
326
 
                      xpointer="foreground"/>
327
 
        </listitem>
328
 
      </varlistentry>
329
 
      
330
 
      <varlistentry>
331
 
        <term><option>--no-zeroconf</option></term>
332
 
        <listitem>
333
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
334
 
        </listitem>
335
 
      </varlistentry>
336
 
      
337
233
    </variablelist>
338
234
  </refsect1>
339
 
  
 
235
 
340
236
  <refsect1 id="overview">
341
237
    <title>OVERVIEW</title>
342
238
    <xi:include href="overview.xml"/>
343
239
    <para>
344
240
      This program is the server part.  It is a normal server program
345
241
      and will run in a normal system environment, not in an initial
346
 
      <acronym>RAM</acronym> disk environment.
 
242
      RAM disk environment.
347
243
    </para>
348
244
  </refsect1>
349
 
  
 
245
 
350
246
  <refsect1 id="protocol">
351
247
    <title>NETWORK PROTOCOL</title>
352
248
    <para>
404
300
      </row>
405
301
    </tbody></tgroup></table>
406
302
  </refsect1>
407
 
  
 
303
 
408
304
  <refsect1 id="checking">
409
305
    <title>CHECKING</title>
410
306
    <para>
411
307
      The server will, by default, continually check that the clients
412
308
      are still up.  If a client has not been confirmed as being up
413
309
      for some time, the client is assumed to be compromised and is no
414
 
      longer eligible to receive the encrypted password.  (Manual
415
 
      intervention is required to re-enable a client.)  The timeout,
416
 
      extended timeout, checker program, and interval between checks
417
 
      can be configured both globally and per client; see
418
 
      <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>
419
314
      <manvolnum>5</manvolnum></citerefentry>.
420
315
    </para>
421
316
  </refsect1>
422
 
  
423
 
  <refsect1 id="approval">
424
 
    <title>APPROVAL</title>
425
 
    <para>
426
 
      The server can be configured to require manual approval for a
427
 
      client before it is sent its secret.  The delay to wait for such
428
 
      approval and the default action (approve or deny) can be
429
 
      configured both globally and per client; see <citerefentry>
430
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
431
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
432
 
      will be approved immediately without delay.
433
 
    </para>
434
 
    <para>
435
 
      This can be used to deny a client its secret if not manually
436
 
      approved within a specified time.  It can also be used to make
437
 
      the server delay before giving a client its secret, allowing
438
 
      optional manual denying of this specific client.
439
 
    </para>
440
 
    
441
 
  </refsect1>
442
 
  
 
317
 
443
318
  <refsect1 id="logging">
444
319
    <title>LOGGING</title>
445
320
    <para>
446
321
      The server will send log message with various severity levels to
447
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
322
      <filename>/dev/log</filename>.  With the
448
323
      <option>--debug</option> option, it will log even more messages,
449
324
      and also show them on the console.
450
325
    </para>
451
326
  </refsect1>
452
 
  
453
 
  <refsect1 id="persistent_state">
454
 
    <title>PERSISTENT STATE</title>
455
 
    <para>
456
 
      Client settings, initially read from
457
 
      <filename>clients.conf</filename>, are persistent across
458
 
      restarts, and run-time changes will override settings in
459
 
      <filename>clients.conf</filename>.  However, if a setting is
460
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
461
 
      <filename>clients.conf</filename>, this will take precedence.
462
 
    </para>
463
 
  </refsect1>
464
 
  
465
 
  <refsect1 id="dbus_interface">
466
 
    <title>D-BUS INTERFACE</title>
467
 
    <para>
468
 
      The server will by default provide a D-Bus system bus interface.
469
 
      This interface will only be accessible by the root user or a
470
 
      Mandos-specific user, if such a user exists.  For documentation
471
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
472
 
    </para>
473
 
  </refsect1>
474
 
  
 
327
 
475
328
  <refsect1 id="exit_status">
476
329
    <title>EXIT STATUS</title>
477
330
    <para>
479
332
      critical error is encountered.
480
333
    </para>
481
334
  </refsect1>
482
 
  
 
335
 
483
336
  <refsect1 id="environment">
484
337
    <title>ENVIRONMENT</title>
485
338
    <variablelist>
486
339
      <varlistentry>
487
 
        <term><envar>PATH</envar></term>
 
340
        <term><varname>PATH</varname></term>
488
341
        <listitem>
489
342
          <para>
490
343
            To start the configured checker (see <xref
499
352
      </varlistentry>
500
353
    </variablelist>
501
354
  </refsect1>
502
 
  
503
 
  <refsect1 id="files">
 
355
 
 
356
  <refsect1 id="file">
504
357
    <title>FILES</title>
505
358
    <para>
506
359
      Use the <option>--configdir</option> option to change where
529
382
        </listitem>
530
383
      </varlistentry>
531
384
      <varlistentry>
532
 
        <term><filename>/run/mandos.pid</filename></term>
533
 
        <listitem>
534
 
          <para>
535
 
            The file containing the process id of the
536
 
            <command>&COMMANDNAME;</command> process started last.
537
 
            <emphasis >Note:</emphasis> If the <filename
538
 
            class="directory">/run</filename> directory does not
539
 
            exist, <filename>/var/run/mandos.pid</filename> will be
540
 
            used instead.
541
 
          </para>
542
 
        </listitem>
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.
552
 
          </para>
553
 
        </listitem>
554
 
      </varlistentry>
555
 
      <varlistentry>
556
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
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>.
 
390
          </para>
 
391
        </listitem>
 
392
      </varlistentry>
 
393
      <varlistentry>
 
394
        <term><filename>/dev/log</filename></term>
557
395
        <listitem>
558
396
          <para>
559
397
            The Unix domain socket to where local syslog messages are
582
420
      backtrace.  This could be considered a feature.
583
421
    </para>
584
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>
585
434
      There is no fine-grained control over logging and debug output.
586
435
    </para>
587
436
    <para>
588
 
      This server does not check the expire time of clients’ OpenPGP
589
 
      keys.
590
 
    </para>
591
 
    <xi:include href="bugs.xml"/>
 
437
      Debug mode is conflated with running in the foreground.
 
438
    </para>
 
439
    <para>
 
440
      The console log messages does not show a timestamp.
 
441
    </para>
592
442
  </refsect1>
593
443
  
594
444
  <refsect1 id="example">
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>
707
572
      </varlistentry>
708
573
      <varlistentry>
709
574
        <term>
710
 
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
 
575
          <ulink
 
576
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
711
577
        </term>
712
578
      <listitem>
713
579
        <para>
719
585
      </varlistentry>
720
586
      <varlistentry>
721
587
        <term>
722
 
          RFC 4291: <citetitle>IP Version 6 Addressing
723
 
          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>
724
591
        </term>
725
592
        <listitem>
726
 
          <variablelist>
727
 
            <varlistentry>
728
 
              <term>Section 2.2: <citetitle>Text Representation of
729
 
              Addresses</citetitle></term>
730
 
              <listitem><para/></listitem>
731
 
            </varlistentry>
732
 
            <varlistentry>
733
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
734
 
              Address</citetitle></term>
735
 
              <listitem><para/></listitem>
736
 
            </varlistentry>
737
 
            <varlistentry>
738
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
739
 
            Addresses</citetitle></term>
740
 
            <listitem>
741
 
              <para>
742
 
                The clients use IPv6 link-local addresses, which are
743
 
                immediately usable since a link-local addresses is
744
 
                automatically assigned to a network interfaces when it
745
 
                is brought up.
746
 
              </para>
747
 
            </listitem>
748
 
            </varlistentry>
749
 
          </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>
750
599
        </listitem>
751
600
      </varlistentry>
752
601
      <varlistentry>
753
602
        <term>
754
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
755
 
          Protocol Version 1.2</citetitle>
 
603
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
604
          (TLS) Protocol Version 1.1</citetitle></citation>
756
605
        </term>
757
606
      <listitem>
758
607
        <para>
759
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
608
          TLS 1.1 is the protocol implemented by GnuTLS.
760
609
        </para>
761
610
      </listitem>
762
611
      </varlistentry>
763
612
      <varlistentry>
764
613
        <term>
765
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
614
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
615
          Format</citetitle></citation>
766
616
        </term>
767
617
      <listitem>
768
618
        <para>
772
622
      </varlistentry>
773
623
      <varlistentry>
774
624
        <term>
775
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
776
 
          Security (TLS) Authentication</citetitle>
 
625
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
626
          Transport Layer Security</citetitle></citation>
777
627
        </term>
778
628
      <listitem>
779
629
        <para>
785
635
    </variablelist>
786
636
  </refsect1>
787
637
</refentry>
788
 
<!-- Local Variables: -->
789
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
790
 
<!-- time-stamp-end: "[\"']>" -->
791
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
792
 
<!-- End: -->