/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-03 05:04:40 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903050440-7cwzxestx6pvdy1i
* Makefile (mandos.8): Add dependency on "overview.xml" and
                       "legalnotice.xml".
  (mandos-keygen.8): New target.
  (mandos-conf.5): Added dependency on "legalnotice.xml".
  (plugin-runner.8mandos): New target
  (plugins.d/password-request.8mandos): - '' -

* mandos-options.xml (priority): Make wording server/client neutral.

* plugins.d/password-request.c (main): Changed .arg fields of the argp
                                       options struct to be more
                                       consistent with the manual.

* plugins.d/password-request.xml (OVERVIEW): Moved to after "OPTIONS".
  (OPTIONS): Improved wording and names of replaceables.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
1
 
<?xml version='1.0' encoding='UTF-8'?>
2
 
<?xml-stylesheet type="text/xsl"
3
 
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
 
1
<?xml version="1.0" encoding="UTF-8"?>
4
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
 
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
4
<!ENTITY VERSION "1.0">
7
5
<!ENTITY COMMANDNAME "mandos">
 
6
<!ENTITY TIMESTAMP "2008-09-02">
8
7
]>
9
8
 
10
 
<refentry>
 
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
10
  <refentryinfo>
12
 
    <title>&COMMANDNAME;</title>
13
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
14
 
    <productname>&COMMANDNAME;</productname>
 
11
    <title>Mandos Manual</title>
 
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
 
13
    <productname>Mandos</productname>
15
14
    <productnumber>&VERSION;</productnumber>
 
15
    <date>&TIMESTAMP;</date>
16
16
    <authorgroup>
17
17
      <author>
18
18
        <firstname>Björn</firstname>
34
34
      <holder>Teddy Hogeborn</holder>
35
35
      <holder>Björn Påhlsson</holder>
36
36
    </copyright>
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>
 
37
    <xi:include href="legalnotice.xml"/>
60
38
  </refentryinfo>
61
39
 
62
40
  <refmeta>
67
45
  <refnamediv>
68
46
    <refname><command>&COMMANDNAME;</command></refname>
69
47
    <refpurpose>
70
 
      Sends encrypted passwords to authenticated Mandos clients
 
48
      Gives encrypted passwords to authenticated Mandos clients
71
49
    </refpurpose>
72
50
  </refnamediv>
73
51
 
74
52
  <refsynopsisdiv>
75
53
    <cmdsynopsis>
76
54
      <command>&COMMANDNAME;</command>
77
 
      <arg choice='opt'>--interface<arg choice='plain'>IF</arg></arg>
78
 
      <arg choice='opt'>--address<arg choice='plain'>ADDRESS</arg></arg>
79
 
      <arg choice='opt'>--port<arg choice='plain'>PORT</arg></arg>
80
 
      <arg choice='opt'>--priority<arg choice='plain'>PRIORITY</arg></arg>
81
 
      <arg choice='opt'>--servicename<arg choice='plain'>NAME</arg></arg>
82
 
      <arg choice='opt'>--configdir<arg choice='plain'>DIRECTORY</arg></arg>
83
 
      <arg choice='opt'>--debug</arg>
84
 
    </cmdsynopsis>
85
 
    <cmdsynopsis>
86
 
      <command>&COMMANDNAME;</command>
87
 
      <arg choice='opt'>-i<arg choice='plain'>IF</arg></arg>
88
 
      <arg choice='opt'>-a<arg choice='plain'>ADDRESS</arg></arg>
89
 
      <arg choice='opt'>-p<arg choice='plain'>PORT</arg></arg>
90
 
      <arg choice='opt'>--priority<arg choice='plain'>PRIORITY</arg></arg>
91
 
      <arg choice='opt'>--servicename<arg choice='plain'>NAME</arg></arg>
92
 
      <arg choice='opt'>--configdir<arg choice='plain'>DIRECTORY</arg></arg>
93
 
      <arg choice='opt'>--debug</arg>
94
 
    </cmdsynopsis>
95
 
    <cmdsynopsis>
96
 
      <command>&COMMANDNAME;</command>
97
 
      <arg choice='plain'>--help</arg>
98
 
    </cmdsynopsis>
99
 
    <cmdsynopsis>
100
 
      <command>&COMMANDNAME;</command>
101
 
      <arg choice='plain'>--version</arg>
