/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: 2015-07-20 03:03:33 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • 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:
1
 
<?xml version='1.0' encoding='UTF-8'?>
2
 
<?xml-stylesheet type="text/xsl"
3
 
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
 
1
<?xml version="1.0" encoding="UTF-8"?>
4
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
 
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
 
<!ENTITY VERSION "1.0">
 
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
7
4
<!ENTITY COMMANDNAME "mandos">
 
5
<!ENTITY TIMESTAMP "2015-07-20">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
8
8
]>
9
9
 
10
 
<refentry>
11
 
  <refentryinfo>
12
 
    <title>&COMMANDNAME;</title>
13
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
14
 
    <productname>&COMMANDNAME;</productname>
15
 
    <productnumber>&VERSION;</productnumber>
 
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
11
   <refentryinfo>
 
12
    <title>Mandos Manual</title>
 
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
 
14
    <productname>Mandos</productname>
 
15
    <productnumber>&version;</productnumber>
 
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
34
 
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
35
      <year>2009</year>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
 
38
      <year>2012</year>
 
39
      <year>2013</year>
 
40
      <holder>Teddy Hogeborn</holder>
 
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 choice='opt' rep='repeat'>OPTION</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>
 
111
    </cmdsynopsis>
 
112
    <cmdsynopsis>
 
113
      <command>&COMMANDNAME;</command>
 
114
      <group choice="req">
 
115
        <arg choice="plain"><option>--help</option></arg>
 
116
        <arg choice="plain"><option>-h</option></arg>
 
117
      </group>
 
118
    </cmdsynopsis>
 
119
    <cmdsynopsis>
 
120
      <command>&COMMANDNAME;</command>
 
121
      <arg choice="plain"><option>--version</option></arg>
 
122
    </cmdsynopsis>
 
123
    <cmdsynopsis>
 
124
      <command>&COMMANDNAME;</command>
 
125
      <arg choice="plain"><option>--check</option></arg>
77
126
    </cmdsynopsis>
78
127
  </refsynopsisdiv>
79
 
 
 
128
  
80
129
  <refsect1 id="description">
81
130
    <title>DESCRIPTION</title>
82
131
    <para>
83
 
      <command>&COMMANDNAME;</command> is a server daemon that handels
84
 
      incomming passwords request for passwords. Mandos use avahi to
85
 
      announce the service, and through gnutls authenticates
86
 
      clients. Any authenticated client is then given its encrypted
87
 
      password.
88
 
    </para>
89
 
 
90
 
    <variablelist>
91
 
      <varlistentry>
92
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
93
 
        <listitem>
94
 
          <para>
95
 
            show a help message and exit
96
 
          </para>
97
 
        </listitem>
98
 
      </varlistentry>
99
 
 
100
 
      <varlistentry>
101
 
        <term><literal>-i</literal>, <literal>--interface <replaceable>
102
 
        IF</replaceable></literal></term>
103
 
        <listitem>
104
 
          <para>
105
 
            Bind to interface IF
106
 
          </para>
107
 
        </listitem>
108
 
      </varlistentry>      
109
 
 
110
 
      <varlistentry>
111
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
112
 
        ADDRESS</replaceable></literal></term>
113
 
        <listitem>
114
 
          <para>
115
 
            Address to listen for requests on
116
 
          </para>
117
 
        </listitem>
118
 
      </varlistentry>          
119
 
 
120
 
      <varlistentry>
121
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
122
 
        PORT</replaceable></literal></term>
123
 
        <listitem>
124
 
          <para>
125
 
            Port number to receive requests on
126
 
          </para>
127
 
        </listitem>
128
 
      </varlistentry>          
129
 
 
130
 
      <varlistentry>
131
 
        <term><literal>--check</literal></term>
132
 
        <listitem>
133
 
          <para>
134
 
            Run self-test on the server
135
 
          </para>
136
 
        </listitem>
137
 
      </varlistentry>      
138
 
 
139
 
      <varlistentry>
140
 
        <term><literal>--debug</literal></term>
141
 
        <listitem>
142
 
          <para>
