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