/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: 2016-02-28 14:22:10 UTC
  • Revision ID: teddy@recompile.se-20160228142210-2df89dih7mzxxr0h
Update copyright year.

* DBUS-API: Update copyright year.
* debian/copyright: - '' -
* intro.xml (COPYRIGHT): - '' -
* mandos: - '' -
* mandos-clients.conf.xml (COPYRIGHT): - '' -
* mandos-ctl: - '' -
* mandos-ctl.xml (COPYRIGHT): - '' -
* mandos-keygen: - '' -
* mandos-keygen.xml (COPYRIGHT): - '' -
* mandos-monitor: - '' -
* mandos-monitor.xml (COPYRIGHT): - '' -
* mandos.conf.xml (COPYRIGHT): - '' -
* mandos.xml (COPYRIGHT): - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: - '' -
* plugin-runner.c: - '' -
* plugin-runner.xml (COPYRIGHT): - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/askpass-fifo.xml (COPYRIGHT): - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/mandos-client.xml (COPYRIGHT): - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/password-prompt.xml (COPYRIGHT): - ''
* plugins.d/plymouth.c: - '' -
* plugins.d/plymouth.xml (COPYRIGHT): - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/splashy.xml (COPYRIGHT): - '' -
* plugins.d/usplash.c: - '' -
* plugins.d/usplash.xml (COPYRIGHT): - '' -

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">
5
4
<!ENTITY COMMANDNAME "mandos">
 
5
<!ENTITY TIMESTAMP "2016-02-28">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
6
8
]>
7
9
 
8
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
9
 
  <refentryinfo>
10
 
    <title>&COMMANDNAME;</title>
 
11
   <refentryinfo>
 
12
    <title>Mandos Manual</title>
11
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
12
 
    <productname>&COMMANDNAME;</productname>
13
 
    <productnumber>&VERSION;</productnumber>
 
14
    <productname>Mandos</productname>
 
15
    <productnumber>&version;</productnumber>
 
16
    <date>&TIMESTAMP;</date>
14
17
    <authorgroup>
15
18
      <author>
16
19
        <firstname>Björn</firstname>
17
20
        <surname>Påhlsson</surname>
18
21
        <address>
19
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
20
23
        </address>
21
24
      </author>
22
25
      <author>
23
26
        <firstname>Teddy</firstname>
24
27
        <surname>Hogeborn</surname>
25
28
        <address>
26
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
27
30
        </address>
28
31
      </author>
29
32
    </authorgroup>
30
33
    <copyright>
31
34
      <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>
32
43
      <holder>Teddy Hogeborn</holder>
33
44
      <holder>Björn Påhlsson</holder>
34
45
    </copyright>
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>
 
46
    <xi:include href="legalnotice.xml"/>
58
47
  </refentryinfo>
59
 
 
 
48
  
60
49
  <refmeta>
61
50
    <refentrytitle>&COMMANDNAME;</refentrytitle>
62
51
    <manvolnum>8</manvolnum>
65
54
  <refnamediv>
66
55
    <refname><command>&COMMANDNAME;</command></refname>
67
56
    <refpurpose>
68
 
      Sends encrypted passwords to authenticated Mandos clients
 
57
      Gives encrypted passwords to authenticated Mandos clients
69
58
    </refpurpose>
70
59
  </refnamediv>
71
 
 
 
60
  
72
61
  <refsynopsisdiv>
73
62
    <cmdsynopsis>
74
63
      <command>&COMMANDNAME;</command>
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>
 
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>
92
114
    </cmdsynopsis>
93
115
    <cmdsynopsis>
94
116
      <command>&COMMANDNAME;</command>
95
117
      <group choice="req">
96
 
        <arg choice="plain">-h</arg>
97
 
        <arg choice="plain">--help</arg>
 
118
        <arg choice="plain"><option>--help</option></arg>
 
119
        <arg choice="plain"><option>-h</option></arg>
98
120
      </group>
99
121
    </cmdsynopsis>
100
122
    <cmdsynopsis>
101
123
      <command>&COMMANDNAME;</command>
102
 
      <arg choice="plain">--version</arg>
 
124
      <arg choice="plain"><option>--version</option></arg>
103
125
    </cmdsynopsis>
104
126
    <cmdsynopsis>
105
127
      <command>&COMMANDNAME;</command>
106
 
      <arg choice="plain">--check</arg>
 
128
      <arg choice="plain"><option>--check</option></arg>
107
129
    </cmdsynopsis>
108
130
  </refsynopsisdiv>
109
 
 
 
131
  
110
132
  <refsect1 id="description">
111
133
    <title>DESCRIPTION</title>
112
134
    <para>
113
135
      <command>&COMMANDNAME;</command> is a server daemon which