143
 
            Debug mode
144
 
          </para>
145
 
        </listitem>
146
 
      </varlistentry>
147
 
 
148
 
      <varlistentry>
149
 
        <term><literal>--priority <replaceable>
150
 
        PRIORITY</replaceable></literal></term>
151
 
        <listitem>
152
 
          <para>
153
 
            GnuTLS priority string. See <citerefentry>
154
 
            <refentrytitle>gnutls_priority_init</refentrytitle>
155
 
            <manvolnum>3</manvolnum></citerefentry>
156
 
          </para>
157
 
        </listitem>
158
 
      </varlistentry>      
159
 
 
160
 
      <varlistentry>
161
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
162
 
        </literal></term>
163
 
        <listitem>
164
 
          <para>
165
 
            Zeroconf service name
166
 
          </para>
167
 
        </listitem>
168
 
      </varlistentry>     
169
 
 
170
 
      <varlistentry>
171
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
172
 
        </literal></term>
173
 
        <listitem>
174
 
          <para>
175
 
            Directory to search for configuration files
176
 
          </para>
177
 
        </listitem>
178
 
      </varlistentry>
179
 
      
 
132
      <command>&COMMANDNAME;</command> is a server daemon which
 
133
      handles incoming request for passwords for a pre-defined list of
 
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.
 
144
    </para>
 
145
  </refsect1>
 
146
  
 
147
  <refsect1 id="purpose">
 
148
    <title>PURPOSE</title>
 
149
    <para>
 
150
      The purpose of this is to enable <emphasis>remote and unattended
 
151
      rebooting</emphasis> of client host computer with an
 
152
      <emphasis>encrypted root file system</emphasis>.  See <xref
 
153
      linkend="overview"/> for details.
 
154
    </para>
 
155
  </refsect1>
 
156
  
 
157
  <refsect1 id="options">
 
158
    <title>OPTIONS</title>
 
159
    <variablelist>
 
160
      <varlistentry>
 
161
        <term><option>--help</option></term>
 
162
        <term><option>-h</option></term>
 
163
        <listitem>
 
164
          <para>
 
165
            Show a help message and exit
 
166
          </para>
 
167
        </listitem>
 
168
      </varlistentry>
 
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>
 
202
        <listitem>
 
203
          <para>
 
204
            Run the server’s self-tests.  This includes any unit
 
205
            tests, etc.
 
206
          </para>
 
207
        </listitem>
 
208
      </varlistentry>
 
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
        <listitem>
 
256
          <para>
 
257
            Directory to search for configuration files.  Default is
 
258
            <quote><literal>/etc/mandos</literal></quote>.  See
 
259
            <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
260
            <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
 
261
            <refentrytitle>mandos-clients.conf</refentrytitle>
 
262
            <manvolnum>5</manvolnum></citerefentry>.
 
263
          </para>
 
264
        </listitem>
 
265
      </varlistentry>
 
266
      
 
267
      <varlistentry>
 
268
        <term><option>--version</option></term>
 
269
        <listitem>
 
270
          <para>
 
271
            Prints the program version and exit.
 
272
          </para>
 
273
        </listitem>
 
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
      
 
334
    </variablelist>
 
335
  </refsect1>
 
336
  
 
337
  <refsect1 id="overview">
 
338
    <title>OVERVIEW</title>
 
339
    <xi:include href="overview.xml"/>
 
340
    <para>
 
341
      This program is the server part.  It is a normal server program
 
342
      and will run in a normal system environment, not in an initial
 
343
      <acronym>RAM</acronym> disk environment.
 
344
    </para>
 
345
  </refsect1>
 
346
  
 
347
  <refsect1 id="protocol">
 
348
    <title>NETWORK PROTOCOL</title>
 
349
    <para>
 
350
      The Mandos server announces itself as a Zeroconf service of type
 
351
      <quote><literal>_mandos._tcp</literal></quote>.  The Mandos
 
352
      client connects to the announced address and port, and sends a
 
353
      line of text where the first whitespace-separated field is the
 
354
      protocol version, which currently is
 