102
 
    </cmdsynopsis>
103
 
    <cmdsynopsis>
104
 
      <command>&COMMANDNAME;</command>
105
 
      <arg choice='plain'>--check</arg>
106
 
    </cmdsynopsis>    
 
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>
 
86
    </cmdsynopsis>
 
87
    <cmdsynopsis>
 
88
      <command>&COMMANDNAME;</command>
 
89
      <group choice="req">
 
90
        <arg choice="plain"><option>--help</option></arg>
 
91
        <arg choice="plain"><option>-h</option></arg>
 
92
      </group>
 
93
    </cmdsynopsis>
 
94
    <cmdsynopsis>
 
95
      <command>&COMMANDNAME;</command>
 
96
      <arg choice="plain"><option>--version</option></arg>
 
97
    </cmdsynopsis>
 
98
    <cmdsynopsis>
 
99
      <command>&COMMANDNAME;</command>
 
100
      <arg choice="plain"><option>--check</option></arg>
 
101
    </cmdsynopsis>
107
102
  </refsynopsisdiv>
108
103
 
109
104
  <refsect1 id="description">
112
107
      <command>&COMMANDNAME;</command> is a server daemon which
113
108
      handles incoming request for passwords for a pre-defined list of
114
109
      client host computers.  The Mandos server uses Zeroconf to
115
 
      announce itself on the local network, and uses GnuTLS to
116
 
      communicate securely with and to authenticate the clients.
117
 
      Mandos uses IPv6 link-local addresses, since the clients are
118
 
      assumed to not have any other addresses configured yet.  Any
119
 
      authenticated client is then given the pre-encrypted password
120
 
      for that specific client.
 
110
      announce itself on the local network, and uses TLS to
 
111
      communicate securely with and to authenticate the clients.  The
 
112
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
 
113
      link-local addresses, since the clients will probably not have
 
114
      any other addresses configured (see <xref linkend="overview"/>).
 
115
      Any authenticated client is then given the stored pre-encrypted
 
116
      password for that specific client.
121
117
    </para>
122
 
 
123
 
  </refsect1>  
 
118
  </refsect1>
124
119
  
125
120
  <refsect1 id="purpose">
126
121
    <title>PURPOSE</title>
127
 
 
128
122
    <para>
129
123
      The purpose of this is to enable <emphasis>remote and unattended
130
 
      rebooting</emphasis> of any client host computer with an
131
 
      <emphasis>encrypted root file system</emphasis>.  The client
132
 
      host computer should start a Mandos client in the initial RAM
133
 
      disk environment, the Mandos client program communicates with
134
 
      this server program to get an encrypted password, which is then
135
 
      decrypted and used to unlock the encrypted root file system.
136
 
      The client host computer can then continue its boot sequence
137
 
      normally.
 
124
      rebooting</emphasis> of client host computer with an
 
125
      <emphasis>encrypted root file system</emphasis>.  See <xref
 
126
      linkend="overview"/> for details.
138
127
    </para>
139
 
 
140
 
  </refsect1>  
 
128
  </refsect1>
141
129
  
142
130
  <refsect1 id="options">
143
131
    <title>OPTIONS</title>
144
 
 
145
132
    <variablelist>
146
133
      <varlistentry>
147
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
134
        <term><option>--help</option></term>
 
135
        <term><option>-h</option></term>
148
136
        <listitem>
149
137
          <para>
150
138
            Show a help message and exit
151
139
          </para>
152
140
        </listitem>
153
141
      </varlistentry>
154
 
 
155
 
      <varlistentry>
156
 
        <term><literal>-i</literal>, <literal>--interface <replaceable>
157
 
        IF</replaceable></literal></term>
158
 
        <listitem>
159
 
          <para>
160
 
            Only announce the server and listen to requests on network
161
 
            interface <replaceable>IF</replaceable>.  Default is to
162
 
            use all available interfaces.
163
 
          </para>
164
 
        </listitem>
165
 
      </varlistentry>      
166
 
 
167
 
      <varlistentry>
168
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
169
 
        ADDRESS</replaceable></literal></term>
170
 
        <listitem>
171
 
          <para>
172
 
            If this option is used, the server will only listen to a
173
 
            specific address.  This must currently be an IPv6 address;
174
 
            an IPv4 address can be specified using the