114
136
      handles incoming request for passwords for a pre-defined list of
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.
 
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.
123
147
    </para>
124
 
 
125
148
  </refsect1>
126
149
  
127
150
  <refsect1 id="purpose">
128
151
    <title>PURPOSE</title>
129
 
 
130
152
    <para>
131
153
      The purpose of this is to enable <emphasis>remote and unattended
132
154
      rebooting</emphasis> of client host computer with an
133
155
      <emphasis>encrypted root file system</emphasis>.  See <xref
134
156
      linkend="overview"/> for details.
135
157
    </para>
136
 
 
137
158
  </refsect1>
138
159
  
139
160
  <refsect1 id="options">
140
161
    <title>OPTIONS</title>
141
 
 
142
162
    <variablelist>
143
163
      <varlistentry>
144
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
164
        <term><option>--help</option></term>
 
165
        <term><option>-h</option></term>
145
166
        <listitem>
146
167
          <para>
147
168
            Show a help message and exit
148
169
          </para>
149
170
        </listitem>
150
171
      </varlistentry>
151
 
 
 
172
      
152
173
      <varlistentry>
153
 
        <term><literal>-i</literal>, <literal>--interface <replaceable
154
 
        >NAME</replaceable></literal></term>
 
174
        <term><option>--interface</option>
 
175
        <replaceable>NAME</replaceable></term>
 
176
        <term><option>-i</option>
 
177
        <replaceable>NAME</replaceable></term>
155
178
        <listitem>
156
179
          <xi:include href="mandos-options.xml" xpointer="interface"/>
157
180
        </listitem>
158
181
      </varlistentry>
159
 
 
 
182
      
160
183
      <varlistentry>
161
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
162
 
        ADDRESS</replaceable></literal></term>
 
184
        <term><option>--address
 
185
        <replaceable>ADDRESS</replaceable></option></term>
 
186
        <term><option>-a
 
187
        <replaceable>ADDRESS</replaceable></option></term>
163
188
        <listitem>
164
189
          <xi:include href="mandos-options.xml" xpointer="address"/>
165
190
        </listitem>
166
191
      </varlistentry>
167
 
 
 
192
      
168
193
      <varlistentry>
169
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
170
 
        PORT</replaceable></literal></term>
 
194
        <term><option>--port
 
195
        <replaceable>PORT</replaceable></option></term>
 
196
        <term><option>-p
 
197
        <replaceable>PORT</replaceable></option></term>
171
198
        <listitem>
172
199
          <xi:include href="mandos-options.xml" xpointer="port"/>
173
200
        </listitem>
174
201
      </varlistentry>
175
 
 
 
202
      
176
203
      <varlistentry>
177
 
        <term><literal>--check</literal></term>
 
204
        <term><option>--check</option></term>
178
205
        <listitem>
179
206
          <para>
180
207
            Run the server’s self-tests.  This includes any unit
182
209
          </para>
183
210
        </listitem>
184
211
      </varlistentry>
185
 
 
 
212
      
186
213
      <varlistentry>
187
 
        <term><literal>--debug</literal></term>
 
214
        <term><option>--debug</option></term>
188
215
        <listitem>
189
216
          <xi:include href="mandos-options.xml" xpointer="debug"/>
190
217
        </listitem>
191
218
      </varlistentry>
192
 
 
193
 
      <varlistentry>
194
 
        <term><literal>--priority <replaceable>
195
 
        PRIORITY</replaceable></literal></term>
 
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>
196
241
        <listitem>
197
242
          <xi:include href="mandos-options.xml" xpointer="priority"/>
198
243
        </listitem>
199
244
      </varlistentry>
200
 
 
 
245
      
201
246
      <varlistentry>
202
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
203
 
        </literal></term>
 
247
        <term><option>--servicename
 
248
        <replaceable>NAME</replaceable></option></term>
204
249
        <listitem>
205
250
          <xi:include href="mandos-options.xml"
206
251
                      xpointer="servicename"/>
207
252
        </listitem>
208
253
      </varlistentry>
209
 
 
 
254
      
210
255
      <varlistentry>
211
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
212
 
        </literal></term>
 
256
        <term><option>--configdir
 
257
        <replaceable>DIRECTORY</replaceable></option></term>
213
258
        <listitem>
214
259
          <para>
215
260
            Directory to search for configuration files.  Default is
221
266
          </para>
222
267
        </listitem>
223
268
      </varlistentry>
224
 
 
 
269
      
225
270
      <varlistentry>
226
 
        <term><literal>--version</literal></term>
 
271
        <term><option>--version</option></term>
227
272
        <listitem>
228
273
          <para>
229
274
            Prints the program version and exit.
230
275
          </para>
