/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:25:01 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818032501-2cl874fi3uvsqn1b
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
                         tags.  Also show the "-h" option.
  (OPTIONS): Note that failure to obey the "--interface" option is not
             considered critical.
  (ENVIRONMENT): New section to document the use of PATH by /bin/sh.
  (FILES): Added "/bin/sh".
  (BUGS): Add five bugs from the TODO file.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).
  (SERVER, CLIENTS): Added "id" attribute.
  (CLIENT): Document the security implications of one of the five
            bugs added to the BUGS section.

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