/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2019-07-07 20:50:21 UTC
  • mto: This revision was merged to the branch mainline in revision 384.
  • Revision ID: teddy@recompile.se-20190707205021-t1yscpsoobk2v29f
plugin-runner.c: Use a statement attribute only for GCC 7 or later.

* plugin-runner.c (main/parse_opt): Use __attribute__((fallthrough))
                                    only on GCC 7 or later; otherwise
                                    use the old comment syntax.

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">
6
 
<!ENTITY OVERVIEW SYSTEM "overview.xml">
 
5
<!ENTITY TIMESTAMP "2019-02-10">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
7
8
]>
8
9
 
9
 
<refentry>
10
 
  <refentryinfo>
11
 
    <title>&COMMANDNAME;</title>
 
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
11
   <refentryinfo>
 
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>&COMMANDNAME;</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
14
    <productname>Mandos</productname>
 
15
    <productnumber>&version;</productnumber>
 
16
    <date>&TIMESTAMP;</date>
15
17
    <authorgroup>
16
18
      <author>
17
19
        <firstname>Björn</firstname>
18
20
        <surname>Påhlsson</surname>
19
21
        <address>
20
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
21
23
        </address>
22
24
      </author>
23
25
      <author>
24
26
        <firstname>Teddy</firstname>
25
27
        <surname>Hogeborn</surname>
26
28
        <address>
27
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
28
30
        </address>
29
31
      </author>
30
32
    </authorgroup>
31
33
    <copyright>
32
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>
33
46
      <holder>Teddy Hogeborn</holder>
34
47
      <holder>Björn Påhlsson</holder>
35
48
    </copyright>
36
 
    <legalnotice>
37
 
      <para>
38
 
        This manual page is free software: you can redistribute it
39
 
        and/or modify it under the terms of the GNU General Public
40
 
        License as published by the Free Software Foundation,
41
 
        either version 3 of the License, or (at your option) any
42
 
        later version.
43
 
      </para>
44
 
 
45
 
      <para>
46
 
        This manual page is distributed in the hope that it will
47
 
        be useful, but WITHOUT ANY WARRANTY; without even the
48
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
49
 
        PARTICULAR PURPOSE.  See the GNU General Public License
50
 
        for more details.
51
 
      </para>
52
 
 
53
 
      <para>
54
 
        You should have received a copy of the GNU General Public
55
 
        License along with this program; If not, see
56
 
        <ulink url="http://www.gnu.org/licenses/"/>.
57
 
      </para>
58
 
    </legalnotice>
 
49
    <xi:include href="legalnotice.xml"/>
59
50
  </refentryinfo>
60
 
 
 
51
  
61
52
  <refmeta>
62
53
    <refentrytitle>&COMMANDNAME;</refentrytitle>
63
54
    <manvolnum>8</manvolnum>
66
57
  <refnamediv>
67
58
    <refname><command>&COMMANDNAME;</command></refname>
68
59
    <refpurpose>
69
 
      Sends encrypted passwords to authenticated Mandos clients
 
60
      Gives encrypted passwords to authenticated Mandos clients
70
61
    </refpurpose>
71
62
  </refnamediv>
72
 
 
 
63
  
73
64
  <refsynopsisdiv>
74
65
    <cmdsynopsis>
75
66
      <command>&COMMANDNAME;</command>
76
 
      <arg>--interface<arg choice="plain">IF</arg></arg>
77
 
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
78
 
      <arg>--port<arg choice="plain">PORT</arg></arg>
79
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
80
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
81
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
82
 
      <arg>--debug</arg>
83
 
    </cmdsynopsis>
84
 
    <cmdsynopsis>
85
 
      <command>&COMMANDNAME;</command>
86
 
      <arg>-i<arg choice="plain">IF</arg></arg>
87
 
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
88
 
      <arg>-p<arg choice="plain">PORT</arg></arg>
89
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
90
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
91
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
92
 
      <arg>--debug</arg>
 
67
      <group>
 
68
        <arg choice="plain"><option>--interface
 
69
        <replaceable>NAME</replaceable></option></arg>
 
70
        <arg choice="plain"><option>-i
 
71
        <replaceable>NAME</replaceable></option></arg>
 
72
      </group>
 
73
      <sbr/>
 
74
      <group>
 
75
        <arg choice="plain"><option>--address
 
76
        <replaceable>ADDRESS</replaceable></option></arg>
 
77
        <arg choice="plain"><option>-a
 
78
        <replaceable>ADDRESS</replaceable></option></arg>
 
79
      </group>
 
80
      <sbr/>
 