175
 
            "<literal>::FFFF:192.0.2.3</literal>" syntax.  Also, if a
176
 
            link-local address is specified, an interface should be
177
 
            set, since a link-local address is only valid on a single
178
 
            interface.  By default, the server will listen to all
179
 
            available addresses.
180
 
          </para>
181
 
        </listitem>
182
 
      </varlistentry>          
183
 
 
184
 
      <varlistentry>
185
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
186
 
        PORT</replaceable></literal></term>
187
 
        <listitem>
188
 
          <para>
189
 
            If this option is used, the server to bind to that
190
 
            port. By default, the server will listen to an arbitrary
191
 
            port given by the operating system.
192
 
          </para>
193
 
        </listitem>
194
 
      </varlistentry>          
195
 
 
196
 
      <varlistentry>
197
 
        <term><literal>--check</literal></term>
198
 
        <listitem>
199
 
          <para>
200
 
            Run the server's self-tests.  This includes any unit
 
142
      
 
143
      <varlistentry>
 
144
        <term><option>--interface</option>
 
145
        <replaceable>NAME</replaceable></term>
 
146
        <term><option>-i</option>
 
147
        <replaceable>NAME</replaceable></term>
 
148
        <listitem>
 
149
          <xi:include href="mandos-options.xml" xpointer="interface"/>
 
150
        </listitem>
 
151
      </varlistentry>
 
152
      
 
153
      <varlistentry>
 
154
        <term><option>--address
 
155
        <replaceable>ADDRESS</replaceable></option></term>
 
156
        <term><option>-a
 
157
        <replaceable>ADDRESS</replaceable></option></term>
 
158
        <listitem>
 
159
          <xi:include href="mandos-options.xml" xpointer="address"/>
 
160
        </listitem>
 
161
      </varlistentry>
 
162
      
 
163
      <varlistentry>
 
164
        <term><option>--port
 
165
        <replaceable>PORT</replaceable></option></term>
 
166
        <term><option>-p
 
167
        <replaceable>PORT</replaceable></option></term>
 
168
        <listitem>
 
169
          <xi:include href="mandos-options.xml" xpointer="port"/>
 
170
        </listitem>
 
171
      </varlistentry>
 
172
      
 
173
      <varlistentry>
 
174
        <term><option>--check</option></term>
 
175
        <listitem>
 
176
          <para>
 
177
            Run the server’s self-tests.  This includes any unit
201
178
            tests, etc.
202
179
          </para>
203
180
        </listitem>
204
 
      </varlistentry>      
205
 
 
206
 
      <varlistentry>
207
 
        <term><literal>--debug</literal></term>
208
 
        <listitem>
209
 
          <para>
210
 
            If the server is run in debug mode, it will run in the
211
 
            foreground and print a lot of debugging information.  The
212
 
            default is <emphasis>not</emphasis> to run in debug mode.
213
 
          </para>
214
 
        </listitem>
215
 
      </varlistentry>
216
 
 
217
 
      <varlistentry>
218
 
        <term><literal>--priority <replaceable>
219
 
        PRIORITY</replaceable></literal></term>
220
 
        <listitem>
221
 
          <para>
222
 
            GnuTLS priority string for the TLS handshake with the
223
 
            clients.  See
224
 
            <citerefentry><refentrytitle>gnutls_priority_init
225
 
            </refentrytitle><manvolnum>3</manvolnum></citerefentry>
226
 
            for the syntax.  The default is
227
 
            "<literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal>".
228
 
            <emphasis>Warning</emphasis>: changing this may make the
229
 
            TLS handshake fail, making communication with clients
230
 
            impossible.
231
 
          </para>
232
 
        </listitem>
233
 
      </varlistentry>      
234
 
 
235
 
      <varlistentry>
236
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
237
 
        </literal></term>
238
 
        <listitem>
239
 
          <para>
240
 
            Zeroconf service name.  The default is
241
 
            "<literal>Mandos</literal>".  You only need to change this
242
 
            if you for some reason want to run more than one server on
243
 
            the same <emphasis>host</emphasis>.  If there are name
244
 
            collisions on the same <emphasis>network</emphasis>, the
245
 
            new server will automatically rename itself to "Mandos
246
 
            #2", etc.
247
 
          </para>
248
 
        </listitem>
249
 
      </varlistentry>     
250
 
 
251
 
      <varlistentry>
