/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:50:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818035028-su31apqs2pv2147v
* mandos-keygen.xml: Removed <?xml-stylesheet>.  New entity
                     "&OVERVIEW;" referring to "overview.xml".
  (PURPOSE, OVERVIEW): New sections, same as in mandos(8).
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).

* mandos.xml (OPTIONS, CLIENTS): Slight wording change.

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