/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-10 00:04:11 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080810000411-jt8mg7yqxtj5uzxn
* mandos (version): New variable.
  (main): New "--version" option.

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 "2014-06-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
 
      <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
 
      <sbr/>
110
 
      <arg><option>--no-zeroconf</option></arg>
111
 
    </cmdsynopsis>
112
 
    <cmdsynopsis>
113
 
      <command>&COMMANDNAME;</command>
114
 
      <group choice="req">
115
 
        <arg choice="plain"><option>--help</option></arg>
116
 
        <arg choice="plain"><option>-h</option></arg>
117
 
      </group>
118
 
    </cmdsynopsis>
119
 
    <cmdsynopsis>
120
 
      <command>&COMMANDNAME;</command>
121
 
      <arg choice="plain"><option>--version</option></arg>
122
 
    </cmdsynopsis>
123
 
    <cmdsynopsis>
124
 
      <command>&COMMANDNAME;</command>
125
 
      <arg choice="plain"><option>--check</option></arg>
 
76
      <arg choice='opt' rep='repeat'>OPTION</arg>
126
77
    </cmdsynopsis>
127
78
  </refsynopsisdiv>
128
 
  
 
79
 
129
80
  <refsect1 id="description">
130
81
    <title>DESCRIPTION</title>
131
82
    <para>
132
 
      <command>&COMMANDNAME;</command> is a server daemon which
133
 
      handles incoming request for passwords for a pre-defined list of
134
 
      client host computers. For an introduction, see
135
 
      <citerefentry><refentrytitle>intro</refentrytitle>
136
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
137
 
      uses Zeroconf to announce itself on the local network, and uses
138
 
      TLS to communicate securely with and to authenticate the
139
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
140
 
      use IPv6 link-local addresses, since the clients will probably
141
 
      not have any other addresses configured (see <xref
142
 
      linkend="overview"/>).  Any authenticated client is then given
143
 
      the stored pre-encrypted password for that specific client.
144
 
    </para>
145
 
  </refsect1>
146
 
  
147
 
  <refsect1 id="purpose">
148
 
    <title>PURPOSE</title>
149
 
    <para>
150
 
      The purpose of this is to enable <emphasis>remote and unattended
151
 
      rebooting</emphasis> of client host computer with an
152
 
      <emphasis>encrypted root file system</emphasis>.  See <xref
153
 
      linkend="overview"/> for details.
154
 
    </para>
155
 
  </refsect1>
156
 
  
157
 
  <refsect1 id="options">
158
 
    <title>OPTIONS</title>
159
 
    <variablelist>
160
 
      <varlistentry>
161
 
        <term><option>--help</option></term>
162
 
        <term><option>-h</option></term>
163
 
        <listitem>
164
 
          <para>
165
 
            Show a help message and exit
166
 
          </para>
167
 
        </listitem>
168
 
      </varlistentry>
169
 
      
170
 
      <varlistentry>
171
 
        <term><option>--interface</option>
172
 
        <replaceable>NAME</replaceable></term>
173
 
        <term><option>-i</option>
174
 
        <replaceable>NAME</replaceable></term>
175
 
        <listitem>
176
 
          <xi:include href="mandos-options.xml" xpointer="interface"/>
177
 
        </listitem>
178
 
      </varlistentry>
179
 
      
180
 
      <varlistentry>
181
 
        <term><option>--address
182
 
        <replaceable>ADDRESS</replaceable></option></term>
183
 
        <term><option>-a
184
 
        <replaceable>ADDRESS</replaceable></option></term>
185
 
        <listitem>
186
 
          <xi:include href="mandos-options.xml" xpointer="address"/>
187
 
        </listitem>
188
 
      </varlistentry>
189
 
      
190
 
      <varlistentry>
191
 
        <term><option>--port
192
 
        <replaceable>PORT</replaceable></option></term>
193
 
        <term><option>-p
194
 
        <replaceable>PORT</replaceable></option></term>
195
 
        <listitem>
196
 
          <xi:include href="mandos-options.xml" xpointer="port"/>
197
 
        </listitem>
198
 
      </varlistentry>
199
 
      
200
 
      <varlistentry>
201
 
        <term><option>--check</option></term>
202
 
        <listitem>
203
 
          <para>
204
 
            Run the server’s self-tests.  This includes any unit
205
 
            tests, etc.
206
 
          </para>
207
 
        </listitem>
208
 
      </varlistentry>
209
 
      
210
 
      <varlistentry>
