/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-18 03:25:01 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818032501-2cl874fi3uvsqn1b
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
                         tags.  Also show the "-h" option.
  (OPTIONS): Note that failure to obey the "--interface" option is not
             considered critical.
  (ENVIRONMENT): New section to document the use of PATH by /bin/sh.
  (FILES): Added "/bin/sh".
  (BUGS): Add five bugs from the TODO file.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).
  (SERVER, CLIENTS): Added "id" attribute.
  (CLIENT): Document the security implications of one of the five
            bugs added to the BUGS section.

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">
4
5
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2016-03-05">
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
 
      <year>2016</year>
43
33
      <holder>Teddy Hogeborn</holder>
44
34
      <holder>Björn Påhlsson</holder>
45
35
    </copyright>
46
 
    <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>
47
59
  </refentryinfo>
48
 
  
 
60
 
49
61
  <refmeta>
50
62
    <refentrytitle>&COMMANDNAME;</refentrytitle>
51
63
    <manvolnum>8</manvolnum>
54
66
  <refnamediv>
55
67
    <refname><command>&COMMANDNAME;</command></refname>
56
68
    <refpurpose>
57
 
      Gives encrypted passwords to authenticated Mandos clients
 
69
      Sends encrypted passwords to authenticated Mandos clients
58
70
    </refpurpose>
59
71
  </refnamediv>
60
 
  
 
72
 
61
73
  <refsynopsisdiv>
62
74
    <cmdsynopsis>
63
75
      <command>&COMMANDNAME;</command>
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>
 
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>
114
93
    </cmdsynopsis>
115
94
    <cmdsynopsis>
116
95
      <command>&COMMANDNAME;</command>
117
96
      <group choice="req">
118
 
        <arg choice="plain"><option>--help</option></arg>
119
 
        <arg choice="plain"><option>-h</option></arg>
 
97
        <arg choice="plain">-h</arg>
 
98
        <arg choice="plain">--help</arg>
120
99
      </group>
121
100
    </cmdsynopsis>
122
101
    <cmdsynopsis>
123
102
      <command>&COMMANDNAME;</command>
124
 
      <arg choice="plain"><option>--version</option></arg>
 
103
      <arg choice="plain">--version</arg>
125
104
    </cmdsynopsis>
126
105
    <cmdsynopsis>
127
106
      <command>&COMMANDNAME;</command>
128
 
      <arg choice="plain"><option>--check</option></arg>
 
107
      <arg choice="plain">--check</arg>
129
108
    </cmdsynopsis>
130
109
  </refsynopsisdiv>
131
 
  
 
110
 
132
111
  <refsect1 id="description">
133
112
    <title>DESCRIPTION</title>
134
113
    <para>
135
114
      <command>&COMMANDNAME;</command> is a server daemon which
136
115
      handles incoming request for passwords for a pre-defined list of
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.
 
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.
147
124
    </para>
 
125
 
148
126
  </refsect1>
149
127
  
150
128
  <refsect1 id="purpose">
151
129
    <title>PURPOSE</title>
 
130
 
152
131
    <para>
153
132
      The purpose of this is to enable <emphasis>remote and unattended
154
133
      rebooting</emphasis> of client host computer with an
155
134
      <emphasis>encrypted root file system</emphasis>.  See <xref
156
135
      linkend="overview"/> for details.
157
136
    </para>
 
137
 
158
138
  </refsect1>
159
139
  
160
140
  <refsect1 id="options">
161
141
    <title>OPTIONS</title>
 
142
 
162
143
    <variablelist>
163
144
      <varlistentry>
164
 
        <term><option>--help</option></term>
165
 
        <term><option>-h</option></term>
 
145
        <term><literal>-h</literal>, <literal>--help</literal></term>
166
146
        <listitem>
167
147
          <para>
168
148
            Show a help message and exit
169
149
          </para>
170
150
        </listitem>
171
151
      </varlistentry>
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>
 
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>
205
198
        <listitem>
206
199
          <para>
207
200
            Run the server’s self-tests.  This includes any unit
209
202
          </para>
210
203
        </listitem>
211
204
      </varlistentry>
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>
 
205
 
 
206
      <varlistentry>
 
207
        <term><literal>--debug</literal></term>
 
208
        <listitem>
 
209
          <para>
 
210
            If the server is run in debug mode, it will run in the
 
211
            foreground and print a lot of debugging information.  The
 
212
            default is <emphasis>not</emphasis> to run in debug mode.
 
213
          </para>
 
214
        </listitem>
 