231
276
        </listitem>
232
277
      </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
      
233
337
    </variablelist>
234
338
  </refsect1>
235
 
 
 
339
  
236
340
  <refsect1 id="overview">
237
341
    <title>OVERVIEW</title>
238
342
    <xi:include href="overview.xml"/>
239
343
    <para>
240
344
      This program is the server part.  It is a normal server program
241
345
      and will run in a normal system environment, not in an initial
242
 
      RAM disk environment.
 
346
      <acronym>RAM</acronym> disk environment.
243
347
    </para>
244
348
  </refsect1>
245
 
 
 
349
  
246
350
  <refsect1 id="protocol">
247
351
    <title>NETWORK PROTOCOL</title>
248
352
    <para>
300
404
      </row>
301
405
    </tbody></tgroup></table>
302
406
  </refsect1>
303
 
 
 
407
  
304
408
  <refsect1 id="checking">
305
409
    <title>CHECKING</title>
306
410
    <para>
307
411
      The server will, by default, continually check that the clients
308
412
      are still up.  If a client has not been confirmed as being up
309
413
      for some time, the client is assumed to be compromised and is no
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>
 
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>
 
419
      <manvolnum>5</manvolnum></citerefentry>.
 
420
    </para>
 
421
  </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>
313
430
      <refentrytitle>mandos-clients.conf</refentrytitle>
314
 
      <manvolnum>5</manvolnum></citerefentry>.
315
 
    </para>
 
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
    
316
441
  </refsect1>
317
 
 
 
442
  
318
443
  <refsect1 id="logging">
319
444
    <title>LOGGING</title>
320
445
    <para>
321
446
      The server will send log message with various severity levels to
322
 
      <filename>/dev/log</filename>.  With the
 
447
      <filename class="devicefile">/dev/log</filename>.  With the
323
448
      <option>--debug</option> option, it will log even more messages,
324
449
      and also show them on the console.
325
450
    </para>
326
451
  </refsect1>
327
 
 
 
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
  
328
475
  <refsect1 id="exit_status">
329
476
    <title>EXIT STATUS</title>
330
477
    <para>
332
479
      critical error is encountered.
333
480
    </para>
334
481
  </refsect1>
335
 
 
 
482
  
336
483
  <refsect1 id="environment">
337
484
    <title>ENVIRONMENT</title>
338
485
    <variablelist>
339
486
      <varlistentry>
340
 
        <term><varname>PATH</varname></term>
 
487
        <term><envar>PATH</envar></term>
341
488
        <listitem>
342
489
          <para>
343
490
            To start the configured checker (see <xref
352
499
      </varlistentry>
353
500
    </variablelist>
354
501
  </refsect1>
355
 
 
356
 
  <refsect1 id="file">
 
502
  
 
503
  <refsect1 id="files">
357
504
    <title>FILES</title>
358
505
    <para>
359
506
      Use the <option>--configdir</option> option to change where
382
529
        </listitem>
383
530
      </varlistentry>
384
531
      <varlistentry>
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>
 
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>
395
557
        <listitem>
396
558
          <para>
397
559
            The Unix domain socket to where local syslog messages are
420
582
      backtrace.  This could be considered a feature.
421
583
    </para>
422
584
    <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>
434
585
      There is no fine-grained control over logging and debug output.
435
586
    </para>
436
587
    <para>
437
 
      Debug mode is conflated with running in the foreground.
438
 
    </para>
439
 
    <para>
440
 
      The console log messages does not show a timestamp.
 
588
      This server does not check the expire time of clients’ OpenPGP
 
589
      keys.
441
590
    </para>
442
591
  </refsect1>
443
592
  
448
597
        Normal invocation needs no options:
449
598
      </para>
450
599
      <para>
451
 
        <userinput>mandos</userinput>
 
600
        <userinput>&COMMANDNAME;</userinput>
452
601
      </para>
453
602
    </informalexample>
454
603
    <informalexample>
455
604
      <para>
456
605
        Run the server in debug mode, read configuration files from
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:
 
606
        the <filename class="directory">~/mandos</filename> directory,
 
607
        and use the Zeroconf service name <quote>Test</quote> to not
 
608
        collide with any other official Mandos server on this host:
460
609
      </para>
461
610
      <para>
462
611
 
463
612
<!-- do not wrap this line -->
464
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
613
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
465
614
 
466
615
      </para>
467
616
    </informalexample>
473
622
      <para>
474
623
 
475
624
<!-- do not wrap this line -->
476
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
625
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
477
626
 
478
627
      </para>
479
628
    </informalexample>
480
629
  </refsect1>
481
 
 
 
630
  
482
631
  <refsect1 id="security">
483
632
    <title>SECURITY</title>
484
 
    <refsect2 id="SERVER">
 
633
    <refsect2 id="server">
485
634
      <title>SERVER</title>
486
635
      <para>
487
636
        Running this <command>&COMMANDNAME;</command> server program
488
637
        should not in itself present any security risk to the host
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.
 
638
        computer running it.  The program switches to a non-root user
 
639
        soon after startup.
491
640
      </para>
492
641
    </refsect2>
493
 
    <refsect2 id="CLIENTS">
 
642
    <refsect2 id="clients">
494
643
      <title>CLIENTS</title>
495
644
      <para>
496
645
        The server only gives out its stored data to clients which
503
652
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
504
653
        <manvolnum>5</manvolnum></citerefentry>)
