/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 "2012-01-15">
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
33
      <holder>Teddy Hogeborn</holder>
40
34
      <holder>Björn Påhlsson</holder>
41
35
    </copyright>
42
 
    <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>
43
59
  </refentryinfo>
44
 
  
 
60
 
45
61
  <refmeta>
46
62
    <refentrytitle>&COMMANDNAME;</refentrytitle>
47
63
    <manvolnum>8</manvolnum>
50
66
  <refnamediv>
51
67
    <refname><command>&COMMANDNAME;</command></refname>
52
68
    <refpurpose>
53
 
      Gives encrypted passwords to authenticated Mandos clients
 
69
      Sends encrypted passwords to authenticated Mandos clients
54
70
    </refpurpose>
55
71
  </refnamediv>
56
 
  
 
72
 
57
73
  <refsynopsisdiv>
58
74
    <cmdsynopsis>
59
75
      <command>&COMMANDNAME;</command>
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>
 
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>
118
105
    </cmdsynopsis>
119
106
  </refsynopsisdiv>
120
 
  
 
107
 
121
108
  <refsect1 id="description">
122
109
    <title>DESCRIPTION</title>
123
110
    <para>
124
111
      <command>&COMMANDNAME;</command> is a server daemon which
125
112
      handles incoming request for passwords for a pre-defined list of
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.
 
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.
136
121
    </para>
 
122
 
137
123
  </refsect1>
138
124
  
139
125
  <refsect1 id="purpose">
140
126
    <title>PURPOSE</title>
 
127
 
141
128
    <para>
142
129
      The purpose of this is to enable <emphasis>remote and unattended
143
130
      rebooting</emphasis> of client host computer with an
144
131
      <emphasis>encrypted root file system</emphasis>.  See <xref
145
132
      linkend="overview"/> for details.
146
133
    </para>
 
134
 
147
135
  </refsect1>
148
136
  
149
137
  <refsect1 id="options">
150
138
    <title>OPTIONS</title>
 
139
 
151
140
    <variablelist>
152
141
      <varlistentry>
153
 
        <term><option>--help</option></term>
154
 
        <term><option>-h</option></term>
 
142
        <term><literal>-h</literal>, <literal>--help</literal></term>
155
143
        <listitem>
156
144
          <para>
157
145
            Show a help message and exit
158
146
          </para>
159
147
        </listitem>
160
148
      </varlistentry>
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>
 
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>
194
193
        <listitem>
195
194
          <para>
196
195
            Run the server’s self-tests.  This includes any unit
198
197
          </para>
199
198
        </listitem>
200
199
      </varlistentry>
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>
 
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>
247
250
        <listitem>
248
251
          <para>
249
252
            Directory to search for configuration files.  Default is
255
258
          </para>
256
259
        </listitem>
257
260
      </varlistentry>
258
 
      
 
261
 
259
262
      <varlistentry>
260
 
        <term><option>--version</option></term>
 
263
        <term><literal>--version</literal></term>
261
264
        <listitem>
262
265
          <para>
263
266
            Prints the program version and exit.
264
267
          </para>
265
268
        </listitem>
266
269
      </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>
302
270
    </variablelist>
303
271
  </refsect1>
304
 
  
 
272
 
305
273
  <refsect1 id="overview">
306
274
    <title>OVERVIEW</title>
307
 
    <xi:include href="overview.xml"/>
 
275
    &OVERVIEW;
308
276
    <para>
309
277
      This program is the server part.  It is a normal server program
310
278
      and will run in a normal system environment, not in an initial
311
 
      <acronym>RAM</acronym> disk environment.
 
279
      RAM disk environment.
312
280
    </para>
313
281
  </refsect1>
314
 
  
 
282
 
315
283
  <refsect1 id="protocol">
316
284
    <title>NETWORK PROTOCOL</title>
317
285
    <para>
343
311
        <entry>-><!-- &rarr; --></entry>
344
312
      </row>
345
313
      <row>
