/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: 2018-02-10 18:58:32 UTC
  • Revision ID: teddy@recompile.se-20180210185832-fz2a92274niyrn44
Update lintian override to use correct line number

* debian/mandos.lintian-overrides
  (init.d-script-needs-depends-on-lsb-base): Change line number to
  "46".

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