/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-20 00:35:41 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080820003541-zxymabnc6yfj8y7t
* mandos-keygen.xml (SEE ALSO): Remove "and".

* mandos.conf.xml (SEE ALSO): New section.

* mandos.xml (SEE ALSO): Changed man page references to a comma-
                         separated list, as per man-pages(7).  Added
                         reference to sh(1).

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 "2009-01-04">
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>
32
29
    </authorgroup>
33
30
    <copyright>
34
31
      <year>2008</year>
35
 
      <year>2009</year>
36
32
      <holder>Teddy Hogeborn</holder>
37
33
      <holder>Björn Påhlsson</holder>
38
34
    </copyright>
39
 
    <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>
40
58
  </refentryinfo>
41
 
  
 
59
 
42
60
  <refmeta>
43
61
    <refentrytitle>&COMMANDNAME;</refentrytitle>
44
62
    <manvolnum>8</manvolnum>
47
65
  <refnamediv>
48
66
    <refname><command>&COMMANDNAME;</command></refname>
49
67
    <refpurpose>
50
 
      Gives encrypted passwords to authenticated Mandos clients
 
68
      Sends encrypted passwords to authenticated Mandos clients
51
69
    </refpurpose>
52
70
  </refnamediv>
53
 
  
 
71
 
54
72
  <refsynopsisdiv>
55
73
    <cmdsynopsis>
56
74
      <command>&COMMANDNAME;</command>
57
 
      <group>
58
 
        <arg choice="plain"><option>--interface
59
 
        <replaceable>NAME</replaceable></option></arg>
60
 
        <arg choice="plain"><option>-i
61
 
        <replaceable>NAME</replaceable></option></arg>
62
 
      </group>
63
 
      <sbr/>
64
 
      <group>
65
 
        <arg choice="plain"><option>--address
66
 
        <replaceable>ADDRESS</replaceable></option></arg>
67
 
        <arg choice="plain"><option>-a
68
 
        <replaceable>ADDRESS</replaceable></option></arg>
69
 
      </group>
70
 
      <sbr/>
71
 
      <group>
72
 
        <arg choice="plain"><option>--port
73
 
        <replaceable>PORT</replaceable></option></arg>
74
 
        <arg choice="plain"><option>-p
75
 
        <replaceable>PORT</replaceable></option></arg>
76
 
      </group>
77
 
      <sbr/>
78
 
      <arg><option>--priority
79
 
      <replaceable>PRIORITY</replaceable></option></arg>
80
 
      <sbr/>
81
 
      <arg><option>--servicename
82
 
      <replaceable>NAME</replaceable></option></arg>
83
 
      <sbr/>
84
 
      <arg><option>--configdir
85
 
      <replaceable>DIRECTORY</replaceable></option></arg>
86
 
      <sbr/>
87
 
      <arg><option>--debug</option></arg>
88
 
      <sbr/>
89
 
      <arg><option>--no-dbus</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>
90
92
    </cmdsynopsis>
91
93
    <cmdsynopsis>
92
94
      <command>&COMMANDNAME;</command>
93
95
      <group choice="req">
94
 
        <arg choice="plain"><option>--help</option></arg>
95
 
        <arg choice="plain"><option>-h</option></arg>
 
96
        <arg choice="plain">-h</arg>
 
97
        <arg choice="plain">--help</arg>
96
98
      </group>
97
99
    </cmdsynopsis>
98
100
    <cmdsynopsis>
99
101
      <command>&COMMANDNAME;</command>
100
 
      <arg choice="plain"><option>--version</option></arg>
 
102
      <arg choice="plain">--version</arg>
101
103
    </cmdsynopsis>
102
104
    <cmdsynopsis>
103
105
      <command>&COMMANDNAME;</command>
104
 
      <arg choice="plain"><option>--check</option></arg>
 
106
      <arg choice="plain">--check</arg>
105
107
    </cmdsynopsis>
106
108
  </refsynopsisdiv>
107
 
  
 
109
 
108
110
  <refsect1 id="description">
109
111
    <title>DESCRIPTION</title>
110
112
    <para>
119
121
      Any authenticated client is then given the stored pre-encrypted
120
122
      password for that specific client.
121
123
    </para>
 
124
 
122
125
  </refsect1>
123
126
  
124
127
  <refsect1 id="purpose">
125
128
    <title>PURPOSE</title>
 
129
 
126
130
    <para>
127
131
      The purpose of this is to enable <emphasis>remote and unattended
128
132
      rebooting</emphasis> of client host computer with an
129
133
      <emphasis>encrypted root file system</emphasis>.  See <xref
