/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2011-03-17 18:13:40 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110317181340-nf79nlcbilqx3ccg
* debian/control (mandos-client): Conflict with correct version of
                                  dropbear.

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-02-27">
 
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>
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>--interface<arg choice="plain">IF</arg></arg>
77
 
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
78
 
      <arg>--port<arg choice="plain">PORT</arg></arg>
79
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
80
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
81
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
82
 
      <arg>--debug</arg>
83
 
    </cmdsynopsis>
84
 
    <cmdsynopsis>
85
 
      <command>&COMMANDNAME;</command>
86
 
      <arg>-i<arg choice="plain">IF</arg></arg>
87
 
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
88
 
      <arg>-p<arg choice="plain">PORT</arg></arg>
89
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
90
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
91
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
92
 
      <arg>--debug</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>
93
97
    </cmdsynopsis>
94
98
    <cmdsynopsis>
95
99
      <command>&COMMANDNAME;</command>
96
100
      <group choice="req">
97
 
        <arg choice="plain">-h</arg>
98
 
        <arg choice="plain">--help</arg>
 
101
        <arg choice="plain"><option>--help</option></arg>
 
102
        <arg choice="plain"><option>-h</option></arg>
99
103
      </group>
100
104
    </cmdsynopsis>
101
105
    <cmdsynopsis>
102
106
      <command>&COMMANDNAME;</command>
103
 
      <arg choice="plain">--version</arg>
 
107
      <arg choice="plain"><option>--version</option></arg>
104
108
    </cmdsynopsis>
105
109
    <cmdsynopsis>
106
110
      <command>&COMMANDNAME;</command>
107
 
      <arg choice="plain">--check</arg>
 
111
      <arg choice="plain"><option>--check</option></arg>
108
112
    </cmdsynopsis>
109
113
  </refsynopsisdiv>
110
 
 
 
114
  
111
115
  <refsect1 id="description">
112
116
    <title>DESCRIPTION</title>
113
117
    <para>
122
126
      Any authenticated client is then given the stored pre-encrypted
123
127
      password for that specific client.
124
128
    </para>
125
 
 
126
129
  </refsect1>
127
130
  
128
131
  <refsect1 id="purpose">
129
132
    <title>PURPOSE</title>
130
 
 
131
133
    <para>
132
134
      The purpose of this is to enable <emphasis>remote and unattended
133
135
      rebooting</emphasis> of client host computer with an
134
136
      <emphasis>encrypted root file system</emphasis>.  See <xref
135
137
      linkend="overview"/> for details.
136
138
    </para>
137
 
 
138
139
  </refsect1>
139
140
  
140
141
  <refsect1 id="options">
141
142
    <title>OPTIONS</title>
142
 
 
143
143
    <variablelist>
144
144
      <varlistentry>
145
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
145
        <term><option>--help</option></term>
 
146
        <term><option>-h</option></term>
146
147
        <listitem>
147
148
          <para>
148
149
            Show a help message and exit
149
150
          </para>
150
151
        </listitem>
151
152
      </varlistentry>
152
 
 
153
 
      <varlistentry>
154
 
        <term><literal>-i</literal>, <literal>--interface <replaceable>
155
 
        IF</replaceable></literal></term>
156
 
        <listitem>
157
 
          <para>
158
 
            Only announce the server and listen to requests on network
159
 
            interface <replaceable>IF</replaceable>.  Default is to
160
 
            use all available interfaces.  <emphasis>Note:</emphasis>
161
 
            a failure to bind to the specified interface is not
162
 
            considered critical, and the server does not exit.
163
 
          </para>
164
 
        </listitem>
165
 
      </varlistentry>
166
 
 
167
 
      <varlistentry>
168
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
169
 
        ADDRESS</replaceable></literal></term>
170
 
        <listitem>
171
 
          <para>
172
 
            If this option is used, the server will only listen to a
173
 
            specific address.  This must currently be an IPv6 address;
174
 
            an IPv4 address can be specified using the
175
 
            <quote><literal>::FFFF:192.0.2.3</literal></quote> syntax.
176
 
            Also, if a link-local address is specified, an interface
177
 
            should be set, since a link-local address is only valid on
178
 
            a single interface.  By default, the server will listen to
179
 
            all available addresses.
180
 
          </para>
181
 
        </listitem>
