/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: 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 "2022-04-24">
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
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <year>2018</year>
45
 
      <year>2019</year>
46
33
      <holder>Teddy Hogeborn</holder>
47
34
      <holder>Björn Påhlsson</holder>
48
35
    </copyright>
49
 
    <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>
50
59
  </refentryinfo>
51
 
  
 
60
 
52
61
  <refmeta>
53
62
    <refentrytitle>&COMMANDNAME;</refentrytitle>
54
63
    <manvolnum>8</manvolnum>
57
66
  <refnamediv>
58
67
    <refname><command>&COMMANDNAME;</command></refname>
59
68
    <refpurpose>
60
 
      Gives encrypted passwords to authenticated Mandos clients
 
69
      Sends encrypted passwords to authenticated Mandos clients
61
70
    </refpurpose>
62
71
  </refnamediv>
63
 
  
 
72
 
64
73
  <refsynopsisdiv>
65
74
    <cmdsynopsis>
66
75
      <command>&COMMANDNAME;</command>
67
 
      <group>
68
 
        <arg choice="plain"><option>--interface
69
 
        <replaceable>NAME</replaceable></option></arg>
70
 
        <arg choice="plain"><option>-i
71
 
        <replaceable>NAME</replaceable></option></arg>
72
 
      </group>
73
 
      <sbr/>
74
 
      <group>
75
 
        <arg choice="plain"><option>--address
76
 
        <replaceable>ADDRESS</replaceable></option></arg>
77
 
        <arg choice="plain"><option>-a
78
 
        <replaceable>ADDRESS</replaceable></option></arg>
79
 
      </group>
80
 
      <sbr/>
81
 
      <group>
82
 
        <arg choice="plain"><option>--port
83
 
        <replaceable>PORT</replaceable></option></arg>
84
 
        <arg choice="plain"><option>-p
85
 
        <replaceable>PORT</replaceable></option></arg>
86
 
      </group>
87
 
      <sbr/>
88
 
      <arg><option>--priority
89
 
      <replaceable>PRIORITY</replaceable></option></arg>
90
 
      <sbr/>
91
 
      <arg><option>--servicename
92
 
      <replaceable>NAME</replaceable></option></arg>
93
 
      <sbr/>
94
 
      <arg><option>--configdir
95
 
      <replaceable>DIRECTORY</replaceable></option></arg>
96
 
      <sbr/>
97
 
      <arg><option>--debug</option></arg>
98
 
      <sbr/>
99
 
      <arg><option>--debuglevel
100
 
      <replaceable>LEVEL</replaceable></option></arg>
101
 
      <sbr/>
102
 
      <arg><option>--no-dbus</option></arg>
103
 
      <sbr/>
104
 
      <arg><option>--no-ipv6</option></arg>
105
 
      <sbr/>
106
 
      <arg><option>--no-restore</option></arg>
107
 
      <sbr/>
108
 
      <arg><option>--statedir
109
 
      <replaceable>DIRECTORY</replaceable></option></arg>
110
 
      <sbr/>
111
 
      <arg><option>--socket
112
 
      <replaceable>FD</replaceable></option></arg>
113
 
      <sbr/>
114
 
      <arg><option>--foreground</option></arg>
115
 
      <sbr/>
116
 
      <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>
117
93
    </cmdsynopsis>
118
94
    <cmdsynopsis>
119
95
      <command>&COMMANDNAME;</command>
120
96
      <group choice="req">
121
 
        <arg choice="plain"><option>--help</option></arg>
122
 
        <arg choice="plain"><option>-h</option></arg>
 
97
        <arg choice="plain">-h</arg>
 
98
        <arg choice="plain">--help</arg>
123
99
      </group>
124
100
    </cmdsynopsis>
125
101
    <cmdsynopsis>
126
102
      <command>&COMMANDNAME;</command>
127
 
      <arg choice="plain"><option>--version</option></arg>
 
103
      <arg choice="plain">--version</arg>
128
104
    </cmdsynopsis>
129
105
    <cmdsynopsis>
130
106
      <command>&COMMANDNAME;</command>
131
 
      <arg choice="plain"><option>--check</option></arg>
 
107
      <arg choice="plain">--check</arg>
132
108
    </cmdsynopsis>
133
109
  </refsynopsisdiv>
134
 
  
 
110
 
135
111
  <refsect1 id="description">
136
112
    <title>DESCRIPTION</title>
137
113
    <para>
138
114
      <command>&COMMANDNAME;</command> is a server daemon which
139
 
      handles incoming requests for passwords for a pre-defined list
