/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: 2012-06-16 19:30:08 UTC
  • Revision ID: teddy@recompile.se-20120616193008-2erbfaw5a5y3yay1
* debian/mandos-client.README.Debian: Update documentation for using
                                      multiple interfaces.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "mandos">
6
 
<!ENTITY OVERVIEW SYSTEM "overview.xml">
 
5
<!ENTITY TIMESTAMP "2012-05-26">
 
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>
33
39
      <holder>Teddy Hogeborn</holder>
34
40
      <holder>Björn Påhlsson</holder>
35
41
    </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>
 
42
    <xi:include href="legalnotice.xml"/>
59
43
  </refentryinfo>
60
 
 
 
44
  
61
45
  <refmeta>
62
46
    <refentrytitle>&COMMANDNAME;</refentrytitle>
63
47
    <manvolnum>8</manvolnum>
66
50
  <refnamediv>
67
51
    <refname><command>&COMMANDNAME;</command></refname>
68
52
    <refpurpose>
69
 
      Sends encrypted passwords to authenticated Mandos clients
 
53
      Gives encrypted passwords to authenticated Mandos clients
70
54
    </refpurpose>
71
55
  </refnamediv>
72
 
 
 
56
  
73
57
  <refsynopsisdiv>
74
58
    <cmdsynopsis>
75
59
      <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>
 
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>
93
106
    </cmdsynopsis>
94
107
    <cmdsynopsis>
95
108
      <command>&COMMANDNAME;</command>
96
109
      <group choice="req">
97
 
        <arg choice="plain">-h</arg>
98
 
        <arg choice="plain">--help</arg>
 
110
        <arg choice="plain"><option>--help</option></arg>
 
111
        <arg choice="plain"><option>-h</option></arg>
99
112
      </group>
100
113
    </cmdsynopsis>
101
114
    <cmdsynopsis>
102
115
      <command>&COMMANDNAME;</command>
103
 
      <arg choice="plain">--version</arg>
 
116
      <arg choice="plain"><option>--version</option></arg>
104
117
    </cmdsynopsis>
105
118
    <cmdsynopsis>
106
119
      <command>&COMMANDNAME;</command>
107
 
      <arg choice="plain">--check</arg>
 
120
      <arg choice="plain"><option>--check</option></arg>
108
121
    </cmdsynopsis>
109
122
  </refsynopsisdiv>
110
 
 
 
123
  
111
124
  <refsect1 id="description">
112
125
    <title>DESCRIPTION</title>
113
126
    <para>
114
127
      <command>&COMMANDNAME;</command> is a server daemon which
115
128
      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.
 
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.
124
139
    </para>
125
 
 
126
140
  </refsect1>
127
141
  
128
142
  <refsect1 id="purpose">
129
143
    <title>PURPOSE</title>
130
 
 
131
144
    <para>
132
145
      The purpose of this is to enable <emphasis>remote and unattended
133
146
      rebooting</emphasis> of client host computer with an
134
147
      <emphasis>encrypted root file system</emphasis>.  See <xref
135
148
      linkend="overview"/> for details.
136
149
    </para>
137
 
 
138
150
  </refsect1>
139
151
  
140
152
  <refsect1 id="options">
141
153
    <title>OPTIONS</title>
142
 
 
143
154
    <variablelist>
144
155
      <varlistentry>
145
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
156
        <term><option>--help</option></term>
 
157
        <term><option>-h</option></term>
146
158
        <listitem>
147
159
          <para>
148
160
            Show a help message and exit
149
161
          </para>
150
162
        </listitem>
151
163
      </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>
 
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>
198
197
        <listitem>
199
198
          <para>
200
199
            Run the server’s self-tests.  This includes any unit
202
201
          </para>
203
202
        </listitem>
204
203
      </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>
 
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>
256
250
        <listitem>
257
251
          <para>
258
252
            Directory to search for configuration files.  Default is
264
258
          </para>
265
259
        </listitem>
266
260
      </varlistentry>
267
 
 
 
261
      
268
262
      <varlistentry>
269
 
        <term><literal>--version</literal></term>
 
263
        <term><option>--version</option></term>
270
264
        <listitem>
271
265
          <para>
272
266
            Prints the program version and exit.
273
267
          </para>
