/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-17 22:42:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080817224228-nhor2yuv230if01i
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
                           not rely on a stylesheet declaration.

* mandos.xml: Removed <?xml-stylesheet>.  New entity "&OVERVIEW;"
              refers to "overview.xml". Changed all single quotes to
              double quotes for consistency.
  (DESCRIPTION): Use the term "TLS" and not "GnuTLS" for the protocol.
                 Refer to the "OVERVIEW" section for reason for IPv6
                 link-local addresses.
  (PURPOSE): Shortened a lot.  Refer to "OVERVIEW" section for details.
  (OVERVIEW): New section.  Include &OVERVIEW; and add a paragraph
              about what the role of this program is.
  (SECURITY/CLIENTS): Refer to the "CHECKING" section for details on
                      checking.
  (SEE ALSO): Changed from an <itemizedlist> to a <variablelist>.
              Added a short text for each entry.  Removed reference to
              plugin-runner(8mandos).  Add reference to RFC 4291 and
              RFC 4346.

* overview.xml: New file, containing a single <para>.  The idea is to
                use this in all the man pages.

* plugins.d/password-request.c: Updated comments about spurious
                                warnings.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
4
<!ENTITY VERSION "1.0">
4
5
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2022-04-24">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY OVERVIEW SYSTEM "overview.xml">
8
7
]>
9
8
 
10
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
   <refentryinfo>
12
 
    <title>Mandos Manual</title>
 
9
<refentry>
 
10
  <refentryinfo>
 
11
    <title>&COMMANDNAME;</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
16
 
    <date>&TIMESTAMP;</date>
 
13
    <productname>&COMMANDNAME;</productname>
 
14
    <productnumber>&VERSION;</productnumber>
17
15
    <authorgroup>
18
16
      <author>
19
17
        <firstname>Björn</firstname>
20
18
        <surname>Påhlsson</surname>
21
19
        <address>
22
 
          <email>belorn@recompile.se</email>
 
20
          <email>belorn@fukt.bsnet.se</email>
23
21
        </address>
24
22
      </author>
25
23
      <author>
26
24
        <firstname>Teddy</firstname>
27
25
        <surname>Hogeborn</surname>
28
26
        <address>
29
 
          <email>teddy@recompile.se</email>
 
27
          <email>teddy@fukt.bsnet.se</email>
30
28
        </address>
31
29
      </author>
32
30
    </authorgroup>
33
31
    <copyright>
34
32
      <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
33
      <holder>Teddy Hogeborn</holder>
47
34
      <holder>Björn Påhlsson</holder>
48
35
    </copyright>
49
 
    <xi:include href="legalnotice.xml"/>
 
36
    <legalnotice>
 
37
      <para>
 
38
        This manual page is free software: you can redistribute it
 
39
        and/or modify it under the terms of the GNU General Public
 
40
        License as published by the Free Software Foundation,
 
41
        either version 3 of the License, or (at your option) any
 
42
        later version.
 
43
      </para>
 
44
 
 
45
      <para>
 
46
        This manual page is distributed in the hope that it will
 
47
        be useful, but WITHOUT ANY WARRANTY; without even the
 
48
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
49
        PARTICULAR PURPOSE.  See the GNU General Public License
 
50
        for more details.
 
51
      </para>
 
52
 
 
53
      <para>
 
54
        You should have received a copy of the GNU General Public
 
55
        License along with this program; If not, see
 
56
        <ulink url="http://www.gnu.org/licenses/"/>.
 
57
      </para>
 
58
    </legalnotice>
50
59
  </refentryinfo>
51
 
  
 
60
 
52
61
  <refmeta>
53
62
    <refentrytitle>&COMMANDNAME;</refentrytitle>
54
63
    <manvolnum>8</manvolnum>
57
66
  <refnamediv>
58
67
    <refname><command>&COMMANDNAME;</command></refname>
59
68
    <refpurpose>
60
 
      Gives encrypted passwords to authenticated Mandos clients
 
69
      Sends encrypted passwords to authenticated Mandos clients
61
70
    </refpurpose>
62
71
  </refnamediv>
63
 
  
 
72
 
64
73
  <refsynopsisdiv>
65
74
    <cmdsynopsis>
66
75
      <command>&COMMANDNAME;</command>
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>
 
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="opt">-i<arg choice="plain">IF</arg></arg>
 
87
      <arg choice="opt">-a<arg choice="plain">ADDRESS</arg></arg>
 
88
      <arg choice="opt">-p<arg choice="plain">PORT</arg></arg>
 