252
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
253
 
        </literal></term>
 
181
      </varlistentry>
 
182
      
 
183
      <varlistentry>
 
184
        <term><option>--debug</option></term>
 
185
        <listitem>
 
186
          <xi:include href="mandos-options.xml" xpointer="debug"/>
 
187
        </listitem>
 
188
      </varlistentry>
 
189
 
 
190
      <varlistentry>
 
191
        <term><option>--priority <replaceable>
 
192
        PRIORITY</replaceable></option></term>
 
193
        <listitem>
 
194
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
195
        </listitem>
 
196
      </varlistentry>
 
197
 
 
198
      <varlistentry>
 
199
        <term><option>--servicename
 
200
        <replaceable>NAME</replaceable></option></term>
 
201
        <listitem>
 
202
          <xi:include href="mandos-options.xml"
 
203
                      xpointer="servicename"/>
 
204
        </listitem>
 
205
      </varlistentry>
 
206
 
 
207
      <varlistentry>
 
208
        <term><option>--configdir
 
209
        <replaceable>DIRECTORY</replaceable></option></term>
254
210
        <listitem>
255
211
          <para>
256
212
            Directory to search for configuration files.  Default is
257
 
            "<literal>/etc/mandos</literal>".  See <citerefentry>
258
 
            <refentrytitle>mandos.conf</refentrytitle>
 
213
            <quote><literal>/etc/mandos</literal></quote>.  See
 
214
            <citerefentry><refentrytitle>mandos.conf</refentrytitle>
259
215
            <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
260
216
            <refentrytitle>mandos-clients.conf</refentrytitle>
261
217
            <manvolnum>5</manvolnum></citerefentry>.
264
220
      </varlistentry>
265
221
 
266
222
      <varlistentry>
267
 
        <term><literal>--version</literal></term>
 
223
        <term><option>--version</option></term>
268
224
        <listitem>
269
225
          <para>
270
226
            Prints the program version and exit.
271
227
          </para>
272
228
        </listitem>
273
 
      </varlistentry>      
 
229
      </varlistentry>
274
230
    </variablelist>
275
231
  </refsect1>
276
232
 
 
233
  <refsect1 id="overview">
 
234
    <title>OVERVIEW</title>
 
235
    <xi:include href="overview.xml"/>
 
236
    <para>
 
237
      This program is the server part.  It is a normal server program
 
238
      and will run in a normal system environment, not in an initial
 
239
      <acronym>RAM</acronym> disk environment.
 
240
    </para>
 
241
  </refsect1>
 
242
 
277
243
  <refsect1 id="protocol">
278
244
    <title>NETWORK PROTOCOL</title>
279
245
    <para>
280
246
      The Mandos server announces itself as a Zeroconf service of type
281
 
      "<literal>_mandos._tcp</literal>".  The Mandos client connects
282
 
      to the announced address and port, and sends a line of text
283
 
      where the first whitespace-separated field is the protocol
284
 
      version, which currently is "<literal>1</literal>".  The client
285
 
      and server then start a TLS protocol handshake with a slight
286
 
      quirk: the Mandos server program acts as a TLS "client" while
287
 
      the connecting Mandos client acts as a TLS "server".  The Mandos
288
 
      client must supply an OpenPGP certificate, and the fingerprint
289
 
      of this certificate is used by the Mandos server to look up (in
290
 
      a list read from a file at start time) which binary blob to give
291
 
      the client.  No other authentication or authorization is done by
292
 
      the server.
 
247
      <quote><literal>_mandos._tcp</literal></quote>.  The Mandos
 
248
      client connects to the announced address and port, and sends a
 
249
      line of text where the first whitespace-separated field is the
 
250
      protocol version, which currently is
 
251
      <quote><literal>1</literal></quote>.  The client and server then
 
252
      start a TLS protocol handshake with a slight quirk: the Mandos
 
253
      server program acts as a TLS <quote>client</quote> while the
 
254
      connecting Mandos client acts as a TLS <quote>server</quote>.
 
255
      The Mandos client must supply an OpenPGP certificate, and the
 
256
      fingerprint of this certificate is used by the Mandos server to
 
257
      look up (in a list read from <filename>clients.conf</filename>
 
258
      at start time) which binary blob to give the client.  No other
 
259
      authentication or authorization is done by the server.
293
260
    </para>