355
      <quote><literal>1</literal></quote>.  The client and server then
 
356
      start a TLS protocol handshake with a slight quirk: the Mandos
 
357
      server program acts as a TLS <quote>client</quote> while the
 
358
      connecting Mandos client acts as a TLS <quote>server</quote>.
 
359
      The Mandos client must supply an OpenPGP certificate, and the
 
360
      fingerprint of this certificate is used by the Mandos server to
 
361
      look up (in a list read from <filename>clients.conf</filename>
 
362
      at start time) which binary blob to give the client.  No other
 
363
      authentication or authorization is done by the server.
 
364
    </para>
 
365
    <table>
 
366
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
 
367
      <row>
 
368
        <entry>Mandos Client</entry>
 
369
        <entry>Direction</entry>
 
370
        <entry>Mandos Server</entry>
 
371
      </row>
 
372
      </thead><tbody>
 
373
      <row>
 
374
        <entry>Connect</entry>
 
375
        <entry>-><!-- &rarr; --></entry>
 
376
      </row>
 
377
      <row>
 
378
        <entry><quote><literal>1\r\n</literal></quote></entry>
 
379
        <entry>-><!-- &rarr; --></entry>
 
380
      </row>
 
381
      <row>
 
382
        <entry>TLS handshake <emphasis>as TLS <quote>server</quote>
 
383
        </emphasis></entry>
 
384
        <entry>&lt;-><!-- &xharr; --></entry>
 
385
        <entry>TLS handshake <emphasis>as TLS <quote>client</quote>
 
386
        </emphasis></entry>
 
387
      </row>
 
388
      <row>
 
389
        <entry>OpenPGP public key (part of TLS handshake)</entry>
 
390
        <entry>-><!-- &rarr; --></entry>
 
391
      </row>
 
392
      <row>
 
393
        <entry/>
 
394
        <entry>&lt;-<!-- &larr; --></entry>
 
395
        <entry>Binary blob (client will assume OpenPGP data)</entry>
 
396
      </row>
 
397
      <row>
 
398
        <entry/>
 
399
        <entry>&lt;-<!-- &larr; --></entry>
 
400
        <entry>Close</entry>
 
401
      </row>
 
402
    </tbody></tgroup></table>
 
403
  </refsect1>
 
404
  
 
405
  <refsect1 id="checking">
 
406
    <title>CHECKING</title>
 
407
    <para>
 
408
      The server will, by default, continually check that the clients
 
409
      are still up.  If a client has not been confirmed as being up
 
410
      for some time, the client is assumed to be compromised and is no
 
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>
 
427
      <refentrytitle>mandos-clients.conf</refentrytitle>
 
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
    
 
438
  </refsect1>
 
439
  
 
440
  <refsect1 id="logging">
 
441
    <title>LOGGING</title>
 
442
    <para>
 
443
      The server will send log message with various severity levels to
 
444
      <filename class="devicefile">/dev/log</filename>.  With the
 
445
      <option>--debug</option> option, it will log even more messages,
 
446
      and also show them on the console.
 
447
    </para>
 
448
  </refsect1>
 
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
  
 
472
  <refsect1 id="exit_status">
 
473
    <title>EXIT STATUS</title>
 
474
    <para>
 
475
      The server will exit with a non-zero exit status only when a
 
476
      critical error is encountered.
 
477
    </para>
 
478
  </refsect1>
 
479
  
 
480
  <refsect1 id="environment">
 
481
    <title>ENVIRONMENT</title>
 
482
    <variablelist>
 
483
      <varlistentry>
 
484
        <term><envar>PATH</envar></term>
 
485
        <listitem>
 
486
          <para>
 
487
            To start the configured checker (see <xref
 
488
            linkend="checking"/>), the server uses
 
489
            <filename>/bin/sh</filename>, which in turn uses
 
490
            <varname>PATH</varname> to search for matching commands if
 
491
            an absolute path is not given.  See <citerefentry>
 
492
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
493
            </citerefentry>.
 
494
          </para>
 
495
        </listitem>
 