81
      <group>
 
82
        <arg choice="plain"><option>--port
 
83
        <replaceable>PORT</replaceable></option></arg>
 
84
        <arg choice="plain"><option>-p
 
85
        <replaceable>PORT</replaceable></option></arg>
 
86
      </group>
 
87
      <sbr/>
 
88
      <arg><option>--priority
 
89
      <replaceable>PRIORITY</replaceable></option></arg>
 
90
      <sbr/>
 
91
      <arg><option>--servicename
 
92
      <replaceable>NAME</replaceable></option></arg>
 
93
      <sbr/>
 
94
      <arg><option>--configdir
 
95
      <replaceable>DIRECTORY</replaceable></option></arg>
 
96
      <sbr/>
 
97
      <arg><option>--debug</option></arg>
 
98
      <sbr/>
 
99
      <arg><option>--debuglevel
 
100
      <replaceable>LEVEL</replaceable></option></arg>
 
101
      <sbr/>
 
102
      <arg><option>--no-dbus</option></arg>
 
103
      <sbr/>
 
104
      <arg><option>--no-ipv6</option></arg>
 
105
      <sbr/>
 
106
      <arg><option>--no-restore</option></arg>
 
107
      <sbr/>
 
108
      <arg><option>--statedir
 
109
      <replaceable>DIRECTORY</replaceable></option></arg>
 
110
      <sbr/>
 
111
      <arg><option>--socket
 
112
      <replaceable>FD</replaceable></option></arg>
 
113
      <sbr/>
 
114
      <arg><option>--foreground</option></arg>
 
115
      <sbr/>
 
116
      <arg><option>--no-zeroconf</option></arg>
93
117
    </cmdsynopsis>
94
118
    <cmdsynopsis>
95
119
      <command>&COMMANDNAME;</command>
96
120
      <group choice="req">
97
 
        <arg choice="plain">-h</arg>
98
 
        <arg choice="plain">--help</arg>
 
121
        <arg choice="plain"><option>--help</option></arg>
 
122
        <arg choice="plain"><option>-h</option></arg>
99
123
      </group>
100
124
    </cmdsynopsis>
101
125
    <cmdsynopsis>
102
126
      <command>&COMMANDNAME;</command>
103
 
      <arg choice="plain">--version</arg>
 
127
      <arg choice="plain"><option>--version</option></arg>
104
128
    </cmdsynopsis>
105
129
    <cmdsynopsis>
106
130
      <command>&COMMANDNAME;</command>
107
 
      <arg choice="plain">--check</arg>
 
131
      <arg choice="plain"><option>--check</option></arg>
108
132
    </cmdsynopsis>
109
133
  </refsynopsisdiv>
110
 
 
 
134
  
111
135
  <refsect1 id="description">
112
136
    <title>DESCRIPTION</title>
113
137
    <para>
114
138
      <command>&COMMANDNAME;</command> is a server daemon which
115
139
      handles incoming request for passwords for a pre-defined list of
116
 
      client host computers.  The Mandos server uses Zeroconf to
117
 
      announce itself on the local network, and uses TLS to
118
 
      communicate securely with and to authenticate the clients.  The
119
 
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
120
 
      link-local addresses, since the clients will probably not have
121
 
      any other addresses configured (see <xref linkend="overview"/>).
122
 
      Any authenticated client is then given the stored pre-encrypted
123
 
      password for that specific client.
 
140
      client host computers. For an introduction, see
 
141
      <citerefentry><refentrytitle>intro</refentrytitle>
 
142
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
143
      uses Zeroconf to announce itself on the local network, and uses
 
144
      TLS to communicate securely with and to authenticate the
 
145
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
146
      use IPv6 link-local addresses, since the clients will probably
 
147
      not have any other addresses configured (see <xref
 
148
      linkend="overview"/>).  Any authenticated client is then given
 
149
      the stored pre-encrypted password for that specific client.
124
150
    </para>
125
 
 
126
151
  </refsect1>
127
152
  
128
153
  <refsect1 id="purpose">
129
154
    <title>PURPOSE</title>
130
 
 
131
155
    <para>
132
156
      The purpose of this is to enable <emphasis>remote and unattended
133
157
      rebooting</emphasis> of client host computer with an
134
158
      <emphasis>encrypted root file system</emphasis>.  See <xref
135
159
      linkend="overview"/> for details.
136
160
    </para>
137
 
 
138
161
  </refsect1>
139
162
  
140
163
  <refsect1 id="options">
141
164
    <title>OPTIONS</title>
142
 
 
143
165
    <variablelist>
