/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-09-13 15:36:18 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080913153618-atp386q2bqj0ku99
* Makefile (install-client-nokey): Do "&&" instead of ";" to catch
                                   errors.

* README: Kill the straight quotes.  Add copyright notice.

* overview.xml: Improved wording.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY COMMANDNAME "mandos">
 
6
<!ENTITY TIMESTAMP "2008-09-12">
6
7
]>
7
8
 
8
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
9
10
  <refentryinfo>
10
 
    <title>&COMMANDNAME;</title>
 
11
    <title>Mandos Manual</title>
11
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
12
 
    <productname>&COMMANDNAME;</productname>
 
13
    <productname>Mandos</productname>
13
14
    <productnumber>&VERSION;</productnumber>
 
15
    <date>&TIMESTAMP;</date>
14
16
    <authorgroup>
15
17
      <author>
16
18
        <firstname>Björn</firstname>
32
34
      <holder>Teddy Hogeborn</holder>
33
35
      <holder>Björn Påhlsson</holder>
34
36
    </copyright>
35
 
    <legalnotice>
36
 
      <para>
37
 
        This manual page is free software: you can redistribute it
38
 
        and/or modify it under the terms of the GNU General Public
39
 
        License as published by the Free Software Foundation,
40
 
        either version 3 of the License, or (at your option) any
41
 
        later version.
42
 
      </para>
43
 
 
44
 
      <para>
45
 
        This manual page is distributed in the hope that it will
46
 
        be useful, but WITHOUT ANY WARRANTY; without even the
47
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
48
 
        PARTICULAR PURPOSE.  See the GNU General Public License
49
 
        for more details.
50
 
      </para>
51
 
 
52
 
      <para>
53
 
        You should have received a copy of the GNU General Public
54
 
        License along with this program; If not, see
55
 
        <ulink url="http://www.gnu.org/licenses/"/>.
56
 
      </para>
57
 
    </legalnotice>
 
37
    <xi:include href="legalnotice.xml"/>
58
38
  </refentryinfo>
59
 
 
 
39
  
60
40
  <refmeta>
61
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
62
42
    <manvolnum>8</manvolnum>
65
45
  <refnamediv>
66
46
    <refname><command>&COMMANDNAME;</command></refname>
67
47
    <refpurpose>
68
 
      Sends encrypted passwords to authenticated Mandos clients
 
48
      Gives encrypted passwords to authenticated Mandos clients
69
49
    </refpurpose>
70
50
  </refnamediv>
71
 
 
 
51
  
72
52
  <refsynopsisdiv>
73
53
    <cmdsynopsis>
74
54
      <command>&COMMANDNAME;</command>
75
 
      <arg>--interface<arg choice="plain">IF</arg></arg>
76
 
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
77
 
      <arg>--port<arg choice="plain">PORT</arg></arg>
78
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
79
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
80
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
81
 
      <arg>--debug</arg>
82
 
    </cmdsynopsis>
83
 
    <cmdsynopsis>
84
 
      <command>&COMMANDNAME;</command>
85
 
      <arg>-i<arg choice="plain">IF</arg></arg>
86
 
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
87
 
      <arg>-p<arg choice="plain">PORT</arg></arg>
88
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
89
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
90
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
91
 
      <arg>--debug</arg>
 
55
      <group>
 
56
        <arg choice="plain"><option>--interface
 
57
        <replaceable>NAME</replaceable></option></arg>
 
58
        <arg choice="plain"><option>-i
 
59
        <replaceable>NAME</replaceable></option></arg>
 
60
      </group>
 
61
      <sbr/>
 
62
      <group>
 
63
        <arg choice="plain"><option>--address
 
64
        <replaceable>ADDRESS</replaceable></option></arg>
 
65
        <arg choice="plain"><option>-a
 
66
        <replaceable>ADDRESS</replaceable></option></arg>
 
67
      </group>
 