140
 
      of client host computers. For an introduction, see
141
 
      <citerefentry><refentrytitle>intro</refentrytitle>
142
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
143
 
      uses Zeroconf to announce itself on the local network, and uses
144
 
      TLS to communicate securely with and to authenticate the
145
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
146
 
      use IPv6 link-local addresses, since the clients will probably
147
 
      not have any other addresses configured (see <xref
148
 
      linkend="overview"/>).  Any authenticated client is then given
149
 
      the stored pre-encrypted password for that specific client.
 
115
      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.
150
124
    </para>
 
125
 
151
126
  </refsect1>
152
127
  
153
128
  <refsect1 id="purpose">
154
129
    <title>PURPOSE</title>
 
130
 
155
131
    <para>
156
132
      The purpose of this is to enable <emphasis>remote and unattended
157
133
      rebooting</emphasis> of client host computer with an
158
134
      <emphasis>encrypted root file system</emphasis>.  See <xref
159
135
      linkend="overview"/> for details.
160
136
    </para>
 
137
 
161
138
  </refsect1>
162
139
  
163
140
  <refsect1 id="options">
164
141
    <title>OPTIONS</title>
 
142
 
165
143
    <variablelist>
166
144
      <varlistentry>
167
 
        <term><option>--help</option></term>
168
 
        <term><option>-h</option></term>
 
145
        <term><literal>-h</literal>, <literal>--help</literal></term>
169
146
        <listitem>
170
147
          <para>
171
148
            Show a help message and exit
172
149
          </para>
173
150
        </listitem>
174
151
      </varlistentry>
175
 
      
176
 
      <varlistentry>
177
 
        <term><option>--interface</option>
178
 
        <replaceable>NAME</replaceable></term>
179
 
        <term><option>-i</option>
180
 
        <replaceable>NAME</replaceable></term>
181
 
        <listitem>
182
 
          <xi:include href="mandos-options.xml" xpointer="interface"/>
183
 
        </listitem>
184
 
      </varlistentry>
185
 
      
186
 
      <varlistentry>
187
 
        <term><option>--address
188
 
        <replaceable>ADDRESS</replaceable></option></term>
189
 
        <term><option>-a
190
 
        <replaceable>ADDRESS</replaceable></option></term>
191
 
        <listitem>
192
 
          <xi:include href="mandos-options.xml" xpointer="address"/>
193
 
        </listitem>
194
 
      </varlistentry>
195
 
      
196
 
      <varlistentry>
197
 
        <term><option>--port
198
 
        <replaceable>PORT</replaceable></option></term>
199
 
        <term><option>-p
200
 
        <replaceable>PORT</replaceable></option></term>
201
 
        <listitem>
202
 
          <xi:include href="mandos-options.xml" xpointer="port"/>
203
 
        </listitem>
204
 
      </varlistentry>
205
 
      
206
 
      <varlistentry>
207
 
        <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>
208
198
        <listitem>
209
199
          <para>
210
200
            Run the server’s self-tests.  This includes any unit
212
202
          </para>
213
203
        </listitem>
214
204
      </varlistentry>
215
 
      
216
 
      <varlistentry>
217
 
        <term><option>--debug</option></term>
218
 
        <listitem>
219
 
          <xi:include href="mandos-options.xml" xpointer="debug"/>
220
 
        </listitem>
221
 
      </varlistentry>
222
 
      
223
 
      <varlistentry>
224
 
        <term><option>--debuglevel
225
 
        <replaceable>LEVEL</replaceable></option></term>
226
 
        <listitem>
227
 
          <para>
228
 
            Set the debugging log level.
229
 
            <replaceable>LEVEL</replaceable> is a string, one of
230
 
            <quote><literal>CRITICAL</literal></quote>,
231
 
            <quote><literal>ERROR</literal></quote>,
232
 
            <quote><literal>WARNING</literal></quote>,
233
 
            <quote><literal>INFO</literal></quote>, or
234
 
            <quote><literal>DEBUG</literal></quote>, in order of
235
 
            increasing verbosity.  The default level is
236
 
            <quote><literal>WARNING</literal></quote>.
237
 
          </para>
238
 
        </listitem>
239
 
      </varlistentry>
240
 
      
241
 
      <varlistentry>
242
 
        <term><option>--priority <replaceable>
243
 
        PRIORITY</replaceable></option></term>
244
 
        <listitem>
245
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
246
 
        </listitem>
247
 
      </varlistentry>
248
 
      
249
 
      <varlistentry>
