/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: 2016-02-28 13:09:43 UTC
  • Revision ID: teddy@recompile.se-20160228130943-6ofi0xgek1xd7qmy
Use GnuPG 2 if available

* debian/control (Package: mandos/Depends): Change "gnupg (<< 2)" to
                                            "gnupg".
  (Package: mandos-client/Depends): Remove "gnupg (<< 2)"; it will be
                                    depended on by libgpgme11, which
                                    will be added automatically by
                                    ${shlibs:Depends}.
* mandos (PGPEngine.__init__): Try to run "gpgconf" and set 'self.gpg'
                               to any binary found.  Also change
                               "--home" to "--homedir".
  (PGPEngine.encrypt, PGPEngine.decrypt): Use the 'self.gpg' attribute
                                          instead of "gpg".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
1
 
<?xml version='1.0' encoding='UTF-8'?>
2
 
<?xml-stylesheet type="text/xsl"
3
 
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
 
1
<?xml version="1.0" encoding="UTF-8"?>
4
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
 
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
 
<!ENTITY VERSION "1.0">
 
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
7
4
<!ENTITY COMMANDNAME "mandos">
 
5
<!ENTITY TIMESTAMP "2015-12-06">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
8
8
]>
9
9
 
10
 
<refentry>
11
 
  <refentryinfo>
12
 
    <title>&COMMANDNAME;</title>
13
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
14
 
    <productname>&COMMANDNAME;</productname>
15
 
    <productnumber>&VERSION;</productnumber>
 
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
11
   <refentryinfo>
 
12
    <title>Mandos Manual</title>
 
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
 
14
    <productname>Mandos</productname>
 
15
    <productnumber>&version;</productnumber>
 
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <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>
34
42
      <holder>Teddy Hogeborn</holder>
35
43
      <holder>Björn Påhlsson</holder>
36
44
    </copyright>
37
 
    <legalnotice>
38
 
      <para>
39
 
        This manual page is free software: you can redistribute it
40
 
        and/or modify it under the terms of the GNU General Public
41
 
        License as published by the Free Software Foundation,
42
 
        either version 3 of the License, or (at your option) any
43
 
        later version.
44
 
      </para>
45
 
 
46
 
      <para>
47
 
        This manual page is distributed in the hope that it will
48
 
        be useful, but WITHOUT ANY WARRANTY; without even the
49
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
50
 
        PARTICULAR PURPOSE.  See the GNU General Public License
51
 
        for more details.
52
 
      </para>
53
 
 
54
 
      <para>
55
 
        You should have received a copy of the GNU General Public
56
 
        License along with this program; If not, see
57
 
        <ulink url="http://www.gnu.org/licenses/"/>.
58
 
      </para>
59
 
    </legalnotice>
 
45
    <xi:include href="legalnotice.xml"/>
60
46
  </refentryinfo>
61
 
 
 
47
  
62
48
  <refmeta>
63
49
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
50
    <manvolnum>8</manvolnum>
67
53
  <refnamediv>
68
54
    <refname><command>&COMMANDNAME;</command></refname>
69
55
    <refpurpose>
70
 
      Sends encrypted passwords to authenticated Mandos clients
 
56
      Gives encrypted passwords to authenticated Mandos clients
71
57
    </refpurpose>
72
58
  </refnamediv>
73
 
 
 
59
  
74
60
  <refsynopsisdiv>
75
61
    <cmdsynopsis>
76
62
      <command>&COMMANDNAME;</command>
77
 
      <arg choice='opt'>--interface<arg choice='plain'>IF</arg></arg>
78
 
      <arg choice='opt'>--address<arg choice='plain'>ADDRESS</arg></arg>
79
 
      <arg choice='opt'>--port<arg choice='plain'>PORT</arg></arg>
80
 
      <arg choice='opt'>--priority<arg choice='plain'>PRIORITY</arg></arg>
81
 
      <arg choice='opt'>--servicename<arg choice='plain'>NAME</arg></arg>
82
 
      <arg choice='opt'>--configdir<arg choice='plain'>DIRECTORY</arg></arg>
83
 
      <arg choice='opt'>--debug</arg>
84
 
    </cmdsynopsis>
85
 
    <cmdsynopsis>
86
 
      <command>&COMMANDNAME;</command>
87
 
      <arg choice='opt'>-i<arg choice='plain'>IF</arg></arg>
88
 
      <arg choice='opt'>-a<arg choice='plain'>ADDRESS</arg></arg>
