/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: 2023-02-07 19:40:12 UTC
  • Revision ID: teddy@recompile.se-20230207194012-hm2gev01cn7vlodp
Make builds reproducible 

* debian/rules (override_dh_fixperms-arch): Exclude from dh_fixperms
  only what is inside the
  /usr/share/doc/mandos-client/examples/network-hooks.d/ directory.
  That is, do not exclude (i.e. include in the normal dh_fixperms) the
  example/network-hooks.d directory itself.

Show diffs side-by-side

added added

removed removed

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