505
654
        <emphasis>must</emphasis> be made non-readable by anyone
506
 
        except the user running the server.
 
655
        except the user starting the server (usually root).
507
656
      </para>
508
657
      <para>
509
658
        As detailed in <xref linkend="checking"/>, the status of all
511
660
        compromised if they are gone for too long.
512
661
      </para>
513
662
      <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>
530
663
        For more details on client-side security, see
531
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
664
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
532
665
        <manvolnum>8mandos</manvolnum></citerefentry>.
533
666
      </para>
534
667
    </refsect2>
535
668
  </refsect1>
536
 
 
 
669
  
537
670
  <refsect1 id="see_also">
538
671
    <title>SEE ALSO</title>
539
672
    <para>
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>
 
673
      <citerefentry><refentrytitle>intro</refentrytitle>
 
674
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
675
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
676
      <manvolnum>5</manvolnum></citerefentry>,
 
677
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
678
      <manvolnum>5</manvolnum></citerefentry>,
 
679
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
680
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
681
      <citerefentry><refentrytitle>sh</refentrytitle>
 
682
      <manvolnum>1</manvolnum></citerefentry>
549
683
    </para>
550
684
    <variablelist>
551
685
      <varlistentry>
572
706
      </varlistentry>
573
707
      <varlistentry>
574
708
        <term>
575
 
          <ulink
576
 
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
709
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
577
710
        </term>
578
711
      <listitem>
579
712
        <para>
585
718
      </varlistentry>
586
719
      <varlistentry>
587
720
        <term>
588
 
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
589
 
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
590
 
          Unicast Addresses</citation>
 
721
          RFC 4291: <citetitle>IP Version 6 Addressing
 
722
          Architecture</citetitle>
591
723
        </term>
592
724
        <listitem>
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>
 
725
          <variablelist>
 
726
            <varlistentry>
 
727
              <term>Section 2.2: <citetitle>Text Representation of
 
728
              Addresses</citetitle></term>
 
729
              <listitem><para/></listitem>
 
730
            </varlistentry>
 
731
            <varlistentry>
 
732
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
733
              Address</citetitle></term>
 
734
              <listitem><para/></listitem>
 
735
            </varlistentry>
 
736
            <varlistentry>
 
737
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
738
            Addresses</citetitle></term>
 
739
            <listitem>
 
740
              <para>
 
741
                The clients use IPv6 link-local addresses, which are
 
742
                immediately usable since a link-local addresses is
 
743
                automatically assigned to a network interfaces when it
 
744
                is brought up.
 
745
              </para>
 
746
            </listitem>
 
747
            </varlistentry>
 
748
          </variablelist>
599
749
        </listitem>
600
750
      </varlistentry>
601
751
      <varlistentry>
602
752
        <term>
603
 
          <citation>RFC 4346: <citetitle>The Transport Layer Security
604
 
          (TLS) Protocol Version 1.1</citetitle></citation>
 
753
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
754
          Protocol Version 1.2</citetitle>
605
755
        </term>
606
756
      <listitem>
607
757
        <para>
608
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
758
          TLS 1.2 is the protocol implemented by GnuTLS.
609
759
        </para>
610
760
      </listitem>
611
761
      </varlistentry>
612
762
      <varlistentry>
613
763
        <term>
614
 
          <citation>RFC 4880: <citetitle>OpenPGP Message
615
 
          Format</citetitle></citation>
 
764
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
616
765
        </term>
617
766
      <listitem>
618
767
        <para>
622
771
      </varlistentry>
623
772
      <varlistentry>
624
773
        <term>
625
 
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
626
 
          Transport Layer Security</citetitle></citation>
 
774
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
775
          Security (TLS) Authentication</citetitle>
627
776
        </term>
628
777
      <listitem>
629
778
        <para>
635
784
    </variablelist>
636
785
  </refsect1>
637
786
</refentry>
 
787
<!-- Local Variables: -->
 
788
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
789
<!-- time-stamp-end: "[\"']>" -->
 
790
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
791
<!-- End: -->