/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: 2008-08-09 20:32:12 UTC
  • mfrom: (24.1.32 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080809203212-m0klt43cpge9qysg
Resolving merge commit.

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