89
 
      <arg choice='opt'>-p<arg choice='plain'>PORT</arg></arg>
90
 
      <arg choice='opt'>--priority<arg choice='plain'>PRIORITY</arg></arg>
91
 
      <arg choice='opt'>--servicename<arg choice='plain'>NAME</arg></arg>
92
 
      <arg choice='opt'>--configdir<arg choice='plain'>DIRECTORY</arg></arg>
93
 
      <arg choice='opt'>--debug</arg>
94
 
    </cmdsynopsis>
95
 
    <cmdsynopsis>
96
 
      <command>&COMMANDNAME;</command>
97
 
      <arg choice='plain'>--help</arg>
98
 
    </cmdsynopsis>
99
 
    <cmdsynopsis>
100
 
      <command>&COMMANDNAME;</command>
101
 
      <arg choice='plain'>--version</arg>
102
 
    </cmdsynopsis>
103
 
    <cmdsynopsis>
104
 
      <command>&COMMANDNAME;</command>
105
 
      <arg choice='plain'>--check</arg>
 
63
      <group>
 
64
        <arg choice="plain"><option>--interface
 
65
        <replaceable>NAME</replaceable></option></arg>
 
66
        <arg choice="plain"><option>-i
 
67
        <replaceable>NAME</replaceable></option></arg>
 
68
      </group>
 
69
      <sbr/>
 
70
      <group>
 
71
        <arg choice="plain"><option>--address
 
72
        <replaceable>ADDRESS</replaceable></option></arg>
 
73
        <arg choice="plain"><option>-a
 
74
        <replaceable>ADDRESS</replaceable></option></arg>
 
75
      </group>
 
76
      <sbr/>
 
77
      <group>
 
78
        <arg choice="plain"><option>--port
 
79
        <replaceable>PORT</replaceable></option></arg>
 
80
        <arg choice="plain"><option>-p
 
81
        <replaceable>PORT</replaceable></option></arg>
 
82
      </group>
 
83
      <sbr/>
 
84
      <arg><option>--priority
 
85
      <replaceable>PRIORITY</replaceable></option></arg>
 
86
      <sbr/>
 
87
      <arg><option>--servicename
 
88
      <replaceable>NAME</replaceable></option></arg>
 
89
      <sbr/>
 
90
      <arg><option>--configdir
 
91
      <replaceable>DIRECTORY</replaceable></option></arg>
 
92
      <sbr/>
 
93
      <arg><option>--debug</option></arg>
 
94
      <sbr/>
 
95
      <arg><option>--debuglevel
 
96
      <replaceable>LEVEL</replaceable></option></arg>
 
97
      <sbr/>
 
98
      <arg><option>--no-dbus</option></arg>
 
99
      <sbr/>
 
100
      <arg><option>--no-ipv6</option></arg>
 
101
      <sbr/>
 
102
      <arg><option>--no-restore</option></arg>
 
103
      <sbr/>
 
104
      <arg><option>--statedir
 
105
      <replaceable>DIRECTORY</replaceable></option></arg>
 
106
      <sbr/>
 
107
      <arg><option>--socket
 
108
      <replaceable>FD</replaceable></option></arg>
 
109
      <sbr/>
 
110
      <arg><option>--foreground</option></arg>
 
111
      <sbr/>
 
112
      <arg><option>--no-zeroconf</option></arg>
 
113
    </cmdsynopsis>
 
114
    <cmdsynopsis>
 
115
      <command>&COMMANDNAME;</command>
 
116
      <group choice="req">
 
117
        <arg choice="plain"><option>--help</option></arg>
 
118
        <arg choice="plain"><option>-h</option></arg>
 
119
      </group>
 
120
    </cmdsynopsis>
 
121
    <cmdsynopsis>
 
122
      <command>&COMMANDNAME;</command>
 
123
      <arg choice="plain"><option>--version</option></arg>
 
124
    </cmdsynopsis>
 
125
    <cmdsynopsis>
 
126
      <command>&COMMANDNAME;</command>
 
127
      <arg choice="plain"><option>--check</option></arg>
106
128
    </cmdsynopsis>
107
129
  </refsynopsisdiv>
108
 
 
 
130
  
109
131
  <refsect1 id="description">
110
132
    <title>DESCRIPTION</title>
111
133
    <para>
112
134
      <command>&COMMANDNAME;</command> is a server daemon which
113
135
      handles incoming request for passwords for a pre-defined list of
114
 
      client host computers.  The Mandos server uses Zeroconf to