144
166
      <varlistentry>
145
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
167
        <term><option>--help</option></term>
 
168
        <term><option>-h</option></term>
146
169
        <listitem>
147
170
          <para>
148
171
            Show a help message and exit
149
172
          </para>
150
173
        </listitem>
151
174
      </varlistentry>
152
 
 
153
 
      <varlistentry>
154
 
        <term><literal>-i</literal>, <literal>--interface <replaceable>
155
 
        IF</replaceable></literal></term>
156
 
        <listitem>
157
 
          <para>
158
 
            Only announce the server and listen to requests on network
159
 
            interface <replaceable>IF</replaceable>.  Default is to
160
 
            use all available interfaces.  <emphasis>Note:</emphasis>
161
 
            a failure to bind to the specified interface is not
162
 
            considered critical, and the server does not exit.
163
 
          </para>
164
 
        </listitem>
165
 
      </varlistentry>
166
 
 
167
 
      <varlistentry>
168
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
169
 
        ADDRESS</replaceable></literal></term>
170
 
        <listitem>
171
 
          <para>
172
 
            If this option is used, the server will only listen to a
173
 
            specific address.  This must currently be an IPv6 address;
174
 
            an IPv4 address can be specified using the
175
 
            <quote><literal>::FFFF:192.0.2.3</literal></quote> syntax.
176
 
            Also, if a link-local address is specified, an interface
177
 
            should be set, since a link-local address is only valid on
178
 
            a single interface.  By default, the server will listen to
179
 
            all available addresses.
180
 
          </para>
181
 
        </listitem>
182
 
      </varlistentry>
183
 
 
184
 
      <varlistentry>
185
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
186
 
        PORT</replaceable></literal></term>
187
 
        <listitem>
188
 
          <para>
189
 
            If this option is used, the server to bind to that
190
 
            port. By default, the server will listen to an arbitrary
191
 
            port given by the operating system.
192
 
          </para>
193
 
        </listitem>
194
 
      </varlistentry>
195
 
 
196
 
      <varlistentry>
197
 
        <term><literal>--check</literal></term>
 
175
      
 
176
      <varlistentry>
 
177
        <term><option>--interface</option>
 
178
        <replaceable>NAME</replaceable></term>
 
179
        <term><option>-i</option>
 
180
        <replaceable>NAME</replaceable></term>
 
181
        <listitem>
 
182
          <xi:include href="mandos-options.xml" xpointer="interface"/>
 
183
        </listitem>
 
184
      </varlistentry>
 
185
      
 
186
      <varlistentry>
 
187
        <term><option>--address
 
188
        <replaceable>ADDRESS</replaceable></option></term>
 
189
        <term><option>-a
 
190
        <replaceable>ADDRESS</replaceable></option></term>
 
191
        <listitem>
 
192
          <xi:include href="mandos-options.xml" xpointer="address"/>
 
193
        </listitem>
 
194
      </varlistentry>
 
195
      
 
196
      <varlistentry>
 
197
        <term><option>--port
 
198
        <replaceable>PORT</replaceable></option></term>
 
199
        <term><option>-p
 
200
        <replaceable>PORT</replaceable></option></term>
 
201
        <listitem>
 
202
          <xi:include href="mandos-options.xml" xpointer="port"/>
 
203
        </listitem>
 
204
      </varlistentry>
 
205
      
 
206
      <varlistentry>
 
207
        <term><option>--check</option></term>
198
208
        <listitem>
199
209
          <para>
200
210
            Run the server’s self-tests.  This includes any unit
202
212
          </para>
203
213
        </listitem>
204
214
      </varlistentry>
205
 
 
206
 
      <varlistentry>
207
 
        <term><literal>--debug</literal></term>
208
 
        <listitem>
209
 
          <para>
210
 
            If the server is run in debug mode, it will run in the
211
 
            foreground and print a lot of debugging information.  The
212
 
            default is <emphasis>not</emphasis> to run in debug mode.
213
 
          </para>
214
 
        </listitem>
215
 
      </varlistentry>
216
 
 
217
 
      <varlistentry>
218
 
        <term><literal>--priority <replaceable>
219
 
        PRIORITY</replaceable></literal></term>
220
 
        <listitem>
221
 
          <para>
222
 
            GnuTLS priority string for the TLS handshake with the
223
 
            clients.  The default is
224
 
            <quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.
225
 
            See <citerefentry><refentrytitle>gnutls_priority_init
226
 
            </refentrytitle><manvolnum>3</manvolnum></citerefentry>
227
 
            for the syntax.  <emphasis>Warning</emphasis>: changing
