/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: 2013-10-22 19:24:01 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 305.
  • Revision ID: teddy@recompile.se-20131022192401-op6mwsb7f7gygjyh
http://bugs.debian.org/702120
* mandos (priority): Bug fix: Add even more magic to make the old
                     DSA/ELG 2048-bit keys work with GnuTLS.
* mandos-keygen (KEYCOMMENT): Changed default to "".
* mandos-keygen (OPTIONS): Document new default value of "--comment".
* mandos-options.xml (priority): Document new default value.
* mandos.conf (priority): - '' -

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 "2013-10-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>
93
109
    </cmdsynopsis>
94
110
    <cmdsynopsis>
95
111
      <command>&COMMANDNAME;</command>
96
112
      <group choice="req">
97
 
        <arg choice="plain">-h</arg>
98
 
        <arg choice="plain">--help</arg>
 
113
        <arg choice="plain"><option>--help</option></arg>
 
114
        <arg choice="plain"><option>-h</option></arg>
99
115
      </group>
100
116
    </cmdsynopsis>
101
117
    <cmdsynopsis>
102
118
      <command>&COMMANDNAME;</command>
103
 
      <arg choice="plain">--version</arg>
 
119
      <arg choice="plain"><option>--version</option></arg>
104
120
    </cmdsynopsis>
105
121
    <cmdsynopsis>
106
122
      <command>&COMMANDNAME;</command>
107
 
      <arg choice="plain">--check</arg>
 
123
      <arg choice="plain"><option>--check</option></arg>
108
124
    </cmdsynopsis>
109
125
  </refsynopsisdiv>
110
 
 
 
126
  
111
127
  <refsect1 id="description">
112
128
    <title>DESCRIPTION</title>
113
129
    <para>
114
130
      <command>&COMMANDNAME;</command> is a server daemon which
115
131
      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.
 
132
      client host computers. For an introduction, see
 
133
      <citerefentry><refentrytitle>intro</refentrytitle>
 
134
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
135
      uses Zeroconf to announce itself on the local network, and uses
 
136
      TLS to communicate securely with and to authenticate the
 
137
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
138
      use IPv6 link-local addresses, since the clients will probably
 
139
      not have any other addresses configured (see <xref
 
140
      linkend="overview"/>).  Any authenticated client is then given
 
141
      the stored pre-encrypted password for that specific client.
124
142
    </para>
125
 
 
126
143
  </refsect1>
127
144
  
128
145
  <refsect1 id="purpose">
129
146
    <title>PURPOSE</title>
130
 
 
131
147
    <para>
132
148
      The purpose of this is to enable <emphasis>remote and unattended
133
149
      rebooting</emphasis> of client host computer with an
134
150
      <emphasis>encrypted root file system</emphasis>.  See <xref
135
151
      linkend="overview"/> for details.
136
152
    </para>
137
 
 
138
153
  </refsect1>
139
154
  
140
155
  <refsect1 id="options">
141
156
    <title>OPTIONS</title>
142
 
 
143
157
    <variablelist>
144
158
      <varlistentry>
145
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
159
        <term><option>--help</option></term>
 
160
        <term><option>-h</option></term>
146
161
        <listitem>
147
162
          <para>
148
163
            Show a help message and exit
149
164
          </para>
150
165
        </listitem>
151
166
      </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>
 
167
      
 
168
      <varlistentry>
 
169
        <term><option>--interface</option>
 
170
        <replaceable>NAME</replaceable></term>
 
171
        <term><option>-i</option>
 
172
        <replaceable>NAME</replaceable></term>
 
173
        <listitem>
 
174
          <xi:include href="mandos-options.xml" xpointer="interface"/>
 
175
        </listitem>
 
176
      </varlistentry>
 
177
      
 
178
      <varlistentry>
 
179
        <term><option>--address
 
180
        <replaceable>ADDRESS</replaceable></option></term>
 
181
        <term><option>-a
 
182
        <replaceable>ADDRESS</replaceable></option></term>
 
183
        <listitem>
 
184
          <xi:include href="mandos-options.xml" xpointer="address"/>
 
185
        </listitem>
 
186
      </varlistentry>
 
187
      
 
188
      <varlistentry>
 
189
        <term><option>--port
 
