/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: 2025-06-27 19:56:23 UTC
  • Revision ID: teddy@recompile.se-20250627195623-02t2vap0gixox3mo
Update Debian Policy version to 4.7.2; no other changes necessary.

* debian/control (Standards-Version): Change to "4.7.2".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
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 "2025-06-27">
 
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>
 
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>
34
49
      <holder>Teddy Hogeborn</holder>
35
50
      <holder>Björn Påhlsson</holder>
36
51
    </copyright>
37
 
    <legalnotice>
38
 
      <para>
39
 
        This manual page is free software: you can redistribute it
40
 
        and/or modify it under the terms of the GNU General Public
41
 
        License as published by the Free Software Foundation,
42
 
        either version 3 of the License, or (at your option) any
43
 
        later version.
44
 
      </para>
45
 
 
46
 
      <para>
47
 
        This manual page is distributed in the hope that it will
48
 
        be useful, but WITHOUT ANY WARRANTY; without even the
49
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
50
 
        PARTICULAR PURPOSE.  See the GNU General Public License
51
 
        for more details.
52
 
      </para>
53
 
 
54
 
      <para>
55
 
        You should have received a copy of the GNU General Public
56
 
        License along with this program; If not, see
57
 
        <ulink url="http://www.gnu.org/licenses/"/>.
58
 
      </para>
59
 
    </legalnotice>
 
52
    <xi:include href="legalnotice.xml"/>
60
53
  </refentryinfo>
61
 
 
 
54
  
62
55
  <refmeta>
63
56
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
57
    <manvolnum>8</manvolnum>
67
60
  <refnamediv>
68
61
    <refname><command>&COMMANDNAME;</command></refname>
69
62
    <refpurpose>
70
 
      Sends encrypted passwords to authenticated Mandos clients
 
63
      Gives encrypted passwords to authenticated Mandos clients
71
64
    </refpurpose>
72
65
  </refnamediv>
73
 
 
 
66
  
74
67
  <refsynopsisdiv>
75
68
    <cmdsynopsis>
76
69
      <command>&COMMANDNAME;</command>
77
 
      <arg choice='opt'>--interface<arg choice='plain'>IF</arg></arg>
78
 
      <arg choice='opt'>--address<arg choice='plain'>ADDRESS</arg></arg>
79
 
      <arg choice='opt'>--port<arg choice='plain'>PORT</arg></arg>
80
 
      <arg choice='opt'>--priority<arg choice='plain'>PRIORITY</arg></arg>
81
 
      <arg choice='opt'>--servicename<arg choice='plain'>NAME</arg></arg>
82
 
      <arg choice='opt'>--configdir<arg choice='plain'>DIRECTORY</arg></arg>
83
 
      <arg choice='opt'>--debug</arg>
84
 
    </cmdsynopsis>
85
 
    <cmdsynopsis>
86
 
      <command>&COMMANDNAME;</command>
87
 
      <arg choice='opt'>-i<arg choice='plain'>IF</arg></arg>
88
 
      <arg choice='opt'>-a<arg choice='plain'>ADDRESS</arg></arg>
89
 
      <arg choice='opt'>-p<arg choice='plain'>PORT</arg></arg>
90
 
      <arg choice='opt'>--priority<arg choice='plain'>PRIORITY</arg></arg>
91
 
      <arg choice='opt'>--servicename<arg choice='plain'>NAME</arg></arg>
92
 
      <arg choice='opt'>--configdir<arg choice='plain'>DIRECTORY</arg></arg>
93
 
      <arg choice='opt'>--debug</arg>
94
 
    </cmdsynopsis>
95
 
    <cmdsynopsis>
96
 
      <command>&COMMANDNAME;</command>
97
 
      <arg choice='plain'>--help</arg>
98
 
    </cmdsynopsis>
99
 
    <cmdsynopsis>
100
 
      <command>&COMMANDNAME;</command>
101
 
      <arg choice='plain'>--version</arg>