182
 
      </varlistentry>
183
 
 
184
 
      <varlistentry>
185
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
186
 
        PORT</replaceable></literal></term>
187
 
        <listitem>
188
 
          <para>
189
 
            If this option is used, the server to bind to that
190
 
            port. By default, the server will listen to an arbitrary
191
 
            port given by the operating system.
192
 
          </para>
193
 
        </listitem>
194
 
      </varlistentry>
195
 
 
196
 
      <varlistentry>
197
 
        <term><literal>--check</literal></term>
 
153
      
 
154
      <varlistentry>
 
155
        <term><option>--interface</option>
 
156
        <replaceable>NAME</replaceable></term>
 
157
        <term><option>-i</option>
 
158
        <replaceable>NAME</replaceable></term>
 
159
        <listitem>
 
160
          <xi:include href="mandos-options.xml" xpointer="interface"/>
 
161
        </listitem>
 
162
      </varlistentry>
 
163
      
 
164
      <varlistentry>
 
165
        <term><option>--address
 
166
        <replaceable>ADDRESS</replaceable></option></term>
 
167
        <term><option>-a
 
168
        <replaceable>ADDRESS</replaceable></option></term>
 
169
        <listitem>
 
170
          <xi:include href="mandos-options.xml" xpointer="address"/>
 
171
        </listitem>
 
172
      </varlistentry>
 
173
      
 
174
      <varlistentry>
 
175
        <term><option>--port
 
176
        <replaceable>PORT</replaceable></option></term>
 
177
        <term><option>-p
 
178
        <replaceable>PORT</replaceable></option></term>
 
179
        <listitem>
 
180
          <xi:include href="mandos-options.xml" xpointer="port"/>
 
181
        </listitem>
 
182
      </varlistentry>
 
183
      
 
184
      <varlistentry>
 
185
        <term><option>--check</option></term>
198
186
        <listitem>
199
187
          <para>
200
188
            Run the server’s self-tests.  This includes any unit
202
190
          </para>
203
191
        </listitem>
204
192
      </varlistentry>
205
 
 
206
 
      <varlistentry>
207
 
        <term><literal>--debug</literal></term>
208
 
        <listitem>
209
 
          <para>
210
 
            If the server is run in debug mode, it will run in the
211
 
            foreground and print a lot of debugging information.  The
212
 
            default is <emphasis>not</emphasis> to run in debug mode.
213
 
          </para>
214
 
        </listitem>
215
 
      </varlistentry>
216
 
 
217
 
      <varlistentry>
218
 
        <term><literal>--priority <replaceable>
219
 
        PRIORITY</replaceable></literal></term>
220
 
        <listitem>
221
 
          <para>
222
 
            GnuTLS priority string for the TLS handshake with the
223
 
            clients.  The default is
224
 
            <quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.
225
 
            See <citerefentry><refentrytitle>gnutls_priority_init
226
 
            </refentrytitle><manvolnum>3</manvolnum></citerefentry>
227
 
            for the syntax.  <emphasis>Warning</emphasis>: changing
228
 
            this may make the TLS handshake fail, making communication
229
 
            with clients impossible.
230
 
          </para>
231
 
        </listitem>
232
 
      </varlistentry>
233
 
 
234
 
      <varlistentry>
235
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
236
 
        </literal></term>
237
 
        <listitem>
238
 
          <para>
239
 
            Zeroconf service name.  The default is
240
 
            <quote><literal>Mandos</literal></quote>.  This only needs
241
 
            to be changed this if it, for some reason, is necessary to
242
 
            run more than one server on the same
243
 
            <emphasis>host</emphasis>, which would not normally be
244
 
            useful.  If there are name collisions on the same
245
 
            <emphasis>network</emphasis>, the newer server will
246
 
            automatically rename itself to <quote><literal>Mandos
247
 
            #2</literal></quote>, and so on; therefore, this option is
248
 
            not needed in that case.
249
 
          </para>
250
 
        </listitem>
251
 
      </varlistentry>
252
 
 
253
 
      <varlistentry>
254
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
255
 
        </literal></term>
 
193
      
 
194
      <varlistentry>
 
195
        <term><option>--debug</option></term>
 
196
        <listitem>
 
197
          <xi:include href="mandos-options.xml" xpointer="debug"/>
 
198
        </listitem>
 