115
 
      announce itself on the local network, and uses GnuTLS to
116
 
      communicate securely with and to authenticate the clients.
117
 
      Mandos uses IPv6 link-local addresses, since the clients are
118
 
      assumed to not have any other addresses configured.  Any
119
 
      authenticated client is then given the pre-encrypted password
120
 
      for that specific client.
 
136
      client host computers. For an introduction, see
 
137
      <citerefentry><refentrytitle>intro</refentrytitle>
 
138
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
139
      uses Zeroconf to announce itself on the local network, and uses
 
140
      TLS to communicate securely with and to authenticate the
 
141
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
142
      use IPv6 link-local addresses, since the clients will probably
 
143
      not have any other addresses configured (see <xref
 
144
      linkend="overview"/>).  Any authenticated client is then given
 
145
      the stored pre-encrypted password for that specific client.
121
146
    </para>
122
 
 
123
147
  </refsect1>
124
148
  
125
149
  <refsect1 id="purpose">
126
150
    <title>PURPOSE</title>
127
 
 
128
151
    <para>
129
152
      The purpose of this is to enable <emphasis>remote and unattended
130
 
      rebooting</emphasis> of any client host computer with an
131
 
      <emphasis>encrypted root file system</emphasis>.  The client
132
 
      host computer should start a Mandos client in the initial RAM
133
 
      disk environment, the Mandos client program communicates with
134
 
      this server program to get an encrypted password, which is then
135
 
      decrypted and used to unlock the encrypted root file system.
136
 
      The client host computer can then continue its boot sequence
137
 
      normally.
 
153
      rebooting</emphasis> of client host computer with an
 
154
      <emphasis>encrypted root file system</emphasis>.  See <xref
 
155
      linkend="overview"/> for details.
138
156
    </para>
139
 
 
140
157
  </refsect1>
141
158
  
142
159
  <refsect1 id="options">
143
160
    <title>OPTIONS</title>
144
 
 
145
161
    <variablelist>
146
162
      <varlistentry>
147
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
163
        <term><option>--help</option></term>
 
164
        <term><option>-h</option></term>
148
165
        <listitem>
149
166
          <para>
150
167
            Show a help message and exit
151
168
          </para>
152
169
        </listitem>
153
170
      </varlistentry>
154
 
 
155
 
      <varlistentry>
156
 
        <term><literal>-i</literal>, <literal>--interface <replaceable>
157
 
        IF</replaceable></literal></term>
158
 
        <listitem>
159
 
          <para>
160
 
            Only announce the server and listen to requests on network
161
 
            interface <replaceable>IF</replaceable>.  Default is to
162
 
            use all available interfaces.
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>
198
 
        <listitem>
199
 
          <para>
200
 
            Run the server's self-tests.  This includes any unit
 
171
      
 
172
      <varlistentry>
 
173
        <term><option>--interface</option>
 
174
        <replaceable>NAME</replaceable></term>
 
175
        <term><option>-i</option>
 
176
        <replaceable>NAME</replaceable></term>
 
177
        <listitem>
 
178
          <xi:include href="mandos-options.xml" xpointer="interface"/>
 
179
        </listitem>
 
180
      </varlistentry>
 
181
      
 
182
      <varlistentry>
 
183
        <term><option>--address
 
184
        <replaceable>ADDRESS</replaceable></option></term>
 
185
        <term><option>-a
 
186
        <replaceable>ADDRESS</replaceable></option></term>
 
187
        <listitem>
 
188
          <xi:include href="mandos-options.xml" xpointer="address"/>
 
189
        </listitem>
 
190
      </varlistentry>
 
191
      
 
192
      <varlistentry>
 
193
        <term><option>--port
 
194
        <replaceable>PORT</replaceable></option></term>
 
195
        <term><option>-p
 
196
        <replaceable>PORT</replaceable></option></term>
 
197
        <listitem>
 
198
          <xi:include href="mandos-options.xml" xpointer="port"/>
 
199
        </listitem>
 
200
      </varlistentry>
 
201
      
 
202
      <varlistentry>
 
203
        <term><option>--check</option></term>
 
204
        <listitem>
 
205
          <para>
 
206
            Run the server’s self-tests.  This includes any unit
201
207
            tests, etc.
202
208
          </para>
203
209
        </listitem>
204
210
      </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.  See
224
 
            <citerefentry><refentrytitle>gnutls_priority_init
225
 
            </refentrytitle><manvolnum>3</manvolnum></citerefentry>