346
 
        <entry><quote><literal>1\r\n</literal></quote></entry>
 
314
        <entry><quote><literal>1\r\en</literal></quote></entry>
347
315
        <entry>-><!-- &rarr; --></entry>
348
316
      </row>
349
317
      <row>
369
337
      </row>
370
338
    </tbody></tgroup></table>
371
339
  </refsect1>
372
 
  
 
340
 
373
341
  <refsect1 id="checking">
374
342
    <title>CHECKING</title>
375
343
    <para>
376
344
      The server will, by default, continually check that the clients
377
345
      are still up.  If a client has not been confirmed as being up
378
346
      for some time, the client is assumed to be compromised and is no
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>
 
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>
384
353
      <manvolnum>5</manvolnum></citerefentry>.
385
354
    </para>
386
355
  </refsect1>
387
 
  
388
 
  <refsect1 id="approval">
389
 
    <title>APPROVAL</title>
390
 
    <para>
391
 
      The server can be configured to require manual approval for a
392
 
      client before it is sent its secret.  The delay to wait for such
393
 
      approval and the default action (approve or deny) can be
394
 
      configured both globally and per client; see <citerefentry>
395
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
396
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
397
 
      will be approved immediately without delay.
398
 
    </para>
399
 
    <para>
400
 
      This can be used to deny a client its secret if not manually
401
 
      approved within a specified time.  It can also be used to make
402
 
      the server delay before giving a client its secret, allowing
403
 
      optional manual denying of this specific client.
404
 
    </para>
405
 
    
406
 
  </refsect1>
407
 
  
 
356
 
408
357
  <refsect1 id="logging">
409
358
    <title>LOGGING</title>
410
359
    <para>
411
 
      The server will send log message with various severity levels to
412
 
      <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
413
362
      <option>--debug</option> option, it will log even more messages,
414
363
      and also show them on the console.
415
364
    </para>
416
365
  </refsect1>
417
 
  
418
 
  <refsect1 id="persistent_state">
419
 
    <title>PERSISTENT STATE</title>
420
 
    <para>
421
 
      Client settings, initially read from
422
 
      <filename>clients.conf</filename>, are persistent across
423
 
      restarts, and run-time changes will override settings in
424
 
      <filename>clients.conf</filename>.  However, if a setting is
425
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
426
 
      <filename>clients.conf</filename>, this will take precedence.
427
 
    </para>
428
 
  </refsect1>
429
 
  
430
 
  <refsect1 id="dbus_interface">
431
 
    <title>D-BUS INTERFACE</title>
432
 
    <para>
433
 
      The server will by default provide a D-Bus system bus interface.
434
 
      This interface will only be accessible by the root user or a
435
 
      Mandos-specific user, if such a user exists.  For documentation
436
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
437
 
    </para>
438
 
  </refsect1>
439
 
  
 
366
 
440
367
  <refsect1 id="exit_status">
441
368
    <title>EXIT STATUS</title>
442
369
    <para>
444
371
      critical error is encountered.
445
372
    </para>
446
373
  </refsect1>
447
 
  
448
 
  <refsect1 id="environment">
449
 
    <title>ENVIRONMENT</title>
450
 
    <variablelist>
451
 
      <varlistentry>
452
 
        <term><envar>PATH</envar></term>
453
 
        <listitem>
454
 
          <para>
455
 
            To start the configured checker (see <xref
456
 
            linkend="checking"/>), the server uses
457
 
            <filename>/bin/sh</filename>, which in turn uses
458
 
            <varname>PATH</varname> to search for matching commands if
459
 
            an absolute path is not given.  See <citerefentry>
460
 
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
461
 
            </citerefentry>.
462
 
          </para>
463
 
        </listitem>
464
 
      </varlistentry>
465
 
    </variablelist>
466
 
  </refsect1>
467
 
  
468
 
  <refsect1 id="files">
 
374
 
 
375
  <refsect1 id="file">
469
376
    <title>FILES</title>
470
377
    <para>
471
378
      Use the <option>--configdir</option> option to change where