68
      <sbr/>
 
69
      <group>
 
70
        <arg choice="plain"><option>--port
 
71
        <replaceable>PORT</replaceable></option></arg>
 
72
        <arg choice="plain"><option>-p
 
73
        <replaceable>PORT</replaceable></option></arg>
 
74
      </group>
 
75
      <sbr/>
 
76
      <arg><option>--priority
 
77
      <replaceable>PRIORITY</replaceable></option></arg>
 
78
      <sbr/>
 
79
      <arg><option>--servicename
 
80
      <replaceable>NAME</replaceable></option></arg>
 
81
      <sbr/>
 
82
      <arg><option>--configdir
 
83
      <replaceable>DIRECTORY</replaceable></option></arg>
 
84
      <sbr/>
 
85
      <arg><option>--debug</option></arg>
92
86
    </cmdsynopsis>
93
87
    <cmdsynopsis>
94
88
      <command>&COMMANDNAME;</command>
95
89
      <group choice="req">
96
 
        <arg choice="plain">-h</arg>
97
 
        <arg choice="plain">--help</arg>
 
90
        <arg choice="plain"><option>--help</option></arg>
 
91
        <arg choice="plain"><option>-h</option></arg>
98
92
      </group>
99
93
    </cmdsynopsis>
100
94
    <cmdsynopsis>
101
95
      <command>&COMMANDNAME;</command>
102
 
      <arg choice="plain">--version</arg>
 
96
      <arg choice="plain"><option>--version</option></arg>
103
97
    </cmdsynopsis>
104
98
    <cmdsynopsis>
105
99
      <command>&COMMANDNAME;</command>
106
 
      <arg choice="plain">--check</arg>
 
100
      <arg choice="plain"><option>--check</option></arg>
107
101
    </cmdsynopsis>
108
102
  </refsynopsisdiv>
109
 
 
 
103
  
110
104
  <refsect1 id="description">
111
105
    <title>DESCRIPTION</title>
112
106
    <para>
121
115
      Any authenticated client is then given the stored pre-encrypted
122
116
      password for that specific client.
123
117
    </para>
124
 
 
125
118
  </refsect1>
126
119
  
127
120
  <refsect1 id="purpose">
128
121
    <title>PURPOSE</title>
129
 
 
130
122
    <para>
131
123
      The purpose of this is to enable <emphasis>remote and unattended
132
124
      rebooting</emphasis> of client host computer with an
133
125
      <emphasis>encrypted root file system</emphasis>.  See <xref
134
126
      linkend="overview"/> for details.
135
127
    </para>
136
 
 
137
128
  </refsect1>
138
129
  
139
130
  <refsect1 id="options">
140
131
    <title>OPTIONS</title>
141
 
 
142
132
    <variablelist>
143
133
      <varlistentry>
144
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
134
        <term><option>--help</option></term>
 
135
        <term><option>-h</option></term>
145
136
        <listitem>
146
137
          <para>
147
138
            Show a help message and exit
148
139
          </para>
149
140
        </listitem>
150
141
      </varlistentry>
151
 
 
 
142
      
152
143
      <varlistentry>
153
 
        <term><literal>-i</literal>, <literal>--interface <replaceable>
154
 
        IF</replaceable></literal></term>
 
144
        <term><option>--interface</option>
 
145
        <replaceable>NAME</replaceable></term>
 
146
        <term><option>-i</option>
 
147
        <replaceable>NAME</replaceable></term>
155
148
        <listitem>
156
149
          <xi:include href="mandos-options.xml" xpointer="interface"/>
157
150
        </listitem>
158
151
      </varlistentry>
159
 
 
 
152
      
160
153
      <varlistentry>
161
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
162
 
        ADDRESS</replaceable></literal></term>
 
154
        <term><option>--address
 
155
        <replaceable>ADDRESS</replaceable></option></term>
 
156
        <term><option>-a
 