294
 
    <informaltable><tgroup cols="3"><thead>
 
261
    <table>
 
262
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
295
263
      <row>
296
264
        <entry>Mandos Client</entry>
297
265
        <entry>Direction</entry>
303
271
        <entry>-><!-- &rarr; --></entry>
304
272
      </row>
305
273
      <row>
306
 
        <entry>"<literal>1\r\en</literal>"</entry>
 
274
        <entry><quote><literal>1\r\n</literal></quote></entry>
307
275
        <entry>-><!-- &rarr; --></entry>
308
276
      </row>
309
277
      <row>
310
 
        <entry>TLS handshake</entry>
 
278
        <entry>TLS handshake <emphasis>as TLS <quote>server</quote>
 
279
        </emphasis></entry>
311
280
        <entry>&lt;-><!-- &xharr; --></entry>
312
 
        <entry>TLS handshake</entry>
 
281
        <entry>TLS handshake <emphasis>as TLS <quote>client</quote>
 
282
        </emphasis></entry>
313
283
      </row>
314
284
      <row>
315
285
        <entry>OpenPGP public key (part of TLS handshake)</entry>
318
288
      <row>
319
289
        <entry/>
320
290
        <entry>&lt;-<!-- &larr; --></entry>
321
 
        <entry>Binary blob</entry>
 
291
        <entry>Binary blob (client will assume OpenPGP data)</entry>
322
292
      </row>
323
293
      <row>
324
294
        <entry/>
325
295
        <entry>&lt;-<!-- &larr; --></entry>
326
296
        <entry>Close</entry>
327
297
      </row>
328
 
    </tbody></tgroup></informaltable>
 
298
    </tbody></tgroup></table>
 
299
  </refsect1>
 
300
 
 
301
  <refsect1 id="checking">
 
302
    <title>CHECKING</title>
 
303
    <para>
 
304
      The server will, by default, continually check that the clients
 
305
      are still up.  If a client has not been confirmed as being up
 
306
      for some time, the client is assumed to be compromised and is no
 
307
      longer eligible to receive the encrypted password.  The timeout,
 
308
      checker program, and interval between checks can be configured
 
309
      both globally and per client; see <citerefentry>
 
310
      <refentrytitle>mandos-clients.conf</refentrytitle>
 
311
      <manvolnum>5</manvolnum></citerefentry>.
 
312
    </para>
329
313
  </refsect1>
330
314
 
331
315
  <refsect1 id="logging">
332
316
    <title>LOGGING</title>
333
317
    <para>
334
 
      The server will log a lot of information with various severity
335
 
      levels to
336
 
      <citerefentry><refentrytitle>syslog</refentrytitle>
337
 
      <manvolnum>8</manvolnum></citerefentry>.  With the
 
318
      The server will send log message with various severity levels to
 
319
      <filename>/dev/log</filename>.  With the
338
320
      <option>--debug</option> option, it will log even more messages,
339
321
      and also show them on the console.
340
322
    </para>
348
330
    </para>
349
331
  </refsect1>
350
332
 
 
333
  <refsect1 id="environment">
 
334
    <title>ENVIRONMENT</title>
 
335
    <variablelist>
 
336
      <varlistentry>
 
337
        <term><envar>PATH</envar></term>
 
338
        <listitem>
 
339
          <para>
 
340
            To start the configured checker (see <xref
 
341
            linkend="checking"/>), the server uses
 
342
            <filename>/bin/sh</filename>, which in turn uses
 
343
            <varname>PATH</varname> to search for matching commands if
 
344
            an absolute path is not given.  See <citerefentry>
 
345
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
346
            </citerefentry>.
 
347
          </para>
 
348
        </listitem>
 
349
      </varlistentry>
 
350
    </variablelist>
 
351
  </refsect1>
 
352
 
351
353
  <refsect1 id="file">
352
354
    <title>FILES</title>
353
355
    <para>
354
 
      <itemizedlist>
355
 
        <listitem><para>
356
 
          <filename>/etc/mandos/mandos.conf</filename>  See <citerefentry>
357
 
            <refentrytitle>mandos.conf</refentrytitle>
358
 
            <manvolnum>5</manvolnum></citerefentry>.
359
 
        </para></listitem>
360
 
        <listitem><para>
361
 
          <filename>/etc/mandos/clients.conf</filename> See <citerefentry>
 
