/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-29 07:30:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829073017-tvryowganbf75zp5
* mandos-clients.conf.xml (SEE ALSO): Alphabetized, as per
                                      man-pages(7).
* mandos-keygen.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* plugin-runner.xml: - '' -
* plugins.d/password-request.xml (SEE ALSO): Changed from an
                                             <itemizedlist> to a
                                             <para>, as per
                                             man-pages(7).  Also
                                             alphabetize.

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 "2008-10-03">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-08-29">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
   <refentryinfo>
 
10
  <refentryinfo>
12
11
    <title>Mandos Manual</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
35
34
      <holder>Teddy Hogeborn</holder>
36
35
      <holder>Björn Påhlsson</holder>
37
36
    </copyright>
38
 
    <xi:include href="legalnotice.xml"/>
 
37
    <legalnotice>
 
38
      <para>
 
39
        This manual page is free software: you can redistribute it
 
40
        and/or modify it under the terms of the GNU General Public
 
41
        License as published by the Free Software Foundation,
 
42
        either version 3 of the License, or (at your option) any
 
43
        later version.
 
44
      </para>
 
45
 
 
46
      <para>
 
47
        This manual page is distributed in the hope that it will
 
48
        be useful, but WITHOUT ANY WARRANTY; without even the
 
49
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
50
        PARTICULAR PURPOSE.  See the GNU General Public License
 
51
        for more details.
 
52
      </para>
 
53
 
 
54
      <para>
 
55
        You should have received a copy of the GNU General Public
 
56
        License along with this program; If not, see
 
57
        <ulink url="http://www.gnu.org/licenses/"/>.
 
58
      </para>
 
59
    </legalnotice>
39
60
  </refentryinfo>
40
 
  
 
61
 
41
62
  <refmeta>
42
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
43
64
    <manvolnum>8</manvolnum>
46
67
  <refnamediv>
47
68
    <refname><command>&COMMANDNAME;</command></refname>
48
69
    <refpurpose>
49
 
      Gives encrypted passwords to authenticated Mandos clients
 
70
      Sends encrypted passwords to authenticated Mandos clients
50
71
    </refpurpose>
51
72
  </refnamediv>
52
 
  
 
73
 
53
74
  <refsynopsisdiv>
54
75
    <cmdsynopsis>
55
76
      <command>&COMMANDNAME;</command>
56
 
      <group>
57
 
        <arg choice="plain"><option>--interface
58
 
        <replaceable>NAME</replaceable></option></arg>
59
 
        <arg choice="plain"><option>-i
60
 
        <replaceable>NAME</replaceable></option></arg>
61
 
      </group>
62
 
      <sbr/>
63
 
      <group>
64
 
        <arg choice="plain"><option>--address
65
 
        <replaceable>ADDRESS</replaceable></option></arg>
66
 
        <arg choice="plain"><option>-a
67
 
        <replaceable>ADDRESS</replaceable></option></arg>
68
 
      </group>
69
 
      <sbr/>
70
 
      <group>
71
 
        <arg choice="plain"><option>--port
72
 
        <replaceable>PORT</replaceable></option></arg>
73
 
        <arg choice="plain"><option>-p
74
 
        <replaceable>PORT</replaceable></option></arg>
75
 
      </group>
76
 
      <sbr/>
77
 
      <arg><option>--priority
78
 
      <replaceable>PRIORITY</replaceable></option></arg>
79
 
      <sbr/>
80
 
      <arg><option>--servicename
81
 
      <replaceable>NAME</replaceable></option></arg>
82
 
      <sbr/>
83
 
      <arg><option>--configdir
84
 
      <replaceable>DIRECTORY</replaceable></option></arg>
85
 
      <sbr/>
86
 
      <arg><option>--debug</option></arg>
 
77
      <arg>--interface<arg choice="plain">NAME</arg></arg>
 
78
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
 
79
      <arg>--port<arg choice="plain">PORT</arg></arg>
 
80
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
 
81
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
 
82
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
83
      <arg>--debug</arg>
 
84
    </cmdsynopsis>
 
