/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-24 07:42:14 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080824074214-odju7g3115le171c
* mandos-keygen: Bug fix: Recognize new options --subtype and
                 --sublength.  New option "--password" which prompts
                 for and encrypts a password with an already existing
                 key.

* mandos-keygen.xml (SYNOPSIS): Added separate synopsis for
                                "--password" option.
  (DESCRIPTION): Added text about password creation.
  (OPTIONS): Document default value for "--dir" option.  Document new
             "--password" option.

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