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