85
    <cmdsynopsis>
 
86
      <command>&COMMANDNAME;</command>
 
87
      <arg>-i<arg choice="plain">NAME</arg></arg>
 
88
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
 
89
      <arg>-p<arg choice="plain">PORT</arg></arg>
 
90
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
 
91
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
 
92
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
93
      <arg>--debug</arg>
87
94
    </cmdsynopsis>
88
95
    <cmdsynopsis>
89
96
      <command>&COMMANDNAME;</command>
90
97
      <group choice="req">
91
 
        <arg choice="plain"><option>--help</option></arg>
92
 
        <arg choice="plain"><option>-h</option></arg>
 
98
        <arg choice="plain">-h</arg>
 
99
        <arg choice="plain">--help</arg>
93
100
      </group>
94
101
    </cmdsynopsis>
95
102
    <cmdsynopsis>
96
103
      <command>&COMMANDNAME;</command>
97
 
      <arg choice="plain"><option>--version</option></arg>
 
104
      <arg choice="plain">--version</arg>
98
105
    </cmdsynopsis>
99
106
    <cmdsynopsis>
100
107
      <command>&COMMANDNAME;</command>
101
 
      <arg choice="plain"><option>--check</option></arg>
 
108
      <arg choice="plain">--check</arg>
102
109
    </cmdsynopsis>
103
110
  </refsynopsisdiv>
104
 
  
 
111
 
105
112
  <refsect1 id="description">
106
113
    <title>DESCRIPTION</title>
107
114
    <para>
116
123
      Any authenticated client is then given the stored pre-encrypted
117
124
      password for that specific client.
118
125
    </para>
 
126
 
119
127
  </refsect1>
120
128
  
121
129
  <refsect1 id="purpose">
122
130
    <title>PURPOSE</title>
 
131
 
123
132
    <para>
124
133
      The purpose of this is to enable <emphasis>remote and unattended
125
134
      rebooting</emphasis> of client host computer with an
126
135
      <emphasis>encrypted root file system</emphasis>.  See <xref
127
136
      linkend="overview"/> for details.
128
137
    </para>
 
138
 
129
139
  </refsect1>
130
140
  
131
141
  <refsect1 id="options">
132
142
    <title>OPTIONS</title>
 
143
 
133
144
    <variablelist>
134
145
      <varlistentry>
135
 
        <term><option>--help</option></term>
136
 
        <term><option>-h</option></term>
 
146
        <term><literal>-h</literal>, <literal>--help</literal></term>
137
147
        <listitem>
138
148
          <para>
139
149
            Show a help message and exit
140
150
          </para>
141
151
        </listitem>
142
152
      </varlistentry>
143
 
      
 
153
 
144
154
      <varlistentry>
145
 
        <term><option>--interface</option>
146
 
        <replaceable>NAME</replaceable></term>
147
 
        <term><option>-i</option>
148
 
        <replaceable>NAME</replaceable></term>
 
155
        <term><literal>-i</literal>, <literal>--interface <replaceable
 
156
        >NAME</replaceable></literal></term>
149
157
        <listitem>
150
158
          <xi:include href="mandos-options.xml" xpointer="interface"/>
151
159
        </listitem>
152
160
      </varlistentry>
153
 
      
 
161
 
154
162
      <varlistentry>
155
 
        <term><option>--address
156
 
        <replaceable>ADDRESS</replaceable></option></term>
157
 
        <term><option>-a
158
 
        <replaceable>ADDRESS</replaceable></option></term>
 
163
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
164
        ADDRESS</replaceable></literal></term>
159
165
        <listitem>
160
166
          <xi:include href="mandos-options.xml" xpointer="address"/>
161
167
        </listitem>
162
168
      </varlistentry>
163
 
      
 
169
 
164
170
      <varlistentry>
165
 
        <term><option>--port
166
 
        <replaceable>PORT</replaceable></option></term>
167
 
        <term><option>-p
168
 
        <replaceable>PORT</replaceable></option></term>
 
171
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
172
        PORT</replaceable></literal></term>
169
173
        <listitem>
