/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-09 02:53:48 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080809025348-2xk3e41pptc3hsl6
* mandos: Make syslog use "/dev/log" instead of UDP to localhost.
          Include "Mandos" in the log message.
  (AvahiService.max_renames): Increased to 32768.
  (AvahiService.rename): Alter the syslogger message.
  (main): Only log debug messages if in debug mode.  If different from
          "Mandos" include service name in syslog message.

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 "2017-02-23">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
8
8
]>
9
9
 
10
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
   <refentryinfo>
12
 
    <title>Mandos Manual</title>
13
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
16
 
    <date>&TIMESTAMP;</date>
 
10
<refentry>
 
11
  <refentryinfo>
 
12
    <title>&COMMANDNAME;</title>
 
13
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
14
    <productname>&COMMANDNAME;</productname>
 
15
    <productnumber>&VERSION;</productnumber>
17
16
    <authorgroup>
18
17
      <author>
19
18
        <firstname>Björn</firstname>
20
19
        <surname>Påhlsson</surname>
21
20
        <address>
22
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
23
22
        </address>
24
23
      </author>
25
24
      <author>
26
25
        <firstname>Teddy</firstname>
27
26
        <surname>Hogeborn</surname>
28
27
        <address>
29
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
30
29
        </address>
31
30
      </author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2010</year>
37
 
      <year>2011</year>
38
 
      <year>2012</year>
39
 
      <year>2013</year>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <holder>Teddy Hogeborn</holder>
45
 
      <holder>Björn Påhlsson</holder>
 
34
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
46
35
    </copyright>
47
 
    <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>
48
59
  </refentryinfo>
49
 
  
 
60
 
50
61
  <refmeta>
51
62
    <refentrytitle>&COMMANDNAME;</refentrytitle>
52
63
    <manvolnum>8</manvolnum>
55
66
  <refnamediv>
56
67
    <refname><command>&COMMANDNAME;</command></refname>
57
68
    <refpurpose>
58
 
      Gives encrypted passwords to authenticated Mandos clients
 
69
      Sends encrypted passwords to authenticated mandos clients
59
70
    </refpurpose>
60
71
  </refnamediv>
61
 
  
 
72
 
62
73
  <refsynopsisdiv>
63
74
    <cmdsynopsis>
64
75
      <command>&COMMANDNAME;</command>
65
 
      <group>
66
 
        <arg choice="plain"><option>--interface
67
 
        <replaceable>NAME</replaceable></option></arg>
68
 
        <arg choice="plain"><option>-i
69
 
        <replaceable>NAME</replaceable></option></arg>
70
 
      </group>
71
 
      <sbr/>
72
 
      <group>
73
 
        <arg choice="plain"><option>--address
74
 
        <replaceable>ADDRESS</replaceable></option></arg>
75
 
        <arg choice="plain"><option>-a
76
 
        <replaceable>ADDRESS</replaceable></option></arg>
77
 
      </group>
78
 
      <sbr/>
79
 
      <group>
80
 
        <arg choice="plain"><option>--port
81
 
        <replaceable>PORT</replaceable></option></arg>
82
 
        <arg choice="plain"><option>-p
83
 
        <replaceable>PORT</replaceable></option></arg>
84
 
      </group>
85
 
      <sbr/>
86
 
      <arg><option>--priority
87
 
      <replaceable>PRIORITY</replaceable></option></arg>
88
 
      <sbr/>
89
 
      <arg><option>--servicename
90
 
      <replaceable>NAME</replaceable></option></arg>
91
 
      <sbr/>
92
 
      <arg><option>--configdir
93
 
      <replaceable>DIRECTORY</replaceable></option></arg>
94
 
      <sbr/>
95
 
      <arg><option>--debug</option></arg>
96
 
      <sbr/>
97
 
      <arg><option>--debuglevel
98
 
      <replaceable>LEVEL</replaceable></option></arg>
99
 
      <sbr/>
100
 
      <arg><option>--no-dbus</option></arg>
101
 
      <sbr/>
102
 
      <arg><option>--no-ipv6</option></arg>
103
 
      <sbr/>
104
 
      <arg><option>--no-restore</option></arg>
105
 
      <sbr/>
106
 
      <arg><option>--statedir
107
 
      <replaceable>DIRECTORY</replaceable></option></arg>
108
 
      <sbr/>
109
 
      <arg><option>--socket
