/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

merge

Show diffs side-by-side

added added

removed removed

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