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