/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

* mandos: Use all new builtins.
* mandos-ctl: - '' -
* mandos-monitor: - '' -

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">
 
5
<!ENTITY TIMESTAMP "2012-01-15">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
6
8
]>
7
9
 
8
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
9
 
  <refentryinfo>
10
 
    <title>&COMMANDNAME;</title>
 
11
   <refentryinfo>
 
12
    <title>Mandos Manual</title>
11
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
12
 
    <productname>&COMMANDNAME;</productname>
13
 
    <productnumber>&VERSION;</productnumber>
 
14
    <productname>Mandos</productname>
 
15
    <productnumber>&version;</productnumber>
 
16
    <date>&TIMESTAMP;</date>
14
17
    <authorgroup>
15
18
      <author>
16
19
        <firstname>Björn</firstname>
17
20
        <surname>Påhlsson</surname>
18
21
        <address>
19
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
20
23
        </address>
21
24
      </author>
22
25
      <author>
23
26
        <firstname>Teddy</firstname>
24
27
        <surname>Hogeborn</surname>
25
28
        <address>
26
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
27
30
        </address>
28
31
      </author>
29
32
    </authorgroup>
30
33
    <copyright>
31
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
 
38
      <year>2012</year>
32
39
      <holder>Teddy Hogeborn</holder>
33
40
      <holder>Björn Påhlsson</holder>
34
41
    </copyright>
35
 
    <legalnotice>
36
 
      <para>
37
 
        This manual page is free software: you can redistribute it
38
 
        and/or modify it under the terms of the GNU General Public
39
 
        License as published by the Free Software Foundation,
40
 
        either version 3 of the License, or (at your option) any
41
 
        later version.
42
 
      </para>
43
 
 
44
 
      <para>
45
 
        This manual page is distributed in the hope that it will
46
 
        be useful, but WITHOUT ANY WARRANTY; without even the
47
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
48
 
        PARTICULAR PURPOSE.  See the GNU General Public License
49
 
        for more details.
50
 
      </para>
51
 
 
52
 
      <para>
53
 
        You should have received a copy of the GNU General Public
54
 
        License along with this program; If not, see
55
 
        <ulink url="http://www.gnu.org/licenses/"/>.
56
 
      </para>
57
 
    </legalnotice>
 
42
    <xi:include href="legalnotice.xml"/>
58
43
  </refentryinfo>
59
 
 
 
44
  
60
45
  <refmeta>
61
46
    <refentrytitle>&COMMANDNAME;</refentrytitle>
62
47
    <manvolnum>8</manvolnum>
65
50
  <refnamediv>
66
51
    <refname><command>&COMMANDNAME;</command></refname>
67
52
    <refpurpose>
68
 
      Sends encrypted passwords to authenticated Mandos clients
 
53
      Gives encrypted passwords to authenticated Mandos clients
69
54
    </refpurpose>
70
55
  </refnamediv>
71
 
 
 
56
  
72
57
  <refsynopsisdiv>
73
58
    <cmdsynopsis>
74
59
      <command>&COMMANDNAME;</command>
75
 
      <arg>--interface<arg choice="plain">IF</arg></arg>
76
 
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
77
 
      <arg>--port<arg choice="plain">PORT</arg></arg>
78
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
79
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
80
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
81
 
      <arg>--debug</arg>
82
 
    </cmdsynopsis>
83
 
    <cmdsynopsis>
84
 
      <command>&COMMANDNAME;</command>
85
 
      <arg>-i<arg choice="plain">IF</arg></arg>
86
 
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
87
 
      <arg>-p<arg choice="plain">PORT</arg></arg>
88
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
89
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
90
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
91
 
      <arg>--debug</arg>
 
60
      <group>
 
61
        <arg choice="plain"><option>--interface
 
62
        <replaceable>NAME</replaceable></option></arg>
 
63
        <arg choice="plain"><option>-i
 
64
        <replaceable>NAME</replaceable></option></arg>
 
65
      </group>
 
66
      <sbr/>
 
67
      <group>
 
68
        <arg choice="plain"><option>--address
 
69
        <replaceable>ADDRESS</replaceable></option></arg>
 
70
        <arg choice="plain"><option>-a
 
71
        <replaceable>ADDRESS</replaceable></option></arg>
 
72
      </group>
 