250
 
        <term><option>--servicename
251
 
        <replaceable>NAME</replaceable></option></term>
252
 
        <listitem>
253
 
          <xi:include href="mandos-options.xml"
254
 
                      xpointer="servicename"/>
255
 
        </listitem>
256
 
      </varlistentry>
257
 
      
258
 
      <varlistentry>
259
 
        <term><option>--configdir
260
 
        <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>
261
255
        <listitem>
262
256
          <para>
263
257
            Directory to search for configuration files.  Default is
269
263
          </para>
270
264
        </listitem>
271
265
      </varlistentry>
272
 
      
 
266
 
273
267
      <varlistentry>
274
 
        <term><option>--version</option></term>
 
268
        <term><literal>--version</literal></term>
275
269
        <listitem>
276
270
          <para>
277
271
            Prints the program version and exit.
278
272
          </para>
279
273
        </listitem>
280
274
      </varlistentry>
281
 
      
282
 
      <varlistentry>
283
 
        <term><option>--no-dbus</option></term>
284
 
        <listitem>
285
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
286
 
          <para>
287
 
            See also <xref linkend="dbus_interface"/>.
288
 
          </para>
289
 
        </listitem>
290
 
      </varlistentry>
291
 
      
292
 
      <varlistentry>
293
 
        <term><option>--no-ipv6</option></term>
294
 
        <listitem>
295
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
296
 
        </listitem>
297
 
      </varlistentry>
298
 
      
299
 
      <varlistentry>
300
 
        <term><option>--no-restore</option></term>
301
 
        <listitem>
302
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
303
 
          <para>
304
 
            See also <xref linkend="persistent_state"/>.
305
 
          </para>
306
 
        </listitem>
307
 
      </varlistentry>
308
 
      
309
 
      <varlistentry>
310
 
        <term><option>--statedir
311
 
        <replaceable>DIRECTORY</replaceable></option></term>
312
 
        <listitem>
313
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
314
 
        </listitem>
315
 
      </varlistentry>
316
 
      
317
 
      <varlistentry>
318
 
        <term><option>--socket
319
 
        <replaceable>FD</replaceable></option></term>
320
 
        <listitem>
321
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
322
 
        </listitem>
323
 
      </varlistentry>
324
 
      
325
 
      <varlistentry>
326
 
        <term><option>--foreground</option></term>
327
 
        <listitem>
328
 
          <xi:include href="mandos-options.xml"
329
 
                      xpointer="foreground"/>
330
 
        </listitem>
331
 
      </varlistentry>
332
 
      
333
 
      <varlistentry>
334
 
        <term><option>--no-zeroconf</option></term>
335
 
        <listitem>
336
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
337
 
        </listitem>
338
 
      </varlistentry>
339
 
      
340
275
    </variablelist>
341
276
  </refsect1>
342
 
  
 
277
 
343
278
  <refsect1 id="overview">
344
279
    <title>OVERVIEW</title>
345
 
    <xi:include href="overview.xml"/>
 
280
    &OVERVIEW;
346
281
    <para>
347
282
      This program is the server part.  It is a normal server program
348
283
      and will run in a normal system environment, not in an initial
349
 
      <acronym>RAM</acronym> disk environment.
 
284
      RAM disk environment.
350
285
    </para>
351
286
  </refsect1>
352
 
  
 
287
 
353
288
  <refsect1 id="protocol">
354
289
    <title>NETWORK PROTOCOL</title>
355
290
    <para>
362
297
      start a TLS protocol handshake with a slight quirk: the Mandos
363
298
      server program acts as a TLS <quote>client</quote> while the
364
299
      connecting Mandos client acts as a TLS <quote>server</quote>.
365
 
      The Mandos client must supply a TLS public key, and the key ID
366
 
      of this public key is used by the Mandos server to look up (in a
367
 
      list read from <filename>clients.conf</filename> at start time)
368
 
      which binary blob to give the client.  No other authentication
369
 
      or authorization is done by the server.
 
300
      The Mandos client must supply an OpenPGP certificate, and the
 
301
      fingerprint of this certificate is used by the Mandos server to
 
302
      look up (in a list read from <filename>clients.conf</filename>
 
303
      at start time) which binary blob to give the client.  No other
 
304
      authentication or authorization is done by the server.
370
305
    </para>
371
306
    <table>
372
307
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
381
316
        <entry>-><!-- &rarr; --></entry>
382
317
      </row>
383
318
      <row>
384
 
        <entry><quote><literal>1\r\n</literal></quote></entry>
 