110
 
      <replaceable>FD</replaceable></option></arg>
111
 
      <sbr/>
112
 
      <arg><option>--foreground</option></arg>
113
 
      <sbr/>
114
 
      <arg><option>--no-zeroconf</option></arg>
115
 
    </cmdsynopsis>
116
 
    <cmdsynopsis>
117
 
      <command>&COMMANDNAME;</command>
118
 
      <group choice="req">
119
 
        <arg choice="plain"><option>--help</option></arg>
120
 
        <arg choice="plain"><option>-h</option></arg>
121
 
      </group>
122
 
    </cmdsynopsis>
123
 
    <cmdsynopsis>
124
 
      <command>&COMMANDNAME;</command>
125
 
      <arg choice="plain"><option>--version</option></arg>
126
 
    </cmdsynopsis>
127
 
    <cmdsynopsis>
128
 
      <command>&COMMANDNAME;</command>
129
 
      <arg choice="plain"><option>--check</option></arg>
 
76
      <arg choice='opt' rep='repeat'>OPTION</arg>
130
77
    </cmdsynopsis>
131
78
  </refsynopsisdiv>
132
 
  
 
79
 
133
80
  <refsect1 id="description">
134
81
    <title>DESCRIPTION</title>
135
82
    <para>
136
 
      <command>&COMMANDNAME;</command> is a server daemon which
137
 
      handles incoming request for passwords for a pre-defined list of
138
 
      client host computers. For an introduction, see
139
 
      <citerefentry><refentrytitle>intro</refentrytitle>
140
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
141
 
      uses Zeroconf to announce itself on the local network, and uses
142
 
      TLS to communicate securely with and to authenticate the
143
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
144
 
      use IPv6 link-local addresses, since the clients will probably
145
 
      not have any other addresses configured (see <xref
146
 
      linkend="overview"/>).  Any authenticated client is then given
147
 
      the stored pre-encrypted password for that specific client.
148
 
    </para>
149
 
  </refsect1>
150
 
  
151
 
  <refsect1 id="purpose">
152
 
    <title>PURPOSE</title>
153
 
    <para>
154
 
      The purpose of this is to enable <emphasis>remote and unattended
155
 
      rebooting</emphasis> of client host computer with an
156
 
      <emphasis>encrypted root file system</emphasis>.  See <xref
157
 
      linkend="overview"/> for details.
158
 
    </para>
159
 
  </refsect1>
160
 
  
161
 
  <refsect1 id="options">
162
 
    <title>OPTIONS</title>
163
 
    <variablelist>
164
 
      <varlistentry>
165
 
        <term><option>--help</option></term>
166
 
        <term><option>-h</option></term>
167
 
        <listitem>
168
 
          <para>
169
 
            Show a help message and exit
170
 
          </para>
171
 
        </listitem>
172
 
      </varlistentry>
173
 
      
174
 
      <varlistentry>
175
 
        <term><option>--interface</option>
176
 
        <replaceable>NAME</replaceable></term>
177
 
        <term><option>-i</option>
178
 
        <replaceable>NAME</replaceable></term>
179
 
        <listitem>
180
 
          <xi:include href="mandos-options.xml" xpointer="interface"/>
181
 
        </listitem>
182
 
      </varlistentry>
183
 
      
184
 
      <varlistentry>
185
 
        <term><option>--address
186
 
        <replaceable>ADDRESS</replaceable></option></term>
187
 
        <term><option>-a
188
 
        <replaceable>ADDRESS</replaceable></option></term>
189
 
        <listitem>
190
 
          <xi:include href="mandos-options.xml" xpointer="address"/>
191
 
        </listitem>
192
 
      </varlistentry>
193
 
      
194
 
      <varlistentry>
195
 
        <term><option>--port
196
 
        <replaceable>PORT</replaceable></option></term>
197
 
        <term><option>-p
198
 
        <replaceable>PORT</replaceable></option></term>
199
 
        <listitem>
200
 
          <xi:include href="mandos-options.xml" xpointer="port"/>
201
 
        </listitem>
202
 
      </varlistentry>
203
 
      
204
 
      <varlistentry>
205
 
        <term><option>--check</option></term>
206
 
        <listitem>
207
 
          <para>
208
 
            Run the server’s self-tests.  This includes any unit
209
 
            tests, etc.
210
 
          </para>
211
 
        </listitem>
212
 
      </varlistentry>
