/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: 2015-07-20 03:03:33 UTC
  • Revision ID: teddy@recompile.se-20150720030333-203m2aeblypcsfte
Bug fix for GnuTLS 3: be compatible with old 2048-bit DSA keys.

The mandos-keygen program in Mandos version 1.6.0 and older generated
2048-bit DSA keys, and when GnuTLS uses these it has trouble
connecting using the Mandos default priority string.  This was
previously fixed in Mandos 1.6.2, but the bug reappeared when using
GnuTLS 3, so the default priority string has to change again; this
time also the Mandos client has to change its default, so now the
server and the client should use the same default priority string:

SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA:+SIGN-DSA-SHA256

* mandos (main/server_defaults): Changed default priority string.
* mandos-options.xml (/section/para[id="priority_compat"]): Removed.
  (/section/para[id="priority"]): Changed default priority string.
* mandos.conf ([DEFAULT]/priority): - '' -
* mandos.conf.xml (OPTIONS/priority): Refer to the id "priority"
                                      instead of "priority_compat".
* mandos.xml (OPTIONS/--priority): - '' -
* plugins.d/mandos-client.c (main): Changed default priority string.

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