/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: 2012-01-15 20:27:28 UTC
  • Revision ID: teddy@recompile.se-20120115202728-185929ww2r84s8xg
* DBUS-API (se.recompile.Mandos.Client.LastCheckerStatus): New
                                                           property.
* mandos (Client.last_checker_status): Use -2 instead of None to match
                                       D-Bus property.  All users
                                       changed.
  (Client.checked_ok): Remove "timeout" argument and call
                       "self.bump_timeout()" instead.
  (Client.bump_timeout): New; separated out from "checked_ok".
  (ClientDBus.last_checker_status): Hook to a D-Bus property.
  (ClientDBus.LastCheckerStatus_dbus_property): New D-Bus property.
  (ClientHandler.handle): Call client.bump_timeout() instead of
                          client.checked_ok().

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