89
      <arg choice="opt">--priority<arg choice="plain">PRIORITY</arg></arg>
 
90
      <arg choice="opt">--servicename<arg choice="plain">NAME</arg></arg>
 
91
      <arg choice="opt">--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
92
      <arg choice="opt">--debug</arg>
 
93
    </cmdsynopsis>
 
94
    <cmdsynopsis>
 
95
      <command>&COMMANDNAME;</command>
 
96
      <arg choice="plain">--help</arg>
 
97
    </cmdsynopsis>
 
98
    <cmdsynopsis>
 
99
      <command>&COMMANDNAME;</command>
 
100
      <arg choice="plain">--version</arg>
 
101
    </cmdsynopsis>
 
102
    <cmdsynopsis>
 
103
      <command>&COMMANDNAME;</command>
 
104
      <arg choice="plain">--check</arg>
132
105
    </cmdsynopsis>
133
106
  </refsynopsisdiv>
134
 
  
 
107
 
135
108
  <refsect1 id="description">
136
109
    <title>DESCRIPTION</title>
137
110
    <para>
138
111
      <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.
 
112
      handles incoming request for passwords for a pre-defined list of
 
113
      client host computers.  The Mandos server uses Zeroconf to
 
114
      announce itself on the local network, and uses TLS to
 
115
      communicate securely with and to authenticate the clients.  The
 
116
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
 
117
      link-local addresses, since the clients will probably not have
 
118
      any other addresses configured (see <xref linkend="overview"/>).
 
119
      Any authenticated client is then given the stored pre-encrypted
 
120
      password for that specific client.
150
121
    </para>
 
122
 
151
123
  </refsect1>
152
124
  
153
125
  <refsect1 id="purpose">
154
126
    <title>PURPOSE</title>
 
127
 
155
128
    <para>
156
129
      The purpose of this is to enable <emphasis>remote and unattended
157
130
      rebooting</emphasis> of client host computer with an
158
131
      <emphasis>encrypted root file system</emphasis>.  See <xref
159
132
      linkend="overview"/> for details.
160
133
    </para>
 
134
 
161
135
  </refsect1>
162
136
  
163
137
  <refsect1 id="options">
164
138
    <title>OPTIONS</title>
 
139
 
165
140
    <variablelist>
166
141
      <varlistentry>
167
 
        <term><option>--help</option></term>
168
 
        <term><option>-h</option></term>
 
142
        <term><literal>-h</literal>, <literal>--help</literal></term>
169
143
        <listitem>
170
144
          <para>
171
145
            Show a help message and exit
172
146
          </para>
173
147
        </listitem>
174
148
      </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>
 
149
 
 
150
      <varlistentry>
 
151
        <term><literal>-i</literal>, <literal>--interface <replaceable>
 
152
        IF</replaceable></literal></term>
 
153
        <listitem>
 
154
          <para>
 
155
            Only announce the server and listen to requests on network
 
156
            interface <replaceable>IF</replaceable>.  Default is to
 
157
            use all available interfaces.
 
158
          </para>
 
159
        </listitem>
 
160
      </varlistentry>
 
161
 
 
162
      <varlistentry>
 
163
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
164
        ADDRESS</replaceable></literal></term>
 
165
        <listitem>
 
166
          <para>
 
167
            If this option is used, the server will only listen to a
 
168
            specific address.  This must currently be an IPv6 address;
 
169
            an IPv4 address can be specified using the
 
170
            <quote><literal>::FFFF:192.0.2.3</literal></quote> syntax.
 
171
            Also, if a link-local address is specified, an interface
 
172
            should be set, since a link-local address is only valid on
 
173
            a single interface.  By default, the server will listen to
 
174
            all available addresses.
 
175
          </para>
 
176
        </listitem>
 
177
      </varlistentry>
 
178
 
 
179
      <varlistentry>
 
180
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
181
        PORT</replaceable></literal></term>
 
182
        <listitem>
 
183
          <para>
 
184
            If this option is used, the server to bind to that
 
185
            port. By default, the server will listen to an arbitrary
 
186
            port given by the operating system.
 
187
          </para>
 
188
        </listitem>
 
189
      </varlistentry>
 
190
 
 
191
      <varlistentry>
 
192
        <term><literal>--check</literal></term>
208
193
        <listitem>
209
194
          <para>
210
195
            Run the server’s self-tests.  This includes any unit
212
197
          </para>
213
198
        </listitem>
214
199
      </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>
 
200
 
 
201
      <varlistentry>
 