496
      </varlistentry>
 
497
    </variablelist>
 
498
  </refsect1>
 
499
  
 
500
  <refsect1 id="files">
 
501
    <title>FILES</title>
 
502
    <para>
 
503
      Use the <option>--configdir</option> option to change where
 
504
      <command>&COMMANDNAME;</command> looks for its configurations
 
505
      files.  The default file names are listed here.
 
506
    </para>
 
507
    <variablelist>
 
508
      <varlistentry>
 
509
        <term><filename>/etc/mandos/mandos.conf</filename></term>
 
510
        <listitem>
 
511
          <para>
 
512
            Server-global settings.  See
 
513
            <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
514
            <manvolnum>5</manvolnum></citerefentry> for details.
 
515
          </para>
 
516
        </listitem>
 
517
      </varlistentry>
 
518
      <varlistentry>
 
519
        <term><filename>/etc/mandos/clients.conf</filename></term>
 
520
        <listitem>
 
521
          <para>
 
522
            List of clients and client-specific settings.  See
 
523
            <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
524
            <manvolnum>5</manvolnum></citerefentry> for details.
 
525
          </para>
 
526
        </listitem>
 
527
      </varlistentry>
 
528
      <varlistentry>
 
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.
 
552
          </para>
 
553
        </listitem>
 
554
      </varlistentry>
 
555
      <varlistentry>
 
556
        <term><filename>/dev/log</filename></term>
 
557
        <listitem>
 
558
          <para>
 
559
            The Unix domain socket to where local syslog messages are
 
560
            sent.
 
561
          </para>
 
562
        </listitem>
 
563
      </varlistentry>
 
564
      <varlistentry>
 
565
        <term><filename>/bin/sh</filename></term>
 
566
        <listitem>
 
567
          <para>
 
568
            This is used to start the configured checker command for
 
569
            each client.  See <citerefentry>
 
570
            <refentrytitle>mandos-clients.conf</refentrytitle>
 
571
            <manvolnum>5</manvolnum></citerefentry> for details.
 
572
          </para>
 
573
        </listitem>
 
574
      </varlistentry>
 
575
    </variablelist>
 
576
  </refsect1>
 
577
  
 
578
  <refsect1 id="bugs">
 
579
    <title>BUGS</title>
 
580
    <para>
 
581
      This server might, on especially fatal errors, emit a Python
 
582
      backtrace.  This could be considered a feature.
 
583
    </para>
 
584
    <para>
 
585
      There is no fine-grained control over logging and debug output.
 
586
    </para>
 
587
    <para>
 
588
      This server does not check the expire time of clients’ OpenPGP
 
589
      keys.
 
590
    </para>
 
591
  </refsect1>
 
592
  
 
593
  <refsect1 id="example">
 
594
    <title>EXAMPLE</title>
 
595
    <informalexample>
 
596
      <para>
 
597
        Normal invocation needs no options:
 
598
      </para>
 
599
      <para>
 
600
        <userinput>&COMMANDNAME;</userinput>
 
601
      </para>
 
602
    </informalexample>
 
603
    <informalexample>
 
604
      <para>
 
605
        Run the server in debug mode, read configuration files from
 
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:
 
609
      </para>
 
610
      <para>
 
611
 
 
612
<!-- do not wrap this line -->
 
613
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
614
 
 
615
      </para>
 
616
    </informalexample>
 
617
    <informalexample>
 
618
      <para>
 
619
        Run the server normally, but only listen to one interface and
 
620
        only on the link-local address on that interface:
 
621
      </para>
 
622
      <para>
 
623
 
 
624
<!-- do not wrap this line -->
 
625
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
626
 
 
627
      </para>
 
628
    </informalexample>
 
629
  </refsect1>
 
630
  
 
631
  <refsect1 id="security">
 
632
    <title>SECURITY</title>
 
633
    <refsect2 id="server">
 
634
      <title>SERVER</title>
 
635
      <para>
 
636
        Running this <command>&COMMANDNAME;</command> server program
 
637
        should not in itself present any security risk to the host
 