199
      </varlistentry>
 
200
      
 
201
      <varlistentry>
 
202
        <term><option>--debuglevel
 
203
        <replaceable>LEVEL</replaceable></option></term>
 
204
        <listitem>
 
205
          <para>
 
206
            Set the debugging log level.
 
207
            <replaceable>LEVEL</replaceable> is a string, one of
 
208
            <quote><literal>CRITICAL</literal></quote>,
 
209
            <quote><literal>ERROR</literal></quote>,
 
210
            <quote><literal>WARNING</literal></quote>,
 
211
            <quote><literal>INFO</literal></quote>, or
 
212
            <quote><literal>DEBUG</literal></quote>, in order of
 
213
            increasing verbosity.  The default level is
 
214
            <quote><literal>WARNING</literal></quote>.
 
215
          </para>
 
216
        </listitem>
 
217
      </varlistentry>
 
218
      
 
219
      <varlistentry>
 
220
        <term><option>--priority <replaceable>
 
221
        PRIORITY</replaceable></option></term>
 
222
        <listitem>
 
223
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
224
        </listitem>
 
225
      </varlistentry>
 
226
      
 
227
      <varlistentry>
 
228
        <term><option>--servicename
 
229
        <replaceable>NAME</replaceable></option></term>
 
230
        <listitem>
 
231
          <xi:include href="mandos-options.xml"
 
232
                      xpointer="servicename"/>
 
233
        </listitem>
 
234
      </varlistentry>
 
235
      
 
236
      <varlistentry>
 
237
        <term><option>--configdir
 
238
        <replaceable>DIRECTORY</replaceable></option></term>
256
239
        <listitem>
257
240
          <para>
258
241
            Directory to search for configuration files.  Default is
264
247
          </para>
265
248
        </listitem>
266
249
      </varlistentry>
267
 
 
 
250
      
268
251
      <varlistentry>
269
 
        <term><literal>--version</literal></term>
 
252
        <term><option>--version</option></term>
270
253
        <listitem>
271
254
          <para>
272
255
            Prints the program version and exit.
273
256
          </para>
274
257
        </listitem>
275
258
      </varlistentry>
 
259
      
 
260
      <varlistentry>
 
261
        <term><option>--no-dbus</option></term>
 
262
        <listitem>
 
263
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
264
          <para>
 
265
            See also <xref linkend="dbus_interface"/>.
 
266
          </para>
 
267
        </listitem>
 
268
      </varlistentry>
 
269
      
 
270
      <varlistentry>
 
271
        <term><option>--no-ipv6</option></term>
 
272
        <listitem>
 
273
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
274
        </listitem>
 
275
      </varlistentry>
276
276
    </variablelist>
277
277
  </refsect1>
278
 
 
 
278
  
279
279
  <refsect1 id="overview">
280
280
    <title>OVERVIEW</title>
281
 
    &OVERVIEW;
 
281
    <xi:include href="overview.xml"/>
282
282
    <para>
283
283
      This program is the server part.  It is a normal server program
284
284
      and will run in a normal system environment, not in an initial
285
 
      RAM disk environment.
 
285
      <acronym>RAM</acronym> disk environment.
286
286
    </para>
287
287
  </refsect1>
288
 
 
 
288
  
289
289
  <refsect1 id="protocol">
290
290
    <title>NETWORK PROTOCOL</title>
291
291
    <para>
317
317
        <entry>-><!-- &rarr; --></entry>
318
318
      </row>
319
319
      <row>
320
 
        <entry><quote><literal>1\r\en</literal></quote></entry>
 
320
        <entry><quote><literal>1\r\n</literal></quote></entry>
321
321
        <entry>-><!-- &rarr; --></entry>
322
322
      </row>
323
323
      <row>
343
343
      </row>
344
344
    </tbody></tgroup></table>
345
345
  </refsect1>
346
 
 
 
346
  
347
347
  <refsect1 id="checking">
348
348
    <title>CHECKING</title>
349
349
    <para>
350
350
      The server will, by default, continually check that the clients
351
351
      are still up.  If a client has not been confirmed as being up
352
352
      for some time, the client is assumed to be compromised and is no
353
 
      longer eligible to receive the encrypted password.  The timeout,
 
353
      longer eligible to receive the encrypted password.  (Manual
 
354
      intervention is required to re-enable a client.)  The timeout,
