/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-19 13:25:14 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080819132514-wawrvgmfjovg9poj
* Makefile (DOCBOOKTOMAN): Added "--xinclude".

* mandos-options.xml: New file; moved mandos(8) option descriptions
                      here.

* mandos.conf.xml: Add XInclude namespace.
  (OPTIONS): New separate section with options from old "DESCRIPTION"
             section.  Changed all options to include a synopsis and
             include its paragraph from "mandos-options.xml".
  (FILES): Moved to before "EXAMPLES".
  (BUGS): New section.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).  Unindented
              example text.

* mandos.xml: Removed OVERVIEW entity.  Add XInclude namespace.
  (OPTIONS): Moved all descriptive paragraphs to "mandos-options.xml"
             and just <xi:include/> them from here.
  (OVERVIEW): Changed to do <xi:include/>.

* overview.xml: Added DOCTYPE; reportedly needed for XInclude to work.

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 "2017-02-23">
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
 
      <year>2017</year>
44
32
      <holder>Teddy Hogeborn</holder>
45
33
      <holder>Björn Påhlsson</holder>
46
34
    </copyright>
47
 
    <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>
48
58
  </refentryinfo>
49
 
  
 
59
 
50
60
  <refmeta>
51
61
    <refentrytitle>&COMMANDNAME;</refentrytitle>
52
62
    <manvolnum>8</manvolnum>
55
65
  <refnamediv>
56
66
    <refname><command>&COMMANDNAME;</command></refname>
57
67
    <refpurpose>
58
 
      Gives encrypted passwords to authenticated Mandos clients
 
68
      Sends encrypted passwords to authenticated Mandos clients
59
69
    </refpurpose>
60
70
  </refnamediv>
61
 
  
 
71
 
62
72
  <refsynopsisdiv>
63
73
    <cmdsynopsis>
64
74
      <command>&COMMANDNAME;</command>
65
 
      <group>
66
 
        <arg choice="plain"><option>--interface
67
 
        <replaceable>NAME</replaceable></option></arg>
68
 
        <arg choice="plain"><option>-i
69
 
        <replaceable>NAME</replaceable></option></arg>
70
 
      </group>
71
 
      <sbr/>
72
 
      <group>
73
 
        <arg choice="plain"><option>--address
74
 
        <replaceable>ADDRESS</replaceable></option></arg>
75
 
        <arg choice="plain"><option>-a
76
 
        <replaceable>ADDRESS</replaceable></option></arg>
77
 
      </group>
78
 
      <sbr/>
79
 
      <group>
80
 
        <arg choice="plain"><option>--port
81
 
        <replaceable>PORT</replaceable></option></arg>
82
 
        <arg choice="plain"><option>-p
83
 
        <replaceable>PORT</replaceable></option></arg>
84
 
      </group>
85
 
      <sbr/>
86
 
      <arg><option>--priority
87
 
      <replaceable>PRIORITY</replaceable></option></arg>
88
 
      <sbr/>
89
 
      <arg><option>--servicename
90
 
      <replaceable>NAME</replaceable></option></arg>
91
 
      <sbr/>
92
 
      <arg><option>--configdir
93
 
      <replaceable>DIRECTORY</replaceable></option></arg>
94
 
      <sbr/>
95
 
      <arg><option>--debug</option></arg>
96
 
      <sbr/>
97
 
      <arg><option>--debuglevel
98
 
      <replaceable>LEVEL</replaceable></option></arg>
99
 
      <sbr/>
100
 
      <arg><option>--no-dbus</option></arg>
101
 
      <sbr/>
102
 
      <arg><option>--no-ipv6</option></arg>
103
 
      <sbr/>
104
 
      <arg><option>--no-restore</option></arg>
105
 
      <sbr/>
106
 
      <arg><option>--statedir
107
 
      <replaceable>DIRECTORY</replaceable></option></arg>
108
 
      <sbr/>
109
 
      <arg><option>--socket
110
 
      <replaceable>FD</replaceable></option></arg>
111
 
      <sbr/>
112
 
      <arg><option>--foreground</option></arg>
113
 
      <sbr/>
114
 
      <arg><option>--no-zeroconf</option></arg>
 
