/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: Björn Påhlsson
  • Date: 2008-08-25 07:53:43 UTC
  • mto: (237.7.1 mandos) (24.1.154 mandos)
  • mto: This revision was merged to the branch mainline in revision 107.
  • Revision ID: belorn@braxen-20080825075343-a7gsy6mkam9t1up9
added configfile as a optional argument to plugin-runner

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-01-15">
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>
 
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>
103
92
    </cmdsynopsis>
104
93
    <cmdsynopsis>
105
94
      <command>&COMMANDNAME;</command>
106
95
      <group choice="req">
107
 
        <arg choice="plain"><option>--help</option></arg>
108
 
        <arg choice="plain"><option>-h</option></arg>
 
96
        <arg choice="plain">-h</arg>
 
97
        <arg choice="plain">--help</arg>
109
98
      </group>
110
99
    </cmdsynopsis>
111
100
    <cmdsynopsis>
112
101
      <command>&COMMANDNAME;</command>
113
 
      <arg choice="plain"><option>--version</option></arg>
 
102
      <arg choice="plain">--version</arg>
114
103
    </cmdsynopsis>
115
104
    <cmdsynopsis>
116
105
      <command>&COMMANDNAME;</command>
117
 
      <arg choice="plain"><option>--check</option></arg>
 
106
      <arg choice="plain">--check</arg>
118
107
    </cmdsynopsis>
119
108
  </refsynopsisdiv>
120
 
  
 
109
 
121
110
  <refsect1 id="description">
122
111
    <title>DESCRIPTION</title>
123
112
    <para>
124
113
      <command>&COMMANDNAME;</command> is a server daemon which
125
114
      handles incoming request for passwords for a pre-defined list of
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.
 
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.
136
123
    </para>
 
124
 
137
125
  </refsect1>
138
126
  
139
127
  <refsect1 id="purpose">
140
128
    <title>PURPOSE</title>
 
129
 
141
130
    <para>
142
131
      The purpose of this is to enable <emphasis>remote and unattended
143
132
      rebooting</emphasis> of client host computer with an
144
133
      <emphasis>encrypted root file system</emphasis>.  See <xref
145
134
      linkend="overview"/> for details.
146
135
    </para>
 
136
 
147
137
  </refsect1>
148
138
  
149
139
  <refsect1 id="options">
150
140
    <title>OPTIONS</title>
 
141
 
151
142
    <variablelist>
152
143
      <varlistentry>
153
 
        <term><option>--help</option></term>
154
 
        <term><option>-h</option></term>
 
144
        <term><literal>-h</literal>, <literal>--help</literal></term>
155
145
        <listitem>
156
146
          <para>
157
147
            Show a help message and exit
158
148
          </para>
159
149
        </listitem>
160
150
      </varlistentry>
161
 
      
 
151
 
162
152
      <varlistentry>
163
 
        <term><option>--interface</option>
164
 
        <replaceable>NAME</replaceable></term>
165
 
        <term><option>-i</option>
166
 
        <replaceable>NAME</replaceable></term>
 
153
        <term><literal>-i</literal>, <literal>--interface <replaceable>
 
154
        IF</replaceable></literal></term>
167
155
        <listitem>
168
156
          <xi:include href="mandos-options.xml" xpointer="interface"/>
169
157
        </listitem>
170
158
      </varlistentry>
171
 
      
 
159
 
172
160
      <varlistentry>
173
 
        <term><option>--address
174
 
        <replaceable>ADDRESS</replaceable></option></term>
175
 
        <term><option>-a
176
 
        <replaceable>ADDRESS</replaceable></option></term>
 
161
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
162
        ADDRESS</replaceable></literal></term>
177
163
        <listitem>
178
164
          <xi:include href="mandos-options.xml" xpointer="address"/>
179
165
        </listitem>
180
166
      </varlistentry>
181
 
      
 
167
 
182
168
      <varlistentry>
183
 
        <term><option>--port
184
 
        <replaceable>PORT</replaceable></option></term>
185
 
        <term><option>-p
186
 
        <replaceable>PORT</replaceable></option></term>
 
169
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
170
        PORT</replaceable></literal></term>
187
171
        <listitem>
188
172
          <xi:include href="mandos-options.xml" xpointer="port"/>
189
173
        </listitem>
190
174
      </varlistentry>
191
 
      
 
175
 
192
176
      <varlistentry>
193
 
        <term><option>--check</option></term>
 
177
        <term><literal>--check</literal></term>
194
178
        <listitem>
195
179
          <para>
196
180
            Run the server’s self-tests.  This includes any unit
198
182
          </para>
