/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2014-02-22 17:13:00 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 311.
  • Revision ID: teddy@recompile.se-20140222171300-a1alb0w871t1f174
* mandos (ClientDBus.start_checker): Removed unused variable
                                     "old_checker".
* mandos-monitor: Remove import of unused module "signal"

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