130
134
      linkend="overview"/> for details.
131
135
    </para>
 
136
 
132
137
  </refsect1>
133
138
  
134
139
  <refsect1 id="options">
135
140
    <title>OPTIONS</title>
 
141
 
136
142
    <variablelist>
137
143
      <varlistentry>
138
 
        <term><option>--help</option></term>
139
 
        <term><option>-h</option></term>
 
144
        <term><literal>-h</literal>, <literal>--help</literal></term>
140
145
        <listitem>
141
146
          <para>
142
147
            Show a help message and exit
143
148
          </para>
144
149
        </listitem>
145
150
      </varlistentry>
146
 
      
 
151
 
147
152
      <varlistentry>
148
 
        <term><option>--interface</option>
149
 
        <replaceable>NAME</replaceable></term>
150
 
        <term><option>-i</option>
151
 
        <replaceable>NAME</replaceable></term>
 
153
        <term><literal>-i</literal>, <literal>--interface <replaceable>
 
154
        IF</replaceable></literal></term>
152
155
        <listitem>
153
156
          <xi:include href="mandos-options.xml" xpointer="interface"/>
154
157
        </listitem>
155
158
      </varlistentry>
156
 
      
 
159
 
157
160
      <varlistentry>
158
 
        <term><option>--address
159
 
        <replaceable>ADDRESS</replaceable></option></term>
160
 
        <term><option>-a
161
 
        <replaceable>ADDRESS</replaceable></option></term>
 
161
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
162
        ADDRESS</replaceable></literal></term>
162
163
        <listitem>
163
164
          <xi:include href="mandos-options.xml" xpointer="address"/>
164
165
        </listitem>
165
166
      </varlistentry>
166
 
      
 
167
 
167
168
      <varlistentry>
168
 
        <term><option>--port
169
 
        <replaceable>PORT</replaceable></option></term>
170
 
        <term><option>-p
171
 
        <replaceable>PORT</replaceable></option></term>
 
169
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
170
        PORT</replaceable></literal></term>
172
171
        <listitem>
173
172
          <xi:include href="mandos-options.xml" xpointer="port"/>
174
173
        </listitem>
175
174
      </varlistentry>
176
 
      
 
175
 
177
176
      <varlistentry>
178
 
        <term><option>--check</option></term>
 
177
        <term><literal>--check</literal></term>
179
178
        <listitem>
180
179
          <para>
181
180
            Run the server’s self-tests.  This includes any unit
183
182
          </para>
184
183
        </listitem>
185
184
      </varlistentry>
186
 
      
 
185
 
187
186
      <varlistentry>
188
 
        <term><option>--debug</option></term>
 
187
        <term><literal>--debug</literal></term>
189
188
        <listitem>
190
189
          <xi:include href="mandos-options.xml" xpointer="debug"/>
191
190
        </listitem>
192
191
      </varlistentry>
193
 
      
 
192
 
194
193
      <varlistentry>
195
 
        <term><option>--priority <replaceable>
196
 
        PRIORITY</replaceable></option></term>
 
194
        <term><literal>--priority <replaceable>
 
195
        PRIORITY</replaceable></literal></term>
197
196
        <listitem>
198
197
          <xi:include href="mandos-options.xml" xpointer="priority"/>
199
198
        </listitem>
200
199
      </varlistentry>
201
 
      
 
200
 
202
201
      <varlistentry>
203
 
        <term><option>--servicename
204
 
        <replaceable>NAME</replaceable></option></term>
 
202
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
203
        </literal></term>
205
204
        <listitem>
206
205
          <xi:include href="mandos-options.xml"
207
206
                      xpointer="servicename"/>
208
207
        </listitem>
209
208
      </varlistentry>
210
 
      
 
209
 
211
210
      <varlistentry>
212
 
        <term><option>--configdir
213
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
211
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
212
        </literal></term>
214
213
        <listitem>
215
214
          <para>
216
215
            Directory to search for configuration files.  Default is
222
221
          </para>
223
222
        </listitem>
224
223
      </varlistentry>
225
 
      
 
224
 
226
225
      <varlistentry>
227
 
        <term><option>--version</option></term>
 
226
        <term><literal>--version</literal></term>
228
227
        <listitem>
229
228
          <para>
230
229
            Prints the program version and exit.
231
230
          </para>
232
231
        </listitem>
233
232
      </varlistentry>
234
 
      
235
 
      <varlistentry>
236
 
        <term><option>--no-dbus</option></term>
237
 
        <listitem>
238
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
239
 
          <para>
240
 
            See also <xref linkend="dbus_interface"/>.
241
 
          </para>
242
 
        </listitem>
