/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: 2025-06-27 19:56:23 UTC
  • Revision ID: teddy@recompile.se-20250627195623-02t2vap0gixox3mo
Update Debian Policy version to 4.7.2; no other changes necessary.

* debian/control (Standards-Version): Change to "4.7.2".

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