/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: 2025-06-27 19:57:27 UTC
  • mfrom: (237.7.868 trunk)
  • Revision ID: teddy@recompile.se-20250627195727-wmn5jvu20sor29ts
Merge from trunk

Show diffs side-by-side

added added

removed removed

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