75
      <arg>--interface<arg choice="plain">IF</arg></arg>
 
76
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
 
77
      <arg>--port<arg choice="plain">PORT</arg></arg>
 
78
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
 
79
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
 
80
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
81
      <arg>--debug</arg>
 
82
    </cmdsynopsis>
 
83
    <cmdsynopsis>
 
84
      <command>&COMMANDNAME;</command>
 
85
      <arg>-i<arg choice="plain">IF</arg></arg>
 
86
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
 
87
      <arg>-p<arg choice="plain">PORT</arg></arg>
 
88
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
 
89
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
 
90
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
91
      <arg>--debug</arg>
115
92
    </cmdsynopsis>
116
93
    <cmdsynopsis>
117
94
      <command>&COMMANDNAME;</command>
118
95
      <group choice="req">
119
 
        <arg choice="plain"><option>--help</option></arg>
120
 
        <arg choice="plain"><option>-h</option></arg>
 
96
        <arg choice="plain">-h</arg>
 
97
        <arg choice="plain">--help</arg>
121
98
      </group>
122
99
    </cmdsynopsis>
123
100
    <cmdsynopsis>
124
101
      <command>&COMMANDNAME;</command>
125
 
      <arg choice="plain"><option>--version</option></arg>
 
102
      <arg choice="plain">--version</arg>
126
103
    </cmdsynopsis>
127
104
    <cmdsynopsis>
128
105
      <command>&COMMANDNAME;</command>
129
 
      <arg choice="plain"><option>--check</option></arg>
 
106
      <arg choice="plain">--check</arg>
130
107
    </cmdsynopsis>
131
108
  </refsynopsisdiv>
132
 
  
 
109
 
133
110
  <refsect1 id="description">
134
111
    <title>DESCRIPTION</title>
135
112
    <para>
136
113
      <command>&COMMANDNAME;</command> is a server daemon which
137
114
      handles incoming request for passwords for a pre-defined list of
138
 
      client host computers. For an introduction, see
139
 
      <citerefentry><refentrytitle>intro</refentrytitle>
140
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
141
 
      uses Zeroconf to announce itself on the local network, and uses
142
 
      TLS to communicate securely with and to authenticate the
143
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
144
 
      use IPv6 link-local addresses, since the clients will probably
145
 
      not have any other addresses configured (see <xref
146
 
      linkend="overview"/>).  Any authenticated client is then given
147
 
      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.
148
123
    </para>
 
124
 
149
125
  </refsect1>
150
126
  
151
127
  <refsect1 id="purpose">
152
128
    <title>PURPOSE</title>
 
129
 
153
130
    <para>
154
131
      The purpose of this is to enable <emphasis>remote and unattended
155
132
      rebooting</emphasis> of client host computer with an
156
133
      <emphasis>encrypted root file system</emphasis>.  See <xref
157
134
      linkend="overview"/> for details.
158
135
    </para>
 
136
 
159
137
  </refsect1>
160
138
  
161
139
  <refsect1 id="options">
162
140
    <title>OPTIONS</title>
 
141
 
163
142
    <variablelist>
164
143
      <varlistentry>
165
 
        <term><option>--help</option></term>
166
 
        <term><option>-h</option></term>
 
144
        <term><literal>-h</literal>, <literal>--help</literal></term>
167
145
        <listitem>
168
146
          <para>
169
147
            Show a help message and exit
170
148
          </para>
171
149
        </listitem>
172
150
      </varlistentry>
173
 
      
 
151
 
174
152
      <varlistentry>
175
 
        <term><option>--interface</option>
176
 
        <replaceable>NAME</replaceable></term>
177
 
        <term><option>-i</option>
178
 
        <replaceable>NAME</replaceable></term>
 
153
        <term><literal>-i</literal>, <literal>--interface <replaceable>
 
154
        IF</replaceable></literal></term>
179
155
        <listitem>
180
156
          <xi:include href="mandos-options.xml" xpointer="interface"/>
181
157
        </listitem>
182
158
      </varlistentry>
183
 
      
 
159
 
184
160
      <varlistentry>
185
 
        <term><option>--address
186
 
        <replaceable>ADDRESS</replaceable></option></term>