190
        <replaceable>PORT</replaceable></option></term>
 
191
        <term><option>-p
 
192
        <replaceable>PORT</replaceable></option></term>
 
193
        <listitem>
 
194
          <xi:include href="mandos-options.xml" xpointer="port"/>
 
195
        </listitem>
 
196
      </varlistentry>
 
197
      
 
198
      <varlistentry>
 
199
        <term><option>--check</option></term>
198
200
        <listitem>
199
201
          <para>
200
202
            Run the server’s self-tests.  This includes any unit
202
204
          </para>
203
205
        </listitem>
204
206
      </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>
 
207
      
 
208
      <varlistentry>
 
209
        <term><option>--debug</option></term>
 
210
        <listitem>
 
211
          <xi:include href="mandos-options.xml" xpointer="debug"/>
 
212
        </listitem>
 
213
      </varlistentry>
 
214
      
 
215
      <varlistentry>
 
216
        <term><option>--debuglevel
 
217
        <replaceable>LEVEL</replaceable></option></term>
 
218
        <listitem>
 
219
          <para>
 
220
            Set the debugging log level.
 
221
            <replaceable>LEVEL</replaceable> is a string, one of
 
222
            <quote><literal>CRITICAL</literal></quote>,
 
223
            <quote><literal>ERROR</literal></quote>,
 
224
            <quote><literal>WARNING</literal></quote>,
 
225
            <quote><literal>INFO</literal></quote>, or
 
226
            <quote><literal>DEBUG</literal></quote>, in order of
 
227
            increasing verbosity.  The default level is
 
228
            <quote><literal>WARNING</literal></quote>.
 
229
          </para>
 
230
        </listitem>
 
231
      </varlistentry>
 
232
      
 
233
      <varlistentry>
 
234
        <term><option>--priority <replaceable>
 
235
        PRIORITY</replaceable></option></term>
 
236
        <listitem>
 
237
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
238
        </listitem>
 
239
      </varlistentry>
 
240
      
 
241
      <varlistentry>
 
242
        <term><option>--servicename
 
243
        <replaceable>NAME</replaceable></option></term>
 
244
        <listitem>
 
245
          <xi:include href="mandos-options.xml"
 
246
                      xpointer="servicename"/>
 
247
        </listitem>
 
248
      </varlistentry>
 
249
      
 
250
      <varlistentry>
 
251
        <term><option>--configdir
 
252
        <replaceable>DIRECTORY</replaceable></option></term>
256
253
        <listitem>
257
254
          <para>
258
255
            Directory to search for configuration files.  Default is
264
261
          </para>
265
262
        </listitem>
266
263
      </varlistentry>
267
 
 
 
264
      
268
265
      <varlistentry>
269
 
        <term><literal>--version</literal></term>
 
266
        <term><option>--version</option></term>
270
267
        <listitem>
271
268
          <para>
272
269
            Prints the program version and exit.
273
270
          </para>
274
271
        </listitem>
275
272
      </varlistentry>
 
273
      
 
274
      <varlistentry>
 
275
        <term><option>--no-dbus</option></term>
 
276
        <listitem>
 
277
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
278
          <para>
 
279
            See also <xref linkend="dbus_interface"/>.
 
280
          </para>
 
281
        </listitem>
 
282
      </varlistentry>
 
283
      
 
284
      <varlistentry>
 
285
        <term><option>--no-ipv6</option></term>
 
286
        <listitem>
 
287
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
288
        </listitem>
 
289
      </varlistentry>
 
290
      
 
291
      <varlistentry>
 
292
        <term><option>--no-restore</option></term>
 
293
        <listitem>
 
294
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
295
          <para>
 
296
            See also <xref linkend="persistent_state"/>.
 
297
          </para>
 
298
        </listitem>
 
299
      </varlistentry>
 
300
      
 
301
      <varlistentry>
 
302
        <term><option>--statedir
 
303
        <replaceable>DIRECTORY</replaceable></option></term>
 
304
        <listitem>
 
305
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
306
        </listitem>
 
307
      </varlistentry>
 
308
      
 
309
      <varlistentry>
 
310
        <term><option>--socket
 
311
        <replaceable>FD</replaceable></option></term>
 
312
        <listitem>
 
313
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
314
        </listitem>
 
