/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-24 07:42:14 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080824074214-odju7g3115le171c
* mandos-keygen: Bug fix: Recognize new options --subtype and
                 --sublength.  New option "--password" which prompts
                 for and encrypts a password with an already existing
                 key.

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

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
4
<!ENTITY VERSION "1.0">
4
5
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "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>
 
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>
88
92
    </cmdsynopsis>
89
93
    <cmdsynopsis>
90
94
      <command>&COMMANDNAME;</command>
91
95
      <group choice="req">
92
 
        <arg choice="plain"><option>--help</option></arg>
93
 
        <arg choice="plain"><option>-h</option></arg>
 
96
        <arg choice="plain">-h</arg>
 
97
        <arg choice="plain">--help</arg>
94
98
      </group>
95
99
    </cmdsynopsis>
96
100
    <cmdsynopsis>
97
101
      <command>&COMMANDNAME;</command>
98
 
      <arg choice="plain"><option>--version</option></arg>
 
102
      <arg choice="plain">--version</arg>
99
103
    </cmdsynopsis>
100
104
    <cmdsynopsis>
101
105
      <command>&COMMANDNAME;</command>
102
 
      <arg choice="plain"><option>--check</option></arg>
 
106
      <arg choice="plain">--check</arg>
103
107
    </cmdsynopsis>
104
108
  </refsynopsisdiv>
105
 
  
 
109
 
106
110
  <refsect1 id="description">
107
111
    <title>DESCRIPTION</title>
108
112
    <para>
117
121
      Any authenticated client is then given the stored pre-encrypted
118
122
      password for that specific client.
119
123
    </para>
 
124
 
120
125
  </refsect1>
121
126
  
122
127
  <refsect1 id="purpose">
123
128
    <title>PURPOSE</title>
 
129
 
124
130
    <para>
125
131
      The purpose of this is to enable <emphasis>remote and unattended
126
132
      rebooting</emphasis> of client host computer with an
127
133
      <emphasis>encrypted root file system</emphasis>.  See <xref
128
134
      linkend="overview"/> for details.
129
135
    </para>
 
136
 
130
137
  </refsect1>
131
138
  
132
139
  <refsect1 id="options">
133
140
    <title>OPTIONS</title>
 
141
 
134
142
    <variablelist>
135
143
      <varlistentry>
136
 
        <term><option>--help</option></term>
137
 
        <term><option>-h</option></term>
 
144
        <term><literal>-h</literal>, <literal>--help</literal></term>
138
145
        <listitem>
139
146
          <para>
140
147
            Show a help message and exit
141
148
          </para>
142
149
        </listitem>
143
150
      </varlistentry>
144
 
      
 
151
 
145
152
      <varlistentry>
146
 
        <term><option>--interface</option>
147
 
        <replaceable>NAME</replaceable></term>
148
 
        <term><option>-i</option>
149
 
        <replaceable>NAME</replaceable></term>
 
153
        <term><literal>-i</literal>, <literal>--interface <replaceable>
 
154
        IF</replaceable></literal></term>
150
155
        <listitem>
151
156
          <xi:include href="mandos-options.xml" xpointer="interface"/>
152
157
        </listitem>
153
158
      </varlistentry>
154
 
      
 
159
 
155
160
      <varlistentry>
156
 
        <term><option>--address
157
 
        <replaceable>ADDRESS</replaceable></option></term>
158
 
        <term><option>-a
159
 
        <replaceable>ADDRESS</replaceable></option></term>
 
161
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
162
        ADDRESS</replaceable></literal></term>
160
163
        <listitem>
161
164
          <xi:include href="mandos-options.xml" xpointer="address"/>
162
165
        </listitem>
163
166
      </varlistentry>
164
 
      
 
167
 
165
168
      <varlistentry>
166
 
        <term><option>--port
167
 
        <replaceable>PORT</replaceable></option></term>
168
 
        <term><option>-p
169
 
        <replaceable>PORT</replaceable></option></term>
 
169
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
170
        PORT</replaceable></literal></term>
170
171
        <listitem>
171
172
          <xi:include href="mandos-options.xml" xpointer="port"/>
172
173
        </listitem>
173
174
      </varlistentry>
174
 
      
 
175
 
175
176
      <varlistentry>
176
 
        <term><option>--check</option></term>
 
177
        <term><literal>--check</literal></term>
177
178
        <listitem>
178
179
          <para>
179
180
            Run the server’s self-tests.  This includes any unit
181
182
          </para>
182
183
        </listitem>
183
184
      </varlistentry>
184
 
      
 
185
 
185
186
      <varlistentry>
186
 
        <term><option>--debug</option></term>
 
187
        <term><literal>--debug</literal></term>
187
188
        <listitem>
188
189
          <xi:include href="mandos-options.xml" xpointer="debug"/>
189
190
        </listitem>
190
191
      </varlistentry>
191
 
      
 
192
 
192
193
      <varlistentry>
193
 
        <term><option>--priority <replaceable>
194
 
        PRIORITY</replaceable></option></term>
 