211
 
        <term><option>--debug</option></term>
212
 
        <listitem>
213
 
          <xi:include href="mandos-options.xml" xpointer="debug"/>
214
 
        </listitem>
215
 
      </varlistentry>
216
 
      
217
 
      <varlistentry>
218
 
        <term><option>--debuglevel
219
 
        <replaceable>LEVEL</replaceable></option></term>
220
 
        <listitem>
221
 
          <para>
222
 
            Set the debugging log level.
223
 
            <replaceable>LEVEL</replaceable> is a string, one of
224
 
            <quote><literal>CRITICAL</literal></quote>,
225
 
            <quote><literal>ERROR</literal></quote>,
226
 
            <quote><literal>WARNING</literal></quote>,
227
 
            <quote><literal>INFO</literal></quote>, or
228
 
            <quote><literal>DEBUG</literal></quote>, in order of
229
 
            increasing verbosity.  The default level is
230
 
            <quote><literal>WARNING</literal></quote>.
231
 
          </para>
232
 
        </listitem>
233
 
      </varlistentry>
234
 
      
235
 
      <varlistentry>
236
 
        <term><option>--priority <replaceable>
237
 
        PRIORITY</replaceable></option></term>
238
 
        <listitem>
239
 
          <xi:include href="mandos-options.xml"
240
 
                      xpointer="priority_compat"/>
241
 
        </listitem>
242
 
      </varlistentry>
243
 
      
244
 
      <varlistentry>
245
 
        <term><option>--servicename
246
 
        <replaceable>NAME</replaceable></option></term>
247
 
        <listitem>
248
 
          <xi:include href="mandos-options.xml"
249
 
                      xpointer="servicename"/>
250
 
        </listitem>
251
 
      </varlistentry>
252
 
      
253
 
      <varlistentry>
254
 
        <term><option>--configdir
255
 
        <replaceable>DIRECTORY</replaceable></option></term>
256
 
        <listitem>
257
 
          <para>
258
 
            Directory to search for configuration files.  Default is
259
 
            <quote><literal>/etc/mandos</literal></quote>.  See
260
 
            <citerefentry><refentrytitle>mandos.conf</refentrytitle>
261
 
            <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
262
 
            <refentrytitle>mandos-clients.conf</refentrytitle>
263
 
            <manvolnum>5</manvolnum></citerefentry>.
264
 
          </para>
265
 
        </listitem>
266
 
      </varlistentry>
267
 
      
268
 
      <varlistentry>
269
 
        <term><option>--version</option></term>
270
 
        <listitem>
271
 
          <para>
272
 
            Prints the program version and exit.
273
 
          </para>
274
 
        </listitem>
275
 
      </varlistentry>
276
 
      
277
 
      <varlistentry>
278
 
        <term><option>--no-dbus</option></term>
279
 
        <listitem>
280
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
281
 
          <para>
282
 
            See also <xref linkend="dbus_interface"/>.
283
 
          </para>
284
 
        </listitem>
285
 
      </varlistentry>
286
 
      
287
 
      <varlistentry>
288
 
        <term><option>--no-ipv6</option></term>
289
 
        <listitem>
290
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
291
 
        </listitem>
292
 
      </varlistentry>
293
 
      
294
 
      <varlistentry>
295
 
        <term><option>--no-restore</option></term>
296
 
        <listitem>
297
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
298
 
          <para>
299
 
            See also <xref linkend="persistent_state"/>.
300
 
          </para>
301
 
        </listitem>
302
 
      </varlistentry>
303
 
      
304
 
      <varlistentry>
305
 
        <term><option>--statedir
306
 
        <replaceable>DIRECTORY</replaceable></option></term>
307
 
        <listitem>
308
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
309
 
        </listitem>
310
 
      </varlistentry>
311
 
      
312
 
      <varlistentry>
313
 
        <term><option>--socket
314
 
        <replaceable>FD</replaceable></option></term>
315
 
        <listitem>
316
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
317
 
        </listitem>
318
 
      </varlistentry>
319
 
      
320
 
      <varlistentry>
321
 
        <term><option>--foreground</option></term>
322
 
        <listitem>
323
 
          <xi:include href="mandos-options.xml"
324
 
                      xpointer="foreground"/>
325
 
        </listitem>
326
 
      </varlistentry>
327
 
      
328
 
      <varlistentry>
329
 
        <term><option>--no-zeroconf</option></term>
330
 
        <listitem>
331
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
332
 
        </listitem>