213
 
      
214
 
      <varlistentry>
215
 
        <term><option>--debug</option></term>
216
 
        <listitem>
217
 
          <xi:include href="mandos-options.xml" xpointer="debug"/>
218
 
        </listitem>
219
 
      </varlistentry>
220
 
      
221
 
      <varlistentry>
222
 
        <term><option>--debuglevel
223
 
        <replaceable>LEVEL</replaceable></option></term>
224
 
        <listitem>
225
 
          <para>
226
 
            Set the debugging log level.
227
 
            <replaceable>LEVEL</replaceable> is a string, one of
228
 
            <quote><literal>CRITICAL</literal></quote>,
229
 
            <quote><literal>ERROR</literal></quote>,
230
 
            <quote><literal>WARNING</literal></quote>,
231
 
            <quote><literal>INFO</literal></quote>, or
232
 
            <quote><literal>DEBUG</literal></quote>, in order of
233
 
            increasing verbosity.  The default level is
234
 
            <quote><literal>WARNING</literal></quote>.
235
 
          </para>
236
 
        </listitem>
237
 
      </varlistentry>
238
 
      
239
 
      <varlistentry>
240
 
        <term><option>--priority <replaceable>
241
 
        PRIORITY</replaceable></option></term>
242
 
        <listitem>
243
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
244
 
        </listitem>
245
 
      </varlistentry>
246
 
      
247
 
      <varlistentry>
248
 
        <term><option>--servicename
249
 
        <replaceable>NAME</replaceable></option></term>
250
 
        <listitem>
251
 
          <xi:include href="mandos-options.xml"
252
 
                      xpointer="servicename"/>
253
 
        </listitem>
254
 
      </varlistentry>
255
 
      
256
 
      <varlistentry>
257
 
        <term><option>--configdir
258
 
        <replaceable>DIRECTORY</replaceable></option></term>
259
 
        <listitem>
260
 
          <para>
261
 
            Directory to search for configuration files.  Default is
262
 
            <quote><literal>/etc/mandos</literal></quote>.  See
263
 
            <citerefentry><refentrytitle>mandos.conf</refentrytitle>
264
 
            <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
265
 
            <refentrytitle>mandos-clients.conf</refentrytitle>
266
 
            <manvolnum>5</manvolnum></citerefentry>.
267
 
          </para>
268
 
        </listitem>
269
 
      </varlistentry>
270
 
      
271
 
      <varlistentry>
272
 
        <term><option>--version</option></term>
273
 
        <listitem>
274
 
          <para>
275
 
            Prints the program version and exit.
276
 
          </para>
277
 
        </listitem>
278
 
      </varlistentry>
279
 
      
280
 
      <varlistentry>
281
 
        <term><option>--no-dbus</option></term>
282
 
        <listitem>
283
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
284
 
          <para>
285
 
            See also <xref linkend="dbus_interface"/>.
286
 
          </para>
287
 
        </listitem>
288
 
      </varlistentry>
289
 
      
290
 
      <varlistentry>
291
 
        <term><option>--no-ipv6</option></term>
292
 
        <listitem>
293
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
294
 
        </listitem>
295
 
      </varlistentry>
296
 
      
297
 
      <varlistentry>
298
 
        <term><option>--no-restore</option></term>
299
 
        <listitem>
300
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
301
 
          <para>
302
 
            See also <xref linkend="persistent_state"/>.
303
 
          </para>
304
 
        </listitem>
305
 
      </varlistentry>
306
 
      
307
 
      <varlistentry>
308
 
        <term><option>--statedir
309
 
        <replaceable>DIRECTORY</replaceable></option></term>
310
 
        <listitem>
311
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
312
 
        </listitem>
313
 
      </varlistentry>
314
 
      
315
 
      <varlistentry>
316
 
        <term><option>--socket
317
 
        <replaceable>FD</replaceable></option></term>
318
 
        <listitem>
319
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
320
 
        </listitem>
321
 
      </varlistentry>
322
 
      
323
 
      <varlistentry>
324
 
        <term><option>--foreground</option></term>
325
 
        <listitem>
326
 
          <xi:include href="mandos-options.xml"
327
 
                      xpointer="foreground"/>
328
 
        </listitem>
329
 
      </varlistentry>
330
 
      
331
 
      <varlistentry>
332
 
        <term><option>--no-zeroconf</option></term>
333
 
        <listitem>
334
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
335
 
        </listitem>