243
 
      </varlistentry>
244
233
    </variablelist>
245
234
  </refsect1>
246
 
  
 
235
 
247
236
  <refsect1 id="overview">
248
237
    <title>OVERVIEW</title>
249
238
    <xi:include href="overview.xml"/>
250
239
    <para>
251
240
      This program is the server part.  It is a normal server program
252
241
      and will run in a normal system environment, not in an initial
253
 
      <acronym>RAM</acronym> disk environment.
 
242
      RAM disk environment.
254
243
    </para>
255
244
  </refsect1>
256
 
  
 
245
 
257
246
  <refsect1 id="protocol">
258
247
    <title>NETWORK PROTOCOL</title>
259
248
    <para>
311
300
      </row>
312
301
    </tbody></tgroup></table>
313
302
  </refsect1>
314
 
  
 
303
 
315
304
  <refsect1 id="checking">
316
305
    <title>CHECKING</title>
317
306
    <para>
325
314
      <manvolnum>5</manvolnum></citerefentry>.
326
315
    </para>
327
316
  </refsect1>
328
 
  
 
317
 
329
318
  <refsect1 id="logging">
330
319
    <title>LOGGING</title>
331
320
    <para>
335
324
      and also show them on the console.
336
325
    </para>
337
326
  </refsect1>
338
 
  
339
 
  <refsect1 id="dbus_interface">
340
 
    <title>D-BUS INTERFACE</title>
341
 
    <para>
342
 
      The server will by default provide a D-Bus system bus interface.
343
 
      This interface will only be accessible by the root user or a
344
 
      Mandos-specific user, if such a user exists.
345
 
      <!-- XXX -->
346
 
    </para>
347
 
  </refsect1>
348
327
 
349
328
  <refsect1 id="exit_status">
350
329
    <title>EXIT STATUS</title>
353
332
      critical error is encountered.
354
333
    </para>
355
334
  </refsect1>
356
 
  
 
335
 
357
336
  <refsect1 id="environment">
358
337
    <title>ENVIRONMENT</title>
359
338
    <variablelist>
360
339
      <varlistentry>
361
 
        <term><envar>PATH</envar></term>
 
340
        <term><varname>PATH</varname></term>
362
341
        <listitem>
363
342
          <para>
364
343
            To start the configured checker (see <xref
373
352
      </varlistentry>
374
353
    </variablelist>
375
354
  </refsect1>
376
 
  
377
 
  <refsect1 id="files">
 
355
 
 
356
  <refsect1 id="file">
378
357
    <title>FILES</title>
379
358
    <para>
380
359
      Use the <option>--configdir</option> option to change where
403
382
        </listitem>
404
383
      </varlistentry>
405
384
      <varlistentry>
406
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
385
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
407
386
        <listitem>
408
387
          <para>
409
388
            The file containing the process id of
444
423
      Currently, if a client is declared <quote>invalid</quote> due to
445
424
      having timed out, the server does not record this fact onto
446
425
      permanent storage.  This has some security implications, see
447
 
      <xref linkend="clients"/>.
 
426
      <xref linkend="CLIENTS"/>.
448
427
    </para>
449
428
    <para>
450
429
      There is currently no way of querying the server of the current
458
437
      Debug mode is conflated with running in the foreground.
459
438
    </para>
460
439
    <para>
461
 
      The console log messages does not show a time stamp.
462
 
    </para>
463
 
    <para>
464
 
      This server does not check the expire time of clients’ OpenPGP
465
 
      keys.
 
440
      The console log messages does not show a timestamp.
466
441
    </para>
467
442
  </refsect1>
468
443
  
473
448
        Normal invocation needs no options:
474
449
      </para>
475
450
      <para>
476
 
        <userinput>&COMMANDNAME;</userinput>
 
451
        <userinput>mandos</userinput>
477
452
      </para>
478
453
    </informalexample>
479
454
    <informalexample>
486
461
      <para>
487
462
 
488
463
<!-- do not wrap this line -->
489
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
464
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
490
465
 
491
466
      </para>
492
467
    </informalexample>
498
473
      <para>
499
474
 
500
475
<!-- do not wrap this line -->
501
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
476
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
502
477
 
503
478
      </para>
504
479
    </informalexample>
505
480
  </refsect1>
506
 
  
 
481
 
507
482
  <refsect1 id="security">
508
483
    <title>SECURITY</title>
509
 
    <refsect2 id="server">
 
484
    <refsect2 id="SERVER">
510
485
      <title>SERVER</title>
511
486
      <para>
512
487
        Running this <command>&COMMANDNAME;</command> server program
513
488
        should not in itself present any security risk to the host
514
 
        computer running it.  The program switches to a non-root user
515
 
        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.
516
491
      </para>
517
492
    </refsect2>
518
 
    <refsect2 id="clients">
 
493
    <refsect2 id="CLIENTS">
519
494
      <title>CLIENTS</title>
520
495
      <para>
521
496
        The server only gives out its stored data to clients which
528
503
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
529
504
        <manvolnum>5</manvolnum></citerefentry>)