73
      <sbr/>
 
74
      <group>
 
75
        <arg choice="plain"><option>--port
 
76
        <replaceable>PORT</replaceable></option></arg>
 
77
        <arg choice="plain"><option>-p
 
78
        <replaceable>PORT</replaceable></option></arg>
 
79
      </group>
 
80
      <sbr/>
 
81
      <arg><option>--priority
 
82
      <replaceable>PRIORITY</replaceable></option></arg>
 
83
      <sbr/>
 
84
      <arg><option>--servicename
 
85
      <replaceable>NAME</replaceable></option></arg>
 
86
      <sbr/>
 
87
      <arg><option>--configdir
 
88
      <replaceable>DIRECTORY</replaceable></option></arg>
 
89
      <sbr/>
 
90
      <arg><option>--debug</option></arg>
 
91
      <sbr/>
 
92
      <arg><option>--debuglevel
 
93
      <replaceable>LEVEL</replaceable></option></arg>
 
94
      <sbr/>
 
95
      <arg><option>--no-dbus</option></arg>
 
96
      <sbr/>
 
97
      <arg><option>--no-ipv6</option></arg>
 
98
      <sbr/>
 
99
      <arg><option>--no-restore</option></arg>
 
100
      <sbr/>
 
101
      <arg><option>--statedir
 
102
      <replaceable>DIRECTORY</replaceable></option></arg>
92
103
    </cmdsynopsis>
93
104
    <cmdsynopsis>
94
105
      <command>&COMMANDNAME;</command>
95
106
      <group choice="req">
96
 
        <arg choice="plain">-h</arg>
97
 
        <arg choice="plain">--help</arg>
 
107
        <arg choice="plain"><option>--help</option></arg>
 
108
        <arg choice="plain"><option>-h</option></arg>
98
109
      </group>
99
110
    </cmdsynopsis>
100
111
    <cmdsynopsis>
101
112
      <command>&COMMANDNAME;</command>
102
 
      <arg choice="plain">--version</arg>
 
113
      <arg choice="plain"><option>--version</option></arg>
103
114
    </cmdsynopsis>
104
115
    <cmdsynopsis>
105
116
      <command>&COMMANDNAME;</command>
106
 
      <arg choice="plain">--check</arg>
 
117
      <arg choice="plain"><option>--check</option></arg>
107
118
    </cmdsynopsis>
108
119
  </refsynopsisdiv>
109
 
 
 
120
  
110
121
  <refsect1 id="description">
111
122
    <title>DESCRIPTION</title>
112
123
    <para>
113
124
      <command>&COMMANDNAME;</command> is a server daemon which
114
125
      handles incoming request for passwords for a pre-defined list of
115
 
      client host computers.  The Mandos server uses Zeroconf to
116
 
      announce itself on the local network, and uses TLS to
117
 
      communicate securely with and to authenticate the clients.  The
118
 
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
119
 
      link-local addresses, since the clients will probably not have
120
 
      any other addresses configured (see <xref linkend="overview"/>).
121
 
      Any authenticated client is then given the stored pre-encrypted
122
 
      password for that specific client.
 
126
      client host computers. For an introduction, see
 
127
      <citerefentry><refentrytitle>intro</refentrytitle>
 
128
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
129
      uses Zeroconf to announce itself on the local network, and uses
 
130
      TLS to communicate securely with and to authenticate the
 
131
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
132
      use IPv6 link-local addresses, since the clients will probably
 
133
      not have any other addresses configured (see <xref
 
134
      linkend="overview"/>).  Any authenticated client is then given
 
135
      the stored pre-encrypted password for that specific client.
123
136
    </para>
124
 
 
125
137
  </refsect1>
126
138
  
127
139
  <refsect1 id="purpose">
128
140
    <title>PURPOSE</title>
129
 
 
130
141
    <para>
131
142
      The purpose of this is to enable <emphasis>remote and unattended
132
143
      rebooting</emphasis> of client host computer with an
133
144
      <emphasis>encrypted root file system</emphasis>.  See <xref
134
145
      linkend="overview"/> for details.
135
146
    </para>
136
 
 
137
147
  </refsect1>
138
148
  
139
149
  <refsect1 id="options">
140
150
    <title>OPTIONS</title>
141
 
 
142
151
    <variablelist>
143
152
      <varlistentry>
