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