215
      </varlistentry>
 
216
 
 
217
      <varlistentry>
 
218
        <term><literal>--priority <replaceable>
 
219
        PRIORITY</replaceable></literal></term>
 
220
        <listitem>
 
221
          <para>
 
222
            GnuTLS priority string for the TLS handshake with the
 
223
            clients.  The default is
 
224
            <quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.
 
225
            See <citerefentry><refentrytitle>gnutls_priority_init
 
226
            </refentrytitle><manvolnum>3</manvolnum></citerefentry>
 
227
            for the syntax.  <emphasis>Warning</emphasis>: changing
 
228
            this may make the TLS handshake fail, making communication
 
229
            with clients impossible.
 
230
          </para>
 
231
        </listitem>
 
232
      </varlistentry>
 
233
 
 
234
      <varlistentry>
 
235
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
236
        </literal></term>
 
237
        <listitem>
 
238
          <para>
 
239
            Zeroconf service name.  The default is
 
240
            <quote><literal>Mandos</literal></quote>.  You only need
 
241
            to change this if you for some reason want to run more
 
242
            than one server on the same <emphasis>host</emphasis>,
 
243
            which would not normally be useful.  If there are name
 
244
            collisions on the same <emphasis>network</emphasis>, the
 
245
            newer server will automatically rename itself to
 
246
            <quote><literal>Mandos #2</literal></quote>, and so on;
 
247
            therefore, this option is not needed in that case.
 
248
          </para>
 
249
        </listitem>
 
250
      </varlistentry>
 
251
 
 
252
      <varlistentry>
 
253
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
254
        </literal></term>
258
255
        <listitem>
259
256
          <para>
260
257
            Directory to search for configuration files.  Default is
266
263
          </para>
267
264
        </listitem>
268
265
      </varlistentry>
269
 
      
 
266
 
270
267
      <varlistentry>
271
 
        <term><option>--version</option></term>
 
268
        <term><literal>--version</literal></term>
272
269
        <listitem>
273
270
          <para>
274
271
            Prints the program version and exit.
275
272
          </para>
276
273
        </listitem>
277
274
      </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
 
      
337
275
    </variablelist>
338
276
  </refsect1>
339
 
  
 
277
 
340
278
  <refsect1 id="overview">
341
279
    <title>OVERVIEW</title>
342
 
    <xi:include href="overview.xml"/>
 
280
    &OVERVIEW;
343
281
    <para>
344
282
      This program is the server part.  It is a normal server program
345
283
      and will run in a normal system environment, not in an initial
346
 
      <acronym>RAM</acronym> disk environment.
 
284
      RAM disk environment.
347
285
    </para>
348
286
  </refsect1>
349
 
  
 
287
 
350
288
  <refsect1 id="protocol">
351
289
    <title>NETWORK PROTOCOL</title>
352
290
    <para>
378
316
        <entry>-><!-- &rarr; --></entry>
379
317
      </row>
380
318
      <row>
381
 
        <entry><quote><literal>1\r\n</literal></quote></entry>
 
319
        <entry><quote><literal>1\r\en</literal></quote></entry>
382
320
        <entry>-><!-- &rarr; --></entry>
383
321
      </row>
384
322
      <row>
404
342
      </row>
405
343
    </tbody></tgroup></table>
406
344
  </refsect1>
407
 
  
 
345
 
408
346
  <refsect1 id="checking">
409
347
    <title>CHECKING</title>
410
348
    <para>
411
349
      The server will, by default, continually check that the clients
412
350
      are still up.  If a client has not been confirmed as being up
413
351
      for some time, the client is assumed to be compromised and is no
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>
 
352
      longer eligible to receive the encrypted password.  The timeout,
 
353
      checker program, and interval between checks can be configured
 
354
      both globally and per client; see <citerefentry>
 
355
      <refentrytitle>mandos.conf</refentrytitle>
 
356
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
 
357
      <refentrytitle>mandos-clients.conf</refentrytitle>
419
358
      <manvolnum>5</manvolnum></citerefentry>.
420
359
    </para>
421
360
  </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>
430
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
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
 
    
441
 
  </refsect1>
442
 
  
 
361
 
443
362
  <refsect1 id="logging">
444
363
    <title>LOGGING</title>
445
364
    <para>
446
 
      The server will send log message with various severity levels to
447
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
365
      The server will send log messaged with various severity levels
 
366
      to <filename>/dev/log</filename>.  With the
448
367
      <option>--debug</option> option, it will log even more messages,
449
368
      and also show them on the console.
450
369
    </para>