199
183
        </listitem>
200
184
      </varlistentry>
201
 
      
 
185
 
202
186
      <varlistentry>
203
 
        <term><option>--debug</option></term>
 
187
        <term><literal>--debug</literal></term>
204
188
        <listitem>
205
189
          <xi:include href="mandos-options.xml" xpointer="debug"/>
206
190
        </listitem>
207
191
      </varlistentry>
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>
 
192
 
 
193
      <varlistentry>
 
194
        <term><literal>--priority <replaceable>
 
195
        PRIORITY</replaceable></literal></term>
230
196
        <listitem>
231
197
          <xi:include href="mandos-options.xml" xpointer="priority"/>
232
198
        </listitem>
233
199
      </varlistentry>
234
 
      
 
200
 
235
201
      <varlistentry>
236
 
        <term><option>--servicename
237
 
        <replaceable>NAME</replaceable></option></term>
 
202
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
203
        </literal></term>
238
204
        <listitem>
239
205
          <xi:include href="mandos-options.xml"
240
206
                      xpointer="servicename"/>
241
207
        </listitem>
242
208
      </varlistentry>
243
 
      
 
209
 
244
210
      <varlistentry>
245
 
        <term><option>--configdir
246
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
211
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
212
        </literal></term>
247
213
        <listitem>
248
214
          <para>
249
215
            Directory to search for configuration files.  Default is
255
221
          </para>
256
222
        </listitem>
257
223
      </varlistentry>
258
 
      
 
224
 
259
225
      <varlistentry>
260
 
        <term><option>--version</option></term>
 
226
        <term><literal>--version</literal></term>
261
227
        <listitem>
262
228
          <para>
263
229
            Prints the program version and exit.
264
230
          </para>
265
231
        </listitem>
266
232
      </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>
302
233
    </variablelist>
303
234
  </refsect1>
304
 
  
 
235
 
305
236
  <refsect1 id="overview">
306
237
    <title>OVERVIEW</title>
307
238
    <xi:include href="overview.xml"/>
308
239
    <para>
309
240
      This program is the server part.  It is a normal server program
310
241
      and will run in a normal system environment, not in an initial
311
 
      <acronym>RAM</acronym> disk environment.
 
242
      RAM disk environment.
312
243
    </para>
313
244
  </refsect1>
314
 
  
 
245
 
315
246
  <refsect1 id="protocol">
316
247
    <title>NETWORK PROTOCOL</title>
317
248
    <para>
369
300
      </row>
370
301
    </tbody></tgroup></table>
371
302
  </refsect1>
372
 
  
 
303
 
373
304
  <refsect1 id="checking">
374
305
    <title>CHECKING</title>
375
306
    <para>
376
307
      The server will, by default, continually check that the clients
377
308
      are still up.  If a client has not been confirmed as being up
378
309
      for some time, the client is assumed to be compromised and is no
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>
 
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>
384
314
      <manvolnum>5</manvolnum></citerefentry>.
385
315
    </para>
386
316
  </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>
395
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
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
 
    
406
 
  </refsect1>
407
 
  
 
317
 
408
318
  <refsect1 id="logging">
409
319
    <title>LOGGING</title>
410
320
    <para>
411
321
      The server will send log message with various severity levels to
412
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
322
      <filename>/dev/log</filename>.  With the
413
323
      <option>--debug</option> option, it will log even more messages,
414
324
      and also show them on the console.
415
325
    </para>
416
326
  </refsect1>
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
 
  
 
327
 
440
328
  <refsect1 id="exit_status">
441
329
    <title>EXIT STATUS</title>
442
330
    <para>
444
332
      critical error is encountered.
445
333
    </para>
446
334
  </refsect1>
447
 
  
 
335
 
448
336
  <refsect1 id="environment">
449
337
    <title>ENVIRONMENT</title>
450
338
    <variablelist>
451
339
      <varlistentry>
452
 
        <term><envar>PATH</envar></term>
 
340
        <term><varname>PATH</varname></term>
453
341
        <listitem>
454
342
          <para>