333
 
      </varlistentry>
334
 
      
335
 
    </variablelist>
336
 
  </refsect1>
337
 
  
338
 
  <refsect1 id="overview">
339
 
    <title>OVERVIEW</title>
340
 
    <xi:include href="overview.xml"/>
341
 
    <para>
342
 
      This program is the server part.  It is a normal server program
343
 
      and will run in a normal system environment, not in an initial
344
 
      <acronym>RAM</acronym> disk environment.
345
 
    </para>
346
 
  </refsect1>
347
 
  
348
 
  <refsect1 id="protocol">
349
 
    <title>NETWORK PROTOCOL</title>
350
 
    <para>
351
 
      The Mandos server announces itself as a Zeroconf service of type
352
 
      <quote><literal>_mandos._tcp</literal></quote>.  The Mandos
353
 
      client connects to the announced address and port, and sends a
354
 
      line of text where the first whitespace-separated field is the
355
 
      protocol version, which currently is
356
 
      <quote><literal>1</literal></quote>.  The client and server then
357
 
      start a TLS protocol handshake with a slight quirk: the Mandos
358
 
      server program acts as a TLS <quote>client</quote> while the
359
 
      connecting Mandos client acts as a TLS <quote>server</quote>.
360
 
      The Mandos client must supply an OpenPGP certificate, and the
361
 
      fingerprint of this certificate is used by the Mandos server to
362
 
      look up (in a list read from <filename>clients.conf</filename>
363
 
      at start time) which binary blob to give the client.  No other
364
 
      authentication or authorization is done by the server.
365
 
    </para>
366
 
    <table>
367
 
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
368
 
      <row>
369
 
        <entry>Mandos Client</entry>
370
 
        <entry>Direction</entry>
371
 
        <entry>Mandos Server</entry>
372
 
      </row>
373
 
      </thead><tbody>
374
 
      <row>
375
 
        <entry>Connect</entry>
376
 
        <entry>-><!-- &rarr; --></entry>
377
 
      </row>
378
 
      <row>
379
 
        <entry><quote><literal>1\r\n</literal></quote></entry>
380
 
        <entry>-><!-- &rarr; --></entry>
381
 
      </row>
382
 
      <row>
383
 
        <entry>TLS handshake <emphasis>as TLS <quote>server</quote>
384
 
        </emphasis></entry>
385
 
        <entry>&lt;-><!-- &xharr; --></entry>
386
 
        <entry>TLS handshake <emphasis>as TLS <quote>client</quote>
387
 
        </emphasis></entry>
388
 
      </row>
389
 
      <row>
390
 
        <entry>OpenPGP public key (part of TLS handshake)</entry>
391
 
        <entry>-><!-- &rarr; --></entry>
392
 
      </row>
393
 
      <row>
394
 
        <entry/>
395
 
        <entry>&lt;-<!-- &larr; --></entry>
396
 
        <entry>Binary blob (client will assume OpenPGP data)</entry>
397
 
      </row>
398
 
      <row>
399
 
        <entry/>
400
 
        <entry>&lt;-<!-- &larr; --></entry>
401
 
        <entry>Close</entry>
402
 
      </row>
403
 
    </tbody></tgroup></table>
404
 
  </refsect1>
405
 
  
406
 
  <refsect1 id="checking">
407
 
    <title>CHECKING</title>
408
 
    <para>
409
 
      The server will, by default, continually check that the clients
410
 
      are still up.  If a client has not been confirmed as being up
411
 
      for some time, the client is assumed to be compromised and is no
412
 
      longer eligible to receive the encrypted password.  (Manual
413
 
      intervention is required to re-enable a client.)  The timeout,
414
 
      extended timeout, checker program, and interval between checks
415
 
      can be configured both globally and per client; see
416
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
417
 
      <manvolnum>5</manvolnum></citerefentry>.
418
 
    </para>
419
 
  </refsect1>
420
 
  
421
 
  <refsect1 id="approval">
422
 
    <title>APPROVAL</title>
423
 
    <para>
424
 
      The server can be configured to require manual approval for a
425
 
      client before it is sent its secret.  The delay to wait for such
426
 
      approval and the default action (approve or deny) can be
427
 
      configured both globally and per client; see <citerefentry>
428
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
429
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
430
 
      will be approved immediately without delay.
431
 
    </para>
432
 
    <para>
433
 
      This can be used to deny a client its secret if not manually
434
 
      approved within a specified time.  It can also be used to make