274
268
        </listitem>
275
269
      </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
      
276
314
    </variablelist>
277
315
  </refsect1>
278
 
 
 
316
  
279
317
  <refsect1 id="overview">
280
318
    <title>OVERVIEW</title>
281
 
    &OVERVIEW;
 
319
    <xi:include href="overview.xml"/>
282
320
    <para>
283
321
      This program is the server part.  It is a normal server program
284
322
      and will run in a normal system environment, not in an initial
285
 
      RAM disk environment.
 
323
      <acronym>RAM</acronym> disk environment.
286
324
    </para>
287
325
  </refsect1>
288
 
 
 
326
  
289
327
  <refsect1 id="protocol">
290
328
    <title>NETWORK PROTOCOL</title>
291
329
    <para>
317
355
        <entry>-><!-- &rarr; --></entry>
318
356
      </row>
319
357
      <row>
320
 
        <entry><quote><literal>1\r\en</literal></quote></entry>
 
358
        <entry><quote><literal>1\r\n</literal></quote></entry>
321
359
        <entry>-><!-- &rarr; --></entry>
322
360
      </row>
323
361
      <row>
343
381
      </row>
344
382
    </tbody></tgroup></table>
345
383
  </refsect1>
346
 
 
 
384
  
347
385
  <refsect1 id="checking">
348
386
    <title>CHECKING</title>
349
387
    <para>
350
388
      The server will, by default, continually check that the clients
351
389
      are still up.  If a client has not been confirmed as being up
352
390
      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>
 
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>
 
396
      <manvolnum>5</manvolnum></citerefentry>.
 
397
    </para>
 
398
  </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>
358
407
      <refentrytitle>mandos-clients.conf</refentrytitle>
359
 
      <manvolnum>5</manvolnum></citerefentry>.
360
 
    </para>
 
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
    
361
418
  </refsect1>
362
 
 
 
419
  
363
420
  <refsect1 id="logging">
364
421
    <title>LOGGING</title>
365
422
    <para>
366
 
      The server will send log messaged with various severity levels
367
 
      to <filename>/dev/log</filename>.  With the
 
423
      The server will send log message with various severity levels to
 
424
      <filename class="devicefile">/dev/log</filename>.  With the
368
425
      <option>--debug</option> option, it will log even more messages,
369
426
      and also show them on the console.
370
427
    </para>
371
428
  </refsect1>
372
 
 
 
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
  
373
452
  <refsect1 id="exit_status">
374
453
    <title>EXIT STATUS</title>
375
454
    <para>
377
456
      critical error is encountered.
378
457
    </para>
379
458
  </refsect1>
380
 
 
 
459
  
381
460
  <refsect1 id="environment">
382
461
    <title>ENVIRONMENT</title>
383
462
    <variablelist>
384
463
      <varlistentry>
385
 
        <term><varname>PATH</varname></term>
 
464
        <term><envar>PATH</envar></term>
386
465
        <listitem>
387
466
          <para>
