/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

merge

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-01">
7
6
]>
8
7
 
9
8
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
9
  <refentryinfo>
11
 
    <title>Mandos Manual</title>
 
10
    <title>&COMMANDNAME;</title>
12
11
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>Mandos</productname>
 
12
    <productname>&COMMANDNAME;</productname>
14
13
    <productnumber>&VERSION;</productnumber>
15
 
    <date>&TIMESTAMP;</date>
16
14
    <authorgroup>
17
15
      <author>
18
16
        <firstname>Björn</firstname>
34
32
      <holder>Teddy Hogeborn</holder>
35
33
      <holder>Björn Påhlsson</holder>
36
34
    </copyright>
37
 
    <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>
38
58
  </refentryinfo>
39
59
 
40
60
  <refmeta>
45
65
  <refnamediv>
46
66
    <refname><command>&COMMANDNAME;</command></refname>
47
67
    <refpurpose>
48
 
      Gives encrypted passwords to authenticated Mandos clients
 
68
      Sends encrypted passwords to authenticated Mandos clients
49
69
    </refpurpose>
50
70
  </refnamediv>
51
71
 
52
72
  <refsynopsisdiv>
53
73
    <cmdsynopsis>
54
74
      <command>&COMMANDNAME;</command>
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>
 
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>
86
92
    </cmdsynopsis>
87
93
    <cmdsynopsis>
88
94
      <command>&COMMANDNAME;</command>
89
95
      <group choice="req">
90
 
        <arg choice="plain"><option>--help</option></arg>
91
 
        <arg choice="plain"><option>-h</option></arg>
 
96
        <arg choice="plain">-h</arg>
 
97
        <arg choice="plain">--help</arg>
92
98
      </group>
93
99
    </cmdsynopsis>
94
100
    <cmdsynopsis>
95
101
      <command>&COMMANDNAME;</command>
96
 
      <arg choice="plain"><option>--version</option></arg>
 
102
      <arg choice="plain">--version</arg>
97
103
    </cmdsynopsis>
98
104
    <cmdsynopsis>
99
105
      <command>&COMMANDNAME;</command>
100
 
      <arg choice="plain"><option>--check</option></arg>
 
106
      <arg choice="plain">--check</arg>
101
107
    </cmdsynopsis>
102
108
  </refsynopsisdiv>
103
109
 
127
133
      <emphasis>encrypted root file system</emphasis>.  See <xref
128
134
      linkend="overview"/> for details.
129
135
    </para>
130
 
    
 
136
 
131
137
  </refsect1>
132
138
  
133
139
  <refsect1 id="options">
134
140
    <title>OPTIONS</title>
135
 
    
 
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"/>
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
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.
240
239
    <para>
241
240
      This program is the server part.  It is a normal server program
242
241
      and will run in a normal system environment, not in an initial
243
 
      <acronym>RAM</acronym> disk environment.
 
242
      RAM disk environment.
244
243
    </para>
245
244
  </refsect1>
246
245
 
338
337
    <title>ENVIRONMENT</title>
339
338
    <variablelist>
340
339
      <varlistentry>
341
 
        <term><envar>PATH</envar></term>
 
340
        <term><varname>PATH</varname></term>
342
341
        <listitem>
343
342
          <para>
344
343
            To start the configured checker (see <xref
449
448
        Normal invocation needs no options:
450
449
      </para>
451
450
      <para>
452
 
        <userinput>&COMMANDNAME;</userinput>
 
451
        <userinput>mandos</userinput>
453
452
      </para>
454
453
    </informalexample>
455
454
    <informalexample>
462
461
      <para>
463
462
 
464
463
<!-- do not wrap this line -->
465
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
464
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
466
465
 
467
466
      </para>
468
467
    </informalexample>
474
473
      <para>
475
474
 
476
475
<!-- do not wrap this line -->
477
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
476
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
478
477
 
479
478
      </para>
480
479
    </informalexample>
521
520
        restarting servers if it is suspected that a client has, in
522
521
        fact, been compromised by parties who may now be running a
523
522
        fake Mandos client with the keys from the non-encrypted
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
 
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
527
526
        configuration file to omit any suspect clients, and restart
528
527
        the server program.
529
528
      </para>
539
538
    <title>SEE ALSO</title>
540
539
    <para>
541
540
      <citerefentry>
 
541
        <refentrytitle>mandos.conf</refentrytitle>
 
542
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
542
543
        <refentrytitle>mandos-clients.conf</refentrytitle>
543
544
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
544
 
        <refentrytitle>mandos.conf</refentrytitle>
545
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
545
        <refentrytitle>password-request</refentrytitle>
547
546
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
548
547
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
573
572
      </varlistentry>
574
573
      <varlistentry>
575
574
        <term>
576
 
          <ulink url="http://www.gnu.org/software/gnutls/"
577
 
          >GnuTLS</ulink>
 
575
          <ulink
 
576
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
578
577
        </term>
579
578
      <listitem>
580
579
        <para>
586
585
      </varlistentry>
587
586
      <varlistentry>
588
587
        <term>
589
 
          RFC 4291: <citetitle>IP Version 6 Addressing
590
 
          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>
591
591
        </term>
592
592
        <listitem>
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>
 
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>
617
599
        </listitem>
618
600
      </varlistentry>
619
601
      <varlistentry>
620
602
        <term>
621
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
622
 
          Protocol Version 1.1</citetitle>
 
603
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
604
          (TLS) Protocol Version 1.1</citetitle></citation>
623
605
        </term>
624
606
      <listitem>
625
607
        <para>
629
611
      </varlistentry>
630
612
      <varlistentry>
631
613
        <term>
632
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
614
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
615
          Format</citetitle></citation>
633
616
        </term>
634
617
      <listitem>
635
618
        <para>
639
622
      </varlistentry>
640
623
      <varlistentry>
641
624
        <term>
642
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
643
 
          Security</citetitle>
 
625
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
626
          Transport Layer Security</citetitle></citation>
644
627
        </term>
645
628
      <listitem>
646
629
        <para>
652
635
    </variablelist>
653
636
  </refsect1>
654
637
</refentry>
655
 
<!-- Local Variables: -->
656
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
657
 
<!-- time-stamp-end: "[\"']>" -->
658
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
659
 
<!-- End: -->