187
 
        <term><option>-a
188
 
        <replaceable>ADDRESS</replaceable></option></term>
 
161
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
162
        ADDRESS</replaceable></literal></term>
189
163
        <listitem>
190
164
          <xi:include href="mandos-options.xml" xpointer="address"/>
191
165
        </listitem>
192
166
      </varlistentry>
193
 
      
 
167
 
194
168
      <varlistentry>
195
 
        <term><option>--port
196
 
        <replaceable>PORT</replaceable></option></term>
197
 
        <term><option>-p
198
 
        <replaceable>PORT</replaceable></option></term>
 
169
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
170
        PORT</replaceable></literal></term>
199
171
        <listitem>
200
172
          <xi:include href="mandos-options.xml" xpointer="port"/>
201
173
        </listitem>
202
174
      </varlistentry>
203
 
      
 
175
 
204
176
      <varlistentry>
205
 
        <term><option>--check</option></term>
 
177
        <term><literal>--check</literal></term>
206
178
        <listitem>
207
179
          <para>
208
180
            Run the server’s self-tests.  This includes any unit
210
182
          </para>
211
183
        </listitem>
212
184
      </varlistentry>
213
 
      
 
185
 
214
186
      <varlistentry>
215
 
        <term><option>--debug</option></term>
 
187
        <term><literal>--debug</literal></term>
216
188
        <listitem>
217
189
          <xi:include href="mandos-options.xml" xpointer="debug"/>
218
190
        </listitem>
219
191
      </varlistentry>
220
 
      
221
 
      <varlistentry>
222
 
        <term><option>--debuglevel
223
 
        <replaceable>LEVEL</replaceable></option></term>
224
 
        <listitem>
225
 
          <para>
226
 
            Set the debugging log level.
227
 
            <replaceable>LEVEL</replaceable> is a string, one of
228
 
            <quote><literal>CRITICAL</literal></quote>,
229
 
            <quote><literal>ERROR</literal></quote>,
230
 
            <quote><literal>WARNING</literal></quote>,
231
 
            <quote><literal>INFO</literal></quote>, or
232
 
            <quote><literal>DEBUG</literal></quote>, in order of
233
 
            increasing verbosity.  The default level is
234
 
            <quote><literal>WARNING</literal></quote>.
235
 
          </para>
236
 
        </listitem>
237
 
      </varlistentry>
238
 
      
239
 
      <varlistentry>
240
 
        <term><option>--priority <replaceable>
241
 
        PRIORITY</replaceable></option></term>
 
192
 
 
193
      <varlistentry>
 
194
        <term><literal>--priority <replaceable>
 
195
        PRIORITY</replaceable></literal></term>
242
196
        <listitem>
243
197
          <xi:include href="mandos-options.xml" xpointer="priority"/>
244
198
        </listitem>
245
199
      </varlistentry>
246
 
      
 
200
 
247
201
      <varlistentry>
248
 
        <term><option>--servicename
249
 
        <replaceable>NAME</replaceable></option></term>
 
202
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
203
        </literal></term>
250
204
        <listitem>
251
205
          <xi:include href="mandos-options.xml"
252
206
                      xpointer="servicename"/>
253
207
        </listitem>
254
208
      </varlistentry>
255
 
      
 
209
 
256
210
      <varlistentry>
257
 
        <term><option>--configdir
258
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
211
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
212
        </literal></term>
259
213
        <listitem>
260
214
          <para>
261
215
            Directory to search for configuration files.  Default is
267
221
          </para>
268
222
        </listitem>
269
223
      </varlistentry>
270
 
      
 
224
 
271
225
      <varlistentry>
272
 
        <term><option>--version</option></term>
 
226
        <term><literal>--version</literal></term>
273
227
        <listitem>
274
228
          <para>
275
229
            Prints the program version and exit.
276
230
          </para>
277
231
        </listitem>
278
232
      </varlistentry>
279
 
      
280
 
      <varlistentry>
281
 
        <term><option>--no-dbus</option></term>
282
 
        <listitem>
283
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
284
 
          <para>
285
 
            See also <xref linkend="dbus_interface"/>.
286
 
          </para>
287
 
        </listitem>
288
 
      </varlistentry>