354
355
      checker program, and interval between checks can be configured
355
356
      both globally and per client; see <citerefentry>
356
 
      <refentrytitle>mandos.conf</refentrytitle>
357
 
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
358
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
359
 
      <manvolnum>5</manvolnum></citerefentry>.
360
 
    </para>
361
 
  </refsect1>
362
 
 
 
357
      <refentrytitle>mandos-clients.conf</refentrytitle>
 
358
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
359
      receiving its password will also be treated as a successful
 
360
      checker run.
 
361
    </para>
 
362
  </refsect1>
 
363
  
 
364
  <refsect1 id="approval">
 
365
    <title>APPROVAL</title>
 
366
    <para>
 
367
      The server can be configured to require manual approval for a
 
368
      client before it is sent its secret.  The delay to wait for such
 
369
      approval and the default action (approve or deny) can be
 
370
      configured both globally and per client; see <citerefentry>
 
371
      <refentrytitle>mandos-clients.conf</refentrytitle>
 
372
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
373
      will be approved immediately without delay.
 
374
    </para>
 
375
    <para>
 
376
      This can be used to deny a client its secret if not manually
 
377
      approved within a specified time.  It can also be used to make
 
378
      the server delay before giving a client its secret, allowing
 
379
      optional manual denying of this specific client.
 
380
    </para>
 
381
    
 
382
  </refsect1>
 
383
  
363
384
  <refsect1 id="logging">
364
385
    <title>LOGGING</title>
365
386
    <para>
366
 
      The server will send log messaged with various severity levels
367
 
      to <filename>/dev/log</filename>.  With the
 
387
      The server will send log message with various severity levels to
 
388
      <filename>/dev/log</filename>.  With the
368
389
      <option>--debug</option> option, it will log even more messages,
369
390
      and also show them on the console.
370
391
    </para>
371
392
  </refsect1>
372
 
 
 
393
  
 
394
  <refsect1 id="dbus_interface">
 
395
    <title>D-BUS INTERFACE</title>
 
396
    <para>
 
397
      The server will by default provide a D-Bus system bus interface.
 
398
      This interface will only be accessible by the root user or a
 
399
      Mandos-specific user, if such a user exists.  For documentation
 
400
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
401
    </para>
 
402
  </refsect1>
 
403
  
373
404
  <refsect1 id="exit_status">
374
405
    <title>EXIT STATUS</title>
375
406
    <para>
377
408
      critical error is encountered.
378
409
    </para>
379
410
  </refsect1>
380
 
 
 
411
  
381
412
  <refsect1 id="environment">
382
413
    <title>ENVIRONMENT</title>
383
414
    <variablelist>
384
415
      <varlistentry>
385
 
        <term><varname>PATH</varname></term>
 
416
        <term><envar>PATH</envar></term>
386
417
        <listitem>
387
418
          <para>