228
 
            this may make the TLS handshake fail, making communication
229
 
            with clients impossible.
230
 
          </para>
231
 
        </listitem>
232
 
      </varlistentry>
233
 
 
234
 
      <varlistentry>
235
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
236
 
        </literal></term>
237
 
        <listitem>
238
 
          <para>
239
 
            Zeroconf service name.  The default is
240
 
            <quote><literal>Mandos</literal></quote>.  This only needs
241
 
            to be changed this if it, for some reason, is necessary to
242
 
            run more than one server on the same
243
 
            <emphasis>host</emphasis>, which would not normally be
244
 
            useful.  If there are name collisions on the same
245
 
            <emphasis>network</emphasis>, the newer server will
246
 
            automatically rename itself to <quote><literal>Mandos
247
 
            #2</literal></quote>, and so on; therefore, this option is
248
 
            not needed in that case.
249
 
          </para>
250
 
        </listitem>
251
 
      </varlistentry>
252
 
 
253
 
      <varlistentry>
254
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
255
 
        </literal></term>
 
215
      
 
216
      <varlistentry>
 
217
        <term><option>--debug</option></term>
 
218
        <listitem>
 
219
          <xi:include href="mandos-options.xml" xpointer="debug"/>
 
220
        </listitem>
 
221
      </varlistentry>
 
222
      
 
223
      <varlistentry>
 
224
        <term><option>--debuglevel
 
225
        <replaceable>LEVEL</replaceable></option></term>
 
226
        <listitem>
 
227
          <para>
 
228
            Set the debugging log level.
 
229
            <replaceable>LEVEL</replaceable> is a string, one of
 
230
            <quote><literal>CRITICAL</literal></quote>,
 
231
            <quote><literal>ERROR</literal></quote>,
 
232
            <quote><literal>WARNING</literal></quote>,
 
233
            <quote><literal>INFO</literal></quote>, or
 
234
            <quote><literal>DEBUG</literal></quote>, in order of
 
235
            increasing verbosity.  The default level is
 
236
            <quote><literal>WARNING</literal></quote>.
 
237
          </para>
 
238
        </listitem>
 
239
      </varlistentry>
 
240
      
 
241
      <varlistentry>
 
242
        <term><option>--priority <replaceable>
 
243
        PRIORITY</replaceable></option></term>
 
244
        <listitem>
 
245
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
246
        </listitem>
 
247
      </varlistentry>
 
248
      
 
249
      <varlistentry>
 
250
        <term><option>--servicename
 
251
        <replaceable>NAME</replaceable></option></term>
 
252
        <listitem>
 
253
          <xi:include href="mandos-options.xml"
 
254
                      xpointer="servicename"/>
 
255
        </listitem>
 
256
      </varlistentry>
 
257
      
 
258
      <varlistentry>
 
259
        <term><option>--configdir
 
260
        <replaceable>DIRECTORY</replaceable></option></term>
256
261
        <listitem>
257
262
          <para>
258
263
            Directory to search for configuration files.  Default is
264
269
          </para>
265
270
        </listitem>
266
271
      </varlistentry>
267
 
 
 
272
      
268
273
      <varlistentry>
269
 
        <term><literal>--version</literal></term>
 
274
        <term><option>--version</option></term>
270
275
        <listitem>
271
276
          <para>
272
277
            Prints the program version and exit.
273
278
          </para>
274
279
        </listitem>
275
280
      </varlistentry>
 
281
      
 
282
      <varlistentry>
 
283
        <term><option>--no-dbus</option></term>
 
284
        <listitem>
 
285
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
286
          <para>
 
287
            See also <xref linkend="dbus_interface"/>.
 
288
          </para>
 
289
        </listitem>
 
290
      </varlistentry>
 
291
      
 
292
      <varlistentry>
 
293
        <term><option>--no-ipv6</option></term>
 
294
        <listitem>
 
295
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
296
        </listitem>
 
297
      </varlistentry>
 
298
      
 
299
      <varlistentry>
 
300
        <term><option>--no-restore</option></term>
 
301
        <listitem>
 
302
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
303
          <para>
 
304
            See also <xref linkend="persistent_state"/>.
 
305
          </para>
 
306
        </listitem>
 
307
      </varlistentry>
 
308
      
 
309
      <varlistentry>
 
310
        <term><option>--statedir
 
311
        <replaceable>DIRECTORY</replaceable></option></term>
 
312
        <listitem>
 
313
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
314
        </listitem>
 
315
      </varlistentry>
 
316
      
 
317
      <varlistentry>
 
318
        <term><option>--socket
 