226
 
            for the syntax.  The default is
227
 
            <quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.
228
 
            <emphasis>Warning</emphasis>: changing this may make the
229
 
            TLS handshake fail, making communication with clients
230
 
            impossible.
231
 
          </para>
232
 
        </listitem>
233
 
      </varlistentry>
234
 
 
235
 
      <varlistentry>
236
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
237
 
        </literal></term>
238
 
        <listitem>
239
 
          <para>
240
 
            Zeroconf service name.  The default is
241
 
            <quote><literal>Mandos</literal></quote>.  You only need
242
 
            to change this if you for some reason want to run more
243
 
            than one server on the same <emphasis>host</emphasis>,
244
 
            which would not normally be useful.  If there are name
245
 
            collisions on the same <emphasis>network</emphasis>, the
246
 
            newer server will automatically rename itself to
247
 
            <quote><literal>Mandos #2</literal></quote>, and so on,
248
 
            therefore this option is not needed in that case.
249
 
          </para>
250
 
        </listitem>
251
 
      </varlistentry>
252
 
 
253
 
      <varlistentry>
254
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
255
 
        </literal></term>
 
211
      
 
212
      <varlistentry>
 
213
        <term><option>--debug</option></term>
 
214
        <listitem>
 
215
          <xi:include href="mandos-options.xml" xpointer="debug"/>
 
216
        </listitem>
 
217
      </varlistentry>
 
218
      
 
219
      <varlistentry>
 
220
        <term><option>--debuglevel
 
221
        <replaceable>LEVEL</replaceable></option></term>
 
222
        <listitem>
 
223
          <para>
 
224
            Set the debugging log level.
 
225
            <replaceable>LEVEL</replaceable> is a string, one of
 
226
            <quote><literal>CRITICAL</literal></quote>,
 
227
            <quote><literal>ERROR</literal></quote>,
 
228
            <quote><literal>WARNING</literal></quote>,
 
229
            <quote><literal>INFO</literal></quote>, or
 
230
            <quote><literal>DEBUG</literal></quote>, in order of
 
231
            increasing verbosity.  The default level is
 
232
            <quote><literal>WARNING</literal></quote>.
 
233
          </para>
 
234
        </listitem>
 
235
      </varlistentry>
 
236
      
 
237
      <varlistentry>
 
238
        <term><option>--priority <replaceable>
 
239
        PRIORITY</replaceable></option></term>
 
240
        <listitem>
 
241
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
242
        </listitem>
 
243
      </varlistentry>
 
244
      
 
245
      <varlistentry>
 
246
        <term><option>--servicename
 
247
        <replaceable>NAME</replaceable></option></term>
 
248
        <listitem>
 
249
          <xi:include href="mandos-options.xml"
 
250
                      xpointer="servicename"/>
 
251
        </listitem>
 
252
      </varlistentry>
 
253
      
 
254
      <varlistentry>
 
255
        <term><option>--configdir
 
256
        <replaceable>DIRECTORY</replaceable></option></term>
256
257
        <listitem>
257
258
          <para>
258
259
            Directory to search for configuration files.  Default is
264
265
          </para>
265
266
        </listitem>
266
267
      </varlistentry>
267
 
 
 
268
      
268
269
      <varlistentry>
269
 
        <term><literal>--version</literal></term>
 
270
        <term><option>--version</option></term>
270
271
        <listitem>
271
272
          <para>
272
273
            Prints the program version and exit.
273
274
          </para>
274
275
        </listitem>
275
276
      </varlistentry>
 
277
      
 
278
      <varlistentry>
 
279
        <term><option>--no-dbus</option></term>
 
280
        <listitem>
 
281
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
282
          <para>
 
283
            See also <xref linkend="dbus_interface"/>.
 
284
          </para>
 
285
        </listitem>
 
286
      </varlistentry>
 
287
      
 
288
      <varlistentry>
 
289
        <term><option>--no-ipv6</option></term>
 
290
        <listitem>
 
291
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
292
        </listitem>
 
293
      </varlistentry>
 
294
      
 
295
      <varlistentry>
 
296
        <term><option>--no-restore</option></term>
 
297
        <listitem>
 
298
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
299
          <para>
 
300
            See also <xref linkend="persistent_state"/>.
 
301
          </para>
 
302
        </listitem>
 
303
      </varlistentry>
 
304
      
 
305
      <varlistentry>
 
306
        <term><option>--statedir
 