388
419
            To start the configured checker (see <xref
391
422
            <varname>PATH</varname> to search for matching commands if
392
423
            an absolute path is not given.  See <citerefentry>
393
424
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
394
 
          </citerefentry>
 
425
            </citerefentry>.
395
426
          </para>
396
427
        </listitem>
397
428
      </varlistentry>
398
429
    </variablelist>
399
430
  </refsect1>
400
 
 
401
 
  <refsect1 id="file">
 
431
  
 
432
  <refsect1 id="files">
402
433
    <title>FILES</title>
403
434
    <para>
404
435
      Use the <option>--configdir</option> option to change where
427
458
        </listitem>
428
459
      </varlistentry>
429
460
      <varlistentry>
430
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
461
        <term><filename>/var/run/mandos.pid</filename></term>
431
462
        <listitem>
432
463
          <para>
433
 
            The file containing the process id of
434
 
            <command>&COMMANDNAME;</command>.
 
464
            The file containing the process id of the
 
465
            <command>&COMMANDNAME;</command> process started last.
435
466
          </para>
436
467
        </listitem>
437
468
      </varlistentry>
465
496
      backtrace.  This could be considered a feature.
466
497
    </para>
467
498
    <para>
468
 
      Currently, if a client is declared <quote>invalid</quote> due to
469
 
      having timed out, the server does not record this fact onto
470
 
      permanent storage.  This has some security implications, see
471
 
      <xref linkend="CLIENTS"/>.
472
 
    </para>
473
 
    <para>
474
 
      There is currently no way of querying the server of the current
475
 
      status of clients, other than analyzing its <systemitem
476
 
      class="service">syslog</systemitem> output.
 
499
      Currently, if a client is disabled due to having timed out, the
 
500
      server does not record this fact onto permanent storage.  This
 
501
      has some security implications, see <xref linkend="clients"/>.
477
502
    </para>
478
503
    <para>
479
504
      There is no fine-grained control over logging and debug output.
482
507
      Debug mode is conflated with running in the foreground.
483
508
    </para>
484
509
    <para>
485
 
      The console log messages does not show a timestamp.
 
510
      The console log messages do not show a time stamp.
 
511
    </para>
 
512
    <para>
 
513
      This server does not check the expire time of clients’ OpenPGP
 
514
      keys.
486
515
    </para>
487
516
  </refsect1>
488
517
  
493
522
        Normal invocation needs no options:
494
523
      </para>
495
524
      <para>
496
 
        <userinput>mandos</userinput>
 
525
        <userinput>&COMMANDNAME;</userinput>
497
526
      </para>
498
527
    </informalexample>
499
528
    <informalexample>
506
535
      <para>
507
536
 
508
537
<!-- do not wrap this line -->
509
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
538
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
510
539
 
511
540
      </para>
512
541
    </informalexample>
518
547
      <para>
519
548
 
520
549
<!-- do not wrap this line -->
521
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
550
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
522
551
 
523
552
      </para>
524
553
    </informalexample>
525
554
  </refsect1>
526
 
 
 
555
  
527
556
  <refsect1 id="security">
528
557
    <title>SECURITY</title>
529
 
    <refsect2 id="SERVER">
 
558
    <refsect2 id="server">
530
559
      <title>SERVER</title>
531
560
      <para>
532
561
        Running this <command>&COMMANDNAME;</command> server program
533
562
        should not in itself present any security risk to the host
534
 
        computer running it.  The program does not need any special
535
 
        privileges to run, and is designed to run as a non-root user.
 
563
        computer running it.  The program switches to a non-root user
 
564
        soon after startup.
536
565
      </para>
537
566
    </refsect2>
538
 
    <refsect2 id="CLIENTS">
 
567
    <refsect2 id="clients">
539
568
      <title>CLIENTS</title>
540
569
      <para>
541
570
        The server only gives out its stored data to clients which
548
577
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
549
578
        <manvolnum>5</manvolnum></citerefentry>)
550
579
        <emphasis>must</emphasis> be made non-readable by anyone
551
 
        except the user running the server.
 
580
        except the user starting the server (usually root).
552
581
      </para>
553
582
      <para>
554
583
        As detailed in <xref linkend="checking"/>, the status of all
557
586
      </para>
558
587
      <para>
559
588
        If a client is compromised, its downtime should be duly noted
560
 
        by the server which would therefore declare the client
561
 
        invalid.  But if the server was ever restarted, it would
562
 
        re-read its client list from its configuration file and again
563
 
        regard all clients therein as valid, and hence eligible to
564
 
        receive their passwords.  Therefore, be careful when
565
 
        restarting servers if it is suspected that a client has, in
566
 
        fact, been compromised by parties who may now be running a
567
 
        fake Mandos client with the keys from the non-encrypted
568
 
        initial RAM image of the client host.  What should be done in
569
 
        that case (if restarting the server program really is
570
 
        necessary) is to stop the server program, edit the
571
 
        configuration file to omit any suspect clients, and restart
572
 
        the server program.
 
589
        by the server which would therefore disable the client.  But
 
590
        if the server was ever restarted, it would re-read its client
 
591
        list from its configuration file and again regard all clients
 
592
        therein as enabled, and hence eligible to receive their
 
593
        passwords.  Therefore, be careful when restarting servers if
 
594
        it is suspected that a client has, in fact, been compromised
 
595
        by parties who may now be running a fake Mandos client with
 
596
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
597
        image of the client host.  What should be done in that case
 
598
        (if restarting the server program really is necessary) is to
 
599
        stop the server program, edit the configuration file to omit
 
600
        any suspect clients, and restart the server program.
573
601
      </para>
574
602
      <para>
575
603
        For more details on client-side security, see