388
467
            To start the configured checker (see <xref
391
470
            <varname>PATH</varname> to search for matching commands if
392
471
            an absolute path is not given.  See <citerefentry>
393
472
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
394
 
          </citerefentry>
 
473
            </citerefentry>.
395
474
          </para>
396
475
        </listitem>
397
476
      </varlistentry>
398
477
    </variablelist>
399
478
  </refsect1>
400
 
 
401
 
  <refsect1 id="file">
 
479
  
 
480
  <refsect1 id="files">
402
481
    <title>FILES</title>
403
482
    <para>
404
483
      Use the <option>--configdir</option> option to change where
427
506
        </listitem>
428
507
      </varlistentry>
429
508
      <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>.
 
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.
435
528
          </para>
436
529
        </listitem>
437
530
      </varlistentry>
465
558
      backtrace.  This could be considered a feature.
466
559
    </para>
467
560
    <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
561
      There is no fine-grained control over logging and debug output.
480
562
    </para>
481
563
    <para>
482
564
      Debug mode is conflated with running in the foreground.
483
565
    </para>
484
566
    <para>
485
 
      The console log messages does not show a timestamp.
 
567
      This server does not check the expire time of clients’ OpenPGP
 
568
      keys.
486
569
    </para>
487
570
  </refsect1>
488
571
  
493
576
        Normal invocation needs no options:
494
577
      </para>
495
578
      <para>
496
 
        <userinput>mandos</userinput>
 
579
        <userinput>&COMMANDNAME;</userinput>
497
580
      </para>
498
581
    </informalexample>
499
582
    <informalexample>
500
583
      <para>
501
584
        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:
 
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:
505
588
      </para>
506
589
      <para>
507
590
 
508
591
<!-- do not wrap this line -->
509
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
592
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
510
593
 
511
594
      </para>
512
595
    </informalexample>
518
601
      <para>
519
602
 
520
603
<!-- do not wrap this line -->
521
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
604
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
522
605
 
523
606
      </para>
524
607
    </informalexample>
525
608
  </refsect1>
526
 
 
 
609
  
527
610
  <refsect1 id="security">
528
611
    <title>SECURITY</title>
529
 
    <refsect2 id="SERVER">
 
612
    <refsect2 id="server">
530
613
      <title>SERVER</title>
531
614
      <para>
532
615
        Running this <command>&COMMANDNAME;</command> server program
533
616
        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.
 
617
        computer running it.  The program switches to a non-root user
 
618
        soon after startup.
536
619
      </para>
537
620
    </refsect2>
538
 
    <refsect2 id="CLIENTS">
 
621
    <refsect2 id="clients">
539
622
      <title>CLIENTS</title>
540
623
      <para>
541
624
        The server only gives out its stored data to clients which
548
631
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
549
632
        <manvolnum>5</manvolnum></citerefentry>)
550
633
        <emphasis>must</emphasis> be made non-readable by anyone
551
 
        except the user running the server.
 
634
        except the user starting the server (usually root).
552
635
      </para>
553
636
      <para>
554
637
        As detailed in <xref linkend="checking"/>, the status of all
556
639
        compromised if they are gone for too long.
557
640
      </para>
558
641
      <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
642
        For more details on client-side security, see
576
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
643
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
577
644
        <manvolnum>8mandos</manvolnum></citerefentry>.
578
645
      </para>
579
646
    </refsect2>
580
647
  </refsect1>
581
 
 
 
648
  
582
649
  <refsect1 id="see_also">
583
650
    <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>
584
663
    <variablelist>
585
664
      <varlistentry>
586
665
        <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
666
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
604
667
        </term>
605
668
        <listitem>
622
685
      </varlistentry>
623
686
      <varlistentry>
624
687
        <term>
625
 
          <ulink
626
 
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
688
          <ulink url="http://www.gnu.org/software/gnutls/"
 
689
          >GnuTLS</ulink>
627
690
        </term>
628
691
      <listitem>
629
692
        <para>
635
698
      </varlistentry>
636
699
      <varlistentry>
637
700
        <term>
638
 
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
639
 
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
640
 
          Unicast Addresses</citation>
 
701
          RFC 4291: <citetitle>IP Version 6 Addressing
 
702
          Architecture</citetitle>
641
703
        </term>
642
704
        <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>
 
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>
649
729
        </listitem>
650
730
      </varlistentry>
651
731
      <varlistentry>
652
732
        <term>
653
 
          <citation>RFC 4346: <citetitle>The Transport Layer Security
654
 
          (TLS) Protocol Version 1.1</citetitle></citation>
 
733
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
734
          Protocol Version 1.1</citetitle>
655
735
        </term>
656
736
      <listitem>
657
737
        <para>
661
741
      </varlistentry>
662
742
      <varlistentry>
663
743
        <term>
664
 
          <citation>RFC 4880: <citetitle>OpenPGP Message
665
 
          Format</citetitle></citation>
 
744
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
666
745
        </term>
667
746
      <listitem>
668
747
        <para>
672
751
      </varlistentry>
673
752
      <varlistentry>
674
753
        <term>
675
 
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
676
 
          Transport Layer Security</citetitle></citation>
 
754
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
755
          Security</citetitle>
677
756
        </term>
678
757
      <listitem>
679
758
        <para>
685
764
    </variablelist>
686
765
  </refsect1>
687
766
</refentry>
 
767
<!-- Local Variables: -->
 
768
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
769
<!-- time-stamp-end: "[\"']>" -->
 
770
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
771
<!-- End: -->