307
        <replaceable>DIRECTORY</replaceable></option></term>
 
308
        <listitem>
 
309
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
310
        </listitem>
 
311
      </varlistentry>
 
312
      
 
313
      <varlistentry>
 
314
        <term><option>--socket
 
315
        <replaceable>FD</replaceable></option></term>
 
316
        <listitem>
 
317
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
318
        </listitem>
 
319
      </varlistentry>
 
320
      
 
321
      <varlistentry>
 
322
        <term><option>--foreground</option></term>
 
323
        <listitem>
 
324
          <xi:include href="mandos-options.xml"
 
325
                      xpointer="foreground"/>
 
326
        </listitem>
 
327
      </varlistentry>
 
328
      
 
329
      <varlistentry>
 
330
        <term><option>--no-zeroconf</option></term>
 
331
        <listitem>
 
332
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
 
333
        </listitem>
 
334
      </varlistentry>
 
335
      
276
336
    </variablelist>
277
337
  </refsect1>
278
 
 
 
338
  
 
339
  <refsect1 id="overview">
 
340
    <title>OVERVIEW</title>
 
341
    <xi:include href="overview.xml"/>
 
342
    <para>
 
343
      This program is the server part.  It is a normal server program
 
344
      and will run in a normal system environment, not in an initial
 
345
      <acronym>RAM</acronym> disk environment.
 
346
    </para>
 
347
  </refsect1>
 
348
  
279
349
  <refsect1 id="protocol">
280
350
    <title>NETWORK PROTOCOL</title>
281
351
    <para>
307
377
        <entry>-><!-- &rarr; --></entry>
308
378
      </row>
309
379
      <row>
310
 
        <entry><quote><literal>1\r\en</literal></quote></entry>
 
380
        <entry><quote><literal>1\r\n</literal></quote></entry>
311
381
        <entry>-><!-- &rarr; --></entry>
312
382
      </row>
313
383
      <row>
333
403
      </row>
334
404
    </tbody></tgroup></table>
335
405
  </refsect1>
336
 
 
 
406
  
337
407
  <refsect1 id="checking">
338
408
    <title>CHECKING</title>
339
409
    <para>
340
410
      The server will, by default, continually check that the clients
341
411
      are still up.  If a client has not been confirmed as being up
342
412
      for some time, the client is assumed to be compromised and is no
343
 
      longer eligible to receive the encrypted password.  The timeout,
344
 
      checker program and interval between checks can be configured
345
 
      both globally and per client; see <citerefentry>
346
 
      <refentrytitle>mandos.conf</refentrytitle>
347
 
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
 
413
      longer eligible to receive the encrypted password.  (Manual
 
414
      intervention is required to re-enable a client.)  The timeout,
 
415
      extended timeout, checker program, and interval between checks
 
416
      can be configured both globally and per client; see
 
417
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
418
      <manvolnum>5</manvolnum></citerefentry>.
 
419
    </para>
 
420
  </refsect1>
 
421
  
 
422
  <refsect1 id="approval">
 
423
    <title>APPROVAL</title>
 
424
    <para>
 
425
      The server can be configured to require manual approval for a
 
426
      client before it is sent its secret.  The delay to wait for such
 
427
      approval and the default action (approve or deny) can be
 
428
      configured both globally and per client; see <citerefentry>
348
429
      <refentrytitle>mandos-clients.conf</refentrytitle>
349
 
      <manvolnum>5</manvolnum></citerefentry>.
350
 
    </para>
 
430
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
431
      will be approved immediately without delay.
 
432
    </para>
 
433
    <para>
 
434
      This can be used to deny a client its secret if not manually
 
435
      approved within a specified time.  It can also be used to make
 
436
      the server delay before giving a client its secret, allowing
 
437
      optional manual denying of this specific client.
 
438
    </para>
 
439
    
351
440
  </refsect1>
352
 
 
 
441
  
353
442
  <refsect1 id="logging">
354
443
    <title>LOGGING</title>
355
444
    <para>
356
 
      The server will send log messaged with various severity levels
357
 
      to <filename>/dev/log</filename>.  With the
 
445
      The server will send log message with various severity levels to
 
446
      <filename class="devicefile">/dev/log</filename>.  With the
358
447
      <option>--debug</option> option, it will log even more messages,
359
448
      and also show them on the console.
360
449
    </para>
361
450
  </refsect1>
362
 
 
 
451
  
 
452
  <refsect1 id="persistent_state">
 