157
        <replaceable>ADDRESS</replaceable></option></term>
163
158
        <listitem>
164
159
          <xi:include href="mandos-options.xml" xpointer="address"/>
165
160
        </listitem>
166
161
      </varlistentry>
167
 
 
 
162
      
168
163
      <varlistentry>
169
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
170
 
        PORT</replaceable></literal></term>
 
164
        <term><option>--port
 
165
        <replaceable>PORT</replaceable></option></term>
 
166
        <term><option>-p
 
167
        <replaceable>PORT</replaceable></option></term>
171
168
        <listitem>
172
169
          <xi:include href="mandos-options.xml" xpointer="port"/>
173
170
        </listitem>
174
171
      </varlistentry>
175
 
 
 
172
      
176
173
      <varlistentry>
177
 
        <term><literal>--check</literal></term>
 
174
        <term><option>--check</option></term>
178
175
        <listitem>
179
176
          <para>
180
177
            Run the server’s self-tests.  This includes any unit
182
179
          </para>
183
180
        </listitem>
184
181
      </varlistentry>
185
 
 
 
182
      
186
183
      <varlistentry>
187
 
        <term><literal>--debug</literal></term>
 
184
        <term><option>--debug</option></term>
188
185
        <listitem>
189
186
          <xi:include href="mandos-options.xml" xpointer="debug"/>
190
187
        </listitem>
191
188
      </varlistentry>
192
 
 
 
189
      
193
190
      <varlistentry>
194
 
        <term><literal>--priority <replaceable>
195
 
        PRIORITY</replaceable></literal></term>
 
191
        <term><option>--priority <replaceable>
 
192
        PRIORITY</replaceable></option></term>
196
193
        <listitem>
197
194
          <xi:include href="mandos-options.xml" xpointer="priority"/>
198
195
        </listitem>
199
196
      </varlistentry>
200
 
 
 
197
      
201
198
      <varlistentry>
202
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
203
 
        </literal></term>
 
199
        <term><option>--servicename
 
200
        <replaceable>NAME</replaceable></option></term>
204
201
        <listitem>
205
202
          <xi:include href="mandos-options.xml"
206
203
                      xpointer="servicename"/>
207
204
        </listitem>
208
205
      </varlistentry>
209
 
 
 
206
      
210
207
      <varlistentry>
211
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
212
 
        </literal></term>
 
208
        <term><option>--configdir
 
209
        <replaceable>DIRECTORY</replaceable></option></term>
213
210
        <listitem>
214
211
          <para>
215
212
            Directory to search for configuration files.  Default is
221
218
          </para>
222
219
        </listitem>
223
220
      </varlistentry>
224
 
 
 
221
      
225
222
      <varlistentry>
226
 
        <term><literal>--version</literal></term>
 
223
        <term><option>--version</option></term>
227
224
        <listitem>
228
225
          <para>
229
226
            Prints the program version and exit.
232
229
      </varlistentry>
233
230
    </variablelist>
234
231
  </refsect1>
235
 
 
 
232
  
236
233
  <refsect1 id="overview">
237
234
    <title>OVERVIEW</title>
238
235
    <xi:include href="overview.xml"/>
239
236
    <para>
240
237
      This program is the server part.  It is a normal server program
241
238
      and will run in a normal system environment, not in an initial
242
 
      RAM disk environment.
 
239
      <acronym>RAM</acronym> disk environment.
243
240
    </para>
244
241
  </refsect1>
245
 
 
 
242
  
246
243
  <refsect1 id="protocol">
247
244
    <title>NETWORK PROTOCOL</title>
248
245
    <para>
300
297
      </row>
301
298
    </tbody></tgroup></table>
302
299
  </refsect1>
303
 
 
 
300
  
304
301
  <refsect1 id="checking">
305
302
    <title>CHECKING</title>
306
303
    <para>
314
311
      <manvolnum>5</manvolnum></citerefentry>.