455
343
            To start the configured checker (see <xref
464
352
      </varlistentry>
465
353
    </variablelist>
466
354
  </refsect1>
467
 
  
468
 
  <refsect1 id="files">
 
355
 
 
356
  <refsect1 id="file">
469
357
    <title>FILES</title>
470
358
    <para>
471
359
      Use the <option>--configdir</option> option to change where
494
382
        </listitem>
495
383
      </varlistentry>
496
384
      <varlistentry>
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.
 
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>.
516
390
          </para>
517
391
        </listitem>
518
392
      </varlistentry>
546
420
      backtrace.  This could be considered a feature.
547
421
    </para>
548
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>
549
434
      There is no fine-grained control over logging and debug output.
550
435
    </para>
551
436
    <para>
552
437
      Debug mode is conflated with running in the foreground.
553
438
    </para>
554
439
    <para>
555
 
      This server does not check the expire time of clients’ OpenPGP
556
 
      keys.
 
440
      The console log messages does not show a timestamp.
557
441
    </para>
558
442
  </refsect1>
559
443
  
564
448
        Normal invocation needs no options:
565
449
      </para>
566
450
      <para>
567
 
        <userinput>&COMMANDNAME;</userinput>
 
451
        <userinput>mandos</userinput>
568
452
      </para>
569
453
    </informalexample>
570
454
    <informalexample>
571
455
      <para>
572
456
        Run the server in debug mode, read configuration files from
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:
 
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:
576
460
      </para>
577
461
      <para>
578
462
 
579
463
<!-- do not wrap this line -->
580
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
464
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
581
465
 
582
466
      </para>
583
467
    </informalexample>
589
473
      <para>
590
474
 
591
475
<!-- do not wrap this line -->
592
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
476
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
593
477
 
594
478
      </para>
595
479
    </informalexample>
596
480
  </refsect1>
597
 
  
 
481
 
598
482
  <refsect1 id="security">
599
483
    <title>SECURITY</title>
600
 
    <refsect2 id="server">
 
484
    <refsect2 id="SERVER">
601
485
      <title>SERVER</title>
602
486
      <para>
603
487
        Running this <command>&COMMANDNAME;</command> server program
604
488
        should not in itself present any security risk to the host
605
 
        computer running it.  The program switches to a non-root user
606
 
        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.
607
491
      </para>
608
492
    </refsect2>
609
 
    <refsect2 id="clients">
 
493
    <refsect2 id="CLIENTS">
610
494
      <title>CLIENTS</title>
611
495
      <para>
612
496
        The server only gives out its stored data to clients which
619
503
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
620
504
        <manvolnum>5</manvolnum></citerefentry>)
621
505
        <emphasis>must</emphasis> be made non-readable by anyone
622
 
        except the user starting the server (usually root).
 
506
        except the user running the server.
623
507
      </para>
624
508
      <para>
625
509
        As detailed in <xref linkend="checking"/>, the status of all
627
511
        compromised if they are gone for too long.
628
512
      </para>
629
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>
630
530
        For more details on client-side security, see
631
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
531
        <citerefentry><refentrytitle>password-request</refentrytitle>
632
532
        <manvolnum>8mandos</manvolnum></citerefentry>.
633
533
      </para>
634
534
    </refsect2>
635
535
  </refsect1>
636
 
  
 
536
 
637
537
  <refsect1 id="see_also">
638
538
    <title>SEE ALSO</title>
639
539
    <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>
 
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>
650
549
    </para>
651
550
    <variablelist>
652
551
      <varlistentry>
673
572
      </varlistentry>
674
573
      <varlistentry>
675
574
        <term>
676
 
          <ulink url="http://www.gnu.org/software/gnutls/"
677
 
          >GnuTLS</ulink>
 
575
          <ulink
 
576
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
678
577
        </term>
679
578
      <listitem>
680
579
        <para>
686
585
      </varlistentry>
687
586
      <varlistentry>
688
587
        <term>
689
 
          RFC 4291: <citetitle>IP Version 6 Addressing
690
 
          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>
691
591
        </term>
692
592
        <listitem>
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>
 
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>
717
599
        </listitem>
718
600
      </varlistentry>
719
601
      <varlistentry>
720
602
        <term>
721
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
722
 
          Protocol Version 1.1</citetitle>
 
603
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
604
          (TLS) Protocol Version 1.1</citetitle></citation>
723
605
        </term>
724
606
      <listitem>
725
607
        <para>
729
611
      </varlistentry>
730
612
      <varlistentry>
731
613
        <term>
732
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
614
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
615
          Format</citetitle></citation>
733
616
        </term>
734
617
      <listitem>
735
618
        <para>
739
622
      </varlistentry>
740
623
      <varlistentry>
741
624
        <term>
742
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
743
 
          Security</citetitle>
 
625
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
626
          Transport Layer Security</citetitle></citation>
744
627
        </term>
745
628
      <listitem>
746
629
        <para>
752
635
    </variablelist>
753
636
  </refsect1>
754
637
</refentry>
755
 
<!-- Local Variables: -->
756
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
757
 
<!-- time-stamp-end: "[\"']>" -->
758
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
759
 
<!-- End: -->