289
 
      
290
 
      <varlistentry>
291
 
        <term><option>--no-ipv6</option></term>
292
 
        <listitem>
293
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
294
 
        </listitem>
295
 
      </varlistentry>
296
 
      
297
 
      <varlistentry>
298
 
        <term><option>--no-restore</option></term>
299
 
        <listitem>
300
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
301
 
          <para>
302
 
            See also <xref linkend="persistent_state"/>.
303
 
          </para>
304
 
        </listitem>
305
 
      </varlistentry>
306
 
      
307
 
      <varlistentry>
308
 
        <term><option>--statedir
309
 
        <replaceable>DIRECTORY</replaceable></option></term>
310
 
        <listitem>
311
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
312
 
        </listitem>
313
 
      </varlistentry>
314
 
      
315
 
      <varlistentry>
316
 
        <term><option>--socket
317
 
        <replaceable>FD</replaceable></option></term>
318
 
        <listitem>
319
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
320
 
        </listitem>
321
 
      </varlistentry>
322
 
      
323
 
      <varlistentry>
324
 
        <term><option>--foreground</option></term>
325
 
        <listitem>
326
 
          <xi:include href="mandos-options.xml"
327
 
                      xpointer="foreground"/>
328
 
        </listitem>
329
 
      </varlistentry>
330
 
      
331
 
      <varlistentry>
332
 
        <term><option>--no-zeroconf</option></term>
333
 
        <listitem>
334
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
335
 
        </listitem>
336
 
      </varlistentry>
337
 
      
338
233
    </variablelist>
339
234
  </refsect1>
340
 
  
 
235
 
341
236
  <refsect1 id="overview">
342
237
    <title>OVERVIEW</title>
343
238
    <xi:include href="overview.xml"/>
344
239
    <para>
345
240
      This program is the server part.  It is a normal server program
346
241
      and will run in a normal system environment, not in an initial
347
 
      <acronym>RAM</acronym> disk environment.
 
242
      RAM disk environment.
348
243
    </para>
349
244
  </refsect1>
350
 
  
 
245
 
351
246
  <refsect1 id="protocol">
352
247
    <title>NETWORK PROTOCOL</title>
353
248
    <para>
379
274
        <entry>-><!-- &rarr; --></entry>
380
275
      </row>
381
276
      <row>
382
 
        <entry><quote><literal>1\r\n</literal></quote></entry>
 
277
        <entry><quote><literal>1\r\en</literal></quote></entry>
383
278
        <entry>-><!-- &rarr; --></entry>
384
279
      </row>
385
280
      <row>
405
300
      </row>
406
301
    </tbody></tgroup></table>
407
302
  </refsect1>
408
 
  
 
303
 
409
304
  <refsect1 id="checking">
410
305
    <title>CHECKING</title>
411
306
    <para>
412
307
      The server will, by default, continually check that the clients
413
308
      are still up.  If a client has not been confirmed as being up
414
309
      for some time, the client is assumed to be compromised and is no
415
 
      longer eligible to receive the encrypted password.  (Manual
416
 
      intervention is required to re-enable a client.)  The timeout,
417
 
      extended timeout, checker program, and interval between checks
418
 
      can be configured both globally and per client; see
419
 
      <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.conf</refentrytitle>
 
314
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
 
315
      <refentrytitle>mandos-clients.conf</refentrytitle>
420
316
      <manvolnum>5</manvolnum></citerefentry>.
421
317
    </para>
422
318
  </refsect1>
423
 
  
424
 
  <refsect1 id="approval">
425
 
    <title>APPROVAL</title>
426
 
    <para>
427
 
      The server can be configured to require manual approval for a
428
 
      client before it is sent its secret.  The delay to wait for such
429
 
      approval and the default action (approve or deny) can be
430
 
      configured both globally and per client; see <citerefentry>
431
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
432
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
433
 
      will be approved immediately without delay.
434
 
    </para>
435
 
    <para>
436
 
      This can be used to deny a client its secret if not manually
437
 
      approved within a specified time.  It can also be used to make
438
 
      the server delay before giving a client its secret, allowing
439
 
      optional manual denying of this specific client.
440
 
    </para>