202
        <term><literal>--debug</literal></term>
 
203
        <listitem>
 
204
          <para>
 
205
            If the server is run in debug mode, it will run in the
 
206
            foreground and print a lot of debugging information.  The
 
207
            default is <emphasis>not</emphasis> to run in debug mode.
 
208
          </para>
 
209
        </listitem>
 
210
      </varlistentry>
 
211
 
 
212
      <varlistentry>
 
213
        <term><literal>--priority <replaceable>
 
214
        PRIORITY</replaceable></literal></term>
 
215
        <listitem>
 
216
          <para>
 
217
            GnuTLS priority string for the TLS handshake with the
 
218
            clients.  The default is
 
219
            <quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.
 
220
            See <citerefentry><refentrytitle>gnutls_priority_init
 
221
            </refentrytitle><manvolnum>3</manvolnum></citerefentry>
 
222
            for the syntax.  <emphasis>Warning</emphasis>: changing
 
223
            this may make the TLS handshake fail, making communication
 
224
            with clients impossible.
 
225
          </para>
 
226
        </listitem>
 
227
      </varlistentry>
 
228
 
 
229
      <varlistentry>
 
230
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
231
        </literal></term>
 
232
        <listitem>
 
233
          <para>
 
234
            Zeroconf service name.  The default is
 
235
            <quote><literal>Mandos</literal></quote>.  You only need
 
236
            to change this if you for some reason want to run more
 
237
            than one server on the same <emphasis>host</emphasis>,
 
238
            which would not normally be useful.  If there are name
 
239
            collisions on the same <emphasis>network</emphasis>, the
 
240
            newer server will automatically rename itself to
 
241
            <quote><literal>Mandos #2</literal></quote>, and so on;
 
242
            therefore, this option is not needed in that case.
 
243
          </para>
 
244
        </listitem>
 
245
      </varlistentry>
 
246
 
 
247
      <varlistentry>
 
248
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
249
        </literal></term>
261
250
        <listitem>
262
251
          <para>
263
252
            Directory to search for configuration files.  Default is
269
258
          </para>
270
259
        </listitem>
271
260
      </varlistentry>
272
 
      
 
261
 
273
262
      <varlistentry>
274
 
        <term><option>--version</option></term>
 
263
        <term><literal>--version</literal></term>
275
264
        <listitem>
276
265
          <para>
277
266
            Prints the program version and exit.
278
267
          </para>
279
268
        </listitem>
280
269
      </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
270
    </variablelist>
341
271
  </refsect1>
342
 
  
 
272
 
343
273
  <refsect1 id="overview">
344
274
    <title>OVERVIEW</title>
345
 
    <xi:include href="overview.xml"/>
 
275
    &OVERVIEW;
346
276
    <para>
347
277
      This program is the server part.  It is a normal server program
348
278
      and will run in a normal system environment, not in an initial
349
 
      <acronym>RAM</acronym> disk environment.
 
279
      RAM disk environment.
350
280
    </para>
351
281
  </refsect1>
352
 
  
 
282
 
353
283
  <refsect1 id="protocol">
354
284
    <title>NETWORK PROTOCOL</title>
355
285
    <para>
362
292
      start a TLS protocol handshake with a slight quirk: the Mandos
363
293
      server program acts as a TLS <quote>client</quote> while the
364
294
      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.
 
295
      The Mandos client must supply an OpenPGP certificate, and the
 
296
      fingerprint of this certificate is used by the Mandos server to
 
297
      look up (in a list read from <filename>clients.conf</filename>
 
298
      at start time) which binary blob to give the client.  No other
 
299
      authentication or authorization is done by the server.
370
300
    </para>
371
301
    <table>
372
302
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
381
311
        <entry>-><!-- &rarr; --></entry>
382
312
      </row>
383
313
      <row>
384
 
        <entry><quote><literal>1\r\n</literal></quote></entry>
 
314
        <entry><quote><literal>1\r\en</literal></quote></entry>
385
315
        <entry>-><!-- &rarr; --></entry>
386
316
      </row>
387
317
      <row>
392
322
        </emphasis></entry>
393
323
      </row>
394
324
      <row>
395
 
        <entry>Public key (part of TLS handshake)</entry>
 
325
        <entry>OpenPGP public key (part of TLS handshake)</entry>
396
326
        <entry>-><!-- &rarr; --></entry>
397
327
      </row>
398
328
      <row>
407
337
      </row>
408
338
    </tbody></tgroup></table>
409
339
  </refsect1>