315
      </varlistentry>
 
316
      
 
317
      <varlistentry>
 
318
        <term><option>--foreground</option></term>
 
319
        <listitem>
 
320
          <xi:include href="mandos-options.xml"
 
321
                      xpointer="foreground"/>
 
322
        </listitem>
 
323
      </varlistentry>
 
324
      
276
325
    </variablelist>
277
326
  </refsect1>
278
 
 
 
327
  
279
328
  <refsect1 id="overview">
280
329
    <title>OVERVIEW</title>
281
 
    &OVERVIEW;
 
330
    <xi:include href="overview.xml"/>
282
331
    <para>
283
332
      This program is the server part.  It is a normal server program
284
333
      and will run in a normal system environment, not in an initial
285
 
      RAM disk environment.
 
334
      <acronym>RAM</acronym> disk environment.
286
335
    </para>
287
336
  </refsect1>
288
 
 
 
337
  
289
338
  <refsect1 id="protocol">
290
339
    <title>NETWORK PROTOCOL</title>
291
340
    <para>
317
366
        <entry>-><!-- &rarr; --></entry>
318
367
      </row>
319
368
      <row>
320
 
        <entry><quote><literal>1\r\en</literal></quote></entry>
 
369
        <entry><quote><literal>1\r\n</literal></quote></entry>
321
370
        <entry>-><!-- &rarr; --></entry>
322
371
      </row>
323
372
      <row>
343
392
      </row>
344
393
    </tbody></tgroup></table>
345
394
  </refsect1>
346
 
 
 
395
  
347
396
  <refsect1 id="checking">
348
397
    <title>CHECKING</title>
349
398
    <para>
350
399
      The server will, by default, continually check that the clients
351
400
      are still up.  If a client has not been confirmed as being up
352
401
      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>
 
402
      longer eligible to receive the encrypted password.  (Manual
 
403
      intervention is required to re-enable a client.)  The timeout,
 
404
      extended timeout, checker program, and interval between checks
 
405
      can be configured both globally and per client; see
 
406
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
407
      <manvolnum>5</manvolnum></citerefentry>.
 
408
    </para>
 
409
  </refsect1>
 
410
  
 
411
  <refsect1 id="approval">
 
412
    <title>APPROVAL</title>
 
413
    <para>
 
414
      The server can be configured to require manual approval for a
 
415
      client before it is sent its secret.  The delay to wait for such
 
416
      approval and the default action (approve or deny) can be
 
417
      configured both globally and per client; see <citerefentry>
358
418
      <refentrytitle>mandos-clients.conf</refentrytitle>
359
 
      <manvolnum>5</manvolnum></citerefentry>.
360
 
    </para>
 
419
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
420
      will be approved immediately without delay.
 
421
    </para>
 
422
    <para>
 
423
      This can be used to deny a client its secret if not manually
 
424
      approved within a specified time.  It can also be used to make
 
425
      the server delay before giving a client its secret, allowing
 
426
      optional manual denying of this specific client.
 
427
    </para>
 
428
    
361
429
  </refsect1>
362
 
 
 
430
  
363
431
  <refsect1 id="logging">
364
432
    <title>LOGGING</title>
365
433
    <para>
366
 
      The server will send log messaged with various severity levels
367
 
      to <filename>/dev/log</filename>.  With the
 
434
      The server will send log message with various severity levels to
 
435
      <filename class="devicefile">/dev/log</filename>.  With the
368
436
      <option>--debug</option> option, it will log even more messages,
369
437
      and also show them on the console.
370
438
    </para>
371
439
  </refsect1>
372
 
 
 
440
  
 
441
  <refsect1 id="persistent_state">
 
442
    <title>PERSISTENT STATE</title>
 
443
    <para>
 
444
      Client settings, initially read from
 
445
      <filename>clients.conf</filename>, are persistent across
 
446
      restarts, and run-time changes will override settings in
 
447
      <filename>clients.conf</filename>.  However, if a setting is
 
448
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
449
      <filename>clients.conf</filename>, this will take precedence.
 
450
    </para>
 
451
  </refsect1>
 
452
  
 
453
  <refsect1 id="dbus_interface">
 
454
    <title>D-BUS INTERFACE</title>
 
455
    <para>
 