435
 
      the server delay before giving a client its secret, allowing
436
 
      optional manual denying of this specific client.
437
 
    </para>
438
 
    
439
 
  </refsect1>
440
 
  
441
 
  <refsect1 id="logging">
442
 
    <title>LOGGING</title>
443
 
    <para>
444
 
      The server will send log message with various severity levels to
445
 
      <filename class="devicefile">/dev/log</filename>.  With the
446
 
      <option>--debug</option> option, it will log even more messages,
447
 
      and also show them on the console.
448
 
    </para>
449
 
  </refsect1>
450
 
  
451
 
  <refsect1 id="persistent_state">
452
 
    <title>PERSISTENT STATE</title>
453
 
    <para>
454
 
      Client settings, initially read from
455
 
      <filename>clients.conf</filename>, are persistent across
456
 
      restarts, and run-time changes will override settings in
457
 
      <filename>clients.conf</filename>.  However, if a setting is
458
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
459
 
      <filename>clients.conf</filename>, this will take precedence.
460
 
    </para>
461
 
  </refsect1>
462
 
  
463
 
  <refsect1 id="dbus_interface">
464
 
    <title>D-BUS INTERFACE</title>
465
 
    <para>
466
 
      The server will by default provide a D-Bus system bus interface.
467
 
      This interface will only be accessible by the root user or a
468
 
      Mandos-specific user, if such a user exists.  For documentation
469
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
470
 
    </para>
471
 
  </refsect1>
472
 
  
473
 
  <refsect1 id="exit_status">
474
 
    <title>EXIT STATUS</title>
475
 
    <para>
476
 
      The server will exit with a non-zero exit status only when a
477
 
      critical error is encountered.
478
 
    </para>
479
 
  </refsect1>
480
 
  
481
 
  <refsect1 id="environment">
482
 
    <title>ENVIRONMENT</title>
483
 
    <variablelist>
484
 
      <varlistentry>
485
 
        <term><envar>PATH</envar></term>
486
 
        <listitem>
487
 
          <para>
488
 
            To start the configured checker (see <xref
489
 
            linkend="checking"/>), the server uses
490
 
            <filename>/bin/sh</filename>, which in turn uses
491
 
            <varname>PATH</varname> to search for matching commands if
492
 
            an absolute path is not given.  See <citerefentry>
493
 
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
494
 
            </citerefentry>.
495
 
          </para>
496
 
        </listitem>
497
 
      </varlistentry>
498
 
    </variablelist>
499
 
  </refsect1>
500
 
  
501
 
  <refsect1 id="files">
502
 
    <title>FILES</title>
503
 
    <para>
504
 
      Use the <option>--configdir</option> option to change where
505
 
      <command>&COMMANDNAME;</command> looks for its configurations
506
 
      files.  The default file names are listed here.
507
 
    </para>
508
 
    <variablelist>
509
 
      <varlistentry>
510
 
        <term><filename>/etc/mandos/mandos.conf</filename></term>
511
 
        <listitem>
512
 
          <para>
513
 
            Server-global settings.  See
514
 
            <citerefentry><refentrytitle>mandos.conf</refentrytitle>
515
 
            <manvolnum>5</manvolnum></citerefentry> for details.
516
 
          </para>
517
 
        </listitem>
518
 
      </varlistentry>
519
 
      <varlistentry>
520
 
        <term><filename>/etc/mandos/clients.conf</filename></term>
521
 
        <listitem>
522
 
          <para>
523
 
            List of clients and client-specific settings.  See
524
 
            <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
525
 
            <manvolnum>5</manvolnum></citerefentry> for details.
526
 
          </para>
527
 
        </listitem>
528
 
      </varlistentry>
529
 
      <varlistentry>
530
 
        <term><filename>/run/mandos.pid</filename></term>
531
 
        <listitem>
532
 
          <para>
533
 
            The file containing the process id of the
534
 
            <command>&COMMANDNAME;</command> process started last.
535
 
            <emphasis >Note:</emphasis> If the <filename
536
 
            class="directory">/run</filename> directory does not
537
 
            exist, <filename>/var/run/mandos.pid</filename> will be
538
 
            used instead.
539
 
          </para>
540
 
        </listitem>
541
 
      </varlistentry>
542
 
      <varlistentry>
543
 
        <term><filename class="devicefile">/dev/log</filename></term>
544
 
      </varlistentry>
545
 
      <varlistentry>
546
 
        <term><filename
547
 
        class="directory">/var/lib/mandos</filename></term>
