/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos.xml

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