453
    <title>PERSISTENT STATE</title>
 
454
    <para>
 
455
      Client settings, initially read from
 
456
      <filename>clients.conf</filename>, are persistent across
 
457
      restarts, and run-time changes will override settings in
 
458
      <filename>clients.conf</filename>.  However, if a setting is
 
459
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
460
      <filename>clients.conf</filename>, this will take precedence.
 
461
    </para>
 
462
  </refsect1>
 
463
  
 
464
  <refsect1 id="dbus_interface">
 
465
    <title>D-BUS INTERFACE</title>
 
466
    <para>
 
467
      The server will by default provide a D-Bus system bus interface.
 
468
      This interface will only be accessible by the root user or a
 
469
      Mandos-specific user, if such a user exists.  For documentation
 
470
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
471
    </para>
 
472
  </refsect1>
 
473
  
363
474
  <refsect1 id="exit_status">
364
475
    <title>EXIT STATUS</title>
365
476
    <para>
367
478
      critical error is encountered.
368
479
    </para>
369
480
  </refsect1>
370
 
 
371
 
  <refsect1 id="file">
 
481
  
 
482
  <refsect1 id="environment">
 
483
    <title>ENVIRONMENT</title>
 
484
    <variablelist>
 
485
      <varlistentry>
 
486
        <term><envar>PATH</envar></term>
 
487
        <listitem>
 
488
          <para>
 
489
            To start the configured checker (see <xref
 
490
            linkend="checking"/>), the server uses
 
491
            <filename>/bin/sh</filename>, which in turn uses
 
492
            <varname>PATH</varname> to search for matching commands if
 
493
            an absolute path is not given.  See <citerefentry>
 
494
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
495
            </citerefentry>.
 
496
          </para>
 
497
        </listitem>
 
498
      </varlistentry>
 
499
    </variablelist>
 
500
  </refsect1>
 
501
  
 
502
  <refsect1 id="files">
372
503
    <title>FILES</title>
373
504
    <para>
374
505
      Use the <option>--configdir</option> option to change where
397
528
        </listitem>
398
529
      </varlistentry>
399
530
      <varlistentry>
400
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
401
 
        <listitem>
402
 
          <para>
403
 
            The file containing the process id of
404
 
            <command>&COMMANDNAME;</command>.
405
 
          </para>
406
 
        </listitem>
407
 
      </varlistentry>
408
 
      <varlistentry>
409
 
        <term><filename>/dev/log</filename></term>
 
531
        <term><filename>/run/mandos.pid</filename></term>
 
532
        <listitem>
 
533
          <para>
 
534
            The file containing the process id of the
 
535
            <command>&COMMANDNAME;</command> process started last.
 
536
            <emphasis >Note:</emphasis> If the <filename
 
537
            class="directory">/run</filename> directory does not
 
538
            exist, <filename>/var/run/mandos.pid</filename> will be
 
539
            used instead.
 
540
          </para>
 
541
        </listitem>
 
542
      </varlistentry>
 
543
      <varlistentry>
 
544
        <term><filename
 
545
        class="directory">/var/lib/mandos</filename></term>
 
546
        <listitem>
 
547
          <para>
 
548
            Directory where persistent state will be saved.  Change
 
549
            this with the <option>--statedir</option> option.  See
 
550
            also the <option>--no-restore</option> option.
 
551
          </para>
 
552
        </listitem>
 
553
      </varlistentry>
 
554
      <varlistentry>
 
555
        <term><filename class="devicefile">/dev/log</filename></term>
410
556
        <listitem>
411
557
          <para>
412
558
            The Unix domain socket to where local syslog messages are
414
560
          </para>
415
561
        </listitem>
416
562
      </varlistentry>
 
563
      <varlistentry>
 
564
        <term><filename>/bin/sh</filename></term>
 
565
        <listitem>
 
566
          <para>
 
567
            This is used to start the configured checker command for
 
568
            each client.  See <citerefentry>
 
569
            <refentrytitle>mandos-clients.conf</refentrytitle>
 
570
            <manvolnum>5</manvolnum></citerefentry> for details.
 
571
          </para>
 
572
        </listitem>
 
573
      </varlistentry>
417
574
    </variablelist>
418
575
  </refsect1>
419
 
 
 
576
  
420
577
  <refsect1 id="bugs">
421
578
    <title>BUGS</title>
422
579
    <para>
423
580
      This server might, on especially fatal errors, emit a Python
424
581
      backtrace.  This could be considered a feature.