144
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
153
        <term><option>--help</option></term>
 
154
        <term><option>-h</option></term>
145
155
        <listitem>
146
156
          <para>
147
157
            Show a help message and exit
148
158
          </para>
149
159
        </listitem>
150
160
      </varlistentry>
151
 
 
 
161
      
152
162
      <varlistentry>
153
 
        <term><literal>-i</literal>, <literal>--interface <replaceable>
154
 
        IF</replaceable></literal></term>
 
163
        <term><option>--interface</option>
 
164
        <replaceable>NAME</replaceable></term>
 
165
        <term><option>-i</option>
 
166
        <replaceable>NAME</replaceable></term>
155
167
        <listitem>
156
168
          <xi:include href="mandos-options.xml" xpointer="interface"/>
157
169
        </listitem>
158
170
      </varlistentry>
159
 
 
 
171
      
160
172
      <varlistentry>
161
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
162
 
        ADDRESS</replaceable></literal></term>
 
173
        <term><option>--address
 
174
        <replaceable>ADDRESS</replaceable></option></term>
 
175
        <term><option>-a
 
176
        <replaceable>ADDRESS</replaceable></option></term>
163
177
        <listitem>
164
178
          <xi:include href="mandos-options.xml" xpointer="address"/>
165
179
        </listitem>
166
180
      </varlistentry>
167
 
 
 
181
      
168
182
      <varlistentry>
169
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
170
 
        PORT</replaceable></literal></term>
 
183
        <term><option>--port
 
184
        <replaceable>PORT</replaceable></option></term>
 
185
        <term><option>-p
 
186
        <replaceable>PORT</replaceable></option></term>
171
187
        <listitem>
172
188
          <xi:include href="mandos-options.xml" xpointer="port"/>
173
189
        </listitem>
174
190
      </varlistentry>
175
 
 
 
191
      
176
192
      <varlistentry>
177
 
        <term><literal>--check</literal></term>
 
193
        <term><option>--check</option></term>
178
194
        <listitem>
179
195
          <para>
180
196
            Run the server’s self-tests.  This includes any unit
182
198
          </para>
183
199
        </listitem>
184
200
      </varlistentry>
185
 
 
 
201
      
186
202
      <varlistentry>
187
 
        <term><literal>--debug</literal></term>
 
203
        <term><option>--debug</option></term>
188
204
        <listitem>
189
205
          <xi:include href="mandos-options.xml" xpointer="debug"/>
190
206
        </listitem>
191
207
      </varlistentry>
192
 
 
193
 
      <varlistentry>
194
 
        <term><literal>--priority <replaceable>
195
 
        PRIORITY</replaceable></literal></term>
 
208
      
 
209
      <varlistentry>
 
210
        <term><option>--debuglevel
 
211
        <replaceable>LEVEL</replaceable></option></term>
 
212
        <listitem>
 
213
          <para>
 
214
            Set the debugging log level.
 
215
            <replaceable>LEVEL</replaceable> is a string, one of
 
216
            <quote><literal>CRITICAL</literal></quote>,
 
217
            <quote><literal>ERROR</literal></quote>,
 
218
            <quote><literal>WARNING</literal></quote>,
 
219
            <quote><literal>INFO</literal></quote>, or
 
220
            <quote><literal>DEBUG</literal></quote>, in order of
 
221
            increasing verbosity.  The default level is
 
222
            <quote><literal>WARNING</literal></quote>.
 
223
          </para>
 
224
        </listitem>
 
225
      </varlistentry>
 
226
      
 
227
      <varlistentry>
 
228
        <term><option>--priority <replaceable>
 
229
        PRIORITY</replaceable></option></term>
196
230
        <listitem>
197
231
          <xi:include href="mandos-options.xml" xpointer="priority"/>
198
232
        </listitem>
199
233
      </varlistentry>
200
 
 
 
234
      
201
235
      <varlistentry>
202
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
203
 
        </literal></term>
 
236
        <term><option>--servicename
 
237
        <replaceable>NAME</replaceable></option></term>
204
238
        <listitem>
205
239
          <xi:include href="mandos-options.xml"
206
240
                      xpointer="servicename"/>
207
241
        </listitem>
208
242
      </varlistentry>
209
 
 
 
243
      
210
244
      <varlistentry>
