/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 23:55:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818235528-dn628nlbrtzl7z4f
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.

* mandos (main): Changed from requiring "[server]" in mandos.conf(5)
                 to requiring "[DEFAULT]".

* mandos.conf ([server]): Renamed to "[DEFAULT]".

* mandos.conf.xml: Removed <?xml-stylesheet>.  New entity "&OVERVIEW;"
                   referring to "overview.xml".
  (DESCRIPTION): Updated to specify the syntax more precisely.  Use
                 <varname> around the option names.

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