/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2014-03-28 22:32:21 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 311.
  • Revision ID: teddy@recompile.se-20140328223221-w579qlvlex5if3dn
Fix location and format of signing key file.

* debian/upstream/signing-key.asc: Added.
* debian/upstream-signing-key.pgp: Removed.

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 "2013-10-26">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
7
8
]>
8
9
 
9
 
<refentry>
10
 
  <refentryinfo>
11
 
    <title>&COMMANDNAME;</title>
 
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
11
   <refentryinfo>
 
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>&COMMANDNAME;</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
14
    <productname>Mandos</productname>
 
15
    <productnumber>&version;</productnumber>
 
16
    <date>&TIMESTAMP;</date>
15
17
    <authorgroup>
16
18
      <author>
17
19
        <firstname>Björn</firstname>
18
20
        <surname>Påhlsson</surname>
19
21
        <address>
20
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
21
23
        </address>
22
24
      </author>
23
25
      <author>
24
26
        <firstname>Teddy</firstname>
25
27
        <surname>Hogeborn</surname>
26
28
        <address>
27
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
28
30
        </address>
29
31
      </author>
30
32
    </authorgroup>
31
33
    <copyright>
32
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
 
38
      <year>2012</year>
 
39
      <year>2013</year>
33
40
      <holder>Teddy Hogeborn</holder>
34
41
      <holder>Björn Påhlsson</holder>
35
42
    </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>
 
43
    <xi:include href="legalnotice.xml"/>
59
44
  </refentryinfo>
60
 
 
 
45
  
61
46
  <refmeta>
62
47
    <refentrytitle>&COMMANDNAME;</refentrytitle>
63
48
    <manvolnum>8</manvolnum>
66
51
  <refnamediv>
67
52
    <refname><command>&COMMANDNAME;</command></refname>
68
53
    <refpurpose>
69
 
      Sends encrypted passwords to authenticated Mandos clients
 
54
      Gives encrypted passwords to authenticated Mandos clients
70
55
    </refpurpose>
71
56
  </refnamediv>
72
 
 
 
57
  
73
58
  <refsynopsisdiv>
74
59
    <cmdsynopsis>
75
60
      <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>
 
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>
93
109
    </cmdsynopsis>
94
110
    <cmdsynopsis>
95
111
      <command>&COMMANDNAME;</command>
96
112
      <group choice="req">
97
 
        <arg choice="plain">-h</arg>
98
 
        <arg choice="plain">--help</arg>
 
113
        <arg choice="plain"><option>--help</option></arg>
 
114
        <arg choice="plain"><option>-h</option></arg>
99
115
      </group>
100
116
    </cmdsynopsis>
101
117
    <cmdsynopsis>
102
118
      <command>&COMMANDNAME;</command>
103
 
      <arg choice="plain">--version</arg>
 
119
      <arg choice="plain"><option>--version</option></arg>
104
120
    </cmdsynopsis>
105
121
    <cmdsynopsis>
106
122
      <command>&COMMANDNAME;</command>
107
 
      <arg choice="plain">--check</arg>
 
123
      <arg choice="plain"><option>--check</option></arg>
108
124
    </cmdsynopsis>
109
125
  </refsynopsisdiv>
110
 
 
 
126
  
111
127
  <refsect1 id="description">
112
128
    <title>DESCRIPTION</title>
113
129
    <para>
114
130
      <command>&COMMANDNAME;</command> is a server daemon which
115
131
      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.
 
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.
124
142
    </para>
125
 
 
126
143
  </refsect1>
127
144
  
128
145
  <refsect1 id="purpose">
129
146
    <title>PURPOSE</title>
130
 
 
131
147
    <para>
132
148
      The purpose of this is to enable <emphasis>remote and unattended
133
149
      rebooting</emphasis> of client host computer with an
134
150
      <emphasis>encrypted root file system</emphasis>.  See <xref
135
151
      linkend="overview"/> for details.
136
152
    </para>
137
 
 
138
153
  </refsect1>
139
154
  
140
155
  <refsect1 id="options">
141
156
    <title>OPTIONS</title>
142
 
 
143
157
    <variablelist>
144
158
      <varlistentry>
145
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
159
        <term><option>--help</option></term>
 
160
        <term><option>-h</option></term>