548
 
        <listitem>
549
 
          <para>
550
 
            Directory where persistent state will be saved.  Change
551
 
            this with the <option>--statedir</option> option.  See
552
 
            also the <option>--no-restore</option> option.
553
 
          </para>
554
 
        </listitem>
555
 
      </varlistentry>
556
 
      <varlistentry>
557
 
        <term><filename>/dev/log</filename></term>
558
 
        <listitem>
559
 
          <para>
560
 
            The Unix domain socket to where local syslog messages are
561
 
            sent.
562
 
          </para>
563
 
        </listitem>
564
 
      </varlistentry>
565
 
      <varlistentry>
566
 
        <term><filename>/bin/sh</filename></term>
567
 
        <listitem>
568
 
          <para>
569
 
            This is used to start the configured checker command for
570
 
            each client.  See <citerefentry>
571
 
            <refentrytitle>mandos-clients.conf</refentrytitle>
572
 
            <manvolnum>5</manvolnum></citerefentry> for details.
573
 
          </para>
574
 
        </listitem>
575
 
      </varlistentry>
576
 
    </variablelist>
577
 
  </refsect1>
578
 
  
579
 
  <refsect1 id="bugs">
580
 
    <title>BUGS</title>
581
 
    <para>
582
 
      This server might, on especially fatal errors, emit a Python
583
 
      backtrace.  This could be considered a feature.
584
 
    </para>
585
 
    <para>
586
 
      There is no fine-grained control over logging and debug output.
587
 
    </para>
588
 
    <para>
589
 
      This server does not check the expire time of clients’ OpenPGP
590
 
      keys.
591
 
    </para>
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://www.gnu.org/software/gnutls/"
711
 
          >GnuTLS</ulink>
712
 
        </term>
713
 
      <listitem>
714
 
        <para>
715
 
          GnuTLS is the library this server uses to implement TLS for
716
 
          communicating securely with the client, and at the same time
717
 
          confidently get the client’s public OpenPGP key.
718
 
        </para>
719
 
      </listitem>
720
 
      </varlistentry>
721
 
      <varlistentry>
722
 
        <term>
723
 
          RFC 4291: <citetitle>IP Version 6 Addressing
724
 
          Architecture</citetitle>
725
 
        </term>
726
 
        <listitem>
727
 
          <variablelist>
728
 
            <varlistentry>
729
 
              <term>Section 2.2: <citetitle>Text Representation of
730
 
              Addresses</citetitle></term>
731
 
              <listitem><para/></listitem>
732
 
            </varlistentry>
733
 
            <varlistentry>
734
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
735
 
              Address</citetitle></term>
736
 
              <listitem><para/></listitem>
737
 
            </varlistentry>
738
 
            <varlistentry>
739
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
740
 
            Addresses</citetitle></term>
741
 
            <listitem>
742
 
              <para>
743
 
                The clients use IPv6 link-local addresses, which are
744
 
                immediately usable since a link-local addresses is
745
 
                automatically assigned to a network interfaces when it
746
 
                is brought up.
747
 
              </para>
748
 
            </listitem>
749
 
            </varlistentry>
750
 
          </variablelist>
751
 
        </listitem>
752
 
      </varlistentry>
753
 
      <varlistentry>
754
 
        <term>
755
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
756
 
          Protocol Version 1.1</citetitle>
757
 
        </term>
758
 
      <listitem>
759
 
        <para>
760
 
          TLS 1.1 is the protocol implemented by GnuTLS.
761
 
        </para>
762
 
      </listitem>
763
 
      </varlistentry>
764
 
      <varlistentry>
765
 
        <term>
766
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
767
 
        </term>
768
 
      <listitem>
769
 
        <para>
770
 
          The data sent to clients is binary encrypted OpenPGP data.
771
 
        </para>
772
 
      </listitem>
773
 
      </varlistentry>
774
 
      <varlistentry>
775
 
        <term>
776
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
777
 
          Security</citetitle>
778
 
        </term>
779
 
      <listitem>
780
 
        <para>
781
 
          This is implemented by GnuTLS and used by this server so
782
 
          that OpenPGP keys can be used.
783
 
        </para>
784
 
      </listitem>
785
 
      </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
      
786
180
    </variablelist>
787
181
  </refsect1>
788
182
</refentry>
789
 
<!-- Local Variables: -->
790
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
791
 
<!-- time-stamp-end: "[\"']>" -->
792
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
793
 
<!-- End: -->