211
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
212
 
        </literal></term>
 
245
        <term><option>--configdir
 
246
        <replaceable>DIRECTORY</replaceable></option></term>
213
247
        <listitem>
214
248
          <para>
215
249
            Directory to search for configuration files.  Default is
221
255
          </para>
222
256
        </listitem>
223
257
      </varlistentry>
224
 
 
 
258
      
225
259
      <varlistentry>
226
 
        <term><literal>--version</literal></term>
 
260
        <term><option>--version</option></term>
227
261
        <listitem>
228
262
          <para>
229
263
            Prints the program version and exit.
230
264
          </para>
231
265
        </listitem>
232
266
      </varlistentry>
 
267
      
 
268
      <varlistentry>
 
269
        <term><option>--no-dbus</option></term>
 
270
        <listitem>
 
271
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
272
          <para>
 
273
            See also <xref linkend="dbus_interface"/>.
 
274
          </para>
 
275
        </listitem>
 
276
      </varlistentry>
 
277
      
 
278
      <varlistentry>
 
279
        <term><option>--no-ipv6</option></term>
 
280
        <listitem>
 
281
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
282
        </listitem>
 
283
      </varlistentry>
 
284
      
 
285
      <varlistentry>
 
286
        <term><option>--no-restore</option></term>
 
287
        <listitem>
 
288
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
289
          <para>
 
290
            See also <xref linkend="persistent_state"/>.
 
291
          </para>
 
292
        </listitem>
 
293
      </varlistentry>
 
294
      
 
295
      <varlistentry>
 
296
        <term><option>--statedir
 
297
        <replaceable>DIRECTORY</replaceable></option></term>
 
298
        <listitem>
 
299
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
300
        </listitem>
 
301
      </varlistentry>
233
302
    </variablelist>
234
303
  </refsect1>
235
 
 
 
304
  
236
305
  <refsect1 id="overview">
237
306
    <title>OVERVIEW</title>
238
307
    <xi:include href="overview.xml"/>
239
308
    <para>
240
309
      This program is the server part.  It is a normal server program
241
310
      and will run in a normal system environment, not in an initial
242
 
      RAM disk environment.
 
311
      <acronym>RAM</acronym> disk environment.
243
312
    </para>
244
313
  </refsect1>
245
 
 
 
314
  
246
315
  <refsect1 id="protocol">
247
316
    <title>NETWORK PROTOCOL</title>
248
317
    <para>
274
343
        <entry>-><!-- &rarr; --></entry>
275
344
      </row>
276
345
      <row>
277
 
        <entry><quote><literal>1\r\en</literal></quote></entry>
 
346
        <entry><quote><literal>1\r\n</literal></quote></entry>
278
347
        <entry>-><!-- &rarr; --></entry>
279
348
      </row>
280
349
      <row>
300
369
      </row>
301
370
    </tbody></tgroup></table>
302
371
  </refsect1>
303
 
 
 
372
  
304
373
  <refsect1 id="checking">
305
374
    <title>CHECKING</title>
306
375
    <para>
307
376
      The server will, by default, continually check that the clients
308
377
      are still up.  If a client has not been confirmed as being up
309
378
      for some time, the client is assumed to be compromised and is no
310
 
      longer eligible to receive the encrypted password.  The timeout,
311
 
      checker program, and interval between checks can be configured
312
 
      both globally and per client; see <citerefentry>
313
 
      <refentrytitle>mandos.conf</refentrytitle>
314
 
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
 
379
      longer eligible to receive the encrypted password.  (Manual
 
380
      intervention is required to re-enable a client.)  The timeout,
 
381
      extended timeout, checker program, and interval between checks
 
382
      can be configured both globally and per client; see
 
383
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
384
      <manvolnum>5</manvolnum></citerefentry>.
 
385
    </para>
 
386
  </refsect1>
 
387
  
 
388
  <refsect1 id="approval">
 
389
    <title>APPROVAL</title>
 
390
    <para>
 
391
      The server can be configured to require manual approval for a
 
392
      client before it is sent its secret.  The delay to wait for such
 
393
      approval and the default action (approve or deny) can be
 
394
      configured both globally and per client; see <citerefentry>
315
395
      <refentrytitle>mandos-clients.conf</refentrytitle>
316
 
      <manvolnum>5</manvolnum></citerefentry>.