319
        <replaceable>FD</replaceable></option></term>
 
320
        <listitem>
 
321
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
322
        </listitem>
 
323
      </varlistentry>
 
324
      
 
325
      <varlistentry>
 
326
        <term><option>--foreground</option></term>
 
327
        <listitem>
 
328
          <xi:include href="mandos-options.xml"
 
329
                      xpointer="foreground"/>
 
330
        </listitem>
 
331
      </varlistentry>
 
332
      
 
333
      <varlistentry>
 
334
        <term><option>--no-zeroconf</option></term>
 
335
        <listitem>
 
336
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
 
337
        </listitem>
 
338
      </varlistentry>
 
339
      
276
340
    </variablelist>
277
341
  </refsect1>
278
 
 
 
342
  
279
343
  <refsect1 id="overview">
280
344
    <title>OVERVIEW</title>
281
 
    &OVERVIEW;
 
345
    <xi:include href="overview.xml"/>
282
346
    <para>
283
347
      This program is the server part.  It is a normal server program
284
348
      and will run in a normal system environment, not in an initial
285
 
      RAM disk environment.
 
349
      <acronym>RAM</acronym> disk environment.
286
350
    </para>
287
351
  </refsect1>
288
 
 
 
352
  
289
353
  <refsect1 id="protocol">
290
354
    <title>NETWORK PROTOCOL</title>
291
355
    <para>
298
362
      start a TLS protocol handshake with a slight quirk: the Mandos
299
363
      server program acts as a TLS <quote>client</quote> while the
300
364
      connecting Mandos client acts as a TLS <quote>server</quote>.
301
 
      The Mandos client must supply an OpenPGP certificate, and the
302
 
      fingerprint of this certificate is used by the Mandos server to
303
 
      look up (in a list read from <filename>clients.conf</filename>
304
 
      at start time) which binary blob to give the client.  No other
305
 
      authentication or authorization is done by the server.
 
365
      The Mandos client must supply a TLS public key, and the key ID
 
366
      of this public key is used by the Mandos server to look up (in a
 
367
      list read from <filename>clients.conf</filename> at start time)
 
368
      which binary blob to give the client.  No other authentication
 
369
      or authorization is done by the server.
306
370
    </para>
307
371
    <table>
308
372
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
317
381
        <entry>-><!-- &rarr; --></entry>
318
382
      </row>
319
383
      <row>
320
 
        <entry><quote><literal>1\r\en</literal></quote></entry>
 
384
        <entry><quote><literal>1\r\n</literal></quote></entry>
321
385
        <entry>-><!-- &rarr; --></entry>
322
386
      </row>
323
387
      <row>
328
392
        </emphasis></entry>
329
393
      </row>
330
394
      <row>
331
 
        <entry>OpenPGP public key (part of TLS handshake)</entry>
 
395
        <entry>Public key (part of TLS handshake)</entry>
332
396
        <entry>-><!-- &rarr; --></entry>
333
397
      </row>
334
398
      <row>
343
407
      </row>
344
408
    </tbody></tgroup></table>
345
409
  </refsect1>
346
 
 
 
410
  
347
411
  <refsect1 id="checking">
348
412
    <title>CHECKING</title>
349
413
    <para>
350
414
      The server will, by default, continually check that the clients
351
415
      are still up.  If a client has not been confirmed as being up
352
416
      for some time, the client is assumed to be compromised and is no
353
 
      longer eligible to receive the encrypted password.  The timeout,
354
 
      checker program, and interval between checks can be configured
355
 
      both globally and per client; see <citerefentry>
356
 
      <refentrytitle>mandos.conf</refentrytitle>
357
 
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
 
417
      longer eligible to receive the encrypted password.  (Manual
 
418
      intervention is required to re-enable a client.)  The timeout,
 
419
      extended timeout, checker program, and interval between checks
 
420
      can be configured both globally and per client; see
 
421
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
422
      <manvolnum>5</manvolnum></citerefentry>.
 
423
    </para>
 
424
  </refsect1>
 
425
  
 
426
  <refsect1 id="approval">
 
427
    <title>APPROVAL</title>
 
428
    <para>
 
429
      The server can be configured to require manual approval for a
 
430
      client before it is sent its secret.  The delay to wait for such
 
431
      approval and the default action (approve or deny) can be
 
432
      configured both globally and per client; see <citerefentry>
358
433
      <refentrytitle>mandos-clients.conf</refentrytitle>
359
 
      <manvolnum>5</manvolnum></citerefentry>.
360
 
    </para>
 
434
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
435
      will be approved immediately without delay.
 