146
161
        <listitem>
147
162
          <para>
148
163
            Show a help message and exit
149
164
          </para>
150
165
        </listitem>
151
166
      </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>
 
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>
198
200
        <listitem>
199
201
          <para>
200
202
            Run the server’s self-tests.  This includes any unit
202
204
          </para>
203
205
        </listitem>
204
206
      </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>.  You only need
241
 
            to change this if you for some reason want to run more
242
 
            than one server on the same <emphasis>host</emphasis>,
243
 
            which would not normally be useful.  If there are name
244
 
            collisions on the same <emphasis>network</emphasis>, the
245
 
            newer server will automatically rename itself to
246
 
            <quote><literal>Mandos #2</literal></quote>, and so on;
247
 
            therefore, this option is not needed in that case.
248
 
          </para>
249
 
        </listitem>
250
 
      </varlistentry>
251
 
 
252
 
      <varlistentry>
253
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
254
 
        </literal></term>
 
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>
255
254
        <listitem>
256
255
          <para>
257
256
            Directory to search for configuration files.  Default is
263
262
          </para>
264
263
        </listitem>
265
264
      </varlistentry>
266
 
 
 
265
      
267
266
      <varlistentry>
268
 
        <term><literal>--version</literal></term>
 
267
        <term><option>--version</option></term>
269
268
        <listitem>
270
269
          <para>
271
270
            Prints the program version and exit.
272
271
          </para>
273
272
        </listitem>
274
273
      </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
      
275
326
    </variablelist>
276
327
  </refsect1>
277
 
 
 
328
  
278
329
  <refsect1 id="overview">
279
330
    <title>OVERVIEW</title>
280
 
    &OVERVIEW;
 
331
    <xi:include href="overview.xml"/>
281
332
    <para>
282
333
      This program is the server part.  It is a normal server program
283
334
      and will run in a normal system environment, not in an initial
284
 
      RAM disk environment.
 
335
      <acronym>RAM</acronym> disk environment.
285
336
    </para>
286
337
  </refsect1>
287
 
 
 
338
  
288
339
  <refsect1 id="protocol">
289
340
    <title>NETWORK PROTOCOL</title>
290
341
    <para>
316
367
        <entry>-><!-- &rarr; --></entry>
317
368
      </row>
318
369
      <row>
319
 
        <entry><quote><literal>1\r\en</literal></quote></entry>
 
370
        <entry><quote><literal>1\r\n</literal></quote></entry>
320
371
        <entry>-><!-- &rarr; --></entry>
321
372
      </row>
322
373
      <row>
342
393
      </row>
343
394
    </tbody></tgroup></table>
344
395
  </refsect1>
345
 
 
 
396
  
346
397
  <refsect1 id="checking">
347
398
    <title>CHECKING</title>
348
399
    <para>
349
400
      The server will, by default, continually check that the clients
350
401
      are still up.  If a client has not been confirmed as being up
351
402
      for some time, the client is assumed to be compromised and is no
352
 
      longer eligible to receive the encrypted password.  The timeout,
353
 
      checker program, and interval between checks can be configured
354
 
      both globally and per client; see <citerefentry>
355
 
      <refentrytitle>mandos.conf</refentrytitle>
356
 
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
 
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>
 
408
      <manvolnum>5</manvolnum></citerefentry>.
 
409
    </para>
 
410
  </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>
357
419
      <refentrytitle>mandos-clients.conf</refentrytitle>
358
 
      <manvolnum>5</manvolnum></citerefentry>.
359
 
    </para>
 
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
    
360
430
  </refsect1>
361
 
 
 
431
  
362
432
  <refsect1 id="logging">
363
433
    <title>LOGGING</title>
364
434
    <para>
365
 
      The server will send log messaged with various severity levels
366
 
      to <filename>/dev/log</filename>.  With the
 
435
      The server will send log message with various severity levels to
 
436
      <filename class="devicefile">/dev/log</filename>.  With the
367
437
      <option>--debug</option> option, it will log even more messages,
368
438
      and also show them on the console.
369
439
    </para>
370
440
  </refsect1>
371
 
 
 
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
  <refsect1 id="exit_status">
373
465
    <title>EXIT STATUS</title>
374
466
    <para>
376
468
      critical error is encountered.
377
469
    </para>