336
 
      </varlistentry>
337
 
      
338
 
    </variablelist>
339
 
  </refsect1>
340
 
  
341
 
  <refsect1 id="overview">
342
 
    <title>OVERVIEW</title>
343
 
    <xi:include href="overview.xml"/>
344
 
    <para>
345
 
      This program is the server part.  It is a normal server program
346
 
      and will run in a normal system environment, not in an initial
347
 
      <acronym>RAM</acronym> disk environment.
348
 
    </para>
349
 
  </refsect1>
350
 
  
351
 
  <refsect1 id="protocol">
352
 
    <title>NETWORK PROTOCOL</title>
353
 
    <para>
354
 
      The Mandos server announces itself as a Zeroconf service of type
355
 
      <quote><literal>_mandos._tcp</literal></quote>.  The Mandos
356
 
      client connects to the announced address and port, and sends a
357
 
      line of text where the first whitespace-separated field is the
358
 
      protocol version, which currently is
359
 
      <quote><literal>1</literal></quote>.  The client and server then
360
 
      start a TLS protocol handshake with a slight quirk: the Mandos
361
 
      server program acts as a TLS <quote>client</quote> while the
362
 
      connecting Mandos client acts as a TLS <quote>server</quote>.
363
 
      The Mandos client must supply an OpenPGP certificate, and the
364
 
      fingerprint of this certificate is used by the Mandos server to
365
 
      look up (in a list read from <filename>clients.conf</filename>
366
 
      at start time) which binary blob to give the client.  No other
367
 
      authentication or authorization is done by the server.
368
 
    </para>
369
 
    <table>
370
 
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
371
 
      <row>
372
 
        <entry>Mandos Client</entry>
373
 
        <entry>Direction</entry>
374
 
        <entry>Mandos Server</entry>
375
 
      </row>
376
 
      </thead><tbody>
377
 
      <row>
378
 
        <entry>Connect</entry>
379
 
        <entry>-><!-- &rarr; --></entry>
380
 
      </row>
381
 
      <row>
382
 
        <entry><quote><literal>1\r\n</literal></quote></entry>
383
 
        <entry>-><!-- &rarr; --></entry>
384
 
      </row>
385
 
      <row>
386
 
        <entry>TLS handshake <emphasis>as TLS <quote>server</quote>
387
 
        </emphasis></entry>
388
 
        <entry>&lt;-><!-- &xharr; --></entry>
389
 
        <entry>TLS handshake <emphasis>as TLS <quote>client</quote>
390
 
        </emphasis></entry>
391
 
      </row>
392
 
      <row>
393
 
        <entry>OpenPGP public key (part of TLS handshake)</entry>
394
 
        <entry>-><!-- &rarr; --></entry>
395
 
      </row>
396
 
      <row>
397
 
        <entry/>
398
 
        <entry>&lt;-<!-- &larr; --></entry>
399
 
        <entry>Binary blob (client will assume OpenPGP data)</entry>
400
 
      </row>
401
 
      <row>
402
 
        <entry/>
403
 
        <entry>&lt;-<!-- &larr; --></entry>
404
 
        <entry>Close</entry>
405
 
      </row>
406
 
    </tbody></tgroup></table>
407
 
  </refsect1>
408
 
  
409
 
  <refsect1 id="checking">
410
 
    <title>CHECKING</title>
411
 
    <para>
412
 
      The server will, by default, continually check that the clients
413
 
      are still up.  If a client has not been confirmed as being up
414
 
      for some time, the client is assumed to be compromised and is no
415
 
      longer eligible to receive the encrypted password.  (Manual
416
 
      intervention is required to re-enable a client.)  The timeout,
417
 
      extended timeout, checker program, and interval between checks
418
 
      can be configured both globally and per client; see
419
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
420
 
      <manvolnum>5</manvolnum></citerefentry>.
421
 
    </para>
422
 
  </refsect1>
423
 
  
424
 
  <refsect1 id="approval">
425
 
    <title>APPROVAL</title>
426
 
    <para>
427
 
      The server can be configured to require manual approval for a
428
 
      client before it is sent its secret.  The delay to wait for such
429
 
      approval and the default action (approve or deny) can be
430
 
      configured both globally and per client; see <citerefentry>
431
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
432
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
433
 
      will be approved immediately without delay.
434
 
    </para>
435
 
    <para>
436
 
      This can be used to deny a client its secret if not manually