441
 
    
442
 
  </refsect1>
443
 
  
 
319
 
444
320
  <refsect1 id="logging">
445
321
    <title>LOGGING</title>
446
322
    <para>
447
 
      The server will send log message with various severity levels to
448
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
323
      The server will send log messaged with various severity levels
 
324
      to <filename>/dev/log</filename>.  With the
449
325
      <option>--debug</option> option, it will log even more messages,
450
326
      and also show them on the console.
451
327
    </para>
452
328
  </refsect1>
453
 
  
454
 
  <refsect1 id="persistent_state">
455
 
    <title>PERSISTENT STATE</title>
456
 
    <para>
457
 
      Client settings, initially read from
458
 
      <filename>clients.conf</filename>, are persistent across
459
 
      restarts, and run-time changes will override settings in
460
 
      <filename>clients.conf</filename>.  However, if a setting is
461
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
462
 
      <filename>clients.conf</filename>, this will take precedence.
463
 
    </para>
464
 
  </refsect1>
465
 
  
466
 
  <refsect1 id="dbus_interface">
467
 
    <title>D-BUS INTERFACE</title>
468
 
    <para>
469
 
      The server will by default provide a D-Bus system bus interface.
470
 
      This interface will only be accessible by the root user or a
471
 
      Mandos-specific user, if such a user exists.  For documentation
472
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
473
 
    </para>
474
 
  </refsect1>
475
 
  
 
329
 
476
330
  <refsect1 id="exit_status">
477
331
    <title>EXIT STATUS</title>
478
332
    <para>
480
334
      critical error is encountered.
481
335
    </para>
482
336
  </refsect1>
483
 
  
 
337
 
484
338
  <refsect1 id="environment">
485
339
    <title>ENVIRONMENT</title>
486
340
    <variablelist>
487
341
      <varlistentry>
488
 
        <term><envar>PATH</envar></term>
 
342
        <term><varname>PATH</varname></term>
489
343
        <listitem>
490
344
          <para>