170
174
          <xi:include href="mandos-options.xml" xpointer="port"/>
171
175
        </listitem>
172
176
      </varlistentry>
173
 
      
 
177
 
174
178
      <varlistentry>
175
 
        <term><option>--check</option></term>
 
179
        <term><literal>--check</literal></term>
176
180
        <listitem>
177
181
          <para>
178
182
            Run the server’s self-tests.  This includes any unit
180
184
          </para>
181
185
        </listitem>
182
186
      </varlistentry>
183
 
      
 
187
 
184
188
      <varlistentry>
185
 
        <term><option>--debug</option></term>
 
189
        <term><literal>--debug</literal></term>
186
190
        <listitem>
187
191
          <xi:include href="mandos-options.xml" xpointer="debug"/>
188
192
        </listitem>
189
193
      </varlistentry>
190
 
      
 
194
 
191
195
      <varlistentry>
192
 
        <term><option>--priority <replaceable>
193
 
        PRIORITY</replaceable></option></term>
 
196
        <term><literal>--priority <replaceable>
 
197
        PRIORITY</replaceable></literal></term>
194
198
        <listitem>
195
199
          <xi:include href="mandos-options.xml" xpointer="priority"/>
196
200
        </listitem>
197
201
      </varlistentry>
198
 
      
 
202
 
199
203
      <varlistentry>
200
 
        <term><option>--servicename
201
 
        <replaceable>NAME</replaceable></option></term>
 
204
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
205
        </literal></term>
202
206
        <listitem>
203
207
          <xi:include href="mandos-options.xml"
204
208
                      xpointer="servicename"/>
205
209
        </listitem>
206
210
      </varlistentry>
207
 
      
 
211
 
208
212
      <varlistentry>
209
 
        <term><option>--configdir
210
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
213
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
214
        </literal></term>
211
215
        <listitem>
212
216
          <para>
213
217
            Directory to search for configuration files.  Default is
219
223
          </para>
220
224
        </listitem>
221
225
      </varlistentry>
222
 
      
 
226
 
223
227
      <varlistentry>
224
 
        <term><option>--version</option></term>
 
228
        <term><literal>--version</literal></term>
225
229
        <listitem>
226
230
          <para>
227
231
            Prints the program version and exit.
230
234
      </varlistentry>
231
235
    </variablelist>
232
236
  </refsect1>
233
 
  
 
237
 
234
238
  <refsect1 id="overview">
235
239
    <title>OVERVIEW</title>
236
240
    <xi:include href="overview.xml"/>
237
241
    <para>
238
242
      This program is the server part.  It is a normal server program
239
243
      and will run in a normal system environment, not in an initial
240
 
      <acronym>RAM</acronym> disk environment.
 
244
      RAM disk environment.
241
245
    </para>
242
246
  </refsect1>
243
 
  
 
247
 
244
248
  <refsect1 id="protocol">
245
249
    <title>NETWORK PROTOCOL</title>
246
250
    <para>
298
302
      </row>
299
303
    </tbody></tgroup></table>
300
304
  </refsect1>
301
 
  
 
305
 
302
306
  <refsect1 id="checking">
303
307
    <title>CHECKING</title>
304
308
    <para>
312
316
      <manvolnum>5</manvolnum></citerefentry>.
313
317
    </para>
314
318
  </refsect1>
315
 
  
 
319
 
316
320
  <refsect1 id="logging">
317
321
    <title>LOGGING</title>
318
322
    <para>
322
326
      and also show them on the console.
323
327
    </para>
324
328
  </refsect1>
325
 
  
 
329
 
326
330
  <refsect1 id="exit_status">
327
331
    <title>EXIT STATUS</title>
328
332
    <para>
330
334
      critical error is encountered.
331
335
    </para>
332
336
  </refsect1>
333
 
  
 
337
 
334
338
  <refsect1 id="environment">
335
339
    <title>ENVIRONMENT</title>
336
340
    <variablelist>
337
341
      <varlistentry>
338
 
        <term><envar>PATH</envar></term>
 
342
        <term><varname>PATH</varname></term>
