/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-10 20:35:01 UTC
  • mfrom: (24.1.42 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080810203501-euh3qcf1nopilksm
Merge.

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