451
370
  </refsect1>
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
 
  
 
371
 
475
372
  <refsect1 id="exit_status">
476
373
    <title>EXIT STATUS</title>
477
374
    <para>
479
376
      critical error is encountered.
480
377
    </para>
481
378
  </refsect1>
482
 
  
 
379
 
483
380
  <refsect1 id="environment">
484
381
    <title>ENVIRONMENT</title>
485
382
    <variablelist>
486
383
      <varlistentry>
487
 
        <term><envar>PATH</envar></term>
 
384
        <term><varname>PATH</varname></term>
488
385
        <listitem>
489
386
          <para>
490
387
            To start the configured checker (see <xref
493
390
            <varname>PATH</varname> to search for matching commands if
494
391
            an absolute path is not given.  See <citerefentry>
495
392
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
496
 
            </citerefentry>.
 
393
          </citerefentry>
497
394
          </para>
498
395
        </listitem>
499
396
      </varlistentry>
500
397
    </variablelist>
501
398
  </refsect1>
502
 
  
503
 
  <refsect1 id="files">
 
399
 
 
400
  <refsect1 id="file">
504
401
    <title>FILES</title>
505
402
    <para>
506
403
      Use the <option>--configdir</option> option to change where
529
426
        </listitem>
530
427
      </varlistentry>
531
428
      <varlistentry>
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>
 
429
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
430
        <listitem>
 
431
          <para>
 
432
            The file containing the process id of
 
433
            <command>&COMMANDNAME;</command>.
 
434
          </para>
 
435
        </listitem>
 
436
      </varlistentry>
 
437
      <varlistentry>
 
438
        <term><filename>/dev/log</filename></term>
557
439
        <listitem>
558
440
          <para>
559
441
            The Unix domain socket to where local syslog messages are
582
464
      backtrace.  This could be considered a feature.
583
465
    </para>
584
466
    <para>
 
467
      Currently, if a client is declared <quote>invalid</quote> due to
 
468
      having timed out, the server does not record this fact onto
 
469
      permanent storage.  This has some security implications, see
 
470
      <xref linkend="CLIENTS"/>.
 
471
    </para>
 
472
    <para>
 
473
      There is currently no way of querying the server of the current
 
474
      status of clients, other than analyzing its <systemitem
 
475
      class="service">syslog</systemitem> output.
 
476
    </para>
 
477
    <para>
585
478
      There is no fine-grained control over logging and debug output.
586
479
    </para>
587
480
    <para>
588
 
      This server does not check the expire time of clients’ OpenPGP
589
 
      keys.
590
 
    </para>
591
 
    <xi:include href="bugs.xml"/>
 
481
      Debug mode is conflated with running in the foreground.
 
482
    </para>
 
483
    <para>
 
484
      The console log messages does not show a timestamp.
 
485
    </para>
592
486
  </refsect1>
593
487
  
594
488
  <refsect1 id="example">
598
492
        Normal invocation needs no options:
599
493
      </para>
600
494
      <para>
601
 
        <userinput>&COMMANDNAME;</userinput>
 
495
        <userinput>mandos</userinput>
602
496
      </para>
603
497
    </informalexample>
604
498
    <informalexample>
605
499
      <para>
606
500
        Run the server in debug mode, read configuration files from
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:
 
501
        the <filename>~/mandos</filename> directory, and use the
 
502
        Zeroconf service name <quote>Test</quote> to not collide with
 
503
        any other official Mandos server on this host:
610
504
      </para>
611
505
      <para>
612
506
 
613
507
<!-- do not wrap this line -->
614
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
508
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
615
509
 
616
510
      </para>
617
511
    </informalexample>
623
517
      <para>
624
518
 
625
519
<!-- do not wrap this line -->
626
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
520
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
627
521
 
628
522
      </para>
629
523
    </informalexample>
630
524
  </refsect1>
631
 
  
 
525
 
632
526
  <refsect1 id="security">
633
527
    <title>SECURITY</title>
634
 
    <refsect2 id="server">
 
528
    <refsect2 id="SERVER">
635
529
      <title>SERVER</title>
636
530
      <para>
637
531
        Running this <command>&COMMANDNAME;</command> server program
638
532
        should not in itself present any security risk to the host
639
 
        computer running it.  The program switches to a non-root user
640
 
        soon after startup.
 
533
        computer running it.  The program does not need any special
 
534
        privileges to run, and is designed to run as a non-root user.
641
535
      </para>
642
536
    </refsect2>
643
 
    <refsect2 id="clients">
 
537
    <refsect2 id="CLIENTS">
644
538
      <title>CLIENTS</title>
645
539
      <para>
646
540
        The server only gives out its stored data to clients which
653
547
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
654
548
        <manvolnum>5</manvolnum></citerefentry>)