356
      Use the <option>--configdir</option> option to change where
 
357
      <command>&COMMANDNAME;</command> looks for its configurations
 
358
      files.  The default file names are listed here.
 
359
    </para>
 
360
    <variablelist>
 
361
      <varlistentry>
 
362
        <term><filename>/etc/mandos/mandos.conf</filename></term>
 
363
        <listitem>
 
364
          <para>
 
365
            Server-global settings.  See
 
366
            <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
367
            <manvolnum>5</manvolnum></citerefentry> for details.
 
368
          </para>
 
369
        </listitem>
 
370
      </varlistentry>
 
371
      <varlistentry>
 
372
        <term><filename>/etc/mandos/clients.conf</filename></term>
 
373
        <listitem>
 
374
          <para>
 
375
            List of clients and client-specific settings.  See
 
376
            <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
377
            <manvolnum>5</manvolnum></citerefentry> for details.
 
378
          </para>
 
379
        </listitem>
 
380
      </varlistentry>
 
381
      <varlistentry>
 
382
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
383
        <listitem>
 
384
          <para>
 
385
            The file containing the process id of
 
386
            <command>&COMMANDNAME;</command>.
 
387
          </para>
 
388
        </listitem>
 
389
      </varlistentry>
 
390
      <varlistentry>
 
391
        <term><filename>/dev/log</filename></term>
 
392
        <listitem>
 
393
          <para>
 
394
            The Unix domain socket to where local syslog messages are
 
395
            sent.
 
396
          </para>
 
397
        </listitem>
 
398
      </varlistentry>
 
399
      <varlistentry>
 
400
        <term><filename>/bin/sh</filename></term>
 
401
        <listitem>
 
402
          <para>
 
403
            This is used to start the configured checker command for
 
404
            each client.  See <citerefentry>
362
405
            <refentrytitle>mandos-clients.conf</refentrytitle>
363
 
            <manvolnum>5</manvolnum></citerefentry>.
364
 
        </para></listitem>
365
 
        <listitem><para>
366
 
          <filename>/var/run/mandos/mandos.pid</filename>
367
 
        </para></listitem>
368
 
      </itemizedlist>
369
 
    </para>
370
 
  </refsect1>  
371
 
 
 
406
            <manvolnum>5</manvolnum></citerefentry> for details.
 
407
          </para>
 
408
        </listitem>
 
409
      </varlistentry>
 
410
    </variablelist>
 
411
  </refsect1>
 
412
  
372
413
  <refsect1 id="bugs">
373
414
    <title>BUGS</title>
374
415
    <para>
375
 
    </para>
376
 
  </refsect1>  
377
 
 
378
 
  <refsect1 id="examples">
379
 
    <title>EXAMPLES</title>
380
 
    <para>
381
 
    </para>
 
416
      This server might, on especially fatal errors, emit a Python
 
417
      backtrace.  This could be considered a feature.
 
418
    </para>
 
419
    <para>
 
420
      Currently, if a client is declared <quote>invalid</quote> due to
 
421
      having timed out, the server does not record this fact onto
 
422
      permanent storage.  This has some security implications, see
 
423
      <xref linkend="CLIENTS"/>.
 
424
    </para>
 
425
    <para>
 
426
      There is currently no way of querying the server of the current
 
427
      status of clients, other than analyzing its <systemitem
 
428
      class="service">syslog</systemitem> output.
 
429
    </para>
 
430
    <para>
 
431
      There is no fine-grained control over logging and debug output.
 
432
    </para>
 
433
    <para>
 
434
      Debug mode is conflated with running in the foreground.
 
435
    </para>
 
436
    <para>
 
437
      The console log messages does not show a timestamp.
 
438
    </para>
 
439
  </refsect1>
 
440
  
 
441
  <refsect1 id="example">
 
442
    <title>EXAMPLE</title>
 
443
    <informalexample>
 
444
      <para>
 
445
        Normal invocation needs no options:
 
446
      </para>
 
447
      <para>
 
448
        <userinput>&COMMANDNAME;</userinput>
 
449
      </para>
 
450
    </informalexample>
 
451
    <informalexample>
 
452
      <para>
 
453
        Run the server in debug mode, read configuration files from
 
454
        the <filename>~/mandos</filename> directory, and use the
 
455
        Zeroconf service name <quote>Test</quote> to not collide with
 
