/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

version 1.0

Show diffs side-by-side

added added

removed removed

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