436
    </para>
 
437
    <para>
 
438
      This can be used to deny a client its secret if not manually
 
439
      approved within a specified time.  It can also be used to make
 
440
      the server delay before giving a client its secret, allowing
 
441
      optional manual denying of this specific client.
 
442
    </para>
 
443
    
361
444
  </refsect1>
362
 
 
 
445
  
363
446
  <refsect1 id="logging">
364
447
    <title>LOGGING</title>
365
448
    <para>
366
 
      The server will send log messaged with various severity levels
367
 
      to <filename>/dev/log</filename>.  With the
 
449
      The server will send log message with various severity levels to
 
450
      <filename class="devicefile">/dev/log</filename>.  With the
368
451
      <option>--debug</option> option, it will log even more messages,
369
452
      and also show them on the console.
370
453
    </para>
371
454
  </refsect1>
372
 
 
 
455
  
 
456
  <refsect1 id="persistent_state">
 
457
    <title>PERSISTENT STATE</title>
 
458
    <para>
 
459
      Client settings, initially read from
 
460
      <filename>clients.conf</filename>, are persistent across
 
461
      restarts, and run-time changes will override settings in
 
462
      <filename>clients.conf</filename>.  However, if a setting is
 
463
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
464
      <filename>clients.conf</filename>, this will take precedence.
 
465
    </para>
 
466
  </refsect1>
 
467
  
 
468
  <refsect1 id="dbus_interface">
 
469
    <title>D-BUS INTERFACE</title>
 
470
    <para>
 
471
      The server will by default provide a D-Bus system bus interface.
 
472
      This interface will only be accessible by the root user or a
 
473
      Mandos-specific user, if such a user exists.  For documentation
 
474
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
475
    </para>
 
476
  </refsect1>
 
477
  
373
478
  <refsect1 id="exit_status">
374
479
    <title>EXIT STATUS</title>
375
480
    <para>
377
482
      critical error is encountered.
378
483
    </para>
379
484
  </refsect1>
380
 
 
 
485
  
381
486
  <refsect1 id="environment">
382
487
    <title>ENVIRONMENT</title>
383
488
    <variablelist>
384
489
      <varlistentry>
385
 
        <term><varname>PATH</varname></term>
 
490
        <term><envar>PATH</envar></term>
386
491
        <listitem>
387
492
          <para>
