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