456
        any other official Mandos server on this host:
 
457
      </para>
 
458
      <para>
 
459
 
 
460
<!-- do not wrap this line -->
 
461
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
462
 
 
463
      </para>
 
464
    </informalexample>
 
465
    <informalexample>
 
466
      <para>
 
467
        Run the server normally, but only listen to one interface and
 
468
        only on the link-local address on that interface:
 
469
      </para>
 
470
      <para>
 
471
 
 
472
<!-- do not wrap this line -->
 
473
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
474
 
 
475
      </para>
 
476
    </informalexample>
382
477
  </refsect1>
383
478
 
384
479
  <refsect1 id="security">
385
480
    <title>SECURITY</title>
386
 
    <para>
387
 
    </para>
 
481
    <refsect2 id="SERVER">
 
482
      <title>SERVER</title>
 
483
      <para>
 
484
        Running this <command>&COMMANDNAME;</command> server program
 
485
        should not in itself present any security risk to the host
 
486
        computer running it.  The program does not need any special
 
487
        privileges to run, and is designed to run as a non-root user.
 
488
      </para>
 
489
    </refsect2>
 
490
    <refsect2 id="CLIENTS">
 
491
      <title>CLIENTS</title>
 
492
      <para>
 
493
        The server only gives out its stored data to clients which
 
494
        does have the OpenPGP key of the stored fingerprint.  This is
 
495
        guaranteed by the fact that the client sends its OpenPGP
 
496
        public key in the TLS handshake; this ensures it to be
 
497
        genuine.  The server computes the fingerprint of the key
 
498
        itself and looks up the fingerprint in its list of
 
499
        clients. The <filename>clients.conf</filename> file (see
 
500
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
501
        <manvolnum>5</manvolnum></citerefentry>)
 
502
        <emphasis>must</emphasis> be made non-readable by anyone
 
503
        except the user running the server.
 
504
      </para>
 
505
      <para>
 
506
        As detailed in <xref linkend="checking"/>, the status of all
 
507
        client computers will continually be checked and be assumed
 
508
        compromised if they are gone for too long.
 
509
      </para>
 
510
      <para>
 
511
        If a client is compromised, its downtime should be duly noted
 
512
        by the server which would therefore declare the client
 
513
        invalid.  But if the server was ever restarted, it would
 
514
        re-read its client list from its configuration file and again
 
515
        regard all clients therein as valid, and hence eligible to
 
516
        receive their passwords.  Therefore, be careful when
 
517
        restarting servers if it is suspected that a client has, in
 
518
        fact, been compromised by parties who may now be running a
 
519
        fake Mandos client with the keys from the non-encrypted
 
520
        initial <acronym>RAM</acronym> image of the client host.  What
 
521
        should be done in that case (if restarting the server program
 
522
        really is necessary) is to stop the server program, edit the
 
523
        configuration file to omit any suspect clients, and restart
 
524
        the server program.
 
525
      </para>
 
526
      <para>
 
527
        For more details on client-side security, see
 
528
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
529
        <manvolnum>8mandos</manvolnum></citerefentry>.
 
530
      </para>
 
531
    </refsect2>
388
532
  </refsect1>
389
533
 
390
534
  <refsect1 id="see_also">
391
535
    <title>SEE ALSO</title>
392
 
    <itemizedlist spacing="compact">
393
 
      <listitem><para>
394
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
395
 
        <manvolnum>8mandos</manvolnum></citerefentry>
396
 
      </para></listitem>
397
 
      
398
 
      <listitem><para>
399
 
        <citerefentry><refentrytitle>plugin-runner</refentrytitle>
400
 
        <manvolnum>8mandos</manvolnum></citerefentry>
401
 
      </para></listitem>
402
 
      
403
 
      <listitem><para>
404
 
        <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
405
 
      </para></listitem>
406
 
      
407
 
      <listitem><para>
408
 
        <ulink url="http://www.avahi.org/">Avahi</ulink>
409
 
      </para></listitem>
410
 
      
411
 
      <listitem><para>
412
 
        <ulink
413
 
            url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
414
 
      </para></listitem>
415
 
      
416
 
      <listitem><para>
417
 
        <citation>RFC 4880: <citetitle>OpenPGP Message
418
 
        Format</citetitle></citation>
419
 
      </para></listitem>
420
 
      
421
 
      <listitem><para>