378
470
  </refsect1>
379
 
 
 
471
  
380
472
  <refsect1 id="environment">
381
473
    <title>ENVIRONMENT</title>
382
474
    <variablelist>
383
475
      <varlistentry>
384
 
        <term><varname>PATH</varname></term>
 
476
        <term><envar>PATH</envar></term>
385
477
        <listitem>
386
478
          <para>
387
479
            To start the configured checker (see <xref
390
482
            <varname>PATH</varname> to search for matching commands if
391
483
            an absolute path is not given.  See <citerefentry>
392
484
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
393
 
          </citerefentry>
 
485
            </citerefentry>.
394
486
          </para>
395
487
        </listitem>
396
488
      </varlistentry>
397
489
    </variablelist>
398
490
  </refsect1>
399
 
 
400
 
  <refsect1 id="file">
 
491
  
 
492
  <refsect1 id="files">
401
493
    <title>FILES</title>
402
494
    <para>
403
495
      Use the <option>--configdir</option> option to change where
426
518
        </listitem>
427
519
      </varlistentry>
428
520
      <varlistentry>
429
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
430
 
        <listitem>
431
 
          <para>
432
 
            The file containing the process id of
433
 
            <command>&COMMANDNAME;</command>.
 
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.
434
544
          </para>
435
545
        </listitem>
436
546
      </varlistentry>
464
574
      backtrace.  This could be considered a feature.
465
575
    </para>
466
576
    <para>
467
 
      Currently, if a client is declared <quote>invalid</quote> due to
468
 
      having timed out, the server does not record this fact onto
469
 
      permanent storage.  This has some security implications, see
470
 
      <xref linkend="CLIENTS"/>.
471
 
    </para>
472
 
    <para>
473
 
      There is currently no way of querying the server of the current
474
 
      status of clients, other than analyzing its <systemitem
475
 
      class="service">syslog</systemitem> output.
476
 
    </para>
477
 
    <para>
478
577
      There is no fine-grained control over logging and debug output.
479
578
    </para>
480
579
    <para>
481
 
      Debug mode is conflated with running in the foreground.
482
 
    </para>
483
 
    <para>
484
 
      The console log messages does not show a timestamp.
 
580
      This server does not check the expire time of clients’ OpenPGP
 
581
      keys.
485
582
    </para>
486
583
  </refsect1>
487
584
  
492
589
        Normal invocation needs no options:
493
590
      </para>
494
591
      <para>
495
 
        <userinput>mandos</userinput>
 
592
        <userinput>&COMMANDNAME;</userinput>
496
593
      </para>
497
594
    </informalexample>
498
595
    <informalexample>
499
596
      <para>
500
597
        Run the server in debug mode, read configuration files from
501
 
        the <filename>~/mandos</filename> directory, and use the
502
 
        Zeroconf service name <quote>Test</quote> to not collide with
503
 
        any other official Mandos server on this host:
 
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:
504
601
      </para>
505
602
      <para>
506
603
 
507
604
<!-- do not wrap this line -->
508
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
605
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
509
606
 
510
607
      </para>
511
608
    </informalexample>
517
614
      <para>
518
615
 
519
616
<!-- do not wrap this line -->
520
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
617
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
521
618
 
522
619
      </para>
523
620
    </informalexample>
524
621
  </refsect1>
525
 
 
 
622
  
526
623
  <refsect1 id="security">
527
624
    <title>SECURITY</title>
528
 
    <refsect2 id="SERVER">
 
625
    <refsect2 id="server">
529
626
      <title>SERVER</title>
530
627
      <para>
531
628
        Running this <command>&COMMANDNAME;</command> server program
532
629
        should not in itself present any security risk to the host
533
 
        computer running it.  The program does not need any special
534
 
        privileges to run, and is designed to run as a non-root user.
 
630
        computer running it.  The program switches to a non-root user
 
631
        soon after startup.
535
632
      </para>
536
633
    </refsect2>
537
 
    <refsect2 id="CLIENTS">
 
634
    <refsect2 id="clients">
538
635
      <title>CLIENTS</title>
539
636
      <para>
540
637
        The server only gives out its stored data to clients which
547
644
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
548
645
        <manvolnum>5</manvolnum></citerefentry>)
549
646
        <emphasis>must</emphasis> be made non-readable by anyone