410
 
  
 
340
 
411
341
  <refsect1 id="checking">
412
342
    <title>CHECKING</title>
413
343
    <para>
414
344
      The server will, by default, continually check that the clients
415
345
      are still up.  If a client has not been confirmed as being up
416
346
      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>
 
347
      longer eligible to receive the encrypted password.  The timeout,
 
348
      checker program, and interval between checks can be configured
 
349
      both globally and per client; see <citerefentry>
 
350
      <refentrytitle>mandos.conf</refentrytitle>
 
351
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
 
352
      <refentrytitle>mandos-clients.conf</refentrytitle>
422
353
      <manvolnum>5</manvolnum></citerefentry>.
423
354
    </para>
424
355
  </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
 
  
 
356
 
446
357
  <refsect1 id="logging">
447
358
    <title>LOGGING</title>
448
359
    <para>
449
 
      The server will send log message with various severity levels to
450
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
360
      The server will send log messaged with various severity levels
 
361
      to <filename>/dev/log</filename>.  With the
451
362
      <option>--debug</option> option, it will log even more messages,
452
363
      and also show them on the console.
453
364
    </para>
454
365
  </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
 
  
 
366
 
478
367
  <refsect1 id="exit_status">
479
368
    <title>EXIT STATUS</title>
480
369
    <para>
482
371
      critical error is encountered.
483
372
    </para>
484
373
  </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">
 
374
 
 
375
  <refsect1 id="file">
507
376
    <title>FILES</title>
508
377
    <para>
509
378
      Use the <option>--configdir</option> option to change where
532
401
        </listitem>
533
402
      </varlistentry>
534
403
      <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>
 
404
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
405
        <listitem>
 
406
          <para>
 
407
            The file containing the process id of
 
408
            <command>&COMMANDNAME;</command>.
 
409
          </para>
 
410
        </listitem>
 
411
      </varlistentry>
 
412
      <varlistentry>
 
413
        <term><filename>/dev/log</filename></term>
560
414
        <listitem>
561
415
          <para>
562
416
            The Unix domain socket to where local syslog messages are
564
418
          </para>
565
419
        </listitem>
566
420
      </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
421
    </variablelist>
579
422
  </refsect1>
580
 
  
 
423
 
581
424
  <refsect1 id="bugs">
582
425
    <title>BUGS</title>
583
426
    <para>
584
427
      This server might, on especially fatal errors, emit a Python
585
428
      backtrace.  This could be considered a feature.
586
429
    </para>
587
 
    <para>
588
 
      There is no fine-grained control over logging and debug output.
589
 
    </para>
590
 
    <xi:include href="bugs.xml"/>
591
430
  </refsect1>
592
 
  
593
 
  <refsect1 id="example">
594
 
    <title>EXAMPLE</title>
 
431
 
 
432
  <refsect1 id="examples">
 
433
    <title>EXAMPLES</title>
595
434
    <informalexample>
596
435
      <para>
597
436
        Normal invocation needs no options:
598
437
      </para>
599
438
      <para>
600
 
        <userinput>&COMMANDNAME;</userinput>
 
439
        <userinput>mandos</userinput>
601
440
      </para>
602
441
    </informalexample>
603
442
    <informalexample>
604
443
      <para>
605
444
        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:
 
445
        the <filename>~/mandos</filename> directory, and use the
 
446
        Zeroconf service name <quote>Test</quote> to not collide with
 
447
        any other official Mandos server on this host:
609
448
      </para>
610
449
      <para>
611
450
 
612
451
<!-- do not wrap this line -->
613
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
452
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
614
453
 
615
454
      </para>
616
455
    </informalexample>
622
461
      <para>
623
462
 
624
463
<!-- do not wrap this line -->
625
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
464
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
626
465
 
627
466
      </para>
628
467
    </informalexample>
629
468
  </refsect1>
630
 
  
 
469
 
631
470
  <refsect1 id="security">
632
471
    <title>SECURITY</title>
633
 
    <refsect2 id="server">
 
472
    <refsect2>
634
473
      <title>SERVER</title>
635
474
      <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.
 
475
        Running this &COMMANDNAME; server program should not in itself
 
476
        present any security risk to the host computer running it.
 
477
        The program does not need any special privileges to run, and
 
478
        is designed to run as a non-root user.
640
479
      </para>
641
480
    </refsect2>
642
 
    <refsect2 id="clients">
 
481
    <refsect2>
643
482
      <title>CLIENTS</title>
644
483
      <para>
645
484
        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
 