315
312
    </para>
316
313
  </refsect1>
317
 
 
 
314
  
318
315
  <refsect1 id="logging">
319
316
    <title>LOGGING</title>
320
317
    <para>
324
321
      and also show them on the console.
325
322
    </para>
326
323
  </refsect1>
327
 
 
 
324
  
328
325
  <refsect1 id="exit_status">
329
326
    <title>EXIT STATUS</title>
330
327
    <para>
332
329
      critical error is encountered.
333
330
    </para>
334
331
  </refsect1>
335
 
 
 
332
  
336
333
  <refsect1 id="environment">
337
334
    <title>ENVIRONMENT</title>
338
335
    <variablelist>
339
336
      <varlistentry>
340
 
        <term><varname>PATH</varname></term>
 
337
        <term><envar>PATH</envar></term>
341
338
        <listitem>
342
339
          <para>
343
340
            To start the configured checker (see <xref
352
349
      </varlistentry>
353
350
    </variablelist>
354
351
  </refsect1>
355
 
 
 
352
  
356
353
  <refsect1 id="file">
357
354
    <title>FILES</title>
358
355
    <para>
382
379
        </listitem>
383
380
      </varlistentry>
384
381
      <varlistentry>
385
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
382
        <term><filename>/var/run/mandos.pid</filename></term>
386
383
        <listitem>
387
384
          <para>
388
385
            The file containing the process id of
437
434
      Debug mode is conflated with running in the foreground.
438
435
    </para>
439
436
    <para>
440
 
      The console log messages does not show a timestamp.
 
437
      The console log messages does not show a time stamp.
 
438
    </para>
 
439
    <para>
 
440
      This server does not check the expire time of clients’ OpenPGP
 
441
      keys.
441
442
    </para>
442
443
  </refsect1>
443
444
  
448
449
        Normal invocation needs no options:
449
450
      </para>
450
451
      <para>
451
 
        <userinput>mandos</userinput>
 
452
        <userinput>&COMMANDNAME;</userinput>
452
453
      </para>
453
454
    </informalexample>
454
455
    <informalexample>
461
462
      <para>
462
463
 
463
464
<!-- do not wrap this line -->
464
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
465
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
465
466
 
466
467
      </para>
467
468
    </informalexample>
473
474
      <para>
474
475
 
475
476
<!-- do not wrap this line -->
476
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
477
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
477
478
 
478
479
      </para>
479
480
    </informalexample>
480
481
  </refsect1>
481
 
 
 
482
  
482
483
  <refsect1 id="security">
483
484
    <title>SECURITY</title>
484
485
    <refsect2 id="SERVER">
486
487
      <para>
487
488
        Running this <command>&COMMANDNAME;</command> server program
488
489
        should not in itself present any security risk to the host
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.
 
490
        computer running it.  The program switches to a non-root user
 
491
        soon after startup.
491
492
      </para>
492
493
    </refsect2>
493
494
    <refsect2 id="CLIENTS">
520
521
        restarting servers if it is suspected that a client has, in
521
522
        fact, been compromised by parties who may now be running a
522
523
        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
 
524
        initial <acronym>RAM</acronym> image of the client host.  What
 
525
        should be done in that case (if restarting the server program
 
526
        really is necessary) is to stop the server program, edit the
526
527
        configuration file to omit any suspect clients, and restart
527
528
        the server program.
528
529
      </para>
529
530
      <para>
530
531
        For more details on client-side security, see
531
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
532
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
532
533
        <manvolnum>8mandos</manvolnum></citerefentry>.
533
534
      </para>
534
535
    </refsect2>
535
536
  </refsect1>
536
 
 
 
537
  
537
538
  <refsect1 id="see_also">
538
539
    <title>SEE ALSO</title>
 
540
    <para>
 
541
      <citerefentry>
 
542
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
543
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
544
        <refentrytitle>mandos.conf</refentrytitle>
 
545
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
546
        <refentrytitle>mandos-client</refentrytitle>
 
547
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
548
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
549
      </citerefentry>
 
550
    </para>
539
551
    <variablelist>
540
552
      <varlistentry>
541
553
        <term>
542
 
          <citerefentry>
543
 
            <refentrytitle>password-request</refentrytitle>
544
 
            <manvolnum>8mandos</manvolnum>
545
 
          </citerefentry>
546
 
        </term>
547
 
        <listitem>
548
 
          <para>
549
 
            This is the actual program which talks to this server.
550
 
            Note that it is normally not invoked directly, and is only
551
 
            run in the initial RAM disk environment, and not on a
552
 
            fully started system.
553
 
          </para>
554
 
        </listitem>
555
 
      </varlistentry>
556
 
      <varlistentry>
557
 
        <term>
558
554
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
559
555
        </term>
560
556
        <listitem>
577
573
      </varlistentry>
578
574
      <varlistentry>
579
575
        <term>
580
 
          <ulink
581
 
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
576
          <ulink url="http://www.gnu.org/software/gnutls/"
 
577
          >GnuTLS</ulink>
582
578
        </term>
583
579
      <listitem>
584
580
        <para>
590
586
      </varlistentry>
591
587
      <varlistentry>
592
588
        <term>
593
 
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
594
 
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
595
 
          Unicast Addresses</citation>
 
589
          RFC 4291: <citetitle>IP Version 6 Addressing
 
590
          Architecture</citetitle>
596
591
        </term>
597
592
        <listitem>
598
 
          <para>
599
 
            The clients use IPv6 link-local addresses, which are
600
 
            immediately usable since a link-local addresses is
601
 
            automatically assigned to a network interfaces when it is
602
 
            brought up.
603
 
          </para>
 
593
          <variablelist>
 
594
            <varlistentry>
 
595
              <term>Section 2.2: <citetitle>Text Representation of
 
596
              Addresses</citetitle></term>
 
597
              <listitem><para/></listitem>
 
598
            </varlistentry>
 
599
            <varlistentry>
 
600
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
601
              Address</citetitle></term>
 
602
              <listitem><para/></listitem>
 
603
            </varlistentry>
 
604
            <varlistentry>
 
605
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
606
            Addresses</citetitle></term>
 
607
            <listitem>
 
608
              <para>
 
609
                The clients use IPv6 link-local addresses, which are
 
610
                immediately usable since a link-local addresses is
 
611
                automatically assigned to a network interfaces when it
 
612
                is brought up.
 
613
              </para>
 
614
            </listitem>
 
615
            </varlistentry>
 
616
          </variablelist>
604
617
        </listitem>
605
618
      </varlistentry>
606
619
      <varlistentry>
607
620
        <term>
608
 
          <citation>RFC 4346: <citetitle>The Transport Layer Security
609
 
          (TLS) Protocol Version 1.1</citetitle></citation>
 
621
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
622
          Protocol Version 1.1</citetitle>
610
623
        </term>
611
624
      <listitem>
612
625
        <para>
616
629
      </varlistentry>
617
630
      <varlistentry>
618
631
        <term>
619
 
          <citation>RFC 4880: <citetitle>OpenPGP Message
620
 
          Format</citetitle></citation>
 
632
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
621
633
        </term>
622
634
      <listitem>
623
635
        <para>
627
639
      </varlistentry>
628
640
      <varlistentry>
629
641
        <term>
630
 
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
631
 
          Transport Layer Security</citetitle></citation>
 
642
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
643
          Security</citetitle>
632
644
        </term>
633
645
      <listitem>
634
646
        <para>
640
652
    </variablelist>
641
653
  </refsect1>
642
654
</refentry>
 
655
<!-- Local Variables: -->
 
656
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
657
<!-- time-stamp-end: "[\"']>" -->
 
658
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
659
<!-- End: -->