317
 
    </para>
 
396
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
397
      will be approved immediately without delay.
 
398
    </para>
 
399
    <para>
 
400
      This can be used to deny a client its secret if not manually
 
401
      approved within a specified time.  It can also be used to make
 
402
      the server delay before giving a client its secret, allowing
 
403
      optional manual denying of this specific client.
 
404
    </para>
 
405
    
318
406
  </refsect1>
319
 
 
 
407
  
320
408
  <refsect1 id="logging">
321
409
    <title>LOGGING</title>
322
410
    <para>
323
 
      The server will send log messaged with various severity levels
324
 
      to <filename>/dev/log</filename>.  With the
 
411
      The server will send log message with various severity levels to
 
412
      <filename class="devicefile">/dev/log</filename>.  With the
325
413
      <option>--debug</option> option, it will log even more messages,
326
414
      and also show them on the console.
327
415
    </para>
328
416
  </refsect1>
329
 
 
 
417
  
 
418
  <refsect1 id="persistent_state">
 
419
    <title>PERSISTENT STATE</title>
 
420
    <para>
 
421
      Client settings, initially read from
 
422
      <filename>clients.conf</filename>, are persistent across
 
423
      restarts, and run-time changes will override settings in
 
424
      <filename>clients.conf</filename>.  However, if a setting is
 
425
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
426
      <filename>clients.conf</filename>, this will take precedence.
 
427
    </para>
 
428
  </refsect1>
 
429
  
 
430
  <refsect1 id="dbus_interface">
 
431
    <title>D-BUS INTERFACE</title>
 
432
    <para>
 
433
      The server will by default provide a D-Bus system bus interface.
 
434
      This interface will only be accessible by the root user or a
 
435
      Mandos-specific user, if such a user exists.  For documentation
 
436
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
437
    </para>
 
438
  </refsect1>
 
439
  
330
440
  <refsect1 id="exit_status">
331
441
    <title>EXIT STATUS</title>
332
442
    <para>
334
444
      critical error is encountered.
335
445
    </para>
336
446
  </refsect1>
337
 
 
 
447
  
338
448
  <refsect1 id="environment">
339
449
    <title>ENVIRONMENT</title>
340
450
    <variablelist>
341
451
      <varlistentry>
342
 
        <term><varname>PATH</varname></term>
 
452
        <term><envar>PATH</envar></term>
343
453
        <listitem>
344
454
          <para>