339
343
        <listitem>
340
344
          <para>
341
345
            To start the configured checker (see <xref
350
354
      </varlistentry>
351
355
    </variablelist>
352
356
  </refsect1>
353
 
  
354
 
  <refsect1 id="files">
 
357
 
 
358
  <refsect1 id="file">
355
359
    <title>FILES</title>
356
360
    <para>
357
361
      Use the <option>--configdir</option> option to change where
380
384
        </listitem>
381
385
      </varlistentry>
382
386
      <varlistentry>
383
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
387
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
384
388
        <listitem>
385
389
          <para>
386
390
            The file containing the process id of
421
425
      Currently, if a client is declared <quote>invalid</quote> due to
422
426
      having timed out, the server does not record this fact onto
423
427
      permanent storage.  This has some security implications, see
424
 
      <xref linkend="clients"/>.
 
428
      <xref linkend="CLIENTS"/>.
425
429
    </para>
426
430
    <para>
427
431
      There is currently no way of querying the server of the current
435
439
      Debug mode is conflated with running in the foreground.
436
440
    </para>
437
441
    <para>
438
 
      The console log messages does not show a time stamp.
439
 
    </para>
440
 
    <para>
441
 
      This server does not check the expire time of clients’ OpenPGP
442
 
      keys.
 
442
      The console log messages does not show a timestamp.
443
443
    </para>
444
444
  </refsect1>
445
445
  
480
480
      </para>
481
481
    </informalexample>
482
482
  </refsect1>
483
 
  
 
483
 
484
484
  <refsect1 id="security">
485
485
    <title>SECURITY</title>
486
 
    <refsect2 id="server">
 
486
    <refsect2 id="SERVER">
487
487
      <title>SERVER</title>
488
488
      <para>
489
489
        Running this <command>&COMMANDNAME;</command> server program
490
490
        should not in itself present any security risk to the host
491
 
        computer running it.  The program switches to a non-root user
492
 
        soon after startup.
 
491
        computer running it.  The program does not need any special
 
492
        privileges to run, and is designed to run as a non-root user.
493
493
      </para>
494
494
    </refsect2>
495
 
    <refsect2 id="clients">
 
495
    <refsect2 id="CLIENTS">
496
496
      <title>CLIENTS</title>
497
497
      <para>
498
498
        The server only gives out its stored data to clients which
505
505
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
506
506
        <manvolnum>5</manvolnum></citerefentry>)
507
507
        <emphasis>must</emphasis> be made non-readable by anyone
508
 
        except the user starting the server (usually root).
 
508
        except the user running the server.
509
509
      </para>
510
510
      <para>
511
511
        As detailed in <xref linkend="checking"/>, the status of all
522
522
        restarting servers if it is suspected that a client has, in
523
523
        fact, been compromised by parties who may now be running a
524
524
        fake Mandos client with the keys from the non-encrypted
525
 
        initial <acronym>RAM</acronym> image of the client host.  What
526
 
        should be done in that case (if restarting the server program
527
 
        really is necessary) is to stop the server program, edit the
 
525
        initial RAM image of the client host.  What should be done in
 
526
        that case (if restarting the server program really is
 
527
        necessary) is to stop the server program, edit the
528
528
        configuration file to omit any suspect clients, and restart
529
529
        the server program.
530
530
      </para>
531
531
      <para>
532
532
        For more details on client-side security, see
533
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
533
        <citerefentry><refentrytitle>password-request</refentrytitle>
534
534
        <manvolnum>8mandos</manvolnum></citerefentry>.
535
535
      </para>
536
536
    </refsect2>
537
537
  </refsect1>
538
 
  
 
538
 
539
539
  <refsect1 id="see_also">
540
540
    <title>SEE ALSO</title>
541
541
    <para>
544
544
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
545
        <refentrytitle>mandos.conf</refentrytitle>
546
546
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
547
 
        <refentrytitle>mandos-client</refentrytitle>
 
547
        <refentrytitle>password-request</refentrytitle>
548
548
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
549
549
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
550
550
      </citerefentry>