102
 
    </cmdsynopsis>
103
 
    <cmdsynopsis>
104
 
      <command>&COMMANDNAME;</command>
105
 
      <arg choice='plain'>--check</arg>
 
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>
106
135
    </cmdsynopsis>
107
136
  </refsynopsisdiv>
108
 
 
 
137
  
109
138
  <refsect1 id="description">
110
139
    <title>DESCRIPTION</title>
111
140
    <para>
112
141
      <command>&COMMANDNAME;</command> is a server daemon which
113
 
      handles incoming request for passwords for a pre-defined list of
114
 
      client host computers.  The Mandos server uses Zeroconf to
115
 
      announce itself on the local network, and uses GnuTLS to
116
 
      communicate securely with and to authenticate the clients.
117
 
      Mandos uses IPv6 link-local addresses, since the clients are
118
 
      assumed to not have any other addresses configured.  Any
119
 
      authenticated client is then given the pre-encrypted password
120
 
      for that specific client.
 
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.
121
153
    </para>
122
 
 
123
154
  </refsect1>
124
155
  
125
156
  <refsect1 id="purpose">
126
157
    <title>PURPOSE</title>
127
 
 
128
158
    <para>
129
159
      The purpose of this is to enable <emphasis>remote and unattended
130
 
      rebooting</emphasis> of any client host computer with an
131
 
      <emphasis>encrypted root file system</emphasis>.  The client
132
 
      host computer should start a Mandos client in the initial RAM
133
 
      disk environment, the Mandos client program communicates with
134
 
      this server program to get an encrypted password, which is then
135
 
      decrypted and used to unlock the encrypted root file system.
136
 
      The client host computer can then continue its boot sequence
137
 
      normally.
 
160
      rebooting</emphasis> of client host computer with an
 
161
      <emphasis>encrypted root file system</emphasis>.  See <xref
 
162
      linkend="overview"/> for details.
138
163
    </para>
139
 
 
140
164
  </refsect1>
141
165
  
142
166
  <refsect1 id="options">
143
167
    <title>OPTIONS</title>
144
 
 
145
168
    <variablelist>
146
169
      <varlistentry>
147
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
170
        <term><option>--help</option></term>
 
171
        <term><option>-h</option></term>
148
172
        <listitem>
149
173
          <para>
150
174
            Show a help message and exit
151
175
          </para>
152
176
        </listitem>
153
177
      </varlistentry>
154
 
 
155
 
      <varlistentry>
156
 
        <term><literal>-i</literal>, <literal>--interface <replaceable>
157
 
        IF</replaceable></literal></term>
158
 
        <listitem>
159
 
          <para>
160
 
            Only announce the server and listen to requests on network
161
 
            interface <replaceable>IF</replaceable>.  Default is to
162
 
            use all available interfaces.
163
 
          </para>
164
 
        </listitem>
165
 
      </varlistentry>
166
 
 
167
 
      <varlistentry>
168
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
169
 
        ADDRESS</replaceable></literal></term>
170
 
        <listitem>
171
 
          <para>
172
 
            If this option is used, the server will only listen to a
173
 
            specific address.  This must currently be an IPv6 address;
174
 
            an IPv4 address can be specified using the
175
 
            <quote><literal>::FFFF:192.0.2.3</literal></quote> syntax.
176
 
            Also, if a link-local address is specified, an interface
177
 
            should be set, since a link-local address is only valid on
178
 
            a single interface.  By default, the server will listen to
179
 
            all available addresses.
180
 
          </para>
181
 
        </listitem>
182
 
      </varlistentry>
183
 
 
184
 
      <varlistentry>
185
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
186
 
        PORT</replaceable></literal></term>
187
 
        <listitem>
188
 
          <para>
189
 
            If this option is used, the server to bind to that
190
 
            port. By default, the server will listen to an arbitrary
191
 
            port given by the operating system.
192
 
          </para>
193
 
        </listitem>