437
 
      approved within a specified time.  It can also be used to make
438
 
      the server delay before giving a client its secret, allowing
439
 
      optional manual denying of this specific client.
440
 
    </para>
441
 
    
442
 
  </refsect1>
443
 
  
444
 
  <refsect1 id="logging">
445
 
    <title>LOGGING</title>
446
 
    <para>
447
 
      The server will send log message with various severity levels to
448
 
      <filename class="devicefile">/dev/log</filename>.  With the
449
 
      <option>--debug</option> option, it will log even more messages,
450
 
      and also show them on the console.
451
 
    </para>
452
 
  </refsect1>
453
 
  
454
 
  <refsect1 id="persistent_state">
455
 
    <title>PERSISTENT STATE</title>
456
 
    <para>
457
 
      Client settings, initially read from
458
 
      <filename>clients.conf</filename>, are persistent across
459
 
      restarts, and run-time changes will override settings in
460
 
      <filename>clients.conf</filename>.  However, if a setting is
461
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
462
 
      <filename>clients.conf</filename>, this will take precedence.
463
 
    </para>
464
 
  </refsect1>
465
 
  
466
 
  <refsect1 id="dbus_interface">
467
 
    <title>D-BUS INTERFACE</title>
468
 
    <para>
469
 
      The server will by default provide a D-Bus system bus interface.
470
 
      This interface will only be accessible by the root user or a
471
 
      Mandos-specific user, if such a user exists.  For documentation
472
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
473
 
    </para>
474
 
  </refsect1>
475
 
  
476
 
  <refsect1 id="exit_status">
477
 
    <title>EXIT STATUS</title>
478
 
    <para>
479
 
      The server will exit with a non-zero exit status only when a
480
 
      critical error is encountered.
481
 
    </para>
482
 
  </refsect1>
483
 
  
484
 
  <refsect1 id="environment">
485
 
    <title>ENVIRONMENT</title>
486
 
    <variablelist>
487
 
      <varlistentry>
488
 
        <term><envar>PATH</envar></term>
489
 
        <listitem>
490
 
          <para>
491
 
            To start the configured checker (see <xref
492
 
            linkend="checking"/>), the server uses
493
 
            <filename>/bin/sh</filename>, which in turn uses
494
 
            <varname>PATH</varname> to search for matching commands if
495
 
            an absolute path is not given.  See <citerefentry>
496
 
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
497
 
            </citerefentry>.
498
 
          </para>
499
 
        </listitem>
500
 
      </varlistentry>
501
 
    </variablelist>
502
 
  </refsect1>
503
 
  
504
 
  <refsect1 id="files">
505
 
    <title>FILES</title>
506
 
    <para>
507
 
      Use the <option>--configdir</option> option to change where
508
 
      <command>&COMMANDNAME;</command> looks for its configurations
509
 
      files.  The default file names are listed here.
510
 
    </para>
511
 
    <variablelist>
512
 
      <varlistentry>
513
 
        <term><filename>/etc/mandos/mandos.conf</filename></term>
514
 
        <listitem>
515
 
          <para>
516
 
            Server-global settings.  See
517
 
            <citerefentry><refentrytitle>mandos.conf</refentrytitle>
518
 
            <manvolnum>5</manvolnum></citerefentry> for details.
519
 
          </para>
520
 
        </listitem>
521
 
      </varlistentry>
522
 
      <varlistentry>
523
 
        <term><filename>/etc/mandos/clients.conf</filename></term>
524
 
        <listitem>
525
 
          <para>
526
 
            List of clients and client-specific settings.  See
527
 
            <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
528
 
            <manvolnum>5</manvolnum></citerefentry> for details.
529
 
          </para>
530
 
        </listitem>
531
 
      </varlistentry>
532
 
      <varlistentry>
533
 
        <term><filename>/run/mandos.pid</filename></term>
534
 
        <listitem>
535
 
          <para>
536
 
            The file containing the process id of the
537
 
            <command>&COMMANDNAME;</command> process started last.
538
 
            <emphasis >Note:</emphasis> If the <filename
539
 
            class="directory">/run</filename> directory does not
540
 
            exist, <filename>/var/run/mandos.pid</filename> will be
541
 
            used instead.
542
 
          </para>
543
 
        </listitem>
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 class="devicefile">/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
 
    <xi:include href="bugs.xml"/>
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="https://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>
 
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: -->