485
        does have the OpenPGP key of the stored fingerprint.  This is
 
486
        guaranteed by the fact that the client sends its OpenPGP
 
487
        public key in the TLS handshake; this ensures it to be
 
488
        genuine.  The server computes the fingerprint of the key
 
489
        itself and looks up the fingerprint in its list of
 
490
        clients. The <filename>clients.conf</filename> file (see
652
491
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
653
492
        <manvolnum>5</manvolnum></citerefentry>)
654
493
        <emphasis>must</emphasis> be made non-readable by anyone
655
 
        except the user starting the server (usually root).
 
494
        except the user running the server.
656
495
      </para>
657
496
      <para>
658
497
        As detailed in <xref linkend="checking"/>, the status of all
661
500
      </para>
662
501
      <para>
663
502
        For more details on client-side security, see
664
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
503
        <citerefentry><refentrytitle>password-request</refentrytitle>
665
504
        <manvolnum>8mandos</manvolnum></citerefentry>.
666
505
      </para>
667
506
    </refsect2>
668
507
  </refsect1>
669
 
  
 
508
 
670
509
  <refsect1 id="see_also">
671
510
    <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
511
    <variablelist>
685
512
      <varlistentry>
686
513
        <term>
 
514
          <citerefentry>
 
515
            <refentrytitle>password-request</refentrytitle>
 
516
            <manvolnum>8mandos</manvolnum>
 
517
          </citerefentry>
 
518
        </term>
 
519
        <listitem>
 
520
          <para>
 
521
            This is the actual program which talks to this server.
 
522
            Note that it is normally not invoked directly, and is only
 
523
            run in the initial RAM disk environment, and not on a
 
524
            fully started system.
 
525
          </para>
 
526
        </listitem>
 
527
      </varlistentry>
 
528
      <varlistentry>
 
529
        <term>
687
530
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
688
531
        </term>
689
532
        <listitem>
695
538
      </varlistentry>
696
539
      <varlistentry>
697
540
        <term>
698
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
 
541
          <ulink url="http://www.avahi.org/">Avahi</ulink>
699
542
        </term>
700
543
      <listitem>
701
544
        <para>
706
549
      </varlistentry>
707
550
      <varlistentry>
708
551
        <term>
709
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
552
          <ulink
 
553
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
710
554
        </term>
711
555
      <listitem>
712
556
        <para>
713
557
          GnuTLS is the library this server uses to implement TLS for
714
558
          communicating securely with the client, and at the same time
715
 
          confidently get the client’s public key.
 
559
          confidently get the client’s public OpenPGP key.
716
560
        </para>
717
561
      </listitem>
718
562
      </varlistentry>
719
563
      <varlistentry>
720
564
        <term>
721
 
          RFC 4291: <citetitle>IP Version 6 Addressing
722
 
          Architecture</citetitle>
 
565
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
 
566
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
 
567
          Unicast Addresses</citation>
723
568
        </term>
724
569
        <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>
 
570
          <para>
 
571
            The clients use IPv6 link-local addresses, which are
 
572
            immediately usable since a link-local addresses is
 
573
            automatically assigned to a network interfaces when it is
 
574
            brought up.
 
575
          </para>
749
576
        </listitem>
750
577
      </varlistentry>
751
578
      <varlistentry>
752
579
        <term>
753
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
 
          Protocol Version 1.2</citetitle>
 
580
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
581
          (TLS) Protocol Version 1.1</citetitle></citation>
755
582
        </term>
756
583
      <listitem>
757
584
        <para>
758
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
585
          TLS 1.1 is the protocol implemented by GnuTLS.
759
586
        </para>
760
587
      </listitem>
761
588
      </varlistentry>
762
589
      <varlistentry>
763
590
        <term>
764
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
591
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
592
          Format</citetitle></citation>
765
593
        </term>
766
594
      <listitem>
767
595
        <para>
771
599
      </varlistentry>
772
600
      <varlistentry>
773
601
        <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.
 
602
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
603
          Transport Layer Security</citetitle></citation>
 
604
        </term>
 
605
      <listitem>
 
606
        <para>
 
607
          This is implemented by GnuTLS and used by this server so
 
608
          that OpenPGP keys can be used.
796
609
        </para>
797
610
      </listitem>
798
611
      </varlistentry>
799
612
    </variablelist>
800
613
  </refsect1>
801
614
</refentry>
802
 
<!-- Local Variables: -->
803
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
804
 
<!-- time-stamp-end: "[\"']>" -->
805
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
806
 
<!-- End: -->