494
401
        </listitem>
495
402
      </varlistentry>
496
403
      <varlistentry>
497
 
        <term><filename>/var/run/mandos.pid</filename></term>
498
 
        <listitem>
499
 
          <para>
500
 
            The file containing the process id of the
501
 
            <command>&COMMANDNAME;</command> process started last.
502
 
          </para>
503
 
        </listitem>
504
 
      </varlistentry>
505
 
      <varlistentry>
506
 
        <term><filename class="devicefile">/dev/log</filename></term>
507
 
      </varlistentry>
508
 
      <varlistentry>
509
 
        <term><filename
510
 
        class="directory">/var/lib/mandos</filename></term>
511
 
        <listitem>
512
 
          <para>
513
 
            Directory where persistent state will be saved.  Change
514
 
            this with the <option>--statedir</option> option.  See
515
 
            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>.
516
409
          </para>
517
410
        </listitem>
518
411
      </varlistentry>
525
418
          </para>
526
419
        </listitem>
527
420
      </varlistentry>
528
 
      <varlistentry>
529
 
        <term><filename>/bin/sh</filename></term>
530
 
        <listitem>
531
 
          <para>
532
 
            This is used to start the configured checker command for
533
 
            each client.  See <citerefentry>
534
 
            <refentrytitle>mandos-clients.conf</refentrytitle>
535
 
            <manvolnum>5</manvolnum></citerefentry> for details.
536
 
          </para>
537
 
        </listitem>
538
 
      </varlistentry>
539
421
    </variablelist>
540
422
  </refsect1>
541
 
  
 
423
 
542
424
  <refsect1 id="bugs">
543
425
    <title>BUGS</title>
544
426
    <para>
545
427
      This server might, on especially fatal errors, emit a Python
546
428
      backtrace.  This could be considered a feature.
547
429
    </para>
548
 
    <para>
549
 
      There is no fine-grained control over logging and debug output.
550
 
    </para>
551
 
    <para>
552
 
      Debug mode is conflated with running in the foreground.
553
 
    </para>
554
 
    <para>
555
 
      This server does not check the expire time of clients’ OpenPGP
556
 
      keys.
557
 
    </para>
558
430
  </refsect1>
559
 
  
560
 
  <refsect1 id="example">
561
 
    <title>EXAMPLE</title>
 
431
 
 
432
  <refsect1 id="examples">
 
433
    <title>EXAMPLES</title>
562
434
    <informalexample>
563
435
      <para>
564
436
        Normal invocation needs no options:
565
437
      </para>
566
438
      <para>
567
 
        <userinput>&COMMANDNAME;</userinput>
 
439
        <userinput>mandos</userinput>
568
440
      </para>
569
441
    </informalexample>
570
442
    <informalexample>
571
443
      <para>
572
444
        Run the server in debug mode, read configuration files from
573
 
        the <filename class="directory">~/mandos</filename> directory,
574
 
        and use the Zeroconf service name <quote>Test</quote> to not
575
 
        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:
576
448
      </para>
577
449
      <para>
578
450
 
579
451
<!-- do not wrap this line -->
580
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
452
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
581
453
 
582
454
      </para>
583
455
    </informalexample>
589
461
      <para>
590
462
 
591
463
<!-- do not wrap this line -->
592
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
464
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
593
465
 
594
466
      </para>
595
467
    </informalexample>
596
468
  </refsect1>
597
 
  
 
469
 
598
470
  <refsect1 id="security">
599
471
    <title>SECURITY</title>
600
 
    <refsect2 id="server">
 
472
    <refsect2>
601
473
      <title>SERVER</title>
602
474
      <para>
603
 
        Running this <command>&COMMANDNAME;</command> server program
604
 
        should not in itself present any security risk to the host
605
 
        computer running it.  The program switches to a non-root user
606
 
        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.
607
479
      </para>
608
480
    </refsect2>
609
 
    <refsect2 id="clients">
 
481
    <refsect2>
610
482
      <title>CLIENTS</title>