345
455
            To start the configured checker (see <xref
348
458
            <varname>PATH</varname> to search for matching commands if
349
459
            an absolute path is not given.  See <citerefentry>
350
460
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
351
 
          </citerefentry>
 
461
            </citerefentry>.
352
462
          </para>
353
463
        </listitem>
354
464
      </varlistentry>
355
465
    </variablelist>
356
466
  </refsect1>
357
 
 
358
 
  <refsect1 id="file">
 
467
  
 
468
  <refsect1 id="files">
359
469
    <title>FILES</title>
360
470
    <para>
361
471
      Use the <option>--configdir</option> option to change where
384
494
        </listitem>
385
495
      </varlistentry>
386
496
      <varlistentry>
387
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
388
 
        <listitem>
389
 
          <para>
390
 
            The file containing the process id of
391
 
            <command>&COMMANDNAME;</command>.
 
497
        <term><filename>/var/run/mandos.pid</filename></term>
 
498
        <listitem>
 
499
          <para>
 
500
            The file containing the process id of the
 
501
            <command>&COMMANDNAME;</command> process started last.
 
502
          </para>
 
503
        </listitem>
 
504
      </varlistentry>
 
505
      <varlistentry>
 
506
        <term><filename class="devicefile">/dev/log</filename></term>
 
507
      </varlistentry>
 
508
      <varlistentry>
 
509
        <term><filename
 
510
        class="directory">/var/lib/mandos</filename></term>
 
511
        <listitem>
 
512
          <para>
 
513
            Directory where persistent state will be saved.  Change
 
514
            this with the <option>--statedir</option> option.  See
 
515
            also the <option>--no-restore</option> option.
392
516
          </para>
393
517
        </listitem>
394
518
      </varlistentry>
422
546
      backtrace.  This could be considered a feature.
423
547
    </para>
424
548
    <para>
425
 
      Currently, if a client is declared <quote>invalid</quote> due to
426
 
      having timed out, the server does not record this fact onto
427
 
      permanent storage.  This has some security implications, see
428
 
      <xref linkend="CLIENTS"/>.
429
 
    </para>
430
 
    <para>
431
 
      There is currently no way of querying the server of the current
432
 
      status of clients, other than analyzing its <systemitem
433
 
      class="service">syslog</systemitem> output.
434
 
    </para>
435
 
    <para>
436
549
      There is no fine-grained control over logging and debug output.
437
550
    </para>
438
551
    <para>
439
552
      Debug mode is conflated with running in the foreground.
440
553
    </para>
441
554
    <para>
442
 
      The console log messages does not show a timestamp.
 
555
      This server does not check the expire time of clients’ OpenPGP
 
556
      keys.
443
557
    </para>
444
558
  </refsect1>
445
559
  
450
564
        Normal invocation needs no options:
451
565
      </para>
452
566
      <para>
453
 
        <userinput>mandos</userinput>
 
567
        <userinput>&COMMANDNAME;</userinput>
454
568
      </para>
455
569
    </informalexample>
456
570
    <informalexample>
457
571
      <para>
458
572
        Run the server in debug mode, read configuration files from
459
 
        the <filename>~/mandos</filename> directory, and use the
460
 
        Zeroconf service name <quote>Test</quote> to not collide with
461
 
        any other official Mandos server on this host:
 
573
        the <filename class="directory">~/mandos</filename> directory,
 
574
        and use the Zeroconf service name <quote>Test</quote> to not
 
575
        collide with any other official Mandos server on this host:
462
576
      </para>
463
577
      <para>
464
578
 
465
579
<!-- do not wrap this line -->
466
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
580
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
467
581
 
468
582
      </para>
469
583
    </informalexample>
475
589
      <para>
476
590
 
477
591
<!-- do not wrap this line -->
478
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
592
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
479
593
 
480
594
      </para>
481
595
    </informalexample>
482
596
  </refsect1>
483
 
 
 
597
  
484
598
  <refsect1 id="security">
485
599
    <title>SECURITY</title>
486
 
    <refsect2 id="SERVER">
 
600
    <refsect2 id="server">
487
601
      <title>SERVER</title>
488
602
      <para>
489
603
        Running this <command>&COMMANDNAME;</command> server program
490
604
        should not in itself present any security risk to the host
491
 
        computer running it.  The program does not need any special
492
 
        privileges to run, and is designed to run as a non-root user.
 
605
        computer running it.  The program switches to a non-root user
 
606
        soon after startup.
493
607
      </para>
494
608
    </refsect2>
495
 
    <refsect2 id="CLIENTS">
 
609
    <refsect2 id="clients">
496
610
      <title>CLIENTS</title>
497
611
      <para>
498
612
        The server only gives out its stored data to clients which
505
619
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
506
620
        <manvolnum>5</manvolnum></citerefentry>)
507
621
        <emphasis>must</emphasis> be made non-readable by anyone
508
 
        except the user running the server.
 
622
        except the user starting the server (usually root).
509
623
      </para>
510
624
      <para>
511
625
        As detailed in <xref linkend="checking"/>, the status of all
513
627
        compromised if they are gone for too long.
514
628
      </para>
515
629
      <para>
516
 
        If a client is compromised, its downtime should be duly noted
517
 
        by the server which would therefore declare the client
518
 
        invalid.  But if the server was ever restarted, it would
519
 
        re-read its client list from its configuration file and again
520
 
        regard all clients therein as valid, and hence eligible to
521
 
        receive their passwords.  Therefore, be careful when
522
 
        restarting servers if it is suspected that a client has, in
523
 
        fact, been compromised by parties who may now be running a
524
 
        fake Mandos client with the keys from the non-encrypted
525
 
        initial RAM image of the client host.  What should be done in
526
 
        that case (if restarting the server program really is
527
 
        necessary) is to stop the server program, edit the
528
 
        configuration file to omit any suspect clients, and restart
529
 
        the server program.
530
 
      </para>
531
 
      <para>
532
630
        For more details on client-side security, see
533
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
631
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
534
632
        <manvolnum>8mandos</manvolnum></citerefentry>.
535
633
      </para>
536
634
    </refsect2>
537
635
  </refsect1>