194
 
      </varlistentry>
195
 
 
196
 
      <varlistentry>
197
 
        <term><literal>--check</literal></term>
198
 
        <listitem>
199
 
          <para>
200
 
            Run the server's self-tests.  This includes any unit
 
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
201
214
            tests, etc.
202
215
          </para>
203
216
        </listitem>
204
217
      </varlistentry>
205
 
 
206
 
      <varlistentry>
207
 
        <term><literal>--debug</literal></term>
208
 
        <listitem>
209
 
          <para>
210
 
            If the server is run in debug mode, it will run in the
211
 
            foreground and print a lot of debugging information.  The
212
 
            default is <emphasis>not</emphasis> to run in debug mode.
213
 
          </para>
214
 
        </listitem>
215
 
      </varlistentry>
216
 
 
217
 
      <varlistentry>
218
 
        <term><literal>--priority <replaceable>
219
 
        PRIORITY</replaceable></literal></term>
220
 
        <listitem>
221
 
          <para>
222
 
            GnuTLS priority string for the TLS handshake with the
223
 
            clients.  See
224
 
            <citerefentry><refentrytitle>gnutls_priority_init
225
 
            </refentrytitle><manvolnum>3</manvolnum></citerefentry>
226
 
            for the syntax.  The default is
227
 
            <quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.
228
 
            <emphasis>Warning</emphasis>: changing this may make the
229
 
            TLS handshake fail, making communication with clients
230
 
            impossible.
231
 
          </para>
232
 
        </listitem>
233
 
      </varlistentry>
234
 
 
235
 
      <varlistentry>
236
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
237
 
        </literal></term>
238
 
        <listitem>
239
 
          <para>
240
 
            Zeroconf service name.  The default is
241
 
            <quote><literal>Mandos</literal></quote>.  You only need
242
 
            to change this if you for some reason want to run more
243
 
            than one server on the same <emphasis>host</emphasis>,
244
 
            which would not normally be useful.  If there are name
245
 
            collisions on the same <emphasis>network</emphasis>, the
246
 
            newer server will automatically rename itself to
247
 
            <quote><literal>Mandos #2</literal></quote>, and so on,
248
 
            therefore this option is not needed in that case.
249
 
          </para>
250
 
        </listitem>
251
 
      </varlistentry>
252
 
 
253
 
      <varlistentry>
254
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
255
 
        </literal></term>
 
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>
256
264
        <listitem>
257
265
          <para>
258
266
            Directory to search for configuration files.  Default is
264
272
          </para>
265
273
        </listitem>
266
274
      </varlistentry>
267
 
 
 
275
      
268
276
      <varlistentry>
269
 
        <term><literal>--version</literal></term>
 
277
        <term><option>--version</option></term>
270
278
        <listitem>
271
279
          <para>
272
280
            Prints the program version and exit.
273
281
          </para>
274
282
        </listitem>
275
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
      
276
343
    </variablelist>
277
344
  </refsect1>
278
 
 
 
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
  
279
356
  <refsect1 id="protocol">
280
357
    <title>NETWORK PROTOCOL</title>
281
358
    <para>
288
365
      start a TLS protocol handshake with a slight quirk: the Mandos
289
366
      server program acts as a TLS <quote>client</quote> while the
290
367
      connecting Mandos client acts as a TLS <quote>server</quote>.
291
 
      The Mandos client must supply an OpenPGP certificate, and the
292
 
      fingerprint of this certificate is used by the Mandos server to
293
 
      look up (in a list read from <filename>clients.conf</filename>
294
 
      at start time) which binary blob to give the client.  No other
295
 
      authentication or authorization is done by the server.
 
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.
296
373
    </para>
297
374
    <table>
298
375
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
307
384
        <entry>-><!-- &rarr; --></entry>
308
385
      </row>
309
386
      <row>
310
 
        <entry><quote><literal>1\r\en</literal></quote></entry>
 