456
      The server will by default provide a D-Bus system bus interface.
 
457
      This interface will only be accessible by the root user or a
 
458
      Mandos-specific user, if such a user exists.  For documentation
 
459
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
460
    </para>
 
461
  </refsect1>
 
462
  
373
463
  <refsect1 id="exit_status">
374
464
    <title>EXIT STATUS</title>
375
465
    <para>
377
467
      critical error is encountered.
378
468
    </para>
379
469
  </refsect1>
380
 
 
 
470
  
381
471
  <refsect1 id="environment">
382
472
    <title>ENVIRONMENT</title>
383
473
    <variablelist>
384
474
      <varlistentry>
385
 
        <term><varname>PATH</varname></term>
 
475
        <term><envar>PATH</envar></term>
386
476
        <listitem>
387
477
          <para>
388
478
            To start the configured checker (see <xref
391
481
            <varname>PATH</varname> to search for matching commands if
392
482
            an absolute path is not given.  See <citerefentry>
393
483
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
394
 
          </citerefentry>
 
484
            </citerefentry>.
395
485
          </para>
396
486
        </listitem>
397
487
      </varlistentry>
398
488
    </variablelist>
399
489
  </refsect1>
400
 
 
401
 
  <refsect1 id="file">
 
490
  
 
491
  <refsect1 id="files">
402
492
    <title>FILES</title>
403
493
    <para>
404
494
      Use the <option>--configdir</option> option to change where
427
517
        </listitem>
428
518
      </varlistentry>
429
519
      <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>.
 
520
        <term><filename>/run/mandos.pid</filename></term>
 
521
        <listitem>
 
522
          <para>
 
523
            The file containing the process id of the
 
524
            <command>&COMMANDNAME;</command> process started last.
 
525
          </para>
 
526
        </listitem>
 
527
      </varlistentry>
 
528
      <varlistentry>
 
529
        <term><filename class="devicefile">/dev/log</filename></term>
 
530
      </varlistentry>
 
531
      <varlistentry>
 
532
        <term><filename
 
533
        class="directory">/var/lib/mandos</filename></term>
 
534
        <listitem>
 
535
          <para>
 
536
            Directory where persistent state will be saved.  Change
 
537
            this with the <option>--statedir</option> option.  See
 
538
            also the <option>--no-restore</option> option.
435
539
          </para>
436
540
        </listitem>
437
541
      </varlistentry>
465
569
      backtrace.  This could be considered a feature.
466
570
    </para>
467
571
    <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
572
      There is no fine-grained control over logging and debug output.
480
573
    </para>
481
574
    <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.
 
575
      This server does not check the expire time of clients’ OpenPGP
 
576
      keys.
486
577
    </para>
487
578
  </refsect1>
488
579
  
493
584
        Normal invocation needs no options:
494
585
      </para>
495
586
      <para>
496
 
        <userinput>mandos</userinput>
 
587
        <userinput>&COMMANDNAME;</userinput>
497
588
      </para>
498
589
    </informalexample>
499
590
    <informalexample>
500
591
      <para>
501
592
        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:
 
593
        the <filename class="directory">~/mandos</filename> directory,
 
594
        and use the Zeroconf service name <quote>Test</quote> to not
 
595
        collide with any other official Mandos server on this host:
505
596
      </para>
506
597
      <para>
507
598
 
508
599
<!-- do not wrap this line -->
509
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
600
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
510
601
 
511
602
      </para>
512
603
    </informalexample>
518
609
      <para>
519
610
 
520
611
<!-- do not wrap this line -->
521
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
612
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
522
613
 
523
614
      </para>
524
615
    </informalexample>
525
616
  </refsect1>
526
 
 
 
617
  
527
618
  <refsect1 id="security">
528
619
    <title>SECURITY</title>
529
 
    <refsect2 id="SERVER">
 
620
    <refsect2 id="server">
530
621
      <title>SERVER</title>
531
622
      <para>
532
623
        Running this <command>&COMMANDNAME;</command> server program
533
624
        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.
 
625
        computer running it.  The program switches to a non-root user
 
626
        soon after startup.
536
627
      </para>
537
628
    </refsect2>
538
 
    <refsect2 id="CLIENTS">
 
629
    <refsect2 id="clients">
539
630
      <title>CLIENTS</title>
540
631
      <para>
541
632
        The server only gives out its stored data to clients which
548
639
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
549
640
        <manvolnum>5</manvolnum></citerefentry>)