655
549
        <emphasis>must</emphasis> be made non-readable by anyone
656
 
        except the user starting the server (usually root).
 
550
        except the user running the server.
657
551
      </para>
658
552
      <para>
659
553
        As detailed in <xref linkend="checking"/>, the status of all
661
555
        compromised if they are gone for too long.
662
556
      </para>
663
557
      <para>
 
558
        If a client is compromised, its downtime should be duly noted
 
559
        by the server which would therefore declare the client
 
560
        invalid.  But if the server was ever restarted, it would
 
561
        re-read its client list from its configuration file and again
 
562
        regard all clients therein as valid, and hence eligible to
 
563
        receive their passwords.  Therefore, be careful when
 
564
        restarting servers if you suspect that a client has, in fact,
 
565
        been compromised by parties who may now be running a fake
 
566
        Mandos client with the keys from the non-encrypted initial RAM
 
567
        image of the client host.  What should be done in that case
 
568
        (if restarting the server program really is necessary) is to
 
569
        stop the server program, edit the configuration file to omit
 
570
        any suspect clients, and restart the server program.
 
571
      </para>
 
572
      <para>
664
573
        For more details on client-side security, see
665
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
574
        <citerefentry><refentrytitle>password-request</refentrytitle>
666
575
        <manvolnum>8mandos</manvolnum></citerefentry>.
667
576
      </para>
668
577
    </refsect2>
669
578
  </refsect1>
670
 
  
 
579
 
671
580
  <refsect1 id="see_also">
672
581
    <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>
685
582
    <variablelist>
686
583
      <varlistentry>
687
584
        <term>
 
585
          <citerefentry>
 
586
            <refentrytitle>password-request</refentrytitle>
 
587
            <manvolnum>8mandos</manvolnum>
 
588
          </citerefentry>
 
589
        </term>
 
590
        <listitem>
 
591
          <para>
 
592
            This is the actual program which talks to this server.
 
593
            Note that it is normally not invoked directly, and is only
 
594
            run in the initial RAM disk environment, and not on a
 
595
            fully started system.
 
596
          </para>
 
597
        </listitem>
 
598
      </varlistentry>
 
599
      <varlistentry>
 
600
        <term>
688
601
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
689
602
        </term>
690
603
        <listitem>
707
620
      </varlistentry>
708
621
      <varlistentry>
709
622
        <term>
710
 
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
 
623
          <ulink
 
624
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
711
625
        </term>
712
626
      <listitem>
713
627
        <para>
719
633
      </varlistentry>
720
634
      <varlistentry>
721
635
        <term>
722
 
          RFC 4291: <citetitle>IP Version 6 Addressing
723
 
          Architecture</citetitle>
 
636
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
 
637
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
 
638
          Unicast Addresses</citation>
724
639
        </term>
725
640
        <listitem>
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>
 
641
          <para>
 
642
            The clients use IPv6 link-local addresses, which are
 
643
            immediately usable since a link-local addresses is
 
644
            automatically assigned to a network interfaces when it is
 
645
            brought up.
 
646
          </para>
750
647
        </listitem>
751
648
      </varlistentry>
752
649
      <varlistentry>
753
650
        <term>
754
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
755
 
          Protocol Version 1.2</citetitle>
 
651
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
652
          (TLS) Protocol Version 1.1</citetitle></citation>
756
653
        </term>
757
654
      <listitem>
758
655
        <para>
759
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
656
          TLS 1.1 is the protocol implemented by GnuTLS.
760
657
        </para>
761
658
      </listitem>
762
659
      </varlistentry>
763
660
      <varlistentry>
764
661
        <term>
765
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
662
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
663
          Format</citetitle></citation>
766
664
        </term>
767
665
      <listitem>
768
666
        <para>
772
670
      </varlistentry>
773
671
      <varlistentry>
774
672
        <term>
775
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
776
 
          Security (TLS) Authentication</citetitle>
 
673
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
674
          Transport Layer Security</citetitle></citation>
777
675
        </term>
778
676
      <listitem>
779
677
        <para>
785
683
    </variablelist>
786
684
  </refsect1>
787
685
</refentry>
788
 
<!-- Local Variables: -->
789
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
790
 
<!-- time-stamp-end: "[\"']>" -->
791
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
792
 
<!-- End: -->