/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-25 01:16:38 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080825011638-zgqej2cafhne05ay
* mandos-keygen: Strip 24-bit checksum of Radix-64 from output to make
                 output strictly base64.

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