387
        <entry><quote><literal>1\r\n</literal></quote></entry>
311
388
        <entry>-><!-- &rarr; --></entry>
312
389
      </row>
313
390
      <row>
318
395
        </emphasis></entry>
319
396
      </row>
320
397
      <row>
321
 
        <entry>OpenPGP public key (part of TLS handshake)</entry>
 
398
        <entry>Public key (part of TLS handshake)</entry>
322
399
        <entry>-><!-- &rarr; --></entry>
323
400
      </row>
324
401
      <row>
333
410
      </row>
334
411
    </tbody></tgroup></table>
335
412
  </refsect1>
336
 
 
 
413
  
337
414
  <refsect1 id="checking">
338
415
    <title>CHECKING</title>
339
416
    <para>
340
417
      The server will, by default, continually check that the clients
341
418
      are still up.  If a client has not been confirmed as being up
342
419
      for some time, the client is assumed to be compromised and is no
343
 
      longer eligible to receive the encrypted password.  The timeout,
344
 
      checker program and interval between checks can be configured
345
 
      both globally and per client; see <citerefentry>
346
 
      <refentrytitle>mandos.conf</refentrytitle>
347
 
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
 
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>
348
436
      <refentrytitle>mandos-clients.conf</refentrytitle>
349
 
      <manvolnum>5</manvolnum></citerefentry>.
350
 
    </para>
 
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
    
351
447
  </refsect1>
352
 
 
 
448
  
353
449
  <refsect1 id="logging">
354
450
    <title>LOGGING</title>
355
451
    <para>
356
 
      The server will send log messaged with various severity levels
357
 
      to <filename>/dev/log</filename>.  With the
 
452
      The server will send log message with various severity levels to
 
453
      <filename class="devicefile">/dev/log</filename>.  With the
358
454
      <option>--debug</option> option, it will log even more messages,
359
455
      and also show them on the console.
360
456
    </para>
361
457
  </refsect1>
362
 
 
 
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
  
363
481
  <refsect1 id="exit_status">
364
482
    <title>EXIT STATUS</title>
365
483
    <para>
367
485
      critical error is encountered.
368
486
    </para>
369
487
  </refsect1>
370
 
 
371
 
  <refsect1 id="file">
 
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">
372
510
    <title>FILES</title>
373
511
    <para>
374
512
      Use the <option>--configdir</option> option to change where
397
535
        </listitem>
398
536
      </varlistentry>
399
537
      <varlistentry>
400
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
401
 
        <listitem>
402
 
          <para>
403
 
            The file containing the process id of
404
 
            <command>&COMMANDNAME;</command>.
405
 
          </para>
406
 
        </listitem>
407
 
      </varlistentry>
408
 
      <varlistentry>
409
 
        <term><filename>/dev/log</filename></term>
 
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>
410
563
        <listitem>
411
564
          <para>
412
565
            The Unix domain socket to where local syslog messages are
414
567
          </para>
415
568
        </listitem>
416
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>
417
581
    </variablelist>
418
582
  </refsect1>
419
 
 
 
583
  
420
584
  <refsect1 id="bugs">
421
585
    <title>BUGS</title>
422
586
    <para>
423
587
      This server might, on especially fatal errors, emit a Python
424
588
      backtrace.  This could be considered a feature.
425
589
    </para>
 
590
    <para>
 
591
      There is no fine-grained control over logging and debug output.
 
592
    </para>
 
593
    <xi:include href="bugs.xml"/>
426
594
  </refsect1>
427
 
 
428
 
  <refsect1 id="examples">
429
 
    <title>EXAMPLES</title>
 
595
  
 
596
  <refsect1 id="example">
 
597
    <title>EXAMPLE</title>
430
598
    <informalexample>
431
599
      <para>
432
600
        Normal invocation needs no options:
433
601
      </para>
434
602
      <para>
435
 
        <userinput>mandos</userinput>
 
603
        <userinput>&COMMANDNAME;</userinput>