194
        <term><literal>--priority <replaceable>
 
195
        PRIORITY</replaceable></literal></term>
195
196
        <listitem>
196
197
          <xi:include href="mandos-options.xml" xpointer="priority"/>
197
198
        </listitem>
198
199
      </varlistentry>
199
 
      
 
200
 
200
201
      <varlistentry>
201
 
        <term><option>--servicename
202
 
        <replaceable>NAME</replaceable></option></term>
 
202
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
203
        </literal></term>
203
204
        <listitem>
204
205
          <xi:include href="mandos-options.xml"
205
206
                      xpointer="servicename"/>
206
207
        </listitem>
207
208
      </varlistentry>
208
 
      
 
209
 
209
210
      <varlistentry>
210
 
        <term><option>--configdir
211
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
211
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
212
        </literal></term>
212
213
        <listitem>
213
214
          <para>
214
215
            Directory to search for configuration files.  Default is
220
221
          </para>
221
222
        </listitem>
222
223
      </varlistentry>
223
 
      
 
224
 
224
225
      <varlistentry>
225
 
        <term><option>--version</option></term>
 
226
        <term><literal>--version</literal></term>
226
227
        <listitem>
227
228
          <para>
228
229
            Prints the program version and exit.
231
232
      </varlistentry>
232
233
    </variablelist>
233
234
  </refsect1>
234
 
  
 
235
 
235
236
  <refsect1 id="overview">
236
237
    <title>OVERVIEW</title>
237
238
    <xi:include href="overview.xml"/>
238
239
    <para>
239
240
      This program is the server part.  It is a normal server program
240
241
      and will run in a normal system environment, not in an initial
241
 
      <acronym>RAM</acronym> disk environment.
 
242
      RAM disk environment.
242
243
    </para>
243
244
  </refsect1>
244
 
  
 
245
 
245
246
  <refsect1 id="protocol">
246
247
    <title>NETWORK PROTOCOL</title>
247
248
    <para>
299
300
      </row>
300
301
    </tbody></tgroup></table>
301
302
  </refsect1>
302
 
  
 
303
 
303
304
  <refsect1 id="checking">
304
305
    <title>CHECKING</title>
305
306
    <para>
313
314
      <manvolnum>5</manvolnum></citerefentry>.
314
315
    </para>
315
316
  </refsect1>
316
 
  
 
317
 
317
318
  <refsect1 id="logging">
318
319
    <title>LOGGING</title>
319
320
    <para>
323
324
      and also show them on the console.
324
325
    </para>
325
326
  </refsect1>
326
 
  
 
327
 
327
328
  <refsect1 id="exit_status">
328
329
    <title>EXIT STATUS</title>
329
330
    <para>
331
332
      critical error is encountered.
332
333
    </para>
333
334
  </refsect1>
334
 
  
 
335
 
335
336
  <refsect1 id="environment">
336
337
    <title>ENVIRONMENT</title>
337
338
    <variablelist>
338
339
      <varlistentry>
339
 
        <term><envar>PATH</envar></term>
 
340
        <term><varname>PATH</varname></term>
340
341
        <listitem>
341
342
          <para>
342
343
            To start the configured checker (see <xref
351
352
      </varlistentry>
352
353
    </variablelist>
353
354
  </refsect1>
354
 
  
355
 
  <refsect1 id="files">
 
355
 
 
356
  <refsect1 id="file">
356
357
    <title>FILES</title>
357
358
    <para>
358
359
      Use the <option>--configdir</option> option to change where
381
382
        </listitem>
382
383
      </varlistentry>
383
384
      <varlistentry>
384
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
385
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
385
386
        <listitem>
386
387
          <para>
387
388
            The file containing the process id of
422
423
      Currently, if a client is declared <quote>invalid</quote> due to
423
424
      having timed out, the server does not record this fact onto
424
425
      permanent storage.  This has some security implications, see
425
 
      <xref linkend="clients"/>.
 
426
      <xref linkend="CLIENTS"/>.
426
427
    </para>
427
428
    <para>
428
429
      There is currently no way of querying the server of the current
436
437
      Debug mode is conflated with running in the foreground.
437
438
    </para>
438
439
    <para>
439
 
      The console log messages does not show a time stamp.
440
 
    </para>
441
 
    <para>
442
 
      This server does not check the expire time of clients’ OpenPGP
443
 
      keys.
 
440
      The console log messages does not show a timestamp.
444
441
    </para>
445
442
  </refsect1>
446
443
  
451
448
        Normal invocation needs no options:
452
449
      </para>
453
450
      <para>
454
 
        <userinput>&COMMANDNAME;</userinput>
 
451
        <userinput>mandos</userinput>
455
452
      </para>
456
453
    </informalexample>
457
454
    <informalexample>
464
461
      <para>
465
462
 
466
463
<!-- do not wrap this line -->
467
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
464
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
468
465
 
469
466
      </para>
470
467
    </informalexample>
476
473
      <para>
477
474
 
478
475
<!-- do not wrap this line -->
479
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
476
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
480
477
 
481
478
      </para>
482
479
    </informalexample>
483
480
  </refsect1>
484
 
  
 
481
 
485
482
  <refsect1 id="security">
486
483
    <title>SECURITY</title>
487
 
    <refsect2 id="server">
 
484
    <refsect2 id="SERVER">
488
485
      <title>SERVER</title>
489
486
      <para>
490
487
        Running this <command>&COMMANDNAME;</command> server program
491
488
        should not in itself present any security risk to the host
492
 
        computer running it.  The program switches to a non-root user
493
 
        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.
494
491
      </para>
495
492
    </refsect2>
496
 
    <refsect2 id="clients">
 
493
    <refsect2 id="CLIENTS">
497
494
      <title>CLIENTS</title>
498
495
      <para>
499
496
        The server only gives out its stored data to clients which
506
503
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
507
504
        <manvolnum>5</manvolnum></citerefentry>)