491
345
            To start the configured checker (see <xref
494
348
            <varname>PATH</varname> to search for matching commands if
495
349
            an absolute path is not given.  See <citerefentry>
496
350
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
497
 
            </citerefentry>.
 
351
          </citerefentry>
498
352
          </para>
499
353
        </listitem>
500
354
      </varlistentry>
501
355
    </variablelist>
502
356
  </refsect1>
503
 
  
504
 
  <refsect1 id="files">
 
357
 
 
358
  <refsect1 id="file">
505
359
    <title>FILES</title>
506
360
    <para>
507
361
      Use the <option>--configdir</option> option to change where
530
384
        </listitem>
531
385
      </varlistentry>
532
386
      <varlistentry>
533
 
        <term><filename>/run/mandos.pid</filename></term>
534
 
        <listitem>
535
 
          <para>
536
 
            The file containing the process id of the
537
 
            <command>&COMMANDNAME;</command> process started last.
538
 
            <emphasis >Note:</emphasis> If the <filename
539
 
            class="directory">/run</filename> directory does not
540
 
            exist, <filename>/var/run/mandos.pid</filename> will be
541
 
            used instead.
542
 
          </para>
543
 
        </listitem>
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.
553
 
          </para>
554
 
        </listitem>
555
 
      </varlistentry>
556
 
      <varlistentry>
557
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
387
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
388
        <listitem>
 
389
          <para>
 
390
            The file containing the process id of
 
391
            <command>&COMMANDNAME;</command>.
 
392
          </para>
 
393
        </listitem>
 
394
      </varlistentry>
 
395
      <varlistentry>
 
396
        <term><filename>/dev/log</filename></term>
558
397
        <listitem>
559
398
          <para>
560
399
            The Unix domain socket to where local syslog messages are
583
422
      backtrace.  This could be considered a feature.
584
423
    </para>
585
424
    <para>
 
425
      Currently, if a client is declared <quote>invalid</quote> due to
 
426
      having timed out, the server does not record this fact onto
 
427
      permanent storage.  This has some security implications, see
 
428
      <xref linkend="CLIENTS"/>.
 
429
    </para>
 
430
    <para>
 
431
      There is currently no way of querying the server of the current
 
432
      status of clients, other than analyzing its <systemitem
 
433
      class="service">syslog</systemitem> output.
 
434
    </para>
 
435
    <para>
586
436
      There is no fine-grained control over logging and debug output.
587
437
    </para>
588
438
    <para>
589
 
      This server does not check the expire time of clients’ OpenPGP
590
 
      keys.
591
 
    </para>
592
 
    <xi:include href="bugs.xml"/>
 
439
      Debug mode is conflated with running in the foreground.
 
440
    </para>
 
441
    <para>
 
442
      The console log messages does not show a timestamp.
 
443
    </para>
593
444
  </refsect1>
594
445
  
595
446
  <refsect1 id="example">
599
450
        Normal invocation needs no options:
600
451
      </para>
601
452
      <para>
602
 
        <userinput>&COMMANDNAME;</userinput>
 
453
        <userinput>mandos</userinput>
603
454
      </para>
604
455
    </informalexample>
605
456
    <informalexample>
606
457
      <para>
607
458
        Run the server in debug mode, read configuration files from
608
 
        the <filename class="directory">~/mandos</filename> directory,
609
 
        and use the Zeroconf service name <quote>Test</quote> to not
610
 
        collide with any other official Mandos server on this host:
 
459
        the <filename>~/mandos</filename> directory, and use the
 
460
        Zeroconf service name <quote>Test</quote> to not collide with
 
461
        any other official Mandos server on this host:
611
462
      </para>
612
463
      <para>
613
464
 
614
465
<!-- do not wrap this line -->
615
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
466
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
616
467
 
617
468
      </para>
618
469
    </informalexample>
624
475
      <para>
625
476
 
626
477
<!-- do not wrap this line -->
627
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
478
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
628
479
 
629
480
      </para>
630
481
    </informalexample>
631
482
  </refsect1>
632
 
  
 
483
 
633
484
  <refsect1 id="security">
634
485
    <title>SECURITY</title>
635
 
    <refsect2 id="server">
 
486
    <refsect2 id="SERVER">
636
487
      <title>SERVER</title>
637
488
      <para>
638
489
        Running this <command>&COMMANDNAME;</command> server program
639
490
        should not in itself present any security risk to the host
640
 
        computer running it.  The program switches to a non-root user
641
 
        soon after startup.
 
491
        computer running it.  The program does not need any special
 
492
        privileges to run, and is designed to run as a non-root user.
642
493
      </para>
643
494
    </refsect2>
644
 
    <refsect2 id="clients">
 
495
    <refsect2 id="CLIENTS">
645
496
      <title>CLIENTS</title>
646
497
      <para>
647
498
        The server only gives out its stored data to clients which
654
505
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
655
506
        <manvolnum>5</manvolnum></citerefentry>)
656
507
        <emphasis>must</emphasis> be made non-readable by anyone
657
 
        except the user starting the server (usually root).
 
508
        except the user running the server.
658
509
      </para>
659
510
      <para>
660
511
        As detailed in <xref linkend="checking"/>, the status of all
662
513
        compromised if they are gone for too long.
663
514
      </para>
664
515
      <para>
 
516
        If a client is compromised, its downtime should be duly noted
 
517
        by the server which would therefore declare the client
 
518
        invalid.  But if the server was ever restarted, it would
 
519
        re-read its client list from its configuration file and again
 
520
        regard all clients therein as valid, and hence eligible to
 
521
        receive their passwords.  Therefore, be careful when
 
522
        restarting servers if it is suspected that a client has, in
 
523
        fact, been compromised by parties who may now be running a
 
524
        fake Mandos client with the keys from the non-encrypted
 
525
        initial RAM image of the client host.  What should be done in
 
526
        that case (if restarting the server program really is
 
527
        necessary) is to stop the server program, edit the
 
528
        configuration file to omit any suspect clients, and restart
 
529
        the server program.
 
530
      </para>
 
531
      <para>
665
532
        For more details on client-side security, see
666
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
533
        <citerefentry><refentrytitle>password-request</refentrytitle>
667
534
        <manvolnum>8mandos</manvolnum></citerefentry>.
668
535
      </para>
669
536
    </refsect2>
670
537
  </refsect1>