538
 
 
 
636
  
539
637
  <refsect1 id="see_also">
540
638
    <title>SEE ALSO</title>
 
639
    <para>
 
640
      <citerefentry><refentrytitle>intro</refentrytitle>
 
641
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
642
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
643
      <manvolnum>5</manvolnum></citerefentry>,
 
644
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
645
      <manvolnum>5</manvolnum></citerefentry>,
 
646
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
647
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
648
      <citerefentry><refentrytitle>sh</refentrytitle>
 
649
      <manvolnum>1</manvolnum></citerefentry>
 
650
    </para>
541
651
    <variablelist>
542
652
      <varlistentry>
543
653
        <term>
544
 
          <citerefentry>
545
 
            <refentrytitle>password-request</refentrytitle>
546
 
            <manvolnum>8mandos</manvolnum>
547
 
          </citerefentry>
548
 
        </term>
549
 
        <listitem>
550
 
          <para>
551
 
            This is the actual program which talks to this server.
552
 
            Note that it is normally not invoked directly, and is only
553
 
            run in the initial RAM disk environment, and not on a
554
 
            fully started system.
555
 
          </para>
556
 
        </listitem>
557
 
      </varlistentry>
558
 
      <varlistentry>
559
 
        <term>
560
654
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
561
655
        </term>
562
656
        <listitem>
579
673
      </varlistentry>
580
674
      <varlistentry>
581
675
        <term>
582
 
          <ulink
583
 
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
676
          <ulink url="http://www.gnu.org/software/gnutls/"
 
677
          >GnuTLS</ulink>
584
678
        </term>
585
679
      <listitem>
586
680
        <para>
592
686
      </varlistentry>
593
687
      <varlistentry>
594
688
        <term>
595
 
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
596
 
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
597
 
          Unicast Addresses</citation>
 
689
          RFC 4291: <citetitle>IP Version 6 Addressing
 
690
          Architecture</citetitle>
598
691
        </term>
599
692
        <listitem>
600
 
          <para>
601
 
            The clients use IPv6 link-local addresses, which are
602
 
            immediately usable since a link-local addresses is
603
 
            automatically assigned to a network interfaces when it is
604
 
            brought up.
605
 
          </para>
 
693
          <variablelist>
 
694
            <varlistentry>
 
695
              <term>Section 2.2: <citetitle>Text Representation of
 
696
              Addresses</citetitle></term>
 
697
              <listitem><para/></listitem>
 
698
            </varlistentry>
 
699
            <varlistentry>
 
700
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
701
              Address</citetitle></term>
 
702
              <listitem><para/></listitem>
 
703
            </varlistentry>
 
704
            <varlistentry>
 
705
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
706
            Addresses</citetitle></term>
 
707
            <listitem>
 
708
              <para>
 
709
                The clients use IPv6 link-local addresses, which are
 
710
                immediately usable since a link-local addresses is
 
711
                automatically assigned to a network interfaces when it
 
712
                is brought up.
 
713
              </para>
 
714
            </listitem>
 
715
            </varlistentry>
 
716
          </variablelist>
606
717
        </listitem>
607
718
      </varlistentry>
608
719
      <varlistentry>
609
720
        <term>
610
 
          <citation>RFC 4346: <citetitle>The Transport Layer Security
611
 
          (TLS) Protocol Version 1.1</citetitle></citation>
 
721
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
722
          Protocol Version 1.1</citetitle>
612
723
        </term>
613
724
      <listitem>
614
725
        <para>
618
729
      </varlistentry>
619
730
      <varlistentry>
620
731
        <term>
621
 
          <citation>RFC 4880: <citetitle>OpenPGP Message
622
 
          Format</citetitle></citation>
 
732
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
623
733
        </term>
624
734
      <listitem>
625
735
        <para>
629
739
      </varlistentry>
630
740
      <varlistentry>
631
741
        <term>
632
 
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
633
 
          Transport Layer Security</citetitle></citation>
 
742
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
743
          Security</citetitle>
634
744
        </term>
635
745
      <listitem>
636
746
        <para>
642
752
    </variablelist>
643
753
  </refsect1>
644
754
</refentry>
 
755
<!-- Local Variables: -->
 
756
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
757
<!-- time-stamp-end: "[\"']>" -->
 
758
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
759
<!-- End: -->