422
 
        <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
423
 
        Transport Layer Security</citetitle></citation>
424
 
      </para></listitem>
425
 
      
426
 
      <listitem><para>
427
 
        <citation>RFC 4291: <citetitle>IP Version 6 Addressing
428
 
        Architecture</citetitle>, section 2.5.6, Link-Local IPv6
429
 
        Unicast Addresses</citation>
430
 
      </para></listitem>
431
 
    </itemizedlist>
 
536
    <para>
 
537
      <citerefentry>
 
538
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
539
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
540
        <refentrytitle>mandos.conf</refentrytitle>
 
541
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
542
        <refentrytitle>password-request</refentrytitle>
 
543
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
544
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
545
      </citerefentry>
 
546
    </para>
 
547
    <variablelist>
 
548
      <varlistentry>
 
549
        <term>
 
550
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
551
        </term>
 
552
        <listitem>
 
553
          <para>
 
554
            Zeroconf is the network protocol standard used by clients
 
555
            for finding this Mandos server on the local network.
 
556
          </para>
 
557
        </listitem>
 
558
      </varlistentry>
 
559
      <varlistentry>
 
560
        <term>
 
561
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
562
        </term>
 
563
      <listitem>
 
564
        <para>
 
565
          Avahi is the library this server calls to implement
 
566
          Zeroconf service announcements.
 
567
        </para>
 
568
      </listitem>
 
569
      </varlistentry>
 
570
      <varlistentry>
 
571
        <term>
 
572
          <ulink url="http://www.gnu.org/software/gnutls/"
 
573
          >GnuTLS</ulink>
 
574
        </term>
 
575
      <listitem>
 
576
        <para>
 
577
          GnuTLS is the library this server uses to implement TLS for
 
578
          communicating securely with the client, and at the same time
 
579
          confidently get the client’s public OpenPGP key.
 
580
        </para>
 
581
      </listitem>
 
582
      </varlistentry>
 
583
      <varlistentry>
 
584
        <term>
 
585
          RFC 4291: <citetitle>IP Version 6 Addressing
 
586
          Architecture</citetitle>
 
587
        </term>
 
588
        <listitem>
 
589
          <variablelist>
 
590
            <varlistentry>
 
591
              <term>Section 2.2: <citetitle>Text Representation of
 
592
              Addresses</citetitle></term>
 
593
              <listitem><para/></listitem>
 
594
            </varlistentry>
 
595
            <varlistentry>
 
596
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
597
              Address</citetitle></term>
 
598
              <listitem><para/></listitem>
 
599
            </varlistentry>
 
600
            <varlistentry>
 
601
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
602
            Addresses</citetitle></term>
 
603
            <listitem>
 
604
              <para>
 
605
                The clients use IPv6 link-local addresses, which are
 
606
                immediately usable since a link-local addresses is
 
607
                automatically assigned to a network interfaces when it
 
608
                is brought up.
 
609
              </para>
 
610
            </listitem>
 
611
            </varlistentry>
 
612
          </variablelist>
 
613
        </listitem>
 
614
      </varlistentry>
 
615
      <varlistentry>
 
616
        <term>
 
617
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
618
          Protocol Version 1.1</citetitle>
 
619
        </term>
 
620
      <listitem>
 
621
        <para>
 
622
          TLS 1.1 is the protocol implemented by GnuTLS.
 
623
        </para>
 
624
      </listitem>
 
625
      </varlistentry>
 
626
      <varlistentry>
 
627
        <term>
 
628
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
629
        </term>
 
630
      <listitem>
 
631
        <para>
 
632
          The data sent to clients is binary encrypted OpenPGP data.
 
633
        </para>
 
634
      </listitem>
 
635
      </varlistentry>
 
636
      <varlistentry>
 
637
        <term>
 
638
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
639
          Security</citetitle>
 
640
        </term>
 
641
      <listitem>
 
642
        <para>
 
643
          This is implemented by GnuTLS and used by this server so
 
644
          that OpenPGP keys can be used.
 
645
        </para>
 
646
      </listitem>
 
647
      </varlistentry>
 
648
    </variablelist>
432
649
  </refsect1>
433
650
</refentry>
 
651
<!-- Local Variables: -->
 
652
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
653
<!-- time-stamp-end: "[\"']>" -->
 
654
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
655
<!-- End: -->