425
582
    </para>
 
583
    <para>
 
584
      There is no fine-grained control over logging and debug output.
 
585
    </para>
 
586
    <para>
 
587
      This server does not check the expire time of clients’ OpenPGP
 
588
      keys.
 
589
    </para>
426
590
  </refsect1>
427
 
 
428
 
  <refsect1 id="examples">
429
 
    <title>EXAMPLES</title>
 
591
  
 
592
  <refsect1 id="example">
 
593
    <title>EXAMPLE</title>
430
594
    <informalexample>
431
595
      <para>
432
596
        Normal invocation needs no options:
433
597
      </para>
434
598
      <para>
435
 
        <userinput>mandos</userinput>
 
599
        <userinput>&COMMANDNAME;</userinput>
436
600
      </para>
437
601
    </informalexample>
438
602
    <informalexample>
439
603
      <para>
440
 
        Run the server in debug mode and read configuration files from
441
 
        the <filename>~/mandos</filename> directory:
 
604
        Run the server in debug mode, read configuration files from
 
605
        the <filename class="directory">~/mandos</filename> directory,
 
606
        and use the Zeroconf service name <quote>Test</quote> to not
 
607
        collide with any other official Mandos server on this host:
442
608
      </para>
443
609
      <para>
444
610
 
445
611
<!-- do not wrap this line -->
446
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
612
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
447
613
 
448
614
      </para>
449
615
    </informalexample>
455
621
      <para>
456
622
 
457
623
<!-- do not wrap this line -->
458
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
624
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
459
625
 
460
626
      </para>
461
627
    </informalexample>
462
628
  </refsect1>
463
 
 
 
629
  
464
630
  <refsect1 id="security">
465
631
    <title>SECURITY</title>
466
 
    <refsect2>
 
632
    <refsect2 id="server">
467
633
      <title>SERVER</title>
468
634
      <para>
469
 
        Running the server should not in itself present any security
470
 
        risk to the host computer running it.
 
635
        Running this <command>&COMMANDNAME;</command> server program
 
636
        should not in itself present any security risk to the host
 
637
        computer running it.  The program switches to a non-root user
 
638
        soon after startup.
471
639
      </para>
472
640
    </refsect2>
473
 
    <refsect2>
 
641
    <refsect2 id="clients">
474
642
      <title>CLIENTS</title>
475
643
      <para>
476
644
        The server only gives out its stored data to clients which
481
649
        itself and looks up the fingerprint in its list of
482
650
        clients. The <filename>clients.conf</filename> file (see
483
651
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
484
 
        <manvolnum>5</manvolnum></citerefentry>) must be non-readable
485
 
        by anyone except the user running the server.
 
652
        <manvolnum>5</manvolnum></citerefentry>)
 
653
        <emphasis>must</emphasis> be made non-readable by anyone
 
654
        except the user starting the server (usually root).
 
655
      </para>
 
656
      <para>
 
657
        As detailed in <xref linkend="checking"/>, the status of all
 
658
        client computers will continually be checked and be assumed
 
659
        compromised if they are gone for too long.
486
660
      </para>
487
661
      <para>
488
662
        For more details on client-side security, see
489
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
663
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
490
664
        <manvolnum>8mandos</manvolnum></citerefentry>.
491
665
      </para>
492
666
    </refsect2>
493
667
  </refsect1>
494
 
 
 
668
  
495
669
  <refsect1 id="see_also">
496
670
    <title>SEE ALSO</title>
497
 
    <itemizedlist spacing="compact">
498
 
      <listitem><para>
499
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
500
 
        <manvolnum>8mandos</manvolnum></citerefentry>
501
 
      </para></listitem>
502
 
      
503
 
      <listitem><para>
504
 
        <citerefentry><refentrytitle>plugin-runner</refentrytitle>
505
 
        <manvolnum>8mandos</manvolnum></citerefentry>
506
 
      </para></listitem>
507
 
      
508
 
      <listitem><para>
509
 
        <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
510
 
      </para></listitem>
511
 
      
512
 
      <listitem><para>
513
 
        <ulink url="http://www.avahi.org/">Avahi</ulink>
514
 
      </para></listitem>
515
 
      
516
 
      <listitem><para>
517
 
        <ulink
518
 
            url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
519
 
      </para></listitem>
520
 
      
521
 
      <listitem><para>
522
 
        <citation>RFC 4880: <citetitle>OpenPGP Message
523
 
        Format</citetitle></citation>