319
        <entry><quote><literal>1\r\en</literal></quote></entry>
385
320
        <entry>-><!-- &rarr; --></entry>
386
321
      </row>
387
322
      <row>
392
327
        </emphasis></entry>
393
328
      </row>
394
329
      <row>
395
 
        <entry>Public key (part of TLS handshake)</entry>
 
330
        <entry>OpenPGP public key (part of TLS handshake)</entry>
396
331
        <entry>-><!-- &rarr; --></entry>
397
332
      </row>
398
333
      <row>
407
342
      </row>
408
343
    </tbody></tgroup></table>
409
344
  </refsect1>
410
 
  
 
345
 
411
346
  <refsect1 id="checking">
412
347
    <title>CHECKING</title>
413
348
    <para>
414
349
      The server will, by default, continually check that the clients
415
350
      are still up.  If a client has not been confirmed as being up
416
351
      for some time, the client is assumed to be compromised and is no
417
 
      longer eligible to receive the encrypted password.  (Manual
418
 
      intervention is required to re-enable a client.)  The timeout,
419
 
      extended timeout, checker program, and interval between checks
420
 
      can be configured both globally and per client; see
421
 
      <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>
422
358
      <manvolnum>5</manvolnum></citerefentry>.
423
359
    </para>
424
360
  </refsect1>
425
 
  
426
 
  <refsect1 id="approval">
427
 
    <title>APPROVAL</title>
428
 
    <para>
429
 
      The server can be configured to require manual approval for a
430
 
      client before it is sent its secret.  The delay to wait for such
431
 
      approval and the default action (approve or deny) can be
432
 
      configured both globally and per client; see <citerefentry>
433
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
434
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
435
 
      will be approved immediately without delay.
436
 
    </para>
437
 
    <para>
438
 
      This can be used to deny a client its secret if not manually
439
 
      approved within a specified time.  It can also be used to make
440
 
      the server delay before giving a client its secret, allowing
441
 
      optional manual denying of this specific client.
442
 
    </para>
443
 
    
444
 
  </refsect1>
445
 
  
 
361
 
446
362
  <refsect1 id="logging">
447
363
    <title>LOGGING</title>
448
364
    <para>
449
 
      The server will send log message with various severity levels to
450
 
      <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
451
367
      <option>--debug</option> option, it will log even more messages,
452
368
      and also show them on the console.
453
369
    </para>
454
370
  </refsect1>
455
 
  
456
 
  <refsect1 id="persistent_state">
457
 
    <title>PERSISTENT STATE</title>
458
 
    <para>
459
 
      Client settings, initially read from
460
 
      <filename>clients.conf</filename>, are persistent across
461
 
      restarts, and run-time changes will override settings in
462
 
      <filename>clients.conf</filename>.  However, if a setting is
463
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
464
 
      <filename>clients.conf</filename>, this will take precedence.
465
 
    </para>
466
 
  </refsect1>
467
 
  
468
 
  <refsect1 id="dbus_interface">
469
 
    <title>D-BUS INTERFACE</title>
470
 
    <para>
471
 
      The server will by default provide a D-Bus system bus interface.
472
 
      This interface will only be accessible by the root user or a
473
 
      Mandos-specific user, if such a user exists.  For documentation
474
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
475
 
    </para>
476
 
  </refsect1>
477
 
  
 
371
 
478
372
  <refsect1 id="exit_status">
479
373
    <title>EXIT STATUS</title>
480
374
    <para>
482
376
      critical error is encountered.
483
377
    </para>
484
378
  </refsect1>
485
 
  
 
379
 
486
380
  <refsect1 id="environment">
487
381
    <title>ENVIRONMENT</title>
488
382
    <variablelist>
489
383
      <varlistentry>
490
 
        <term><envar>PATH</envar></term>
 
384
        <term><varname>PATH</varname></term>
491
385
        <listitem>
492
386
          <para>