530
505
        <emphasis>must</emphasis> be made non-readable by anyone
531
 
        except the user starting the server (usually root).
 
506
        except the user running the server.
532
507
      </para>
533
508
      <para>
534
509
        As detailed in <xref linkend="checking"/>, the status of all
545
520
        restarting servers if it is suspected that a client has, in
546
521
        fact, been compromised by parties who may now be running a
547
522
        fake Mandos client with the keys from the non-encrypted
548
 
        initial <acronym>RAM</acronym> image of the client host.  What
549
 
        should be done in that case (if restarting the server program
550
 
        really is necessary) is to stop the server program, edit the
 
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
551
526
        configuration file to omit any suspect clients, and restart
552
527
        the server program.
553
528
      </para>
554
529
      <para>
555
530
        For more details on client-side security, see
556
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
531
        <citerefentry><refentrytitle>password-request</refentrytitle>
557
532
        <manvolnum>8mandos</manvolnum></citerefentry>.
558
533
      </para>
559
534
    </refsect2>
560
535
  </refsect1>
561
 
  
 
536
 
562
537
  <refsect1 id="see_also">
563
538
    <title>SEE ALSO</title>
564
539
    <para>
565
540
      <citerefentry>
 
541
        <refentrytitle>mandos.conf</refentrytitle>
 
542
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
566
543
        <refentrytitle>mandos-clients.conf</refentrytitle>
567
544
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
 
        <refentrytitle>mandos.conf</refentrytitle>
569
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
570
 
        <refentrytitle>mandos-client</refentrytitle>
 
545
        <refentrytitle>password-request</refentrytitle>
571
546
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
572
547
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
573
548
      </citerefentry>
597
572
      </varlistentry>
598
573
      <varlistentry>
599
574
        <term>
600
 
          <ulink url="http://www.gnu.org/software/gnutls/"
601
 
          >GnuTLS</ulink>
 
575
          <ulink
 
576
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
602
577
        </term>
603
578
      <listitem>
604
579
        <para>
610
585
      </varlistentry>
611
586
      <varlistentry>
612
587
        <term>
613
 
          RFC 4291: <citetitle>IP Version 6 Addressing
614
 
          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>
615
591
        </term>
616
592
        <listitem>
617
 
          <variablelist>
618
 
            <varlistentry>
619
 
              <term>Section 2.2: <citetitle>Text Representation of
620
 
              Addresses</citetitle></term>
621
 
              <listitem><para/></listitem>
622
 
            </varlistentry>
623
 
            <varlistentry>
624
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
625
 
              Address</citetitle></term>
626
 
              <listitem><para/></listitem>
627
 
            </varlistentry>
628
 
            <varlistentry>
629
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
630
 
            Addresses</citetitle></term>
631
 
            <listitem>
632
 
              <para>
633
 
                The clients use IPv6 link-local addresses, which are
634
 
                immediately usable since a link-local addresses is
635
 
                automatically assigned to a network interfaces when it
636
 
                is brought up.
637
 
              </para>
638
 
            </listitem>
639
 
            </varlistentry>
640
 
          </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>
641
599
        </listitem>
642
600
      </varlistentry>
643
601
      <varlistentry>
644
602
        <term>
645
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
646
 
          Protocol Version 1.1</citetitle>
 
603
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
604
          (TLS) Protocol Version 1.1</citetitle></citation>
647
605
        </term>
648
606
      <listitem>
649
607
        <para>
653
611
      </varlistentry>
654
612
      <varlistentry>
655
613
        <term>
656
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
614
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
615
          Format</citetitle></citation>
657
616
        </term>
658
617
      <listitem>
659
618
        <para>
663
622
      </varlistentry>
664
623
      <varlistentry>
665
624
        <term>
666
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
667
 
          Security</citetitle>
 
625
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
626
          Transport Layer Security</citetitle></citation>
668
627
        </term>
669
628
      <listitem>
670
629
        <para>
676
635
    </variablelist>
677
636
  </refsect1>
678
637
</refentry>
679
 
<!-- Local Variables: -->
680
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
681
 
<!-- time-stamp-end: "[\"']>" -->
682
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
683
 
<!-- End: -->