388
493
            To start the configured checker (see <xref
391
496
            <varname>PATH</varname> to search for matching commands if
392
497
            an absolute path is not given.  See <citerefentry>
393
498
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
394
 
          </citerefentry>
 
499
            </citerefentry>.
395
500
          </para>
396
501
        </listitem>
397
502
      </varlistentry>
398
503
    </variablelist>
399
504
  </refsect1>
400
 
 
401
 
  <refsect1 id="file">
 
505
  
 
506
  <refsect1 id="files">
402
507
    <title>FILES</title>
403
508
    <para>
404
509
      Use the <option>--configdir</option> option to change where
427
532
        </listitem>
428
533
      </varlistentry>
429
534
      <varlistentry>
430
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
431
 
        <listitem>
432
 
          <para>
433
 
            The file containing the process id of
434
 
            <command>&COMMANDNAME;</command>.
435
 
          </para>
436
 
        </listitem>
437
 
      </varlistentry>
438
 
      <varlistentry>
439
 
        <term><filename>/dev/log</filename></term>
 
535
        <term><filename>/run/mandos.pid</filename></term>
 
536
        <listitem>
 
537
          <para>
 
538
            The file containing the process id of the
 
539
            <command>&COMMANDNAME;</command> process started last.
 
540
            <emphasis >Note:</emphasis> If the <filename
 
541
            class="directory">/run</filename> directory does not
 
542
            exist, <filename>/var/run/mandos.pid</filename> will be
 
543
            used instead.
 
544
          </para>
 
545
        </listitem>
 
546
      </varlistentry>
 
547
      <varlistentry>
 
548
        <term><filename
 
549
        class="directory">/var/lib/mandos</filename></term>
 
550
        <listitem>
 
551
          <para>
 
552
            Directory where persistent state will be saved.  Change
 
553
            this with the <option>--statedir</option> option.  See
 
554
            also the <option>--no-restore</option> option.
 
555
          </para>
 
556
        </listitem>
 
557
      </varlistentry>
 
558
      <varlistentry>
 
559
        <term><filename class="devicefile">/dev/log</filename></term>
440
560
        <listitem>
441
561
          <para>
442
562
            The Unix domain socket to where local syslog messages are
465
585
      backtrace.  This could be considered a feature.
466
586
    </para>
467
587
    <para>
468
 
      Currently, if a client is declared <quote>invalid</quote> due to
469
 
      having timed out, the server does not record this fact onto
470
 
      permanent storage.  This has some security implications, see
471
 
      <xref linkend="CLIENTS"/>.
472
 
    </para>
473
 
    <para>
474
 
      There is currently no way of querying the server of the current
475
 
      status of clients, other than analyzing its <systemitem
476
 
      class="service">syslog</systemitem> output.
477
 
    </para>
478
 
    <para>
479
588
      There is no fine-grained control over logging and debug output.
480
589
    </para>
481
 
    <para>
482
 
      Debug mode is conflated with running in the foreground.
483
 
    </para>
484
 
    <para>
485
 
      The console log messages does not show a timestamp.
486
 
    </para>
 
590
    <xi:include href="bugs.xml"/>
487
591
  </refsect1>
488
592
  
489
593
  <refsect1 id="example">
493
597
        Normal invocation needs no options:
494
598
      </para>
495
599
      <para>
496
 
        <userinput>mandos</userinput>
 
600
        <userinput>&COMMANDNAME;</userinput>
497
601
      </para>
498
602
    </informalexample>
499
603
    <informalexample>
500
604
      <para>
501
605
        Run the server in debug mode, read configuration files from
502
 
        the <filename>~/mandos</filename> directory, and use the
503
 
        Zeroconf service name <quote>Test</quote> to not collide with
504
 
        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:
505
609
      </para>
506
610
      <para>
507
611
 
508
612
<!-- do not wrap this line -->
509
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
613
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
510
614
 
511
615
      </para>
512
616
    </informalexample>
518
622
      <para>
519
623
 
520
624
<!-- do not wrap this line -->
521
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
625
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
522
626
 
523
627
      </para>
524
628
    </informalexample>
525
629
  </refsect1>
526
 
 
 
630
  
527
631
  <refsect1 id="security">
528
632
    <title>SECURITY</title>
529
 
    <refsect2 id="SERVER">
 
633
    <refsect2 id="server">
530
634
      <title>SERVER</title>
531
635
      <para>
532
636
        Running this <command>&COMMANDNAME;</command> server program
533
637
        should not in itself present any security risk to the host
534
 
        computer running it.  The program does not need any special
535
 
        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.
536
640
      </para>
537
641
    </refsect2>
538
 
    <refsect2 id="CLIENTS">
 
642
    <refsect2 id="clients">
539
643
      <title>CLIENTS</title>
540
644
      <para>
541
645
        The server only gives out its stored data to clients which
542
 
        does have the OpenPGP key of the stored fingerprint.  This is
543
 
        guaranteed by the fact that the client sends its OpenPGP
544
 
        public key in the TLS handshake; this ensures it to be
545
 
        genuine.  The server computes the fingerprint of the key
546
 
        itself and looks up the fingerprint in its list of
547
 
        clients. The <filename>clients.conf</filename> file (see
 
646
        does have the correct key ID of the stored key ID.  This is
 
647
        guaranteed by the fact that the client sends its public key in
 
648
        the TLS handshake; this ensures it to be genuine.  The server
 
649
        computes the key ID of the key itself and looks up the key ID
 
650
        in its list of clients. The <filename>clients.conf</filename>
 
651
        file (see
548
652
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
549
653
        <manvolnum>5</manvolnum></citerefentry>)
550
654
        <emphasis>must</emphasis> be made non-readable by anyone
551
 
        except the user running the server.
 
655
        except the user starting the server (usually root).
552
656
      </para>
553
657
      <para>
554
658
        As detailed in <xref linkend="checking"/>, the status of all
556
660
        compromised if they are gone for too long.
557
661
      </para>
558
662
      <para>
559
 
        If a client is compromised, its downtime should be duly noted
560
 
        by the server which would therefore declare the client
561
 
        invalid.  But if the server was ever restarted, it would
562
 
        re-read its client list from its configuration file and again
563
 
        regard all clients therein as valid, and hence eligible to
564
 
        receive their passwords.  Therefore, be careful when
565
 
        restarting servers if it is suspected that a client has, in
566
 
        fact, been compromised by parties who may now be running a
567
 
        fake Mandos client with the keys from the non-encrypted
568
 
        initial RAM image of the client host.  What should be done in
569
 
        that case (if restarting the server program really is
570
 
        necessary) is to stop the server program, edit the
571
 
        configuration file to omit any suspect clients, and restart
572
 
        the server program.
573
 
      </para>
574
 
      <para>
575
663
        For more details on client-side security, see
576
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
664
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
577
665
        <manvolnum>8mandos</manvolnum></citerefentry>.
578
666
      </para>
579
667
    </refsect2>
580
668
  </refsect1>
581
 
 
 
669
  
582
670
  <refsect1 id="see_also">
583
671
    <title>SEE ALSO</title>
 
672
    <para>
 
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>
 
683
    </para>
584
684
    <variablelist>
585
685
      <varlistentry>
586
686
        <term>
587
 
          <citerefentry>
588
 
            <refentrytitle>password-request</refentrytitle>
589
 
            <manvolnum>8mandos</manvolnum>
590
 
          </citerefentry>
591
 
        </term>
592
 
        <listitem>
593
 
          <para>
594
 
            This is the actual program which talks to this server.
595
 
            Note that it is normally not invoked directly, and is only
596
 
            run in the initial RAM disk environment, and not on a
597
 
            fully started system.
598
 
          </para>
599
 
        </listitem>
600
 
      </varlistentry>
601
 
      <varlistentry>
602
 
        <term>
603
687
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
604
688
        </term>
605
689
        <listitem>
622
706
      </varlistentry>
623
707
      <varlistentry>
624
708
        <term>
625
 
          <ulink
626
 
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
709
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
627
710
        </term>
628
711
      <listitem>
629
712
        <para>
630
713
          GnuTLS is the library this server uses to implement TLS for
631
714
          communicating securely with the client, and at the same time
632
 
          confidently get the client’s public OpenPGP key.
 
715
          confidently get the client’s public key.
633
716
        </para>
634
717
      </listitem>
635
718
      </varlistentry>
636
719
      <varlistentry>
637
720
        <term>
638
 
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
639
 
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
640
 
          Unicast Addresses</citation>
 
721
          RFC 4291: <citetitle>IP Version 6 Addressing
 
722
          Architecture</citetitle>
641
723
        </term>
642
724
        <listitem>
643
 
          <para>
644
 
            The clients use IPv6 link-local addresses, which are
645
 
            immediately usable since a link-local addresses is
646
 
            automatically assigned to a network interfaces when it is
647
 
            brought up.
648
 
          </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>
649
749
        </listitem>
650
750
      </varlistentry>
651
751
      <varlistentry>
652
752
        <term>
653
 
          <citation>RFC 4346: <citetitle>The Transport Layer Security
654
 
          (TLS) Protocol Version 1.1</citetitle></citation>
 
753
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
754
          Protocol Version 1.2</citetitle>
655
755
        </term>
656
756
      <listitem>
657
757
        <para>
658
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
758
          TLS 1.2 is the protocol implemented by GnuTLS.
659
759
        </para>
660
760
      </listitem>
661
761
      </varlistentry>
662
762
      <varlistentry>
663
763
        <term>
664
 
          <citation>RFC 4880: <citetitle>OpenPGP Message
665
 
          Format</citetitle></citation>
 
764
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
666
765
        </term>
667
766
      <listitem>
668
767
        <para>
672
771
      </varlistentry>
673
772
      <varlistentry>
674
773
        <term>
675
 
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
676
 
          Transport Layer Security</citetitle></citation>
677
 
        </term>
678
 
      <listitem>
679
 
        <para>
680
 
          This is implemented by GnuTLS and used by this server so
681
 
          that OpenPGP keys can be used.
 
774
          RFC 7250: <citetitle>Using Raw Public Keys in Transport
 
775
          Layer Security (TLS) and Datagram Transport Layer Security
 
776
          (DTLS)</citetitle>
 
777
        </term>
 
778
      <listitem>
 
779
        <para>
 
780
          This is implemented by GnuTLS version 3.6.6 and is, if
 
781
          present, used by this server so that raw public keys can be
 
782
          used.
 
783
        </para>
 
784
      </listitem>
 
785
      </varlistentry>
 
786
      <varlistentry>
 
787
        <term>
 
788
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
789
          Security (TLS) Authentication</citetitle>
 
790
        </term>
 
791
      <listitem>
 
792
        <para>
 
793
          This is implemented by GnuTLS before version 3.6.0 and is,
 
794
          if present, used by this server so that OpenPGP keys can be
 
795
          used.
682
796
        </para>
683
797
      </listitem>
684
798
      </varlistentry>
685
799
    </variablelist>
686
800
  </refsect1>
687
801
</refentry>
 
802
<!-- Local Variables: -->
 
803
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
804
<!-- time-stamp-end: "[\"']>" -->
 
805
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
806
<!-- End: -->