/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-12 19:39:36 UTC
  • mfrom: (24.1.47 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080812193936-hk8sas7p4j1miwl4
Merge.

Show diffs side-by-side

added added

removed removed

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