671
 
  
 
538
 
672
539
  <refsect1 id="see_also">
673
540
    <title>SEE ALSO</title>
674
 
    <para>
675
 
      <citerefentry><refentrytitle>intro</refentrytitle>
676
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
677
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
678
 
      <manvolnum>5</manvolnum></citerefentry>,
679
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
680
 
      <manvolnum>5</manvolnum></citerefentry>,
681
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
682
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
683
 
      <citerefentry><refentrytitle>sh</refentrytitle>
684
 
      <manvolnum>1</manvolnum></citerefentry>
685
 
    </para>
686
541
    <variablelist>
687
542
      <varlistentry>
688
543
        <term>
 
544
          <citerefentry>
 
545
            <refentrytitle>password-request</refentrytitle>
 
546
            <manvolnum>8mandos</manvolnum>
 
547
          </citerefentry>
 
548
        </term>
 
549
        <listitem>
 
550
          <para>
 
551
            This is the actual program which talks to this server.
 
552
            Note that it is normally not invoked directly, and is only
 
553
            run in the initial RAM disk environment, and not on a
 
554
            fully started system.
 
555
          </para>
 
556
        </listitem>
 
557
      </varlistentry>
 
558
      <varlistentry>
 
559
        <term>
689
560
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
690
561
        </term>
691
562
        <listitem>
708
579
      </varlistentry>
709
580
      <varlistentry>
710
581
        <term>
711
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
582
          <ulink
 
583
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
712
584
        </term>
713
585
      <listitem>
714
586
        <para>
720
592
      </varlistentry>
721
593
      <varlistentry>
722
594
        <term>
723
 
          RFC 4291: <citetitle>IP Version 6 Addressing
724
 
          Architecture</citetitle>
 
595
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
 
596
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
 
597
          Unicast Addresses</citation>
725
598
        </term>
726
599
        <listitem>
727
 
          <variablelist>
728
 
            <varlistentry>
729
 
              <term>Section 2.2: <citetitle>Text Representation of
730
 
              Addresses</citetitle></term>
731
 
              <listitem><para/></listitem>
732
 
            </varlistentry>
733
 
            <varlistentry>
734
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
735
 
              Address</citetitle></term>
736
 
              <listitem><para/></listitem>
737
 
            </varlistentry>
738
 
            <varlistentry>
739
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
740
 
            Addresses</citetitle></term>
741
 
            <listitem>
742
 
              <para>
743
 
                The clients use IPv6 link-local addresses, which are
744
 
                immediately usable since a link-local addresses is
745
 
                automatically assigned to a network interfaces when it
746
 
                is brought up.
747
 
              </para>
748
 
            </listitem>
749
 
            </varlistentry>
750
 
          </variablelist>
 
600
          <para>
 
601
            The clients use IPv6 link-local addresses, which are
 
602
            immediately usable since a link-local addresses is
 
603
            automatically assigned to a network interfaces when it is
 
604
            brought up.
 
605
          </para>
751
606
        </listitem>
752
607
      </varlistentry>
753
608
      <varlistentry>
754
609
        <term>
755
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
756
 
          Protocol Version 1.2</citetitle>
 
610
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
611
          (TLS) Protocol Version 1.1</citetitle></citation>
757
612
        </term>
758
613
      <listitem>
759
614
        <para>
760
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
615
          TLS 1.1 is the protocol implemented by GnuTLS.
761
616
        </para>
762
617
      </listitem>
763
618
      </varlistentry>
764
619
      <varlistentry>
765
620
        <term>
766
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
621
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
622
          Format</citetitle></citation>
767
623
        </term>
768
624
      <listitem>
769
625
        <para>
773
629
      </varlistentry>
774
630
      <varlistentry>
775
631
        <term>
776
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
777
 
          Security (TLS) Authentication</citetitle>
 
632
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
633
          Transport Layer Security</citetitle></citation>
778
634
        </term>
779
635
      <listitem>
780
636
        <para>
786
642
    </variablelist>
787
643
  </refsect1>
788
644
</refentry>
789
 
<!-- Local Variables: -->
790
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
791
 
<!-- time-stamp-end: "[\"']>" -->
792
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
793
 
<!-- End: -->