/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: 2016-03-19 12:10:15 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 341.
  • Revision ID: teddy@recompile.se-20160319121015-ywrw6qx3srtj2dix
Server: Debian package bug fix: Include /usr/lib/tmpfiles.d dir

The Debian package for the server needs the /usr/lib/tmpfiles.d
directory in its .dirs file in order for the directory to exist when
the Makefile "install-server" rule is run, otherwise the
tmpfiles.d-mandos.conf file will not be installed.

* debian/mandos.dirs (usr/lib/tmpfiles.d): Added.

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