436
604
      </para>
437
605
    </informalexample>
438
606
    <informalexample>
439
607
      <para>
440
 
        Run the server in debug mode and read configuration files from
441
 
        the <filename>~/mandos</filename> directory:
 
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:
442
612
      </para>
443
613
      <para>
444
614
 
445
615
<!-- do not wrap this line -->
446
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
616
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
447
617
 
448
618
      </para>
449
619
    </informalexample>
455
625
      <para>
456
626
 
457
627
<!-- do not wrap this line -->
458
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
628
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
459
629
 
460
630
      </para>
461
631
    </informalexample>
462
632
  </refsect1>
463
 
 
 
633
  
464
634
  <refsect1 id="security">
465
635
    <title>SECURITY</title>
466
 
    <refsect2>
 
636
    <refsect2 id="server">
467
637
      <title>SERVER</title>
468
638
      <para>
469
 
        Running the server should not in itself present any security
470
 
        risk to the host computer running it.
 
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.
471
643
      </para>
472
644
    </refsect2>
473
 
    <refsect2>
 
645
    <refsect2 id="clients">
474
646
      <title>CLIENTS</title>
475
647
      <para>
476
648
        The server only gives out its stored data to clients which
477
 
        does have the OpenPGP key of the stored fingerprint.  This is
478
 
        guaranteed by the fact that the client sends its OpenPGP
479
 
        public key in the TLS handshake; this ensures it to be
480
 
        genuine.  The server computes the fingerprint of the key
481
 
        itself and looks up the fingerprint in its list of
482
 
        clients. The <filename>clients.conf</filename> file (see
 
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
483
655
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
484
 
        <manvolnum>5</manvolnum></citerefentry>) must be non-readable
485
 
        by anyone except the user running the server.
 
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.
486
664
      </para>
487
665
      <para>
488
666
        For more details on client-side security, see
489
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
667
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
490
668
        <manvolnum>8mandos</manvolnum></citerefentry>.
491
669
      </para>
492
670
    </refsect2>
493
671
  </refsect1>
494
 
 
 
672
  
495
673
  <refsect1 id="see_also">
496
674
    <title>SEE ALSO</title>
497
 
    <itemizedlist spacing="compact">
498
 
      <listitem><para>
499
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
500
 
        <manvolnum>8mandos</manvolnum></citerefentry>
501
 
      </para></listitem>
502
 
      
503
 
      <listitem><para>
504
 
        <citerefentry><refentrytitle>plugin-runner</refentrytitle>
505
 
        <manvolnum>8mandos</manvolnum></citerefentry>
506
 
      </para></listitem>
507
 
      
508
 
      <listitem><para>
509
 
        <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
510
 
      </para></listitem>
511
 
      
512
 
      <listitem><para>
513
 
        <ulink url="http://www.avahi.org/">Avahi</ulink>
514
 
      </para></listitem>
515
 
      
516
 
      <listitem><para>
517
 
        <ulink
518
 
            url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
519
 
      </para></listitem>
520
 
      
521
 
      <listitem><para>
522
 
        <citation>RFC 4880: <citetitle>OpenPGP Message
523
 
        Format</citetitle></citation>
524
 
      </para></listitem>
525
 
      
526
 
      <listitem><para>
527
 
        <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
528
 
        Transport Layer Security</citetitle></citation>
529
 
      </para></listitem>
530
 
      
531
 
      <listitem><para>
532
 
        <citation>RFC 4291: <citetitle>IP Version 6 Addressing
533
 
        Architecture</citetitle>, section 2.5.6, Link-Local IPv6
534
 
        Unicast Addresses</citation>
535
 
      </para></listitem>
536
 
    </itemizedlist>
 
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>
537
803
  </refsect1>
538
804
</refentry>
 
805
<!-- Local Variables: -->
 
806
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
807
<!-- time-stamp-end: "[\"']>" -->
 
808
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
809
<!-- End: -->