524
 
      </para></listitem>
525
 
      
526
 
      <listitem><para>
527
 
        <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
528
 
        Transport Layer Security</citetitle></citation>
529
 
      </para></listitem>
530
 
      
531
 
      <listitem><para>
532
 
        <citation>RFC 4291: <citetitle>IP Version 6 Addressing
533
 
        Architecture</citetitle>, section 2.5.6, Link-Local IPv6
534
 
        Unicast Addresses</citation>
535
 
      </para></listitem>
536
 
    </itemizedlist>
 
671
    <para>
 
672
      <citerefentry><refentrytitle>intro</refentrytitle>
 
673
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
674
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
675
      <manvolnum>5</manvolnum></citerefentry>,
 
676
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
677
      <manvolnum>5</manvolnum></citerefentry>,
 
678
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
679
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
680
      <citerefentry><refentrytitle>sh</refentrytitle>
 
681
      <manvolnum>1</manvolnum></citerefentry>
 
682
    </para>
 
683
    <variablelist>
 
684
      <varlistentry>
 
685
        <term>
 
686
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
687
        </term>
 
688
        <listitem>
 
689
          <para>
 
690
            Zeroconf is the network protocol standard used by clients
 
691
            for finding this Mandos server on the local network.
 
692
          </para>
 
693
        </listitem>
 
694
      </varlistentry>
 
695
      <varlistentry>
 
696
        <term>
 
697
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
698
        </term>
 
699
      <listitem>
 
700
        <para>
 
701
          Avahi is the library this server calls to implement
 
702
          Zeroconf service announcements.
 
703
        </para>
 
704
      </listitem>
 
705
      </varlistentry>
 
706
      <varlistentry>
 
707
        <term>
 
708
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
 
709
        </term>
 
710
      <listitem>
 
711
        <para>
 
712
          GnuTLS is the library this server uses to implement TLS for
 
713
          communicating securely with the client, and at the same time
 
714
          confidently get the client’s public OpenPGP key.
 
715
        </para>
 
716
      </listitem>
 
717
      </varlistentry>
 
718
      <varlistentry>
 
719
        <term>
 
720
          RFC 4291: <citetitle>IP Version 6 Addressing
 
721
          Architecture</citetitle>
 
722
        </term>
 
723
        <listitem>
 
724
          <variablelist>
 
725
            <varlistentry>
 
726
              <term>Section 2.2: <citetitle>Text Representation of
 
727
              Addresses</citetitle></term>
 
728
              <listitem><para/></listitem>
 
729
            </varlistentry>
 
730
            <varlistentry>
 
731
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
732
              Address</citetitle></term>
 
733
              <listitem><para/></listitem>
 
734
            </varlistentry>
 
735
            <varlistentry>
 
736
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
737
            Addresses</citetitle></term>
 
738
            <listitem>
 
739
              <para>
 
740
                The clients use IPv6 link-local addresses, which are
 
741
                immediately usable since a link-local addresses is
 
742
                automatically assigned to a network interfaces when it
 
743
                is brought up.
 
744
              </para>
 
745
            </listitem>
 
746
            </varlistentry>
 
747
          </variablelist>
 
748
        </listitem>
 
749
      </varlistentry>
 
750
      <varlistentry>
 
751
        <term>
 
752
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
753
          Protocol Version 1.2</citetitle>
 
754
        </term>
 
755
      <listitem>
 
756
        <para>
 
757
          TLS 1.2 is the protocol implemented by GnuTLS.
 
758
        </para>
 
759
      </listitem>
 
760
      </varlistentry>
 
761
      <varlistentry>
 
762
        <term>
 
763
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
764
        </term>
 
765
      <listitem>
 
766
        <para>
 
767
          The data sent to clients is binary encrypted OpenPGP data.
 
768
        </para>
 
769
      </listitem>
 
770
      </varlistentry>
 
771
      <varlistentry>
 
772
        <term>
 
773
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
774
          Security (TLS) Authentication</citetitle>
 
775
        </term>
 
776
      <listitem>
 
777
        <para>
 
778
          This is implemented by GnuTLS and used by this server so
 
779
          that OpenPGP keys can be used.
 
780
        </para>
 
781
      </listitem>
 
782
      </varlistentry>
 
783
    </variablelist>
537
784
  </refsect1>
538
785
</refentry>
 
786
<!-- Local Variables: -->
 
787
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
788
<!-- time-stamp-end: "[\"']>" -->
 
789
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
790
<!-- End: -->