/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 at recompile
  • Date: 2011-12-31 13:25:58 UTC
  • mto: (237.7.89 trunk)
  • mto: This revision was merged to the branch mainline in revision 290.
  • Revision ID: teddy@recompile.se-20111231132558-z0dh7qgofgctmgri
* network-hooks.s/bridge: Don't use interface names directly; search
                          for interface names using their address.
  (addrtoif): New function.
* network-hooks.s/bridge.conf (PORTS): Removed.
  (PORT_ADDRESSES): New.
* network-hooks.s/wireless: Don't use interface names directly; search
                            for interface names using their address.
  (addrtoif): New function.
* network-hooks.s/wireless.conf: Specify address.

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