/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-08-17 06:01:58 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080817060158-o5xakkih6t3br9yq
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
            GPGME_CFLAGS, GPGME_LIBS): New; use libgnutls-config,
                                       pkg-config, and gpgme-config to
                                       get the correct compiler and
                                       linker flags.
  (MANPOST): New post-processing stage to man pages to fix a bug with
             having "\n" in the DocBook pages.
  (objects): Use $(addsuffix) instead of a for loop in a subshell.
  (plugin-runner, plugins.d/password-prompt): Removed; targets no
                                              longer necessary.
  (.PHONY): Added "doc".

* mandos.xml: Much improved.

* plugins.d/password-request.xml: Improved SEE ALSO section.

Show diffs side-by-side

added added

removed removed

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