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