576
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
604
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
577
605
        <manvolnum>8mandos</manvolnum></citerefentry>.
578
606
      </para>
579
607
    </refsect2>
580
608
  </refsect1>
581
 
 
 
609
  
582
610
  <refsect1 id="see_also">
583
611
    <title>SEE ALSO</title>
 
612
    <para>
 
613
      <citerefentry>
 
614
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
615
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
616
        <refentrytitle>mandos.conf</refentrytitle>
 
617
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
618
        <refentrytitle>mandos-client</refentrytitle>
 
619
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
620
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
621
      </citerefentry>
 
622
    </para>
584
623
    <variablelist>
585
624
      <varlistentry>
586
625
        <term>
587
 
          <citerefentry>
588
 
            <refentrytitle>password-request</refentrytitle>
589
 
            <manvolnum>8mandos</manvolnum>
590
 
          </citerefentry>
591
 
        </term>
592
 
        <listitem>
593
 
          <para>
594
 
            This is the actual program which talks to this server.
595
 
            Note that it is normally not invoked directly, and is only
596
 
            run in the initial RAM disk environment, and not on a
597
 
            fully started system.
598
 
          </para>
599
 
        </listitem>
600
 
      </varlistentry>
601
 
      <varlistentry>
602
 
        <term>
603
626
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
604
627
        </term>
605
628
        <listitem>
622
645
      </varlistentry>
623
646
      <varlistentry>
624
647
        <term>
625
 
          <ulink
626
 
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
648
          <ulink url="http://www.gnu.org/software/gnutls/"
 
649
          >GnuTLS</ulink>
627
650
        </term>
628
651
      <listitem>
629
652
        <para>
635
658
      </varlistentry>
636
659
      <varlistentry>
637
660
        <term>
638
 
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
639
 
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
640
 
          Unicast Addresses</citation>
 
661
          RFC 4291: <citetitle>IP Version 6 Addressing
 
662
          Architecture</citetitle>
641
663
        </term>
642
664
        <listitem>
643
 
          <para>
644
 
            The clients use IPv6 link-local addresses, which are
645
 
            immediately usable since a link-local addresses is
646
 
            automatically assigned to a network interfaces when it is
647
 
            brought up.
648
 
          </para>
 
665
          <variablelist>
 
666
            <varlistentry>
 
667
              <term>Section 2.2: <citetitle>Text Representation of
 
668
              Addresses</citetitle></term>
 
669
              <listitem><para/></listitem>
 
670
            </varlistentry>
 
671
            <varlistentry>
 
672
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
673
              Address</citetitle></term>
 
674
              <listitem><para/></listitem>
 
675
            </varlistentry>
 
676
            <varlistentry>
 
677
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
678
            Addresses</citetitle></term>
 
679
            <listitem>
 
680
              <para>
 
681
                The clients use IPv6 link-local addresses, which are
 
682
                immediately usable since a link-local addresses is
 
683
                automatically assigned to a network interfaces when it
 
684
                is brought up.
 
685
              </para>
 
686
            </listitem>
 
687
            </varlistentry>
 
688
          </variablelist>
649
689
        </listitem>
650
690
      </varlistentry>
651
691
      <varlistentry>
652
692
        <term>
653
 
          <citation>RFC 4346: <citetitle>The Transport Layer Security
654
 
          (TLS) Protocol Version 1.1</citetitle></citation>
 
693
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
694
          Protocol Version 1.1</citetitle>
655
695
        </term>
656
696
      <listitem>
657
697
        <para>
661
701
      </varlistentry>
662
702
      <varlistentry>
663
703
        <term>
664
 
          <citation>RFC 4880: <citetitle>OpenPGP Message
665
 
          Format</citetitle></citation>
 
704
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
666
705
        </term>
667
706
      <listitem>
668
707
        <para>
672
711
      </varlistentry>
673
712
      <varlistentry>
674
713
        <term>
675
 
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
676
 
          Transport Layer Security</citetitle></citation>
 
714
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
715
          Security</citetitle>
677
716
        </term>
678
717
      <listitem>
679
718
        <para>
685
724
    </variablelist>
686
725
  </refsect1>
687
726
</refentry>
 
727
<!-- Local Variables: -->
 
728
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
729
<!-- time-stamp-end: "[\"']>" -->
 
730
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
731
<!-- End: -->