638
        computer running it.  The program switches to a non-root user
 
639
        soon after startup.
 
640
      </para>
 
641
    </refsect2>
 
642
    <refsect2 id="clients">
 
643
      <title>CLIENTS</title>
 
644
      <para>
 
645
        The server only gives out its stored data to clients which
 
646
        does have the OpenPGP key of the stored fingerprint.  This is
 
647
        guaranteed by the fact that the client sends its OpenPGP
 
648
        public key in the TLS handshake; this ensures it to be
 
649
        genuine.  The server computes the fingerprint of the key
 
650
        itself and looks up the fingerprint in its list of
 
651
        clients. The <filename>clients.conf</filename> file (see
 
652
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
653
        <manvolnum>5</manvolnum></citerefentry>)
 
654
        <emphasis>must</emphasis> be made non-readable by anyone
 
655
        except the user starting the server (usually root).
 
656
      </para>
 
657
      <para>
 
658
        As detailed in <xref linkend="checking"/>, the status of all
 
659
        client computers will continually be checked and be assumed
 
660
        compromised if they are gone for too long.
 
661
      </para>
 
662
      <para>
 
663
        For more details on client-side security, see
 
664
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
665
        <manvolnum>8mandos</manvolnum></citerefentry>.
 
666
      </para>
 
667
    </refsect2>
 
668
  </refsect1>
 
669
  
 
670
  <refsect1 id="see_also">
 
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>
 
684
    <variablelist>
 
685
      <varlistentry>
 
686
        <term>
 
687
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
688
        </term>
 
689
        <listitem>
 
690
          <para>
 
691
            Zeroconf is the network protocol standard used by clients
 
692
            for finding this Mandos server on the local network.
 
693
          </para>
 
694
        </listitem>
 
695
      </varlistentry>
 
696
      <varlistentry>
 
697
        <term>
 
698
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
699
        </term>
 
700
      <listitem>
 
701
        <para>
 
702
          Avahi is the library this server calls to implement
 
703
          Zeroconf service announcements.
 
704
        </para>
 
705
      </listitem>
 
706
      </varlistentry>
 
707
      <varlistentry>
 
708
        <term>
 
709
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
 
710
        </term>
 
711
      <listitem>
 
712
        <para>
 
713
          GnuTLS is the library this server uses to implement TLS for
 
714
          communicating securely with the client, and at the same time
 
715
          confidently get the client’s public OpenPGP key.
 
716
        </para>
 
717
      </listitem>
 
718
      </varlistentry>
 
719
      <varlistentry>
 
720
        <term>
 
721
          RFC 4291: <citetitle>IP Version 6 Addressing
 
722
          Architecture</citetitle>
 
723
        </term>
 
724
        <listitem>
 
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>
 
749
        </listitem>
 
750
      </varlistentry>
 
751
      <varlistentry>
 
752
        <term>
 
753
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
754
          Protocol Version 1.2</citetitle>
 
755
        </term>
 
756
      <listitem>
 
757
        <para>
 
758
          TLS 1.2 is the protocol implemented by GnuTLS.
 
759
        </para>
 
760
      </listitem>
 
761
      </varlistentry>
 
762
      <varlistentry>
 
763
        <term>
 
764
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
765
        </term>
 
766
      <listitem>
 
767
        <para>
 
768
          The data sent to clients is binary encrypted OpenPGP data.
 
769
        </para>
 
770
      </listitem>
 
771
      </varlistentry>
 
772
      <varlistentry>
 
773
        <term>
 
774
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
775
          Security (TLS) Authentication</citetitle>
 
776
        </term>
 
777
      <listitem>
 
778
        <para>
 
779
          This is implemented by GnuTLS and used by this server so
 
780
          that OpenPGP keys can be used.
 
781
        </para>
 
782
      </listitem>
 
783
      </varlistentry>
180
784
    </variablelist>
181
785
  </refsect1>
182
786
</refentry>
 
787
<!-- Local Variables: -->
 
788
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
789
<!-- time-stamp-end: "[\"']>" -->
 
790
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
791
<!-- End: -->