550
641
        <emphasis>must</emphasis> be made non-readable by anyone
551
 
        except the user running the server.
 
642
        except the user starting the server (usually root).
552
643
      </para>
553
644
      <para>
554
645
        As detailed in <xref linkend="checking"/>, the status of all
556
647
        compromised if they are gone for too long.
557
648
      </para>
558
649
      <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
650
        For more details on client-side security, see
576
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
651
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
577
652
        <manvolnum>8mandos</manvolnum></citerefentry>.
578
653
      </para>
579
654
    </refsect2>
580
655
  </refsect1>
581
 
 
 
656
  
582
657
  <refsect1 id="see_also">
583
658
    <title>SEE ALSO</title>
 
659
    <para>
 
660
      <citerefentry><refentrytitle>intro</refentrytitle>
 
661
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
662
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
663
      <manvolnum>5</manvolnum></citerefentry>,
 
664
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
665
      <manvolnum>5</manvolnum></citerefentry>,
 
666
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
667
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
668
      <citerefentry><refentrytitle>sh</refentrytitle>
 
669
      <manvolnum>1</manvolnum></citerefentry>
 
670
    </para>
584
671
    <variablelist>
585
672
      <varlistentry>
586
673
        <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
674
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
604
675
        </term>
605
676
        <listitem>
622
693
      </varlistentry>
623
694
      <varlistentry>
624
695
        <term>
625
 
          <ulink
626
 
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
696
          <ulink url="http://www.gnu.org/software/gnutls/"
 
697
          >GnuTLS</ulink>
627
698
        </term>
628
699
      <listitem>
629
700
        <para>
635
706
      </varlistentry>
636
707
      <varlistentry>
637
708
        <term>
638
 
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
639
 
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
640
 
          Unicast Addresses</citation>
 
709
          RFC 4291: <citetitle>IP Version 6 Addressing
 
710
          Architecture</citetitle>
641
711
        </term>
642
712
        <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>
 
713
          <variablelist>
 
714
            <varlistentry>
 
715
              <term>Section 2.2: <citetitle>Text Representation of
 
716
              Addresses</citetitle></term>
 
717
              <listitem><para/></listitem>
 
718
            </varlistentry>
 
719
            <varlistentry>
 
720
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
721
              Address</citetitle></term>
 
722
              <listitem><para/></listitem>
 
723
            </varlistentry>
 
724
            <varlistentry>
 
725
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
726
            Addresses</citetitle></term>
 
727
            <listitem>
 
728
              <para>
 
729
                The clients use IPv6 link-local addresses, which are
 
730
                immediately usable since a link-local addresses is
 
731
                automatically assigned to a network interfaces when it
 
732
                is brought up.
 
733
              </para>
 
734
            </listitem>
 
735
            </varlistentry>
 
736
          </variablelist>
649
737
        </listitem>
650
738
      </varlistentry>
651
739
      <varlistentry>
652
740
        <term>
653
 
          <citation>RFC 4346: <citetitle>The Transport Layer Security
654
 
          (TLS) Protocol Version 1.1</citetitle></citation>
 
741
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
742
          Protocol Version 1.1</citetitle>
655
743
        </term>
656
744
      <listitem>
657
745
        <para>
661
749
      </varlistentry>
662
750
      <varlistentry>
663
751
        <term>
664
 
          <citation>RFC 4880: <citetitle>OpenPGP Message
665
 
          Format</citetitle></citation>
 
752
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
666
753
        </term>
667
754
      <listitem>
668
755
        <para>
672
759
      </varlistentry>
673
760
      <varlistentry>
674
761
        <term>
675
 
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
676
 
          Transport Layer Security</citetitle></citation>
 
762
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
763
          Security</citetitle>
677
764
        </term>
678
765
      <listitem>
679
766
        <para>
685
772
    </variablelist>
686
773
  </refsect1>
687
774
</refentry>
 
775
<!-- Local Variables: -->
 
776
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
777
<!-- time-stamp-end: "[\"']>" -->
 
778
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
779
<!-- End: -->