/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-22 23:33:56 UTC
  • Revision ID: teddy@recompile.se-20120622233356-odoqqt2ki2gssn37
* Makefile (check): Also check mandos-ctl.
* mandos-ctl: All options taking a time interval argument can now take
              an RFC 3339 duration.
  (rfc3339_duration_to_delta): New function.
  (string_to_delta): Try rfc3339_duration_to_delta first.
  (main): New "--check" option.
* mandos-ctl.xml (SYNOPSIS, OPTIONS): Document new "--check" option.

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