611
483
      <para>
612
484
        The server only gives out its stored data to clients which
619
491
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
620
492
        <manvolnum>5</manvolnum></citerefentry>)
621
493
        <emphasis>must</emphasis> be made non-readable by anyone
622
 
        except the user starting the server (usually root).
 
494
        except the user running the server.
623
495
      </para>
624
496
      <para>
625
497
        As detailed in <xref linkend="checking"/>, the status of all
628
500
      </para>
629
501
      <para>
630
502
        For more details on client-side security, see
631
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
503
        <citerefentry><refentrytitle>password-request</refentrytitle>
632
504
        <manvolnum>8mandos</manvolnum></citerefentry>.
633
505
      </para>
634
506
    </refsect2>
635
507
  </refsect1>
636
 
  
 
508
 
637
509
  <refsect1 id="see_also">
638
510
    <title>SEE ALSO</title>
639
 
    <para>
640
 
      <citerefentry><refentrytitle>intro</refentrytitle>
641
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
642
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
643
 
      <manvolnum>5</manvolnum></citerefentry>,
644
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
645
 
      <manvolnum>5</manvolnum></citerefentry>,
646
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
647
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
648
 
      <citerefentry><refentrytitle>sh</refentrytitle>
649
 
      <manvolnum>1</manvolnum></citerefentry>
650
 
    </para>
651
511
    <variablelist>
652
512
      <varlistentry>
653
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>
654
530
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
655
531
        </term>
656
532
        <listitem>
673
549
      </varlistentry>
674
550
      <varlistentry>
675
551
        <term>
676
 
          <ulink url="http://www.gnu.org/software/gnutls/"
677
 
          >GnuTLS</ulink>
 
552
          <ulink
 
553
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
678
554
        </term>
679
555
      <listitem>
680
556
        <para>
686
562
      </varlistentry>
687
563
      <varlistentry>
688
564
        <term>
689
 
          RFC 4291: <citetitle>IP Version 6 Addressing
690
 
          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>
691
568
        </term>
692
569
        <listitem>
693
 
          <variablelist>
694
 
            <varlistentry>
695
 
              <term>Section 2.2: <citetitle>Text Representation of
696
 
              Addresses</citetitle></term>
697
 
              <listitem><para/></listitem>
698
 
            </varlistentry>
699
 
            <varlistentry>
700
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
701
 
              Address</citetitle></term>
702
 
              <listitem><para/></listitem>
703
 
            </varlistentry>
704
 
            <varlistentry>
705
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
706
 
            Addresses</citetitle></term>
707
 
            <listitem>
708
 
              <para>
709
 
                The clients use IPv6 link-local addresses, which are
710
 
                immediately usable since a link-local addresses is
711
 
                automatically assigned to a network interfaces when it
712
 
                is brought up.
713
 
              </para>
714
 
            </listitem>
715
 
            </varlistentry>
716
 
          </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>
717
576
        </listitem>
718
577
      </varlistentry>
719
578
      <varlistentry>
720
579
        <term>
721
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
722
 
          Protocol Version 1.1</citetitle>
 
580
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
581
          (TLS) Protocol Version 1.1</citetitle></citation>
723
582
        </term>
724
583
      <listitem>
725
584
        <para>
729
588
      </varlistentry>
730
589
      <varlistentry>
731
590
        <term>
732
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
591
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
592
          Format</citetitle></citation>
733
593
        </term>
734
594
      <listitem>
735
595
        <para>
739
599
      </varlistentry>
740
600
      <varlistentry>
741
601
        <term>
742
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
743
 
          Security</citetitle>
 
602
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
603
          Transport Layer Security</citetitle></citation>
744
604
        </term>
745
605
      <listitem>
746
606
        <para>
752
612
    </variablelist>
753
613
  </refsect1>
754
614
</refentry>
755
 
<!-- Local Variables: -->
756
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
757
 
<!-- time-stamp-end: "[\"']>" -->
758
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
759
 
<!-- End: -->