493
387
            To start the configured checker (see <xref
496
390
            <varname>PATH</varname> to search for matching commands if
497
391
            an absolute path is not given.  See <citerefentry>
498
392
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
499
 
            </citerefentry>.
 
393
          </citerefentry>
500
394
          </para>
501
395
        </listitem>
502
396
      </varlistentry>
503
397
    </variablelist>
504
398
  </refsect1>
505
 
  
506
 
  <refsect1 id="files">
 
399
 
 
400
  <refsect1 id="file">
507
401
    <title>FILES</title>
508
402
    <para>
509
403
      Use the <option>--configdir</option> option to change where
532
426
        </listitem>
533
427
      </varlistentry>
534
428
      <varlistentry>
535
 
        <term><filename>/run/mandos.pid</filename></term>
536
 
        <listitem>
537
 
          <para>
538
 
            The file containing the process id of the
539
 
            <command>&COMMANDNAME;</command> process started last.
540
 
            <emphasis >Note:</emphasis> If the <filename
541
 
            class="directory">/run</filename> directory does not
542
 
            exist, <filename>/var/run/mandos.pid</filename> will be
543
 
            used instead.
544
 
          </para>
545
 
        </listitem>
546
 
      </varlistentry>
547
 
      <varlistentry>
548
 
        <term><filename
549
 
        class="directory">/var/lib/mandos</filename></term>
550
 
        <listitem>
551
 
          <para>
552
 
            Directory where persistent state will be saved.  Change
553
 
            this with the <option>--statedir</option> option.  See
554
 
            also the <option>--no-restore</option> option.
555
 
          </para>
556
 
        </listitem>
557
 
      </varlistentry>
558
 
      <varlistentry>
559
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
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>.
 
434
          </para>
 
435
        </listitem>
 
436
      </varlistentry>
 
437
      <varlistentry>
 
438
        <term><filename>/dev/log</filename></term>
560
439
        <listitem>
561
440
          <para>
562
441
            The Unix domain socket to where local syslog messages are
585
464
      backtrace.  This could be considered a feature.
586
465
    </para>
587
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>
588
478
      There is no fine-grained control over logging and debug output.
589
479
    </para>
590
 
    <xi:include href="bugs.xml"/>
 
480
    <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.
 
485
    </para>
591
486
  </refsect1>
592
487
  
593
488
  <refsect1 id="example">
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
646
 
        does have the correct key ID of the stored key ID.  This is
647
 
        guaranteed by the fact that the client sends its public key in
648
 
        the TLS handshake; this ensures it to be genuine.  The server
649
 
        computes the key ID of the key itself and looks up the key ID
650
 
        in its list of clients. The <filename>clients.conf</filename>
651
 
        file (see
 
541
        does have the OpenPGP key of the stored fingerprint.  This is
 
542
        guaranteed by the fact that the client sends its OpenPGP
 
543
        public key in the TLS handshake; this ensures it to be
 
544
        genuine.  The server computes the fingerprint of the key
 
545
        itself and looks up the fingerprint in its list of
 
546
        clients. The <filename>clients.conf</filename> file (see
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>
695
609
      </varlistentry>
696
610
      <varlistentry>
697
611
        <term>
698
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
 
612
          <ulink url="http://www.avahi.org/">Avahi</ulink>
699
613
        </term>
700
614
      <listitem>
701
615
        <para>
706
620
      </varlistentry>
707
621
      <varlistentry>
708
622
        <term>
709
 
          <ulink url="https://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>
713
628
          GnuTLS is the library this server uses to implement TLS for
714
629
          communicating securely with the client, and at the same time
715
 
          confidently get the client’s public key.
 
630
          confidently get the client’s public OpenPGP key.
716
631
        </para>
717
632
      </listitem>
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 address 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 7250: <citetitle>Using Raw Public Keys in Transport
775
 
          Layer Security (TLS) and Datagram Transport Layer Security
776
 
          (DTLS)</citetitle>
777
 
        </term>
778
 
      <listitem>
779
 
        <para>
780
 
          This is implemented by GnuTLS version 3.6.6 and is, if
781
 
          present, used by this server so that raw public keys can be
782
 
          used.
783
 
        </para>
784
 
      </listitem>
785
 
      </varlistentry>
786
 
      <varlistentry>
787
 
        <term>
788
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
789
 
          Security (TLS) Authentication</citetitle>
790
 
        </term>
791
 
      <listitem>
792
 
        <para>
793
 
          This is implemented by GnuTLS before version 3.6.0 and is,
794
 
          if present, used by this server so that OpenPGP keys can be
795
 
          used.
 
673
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
674
          Transport Layer Security</citetitle></citation>
 
675
        </term>
 
676
      <listitem>
 
677
        <para>
 
678
          This is implemented by GnuTLS and used by this server so
 
679
          that OpenPGP keys can be used.
796
680
        </para>
797
681
      </listitem>
798
682
      </varlistentry>
799
683
    </variablelist>
800
684
  </refsect1>
801
685
</refentry>
802
 
<!-- Local Variables: -->
803
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
804
 
<!-- time-stamp-end: "[\"']>" -->
805
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
806
 
<!-- End: -->