550
 
        except the user running the server.
 
647
        except the user starting the server (usually root).
551
648
      </para>
552
649
      <para>
553
650
        As detailed in <xref linkend="checking"/>, the status of all
555
652
        compromised if they are gone for too long.
556
653
      </para>
557
654
      <para>
558
 
        If a client is compromised, its downtime should be duly noted
559
 
        by the server which would therefore declare the client
560
 
        invalid.  But if the server was ever restarted, it would
561
 
        re-read its client list from its configuration file and again
562
 
        regard all clients therein as valid, and hence eligible to
563
 
        receive their passwords.  Therefore, be careful when
564
 
        restarting servers if you suspect that a client has, in fact,
565
 
        been compromised by parties who may now be running a fake
566
 
        Mandos client with the keys from the non-encrypted initial RAM
567
 
        image of the client host.  What should be done in that case
568
 
        (if restarting the server program really is necessary) is to
569
 
        stop the server program, edit the configuration file to omit
570
 
        any suspect clients, and restart the server program.
571
 
      </para>
572
 
      <para>
573
655
        For more details on client-side security, see
574
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
656
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
575
657
        <manvolnum>8mandos</manvolnum></citerefentry>.
576
658
      </para>
577
659
    </refsect2>
578
660
  </refsect1>
579
 
 
 
661
  
580
662
  <refsect1 id="see_also">
581
663
    <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>
582
676
    <variablelist>
583
677
      <varlistentry>
584
678
        <term>
585
 
          <citerefentry>
586
 
            <refentrytitle>password-request</refentrytitle>
587
 
            <manvolnum>8mandos</manvolnum>
588
 
          </citerefentry>
589
 
        </term>
590
 
        <listitem>
591
 
          <para>
592
 
            This is the actual program which talks to this server.
593
 
            Note that it is normally not invoked directly, and is only
594
 
            run in the initial RAM disk environment, and not on a
595
 
            fully started system.
596
 
          </para>
597
 
        </listitem>
598
 
      </varlistentry>
599
 
      <varlistentry>
600
 
        <term>
601
679
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
602
680
        </term>
603
681
        <listitem>
620
698
      </varlistentry>
621
699
      <varlistentry>
622
700
        <term>
623
 
          <ulink
624
 
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
701
          <ulink url="http://www.gnu.org/software/gnutls/"
 
702
          >GnuTLS</ulink>
625
703
        </term>
626
704
      <listitem>
627
705
        <para>
633
711
      </varlistentry>
634
712
      <varlistentry>
635
713
        <term>
636
 
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
637
 
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
638
 
          Unicast Addresses</citation>
 
714
          RFC 4291: <citetitle>IP Version 6 Addressing
 
715
          Architecture</citetitle>
639
716
        </term>
640
717
        <listitem>
641
 
          <para>
642
 
            The clients use IPv6 link-local addresses, which are
643
 
            immediately usable since a link-local addresses is
644
 
            automatically assigned to a network interfaces when it is
645
 
            brought up.
646
 
          </para>
 
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>
647
742
        </listitem>
648
743
      </varlistentry>
649
744
      <varlistentry>
650
745
        <term>
651
 
          <citation>RFC 4346: <citetitle>The Transport Layer Security
652
 
          (TLS) Protocol Version 1.1</citetitle></citation>
 
746
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
747
          Protocol Version 1.1</citetitle>
653
748
        </term>
654
749
      <listitem>
655
750
        <para>
659
754
      </varlistentry>
660
755
      <varlistentry>
661
756
        <term>
662
 
          <citation>RFC 4880: <citetitle>OpenPGP Message
663
 
          Format</citetitle></citation>
 
757
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
664
758
        </term>
665
759
      <listitem>
666
760
        <para>
670
764
      </varlistentry>
671
765
      <varlistentry>
672
766
        <term>
673
 
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
674
 
          Transport Layer Security</citetitle></citation>
 
767
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
768
          Security</citetitle>
675
769
        </term>
676
770
      <listitem>
677
771
        <para>
683
777
    </variablelist>
684
778
  </refsect1>
685
779
</refentry>
 
780
<!-- Local Variables: -->
 
781
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
782
<!-- time-stamp-end: "[\"']>" -->
 
783
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
784
<!-- End: -->