508
505
        <emphasis>must</emphasis> be made non-readable by anyone
509
 
        except the user starting the server (usually root).
 
506
        except the user running the server.
510
507
      </para>
511
508
      <para>
512
509
        As detailed in <xref linkend="checking"/>, the status of all
523
520
        restarting servers if it is suspected that a client has, in
524
521
        fact, been compromised by parties who may now be running a
525
522
        fake Mandos client with the keys from the non-encrypted
526
 
        initial <acronym>RAM</acronym> image of the client host.  What
527
 
        should be done in that case (if restarting the server program
528
 
        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
529
526
        configuration file to omit any suspect clients, and restart
530
527
        the server program.
531
528
      </para>
532
529
      <para>
533
530
        For more details on client-side security, see
534
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
531
        <citerefentry><refentrytitle>password-request</refentrytitle>
535
532
        <manvolnum>8mandos</manvolnum></citerefentry>.
536
533
      </para>
537
534
    </refsect2>
538
535
  </refsect1>
539
 
  
 
536
 
540
537
  <refsect1 id="see_also">
541
538
    <title>SEE ALSO</title>
542
539
    <para>
543
540
      <citerefentry>
 
541
        <refentrytitle>mandos.conf</refentrytitle>
 
542
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
544
543
        <refentrytitle>mandos-clients.conf</refentrytitle>
545
544
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
 
        <refentrytitle>mandos.conf</refentrytitle>
547
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
548
 
        <refentrytitle>mandos-client</refentrytitle>
 
545
        <refentrytitle>password-request</refentrytitle>
549
546
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
550
547
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
551
548
      </citerefentry>
575
572
      </varlistentry>
576
573
      <varlistentry>
577
574
        <term>
578
 
          <ulink url="http://www.gnu.org/software/gnutls/"
579
 
          >GnuTLS</ulink>
 
575
          <ulink
 
576
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
580
577
        </term>
581
578
      <listitem>
582
579
        <para>
588
585
      </varlistentry>
589
586
      <varlistentry>
590
587
        <term>
591
 
          RFC 4291: <citetitle>IP Version 6 Addressing
592
 
          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>
593
591
        </term>
594
592
        <listitem>
595
 
          <variablelist>
596
 
            <varlistentry>
597
 
              <term>Section 2.2: <citetitle>Text Representation of
598
 
              Addresses</citetitle></term>
599
 
              <listitem><para/></listitem>
600
 
            </varlistentry>
601
 
            <varlistentry>
602
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
603
 
              Address</citetitle></term>
604
 
              <listitem><para/></listitem>
605
 
            </varlistentry>
606
 
            <varlistentry>
607
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
608
 
            Addresses</citetitle></term>
609
 
            <listitem>
610
 
              <para>
611
 
                The clients use IPv6 link-local addresses, which are
612
 
                immediately usable since a link-local addresses is
613
 
                automatically assigned to a network interfaces when it
614
 
                is brought up.
615
 
              </para>
616
 
            </listitem>
617
 
            </varlistentry>
618
 
          </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>
619
599
        </listitem>
620
600
      </varlistentry>
621
601
      <varlistentry>
622
602
        <term>
623
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
624
 
          Protocol Version 1.1</citetitle>
 
603
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
604
          (TLS) Protocol Version 1.1</citetitle></citation>
625
605
        </term>
626
606
      <listitem>
627
607
        <para>
631
611
      </varlistentry>
632
612
      <varlistentry>
633
613
        <term>
634
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
614
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
615
          Format</citetitle></citation>
635
616
        </term>
636
617
      <listitem>
637
618
        <para>
641
622
      </varlistentry>
642
623
      <varlistentry>
643
624
        <term>
644
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
645
 
          Security</citetitle>
 
625
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
626
          Transport Layer Security</citetitle></citation>
646
627
        </term>
647
628
      <listitem>
648
629
        <para>
654
635
    </variablelist>
655
636
  </refsect1>
656
637
</refentry>
657
 
<!-- Local Variables: -->
658
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
659
 
<!-- time-stamp-end: "[\"']>" -->
660
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
661
 
<!-- End: -->