/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: 2019-02-09 23:23:26 UTC
  • Revision ID: teddy@recompile.se-20190209232326-z1z2kzpgfixz7iaj
Add support for using raw public keys in TLS (RFC 7250)

Since GnuTLS removed support for OpenPGP keys in TLS (RFC 6091), and
no other library supports it, we have to change the protocol to use
something else.  We choose to use "raw public keys" (RFC 7250).  Since
we still use OpenPGP keys to decrypt the secret password, this means
that each client will have two keys: One OpenPGP key and one TLS
public/private key, and the key ID of the latter key is used to
identify clients instead of the fingerprint of the OpenPGP key.

Note that this code is still compatible with GnuTLS before version
3.6.0 (when OpenPGP key support was removed).  This commit merely adds
support for using raw pulic keys instead with GnuTLS 3.6.6. or later.

* DBUS-API (Signals/ClientNotFound): Change name of first parameter
                                     from "Fingerprint" to "KeyID".
  (Mandos Client Interface/Properties/KeyID): New.
* INSTALL: Document conflict with GnuTLS 3.6.0 (which removed OpenPGP
           key support) up until 3.6.6, when support for raw public
           keys was added.  Also document new dependency of client on
           "gnutls-bin" package (for certtool).
* Makefile (run-client): Depend on TLS key files, and also pass them
                         as arguments to client.
  (keydir/tls-privkey.pem, keydir/tls-pubkey.pem): New.
  (confdir/clients.conf): Add dependency on TLS public key.
  (purge-client): Add removal of TLS key files.
* clients.conf ([foo]/key_id, [bar]/key_id): New.
* debian/control (Source: mandos/Build-Depends): Also allow
                                                 libgnutls30 (>= 3.6.6)
  (Package: mandos/Depends): - '' -
  (Package: mandos/Description): Alter description to match new
                                 design.
  (Package: mandos-client/Description): - '' -
  (Package: mandos-client/Depends): Move "gnutls-bin | openssl" to
                                    here from "Recommends".
* debian/mandos-client.README.Debian: Add --tls-privkey and
                                      --tls-pubkey options to test
                                      command.
* debian/mandos-client.postinst (create_key): Renamed to "create_keys"
                                             (all callers changed),
                                             and also create TLS key.
* debian/mandos-client.postrm (purge): Also remove TLS key files.
* intro.xml (DESCRIPTION): Describe new dual-key design.
* mandos (GnuTLS): Define different functions depending on whether
                   support for raw public keys is detected.
  (Client.key_id): New attribute.
  (ClientDBus.KeyID_dbus_property): New method.
  (ProxyClient.__init__): Take new "key_id" parameter.
  (ClientHandler.handle): Use key IDs when using raw public keys and
                          use fingerprints when using OpenPGP keys.
  (ClientHandler.peer_certificate): Also handle raw public keys.
  (ClientHandler.key_id): New.
  (MandosServer.handle_ipc): Pass key ID over the pipe IPC.  Also
                             check for key ID matches when looking up
                             clients.
  (main): Default GnuTLS priority string depends on whether we are
          using raw public keys or not.  When unpickling clients, set
          key_id if not set in the pickle.
  (main/MandosDBusService.ClientNotFound): Change name of first
                                           parameter from
                                           "Fingerprint" to "KeyID".
* mandos-clients.conf.xml (OPTIONS): Document new "key_id" option.
  (OPTIONS/secret): Mention new key ID matchning.
  (EXPANSION/RUNTIME EXPANSION): Add new "key_id" option.
  (EXAMPLE): - '' -
* mandos-ctl (tablewords, main/keywords): Add new "KeyID" property.
* mandos-keygen: Create TLS key files.  New "--tls-keytype" (-T)
                 option.  Alter help text to be more clear about key
                 types.  When in password mode, also output "key_id"
                 option.
* mandos-keygen.xml (SYNOPSIS): Add new "--tls-keytype" (-T) option.
  (DESCRIPTION): Alter to match new dual-key design.
  (OVERVIEW): - '' -
  (FILES): Add TLS key files.
* mandos-options.xml (priority): Document new default priority string
                                 when using raw public keys.
* mandos.xml (NETWORK PROTOCOL): Describe new protocol using key ID.
  (BUGS): Remove issue about checking expire times of OpenPGP keys,
          since TLS public keys do not have expiration times.
  (SECURITY/CLIENT): Alter description to match new design.
  (SEE ALSO/GnuTLS): - '' -
  (SEE ALSO): Add reference to RFC 7250, and alter description of when
              RFC 6091 is used.
* overview.xml: Alter text to match new design.
* plugin-runner.xml (EXAMPLE): Add --tls-pubkey and --tls-privkey
                               options to mandos-client options.
* plugins.d/mandos-client.c: Use raw public keys when compiling with
                             supporting GnuTLS versions. Add new
                             "--tls-pubkey" and "--tls-privkey"
                             options (which do nothing if GnuTLS
                             library does not support raw public
                             keys).  Alter text throughout to reflect
                             new design.  Only generate new DH
                             parameters (based on size of OpenPGP key)
                             when using OpenPGP in TLS.  Default
                             GnuTLS priority string depends on whether
                             we are using raw public keys or not.
* plugins.d/mandos-client.xml (SYNOPSIS): Add new "--tls-privkey" (-t)
                                          and "--tls-pubkey" (-T)
                                          options.
  (DESCRIPTION): Describe new dual-key design.
  (OPTIONS): Document new "--tls-privkey" (-t) and "--tls-pubkey" (-T)
             options.
  (OPTIONS/--dh-bits): No longer necessarily depends on OpenPGP key
                       size.
  (FILES): Add default locations for TLS public and private key files.
  (EXAMPLE): Use new --tls-pubkey and --tls-privkey options.
  (SECURITY): Alter wording slightly to reflect new dual-key design.
  (SEE ALSO/GnuTLS): Alter description to match new design.
  (SEE ALSO): Add reference to RFC 7250, and alter description of when
              RFC 6091 is used.

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">
5
4
<!ENTITY COMMANDNAME "mandos">
6
 
<!ENTITY OVERVIEW SYSTEM "overview.xml">
 
5
<!ENTITY TIMESTAMP "2019-02-09">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
7
8
]>
8
9
 
9
 
<refentry>
10
 
  <refentryinfo>
11
 
    <title>&COMMANDNAME;</title>
 
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
11
   <refentryinfo>
 
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>&COMMANDNAME;</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
14
    <productname>Mandos</productname>
 
15
    <productnumber>&version;</productnumber>
 
16
    <date>&TIMESTAMP;</date>
15
17
    <authorgroup>
16
18
      <author>
17
19
        <firstname>Björn</firstname>
18
20
        <surname>Påhlsson</surname>
19
21
        <address>
20
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
21
23
        </address>
22
24
      </author>
23
25
      <author>
24
26
        <firstname>Teddy</firstname>
25
27
        <surname>Hogeborn</surname>
26
28
        <address>
27
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
28
30
        </address>
29
31
      </author>
30
32
    </authorgroup>
31
33
    <copyright>
32
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
 
38
      <year>2012</year>
 
39
      <year>2013</year>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
 
44
      <year>2018</year>
33
45
      <holder>Teddy Hogeborn</holder>
34
46
      <holder>Björn Påhlsson</holder>
35
47
    </copyright>
36
 
    <legalnotice>
37
 
      <para>
38
 
        This manual page is free software: you can redistribute it
39
 
        and/or modify it under the terms of the GNU General Public
40
 
        License as published by the Free Software Foundation,
41
 
        either version 3 of the License, or (at your option) any
42
 
        later version.
43
 
      </para>
44
 
 
45
 
      <para>
46
 
        This manual page is distributed in the hope that it will
47
 
        be useful, but WITHOUT ANY WARRANTY; without even the
48
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
49
 
        PARTICULAR PURPOSE.  See the GNU General Public License
50
 
        for more details.
51
 
      </para>
52
 
 
53
 
      <para>
54
 
        You should have received a copy of the GNU General Public
55
 
        License along with this program; If not, see
56
 
        <ulink url="http://www.gnu.org/licenses/"/>.
57
 
      </para>
58
 
    </legalnotice>
 
48
    <xi:include href="legalnotice.xml"/>
59
49
  </refentryinfo>
60
 
 
 
50
  
61
51
  <refmeta>
62
52
    <refentrytitle>&COMMANDNAME;</refentrytitle>
63
53
    <manvolnum>8</manvolnum>
66
56
  <refnamediv>
67
57
    <refname><command>&COMMANDNAME;</command></refname>
68
58
    <refpurpose>
69
 
      Sends encrypted passwords to authenticated Mandos clients
 
59
      Gives encrypted passwords to authenticated Mandos clients
70
60
    </refpurpose>
71
61
  </refnamediv>
72
 
 
 
62
  
73
63
  <refsynopsisdiv>
74
64
    <cmdsynopsis>
75
65
      <command>&COMMANDNAME;</command>
76
 
      <arg choice="opt">--interface<arg choice="plain">IF</arg></arg>
77
 
      <arg choice="opt">--address<arg choice="plain">ADDRESS</arg></arg>
78
 
      <arg choice="opt">--port<arg choice="plain">PORT</arg></arg>
79
 
      <arg choice="opt">--priority<arg choice="plain">PRIORITY</arg></arg>
80
 
      <arg choice="opt">--servicename<arg choice="plain">NAME</arg></arg>
81
 
      <arg choice="opt">--configdir<arg choice="plain">DIRECTORY</arg></arg>
82
 
      <arg choice="opt">--debug</arg>
83
 
    </cmdsynopsis>
84
 
    <cmdsynopsis>
85
 
      <command>&COMMANDNAME;</command>
86
 
      <arg choice="opt">-i<arg choice="plain">IF</arg></arg>
87
 
      <arg choice="opt">-a<arg choice="plain">ADDRESS</arg></arg>
88
 
      <arg choice="opt">-p<arg choice="plain">PORT</arg></arg>
89
 
      <arg choice="opt">--priority<arg choice="plain">PRIORITY</arg></arg>
90
 
      <arg choice="opt">--servicename<arg choice="plain">NAME</arg></arg>
91
 
      <arg choice="opt">--configdir<arg choice="plain">DIRECTORY</arg></arg>
92
 
      <arg choice="opt">--debug</arg>
93
 
    </cmdsynopsis>
94
 
    <cmdsynopsis>
95
 
      <command>&COMMANDNAME;</command>
96
 
      <arg choice="plain">--help</arg>
97
 
    </cmdsynopsis>
98
 
    <cmdsynopsis>
99
 
      <command>&COMMANDNAME;</command>
100
 
      <arg choice="plain">--version</arg>
101
 
    </cmdsynopsis>
102
 
    <cmdsynopsis>
103
 
      <command>&COMMANDNAME;</command>
104
 
      <arg choice="plain">--check</arg>
 
66
      <group>
 
67
        <arg choice="plain"><option>--interface
 
68
        <replaceable>NAME</replaceable></option></arg>
 
69
        <arg choice="plain"><option>-i
 
70
        <replaceable>NAME</replaceable></option></arg>
 
71
      </group>
 
72
      <sbr/>
 
73
      <group>
 
74
        <arg choice="plain"><option>--address
 
75
        <replaceable>ADDRESS</replaceable></option></arg>
 
76
        <arg choice="plain"><option>-a
 
77
        <replaceable>ADDRESS</replaceable></option></arg>
 
78
      </group>
 
79
      <sbr/>
 
80
      <group>
 
81
        <arg choice="plain"><option>--port
 
82
        <replaceable>PORT</replaceable></option></arg>
 
83
        <arg choice="plain"><option>-p
 
84
        <replaceable>PORT</replaceable></option></arg>
 
85
      </group>
 
86
      <sbr/>
 
87
      <arg><option>--priority
 
88
      <replaceable>PRIORITY</replaceable></option></arg>
 
89
      <sbr/>
 
90
      <arg><option>--servicename
 
91
      <replaceable>NAME</replaceable></option></arg>
 
92
      <sbr/>
 
93
      <arg><option>--configdir
 
94
      <replaceable>DIRECTORY</replaceable></option></arg>
 
95
      <sbr/>
 
96
      <arg><option>--debug</option></arg>
 
97
      <sbr/>
 
98
      <arg><option>--debuglevel
 
99
      <replaceable>LEVEL</replaceable></option></arg>
 
100
      <sbr/>
 
101
      <arg><option>--no-dbus</option></arg>
 
102
      <sbr/>
 
103
      <arg><option>--no-ipv6</option></arg>
 
104
      <sbr/>
 
105
      <arg><option>--no-restore</option></arg>
 
106
      <sbr/>
 
107
      <arg><option>--statedir
 
108
      <replaceable>DIRECTORY</replaceable></option></arg>
 
109
      <sbr/>
 
110
      <arg><option>--socket
 
111
      <replaceable>FD</replaceable></option></arg>
 
112
      <sbr/>
 
113
      <arg><option>--foreground</option></arg>
 
114
      <sbr/>
 
115
      <arg><option>--no-zeroconf</option></arg>
 
116
    </cmdsynopsis>
 
117
    <cmdsynopsis>
 
118
      <command>&COMMANDNAME;</command>
 
119
      <group choice="req">
 
120
        <arg choice="plain"><option>--help</option></arg>
 
121
        <arg choice="plain"><option>-h</option></arg>
 
122
      </group>
 
123
    </cmdsynopsis>
 
124
    <cmdsynopsis>
 
125
      <command>&COMMANDNAME;</command>
 
126
      <arg choice="plain"><option>--version</option></arg>
 
127
    </cmdsynopsis>
 
128
    <cmdsynopsis>
 
129
      <command>&COMMANDNAME;</command>
 
130
      <arg choice="plain"><option>--check</option></arg>
105
131
    </cmdsynopsis>
106
132
  </refsynopsisdiv>
107
 
 
 
133
  
108
134
  <refsect1 id="description">
109
135
    <title>DESCRIPTION</title>
110
136
    <para>
111
137
      <command>&COMMANDNAME;</command> is a server daemon which
112
138
      handles incoming request for passwords for a pre-defined list of
113
 
      client host computers.  The Mandos server uses Zeroconf to
114
 
      announce itself on the local network, and uses TLS to
115
 
      communicate securely with and to authenticate the clients.  The
116
 
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
117
 
      link-local addresses, since the clients will probably not have
118
 
      any other addresses configured (see <xref linkend="overview"/>).
119
 
      Any authenticated client is then given the stored pre-encrypted
120
 
      password for that specific client.
 
139
      client host computers. For an introduction, see
 
140
      <citerefentry><refentrytitle>intro</refentrytitle>
 
141
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
142
      uses Zeroconf to announce itself on the local network, and uses
 
143
      TLS to communicate securely with and to authenticate the
 
144
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
145
      use IPv6 link-local addresses, since the clients will probably
 
146
      not have any other addresses configured (see <xref
 
147
      linkend="overview"/>).  Any authenticated client is then given
 
148
      the stored pre-encrypted password for that specific client.
121
149
    </para>
122
 
 
123
150
  </refsect1>
124
151
  
125
152
  <refsect1 id="purpose">
126
153
    <title>PURPOSE</title>
127
 
 
128
154
    <para>
129
155
      The purpose of this is to enable <emphasis>remote and unattended
130
156
      rebooting</emphasis> of client host computer with an
131
157
      <emphasis>encrypted root file system</emphasis>.  See <xref
132
158
      linkend="overview"/> for details.
133
159
    </para>
134
 
 
135
160
  </refsect1>
136
161
  
137
162
  <refsect1 id="options">
138
163
    <title>OPTIONS</title>
139
 
 
140
164
    <variablelist>
141
165
      <varlistentry>
142
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
166
        <term><option>--help</option></term>
 
167
        <term><option>-h</option></term>
143
168
        <listitem>
144
169
          <para>
145
170
            Show a help message and exit
146
171
          </para>
147
172
        </listitem>
148
173
      </varlistentry>
149
 
 
150
 
      <varlistentry>
151
 
        <term><literal>-i</literal>, <literal>--interface <replaceable>
152
 
        IF</replaceable></literal></term>
153
 
        <listitem>
154
 
          <para>
155
 
            Only announce the server and listen to requests on network
156
 
            interface <replaceable>IF</replaceable>.  Default is to
157
 
            use all available interfaces.
158
 
          </para>
159
 
        </listitem>
160
 
      </varlistentry>
161
 
 
162
 
      <varlistentry>
163
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
164
 
        ADDRESS</replaceable></literal></term>
165
 
        <listitem>
166
 
          <para>
167
 
            If this option is used, the server will only listen to a
168
 
            specific address.  This must currently be an IPv6 address;
169
 
            an IPv4 address can be specified using the
170
 
            <quote><literal>::FFFF:192.0.2.3</literal></quote> syntax.
171
 
            Also, if a link-local address is specified, an interface
172
 
            should be set, since a link-local address is only valid on
173
 
            a single interface.  By default, the server will listen to
174
 
            all available addresses.
175
 
          </para>
176
 
        </listitem>
177
 
      </varlistentry>
178
 
 
179
 
      <varlistentry>
180
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
181
 
        PORT</replaceable></literal></term>
182
 
        <listitem>
183
 
          <para>
184
 
            If this option is used, the server to bind to that
185
 
            port. By default, the server will listen to an arbitrary
186
 
            port given by the operating system.
187
 
          </para>
188
 
        </listitem>
189
 
      </varlistentry>
190
 
 
191
 
      <varlistentry>
192
 
        <term><literal>--check</literal></term>
 
174
      
 
175
      <varlistentry>
 
176
        <term><option>--interface</option>
 
177
        <replaceable>NAME</replaceable></term>
 
178
        <term><option>-i</option>
 
179
        <replaceable>NAME</replaceable></term>
 
180
        <listitem>
 
181
          <xi:include href="mandos-options.xml" xpointer="interface"/>
 
182
        </listitem>
 
183
      </varlistentry>
 
184
      
 
185
      <varlistentry>
 
186
        <term><option>--address
 
187
        <replaceable>ADDRESS</replaceable></option></term>
 
188
        <term><option>-a
 
189
        <replaceable>ADDRESS</replaceable></option></term>
 
190
        <listitem>
 
191
          <xi:include href="mandos-options.xml" xpointer="address"/>
 
192
        </listitem>
 
193
      </varlistentry>
 
194
      
 
195
      <varlistentry>
 
196
        <term><option>--port
 
197
        <replaceable>PORT</replaceable></option></term>
 
198
        <term><option>-p
 
199
        <replaceable>PORT</replaceable></option></term>
 
200
        <listitem>
 
201
          <xi:include href="mandos-options.xml" xpointer="port"/>
 
202
        </listitem>
 
203
      </varlistentry>
 
204
      
 
205
      <varlistentry>
 
206
        <term><option>--check</option></term>
193
207
        <listitem>
194
208
          <para>
195
209
            Run the server’s self-tests.  This includes any unit
197
211
          </para>
198
212
        </listitem>
199
213
      </varlistentry>
200
 
 
201
 
      <varlistentry>
202
 
        <term><literal>--debug</literal></term>
203
 
        <listitem>
204
 
          <para>
205
 
            If the server is run in debug mode, it will run in the
206
 
            foreground and print a lot of debugging information.  The
207
 
            default is <emphasis>not</emphasis> to run in debug mode.
208
 
          </para>
209
 
        </listitem>
210
 
      </varlistentry>
211
 
 
212
 
      <varlistentry>
213
 
        <term><literal>--priority <replaceable>
214
 
        PRIORITY</replaceable></literal></term>
215
 
        <listitem>
216
 
          <para>
217
 
            GnuTLS priority string for the TLS handshake with the
218
 
            clients.  The default is
219
 
            <quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.
220
 
            See <citerefentry><refentrytitle>gnutls_priority_init
221
 
            </refentrytitle><manvolnum>3</manvolnum></citerefentry>
222
 
            for the syntax.  <emphasis>Warning</emphasis>: changing
223
 
            this may make the TLS handshake fail, making communication
224
 
            with clients impossible.
225
 
          </para>
226
 
        </listitem>
227
 
      </varlistentry>
228
 
 
229
 
      <varlistentry>
230
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
231
 
        </literal></term>
232
 
        <listitem>
233
 
          <para>
234
 
            Zeroconf service name.  The default is
235
 
            <quote><literal>Mandos</literal></quote>.  You only need
236
 
            to change this if you for some reason want to run more
237
 
            than one server on the same <emphasis>host</emphasis>,
238
 
            which would not normally be useful.  If there are name
239
 
            collisions on the same <emphasis>network</emphasis>, the
240
 
            newer server will automatically rename itself to
241
 
            <quote><literal>Mandos #2</literal></quote>, and so on;
242
 
            therefore, this option is not needed in that case.
243
 
          </para>
244
 
        </listitem>
245
 
      </varlistentry>
246
 
 
247
 
      <varlistentry>
248
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
249
 
        </literal></term>
 
214
      
 
215
      <varlistentry>
 
216
        <term><option>--debug</option></term>
 
217
        <listitem>
 
218
          <xi:include href="mandos-options.xml" xpointer="debug"/>
 
219
        </listitem>
 
220
      </varlistentry>
 
221
      
 
222
      <varlistentry>
 
223
        <term><option>--debuglevel
 
224
        <replaceable>LEVEL</replaceable></option></term>
 
225
        <listitem>
 
226
          <para>
 
227
            Set the debugging log level.
 
228
            <replaceable>LEVEL</replaceable> is a string, one of
 
229
            <quote><literal>CRITICAL</literal></quote>,
 
230
            <quote><literal>ERROR</literal></quote>,
 
231
            <quote><literal>WARNING</literal></quote>,
 
232
            <quote><literal>INFO</literal></quote>, or
 
233
            <quote><literal>DEBUG</literal></quote>, in order of
 
234
            increasing verbosity.  The default level is
 
235
            <quote><literal>WARNING</literal></quote>.
 
236
          </para>
 
237
        </listitem>
 
238
      </varlistentry>
 
239
      
 
240
      <varlistentry>
 
241
        <term><option>--priority <replaceable>
 
242
        PRIORITY</replaceable></option></term>
 
243
        <listitem>
 
244
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
245
        </listitem>
 
246
      </varlistentry>
 
247
      
 
248
      <varlistentry>
 
249
        <term><option>--servicename
 
250
        <replaceable>NAME</replaceable></option></term>
 
251
        <listitem>
 
252
          <xi:include href="mandos-options.xml"
 
253
                      xpointer="servicename"/>
 
254
        </listitem>
 
255
      </varlistentry>
 
256
      
 
257
      <varlistentry>
 
258
        <term><option>--configdir
 
259
        <replaceable>DIRECTORY</replaceable></option></term>
250
260
        <listitem>
251
261
          <para>
252
262
            Directory to search for configuration files.  Default is
258
268
          </para>
259
269
        </listitem>
260
270
      </varlistentry>
261
 
 
 
271
      
262
272
      <varlistentry>
263
 
        <term><literal>--version</literal></term>
 
273
        <term><option>--version</option></term>
264
274
        <listitem>
265
275
          <para>
266
276
            Prints the program version and exit.
267
277
          </para>
268
278
        </listitem>
269
279
      </varlistentry>
 
280
      
 
281
      <varlistentry>
 
282
        <term><option>--no-dbus</option></term>
 
283
        <listitem>
 
284
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
285
          <para>
 
286
            See also <xref linkend="dbus_interface"/>.
 
287
          </para>
 
288
        </listitem>
 
289
      </varlistentry>
 
290
      
 
291
      <varlistentry>
 
292
        <term><option>--no-ipv6</option></term>
 
293
        <listitem>
 
294
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
295
        </listitem>
 
296
      </varlistentry>
 
297
      
 
298
      <varlistentry>
 
299
        <term><option>--no-restore</option></term>
 
300
        <listitem>
 
301
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
302
          <para>
 
303
            See also <xref linkend="persistent_state"/>.
 
304
          </para>
 
305
        </listitem>
 
306
      </varlistentry>
 
307
      
 
308
      <varlistentry>
 
309
        <term><option>--statedir
 
310
        <replaceable>DIRECTORY</replaceable></option></term>
 
311
        <listitem>
 
312
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
313
        </listitem>
 
314
      </varlistentry>
 
315
      
 
316
      <varlistentry>
 
317
        <term><option>--socket
 
318
        <replaceable>FD</replaceable></option></term>
 
319
        <listitem>
 
320
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
321
        </listitem>
 
322
      </varlistentry>
 
323
      
 
324
      <varlistentry>
 
325
        <term><option>--foreground</option></term>
 
326
        <listitem>
 
327
          <xi:include href="mandos-options.xml"
 
328
                      xpointer="foreground"/>
 
329
        </listitem>
 
330
      </varlistentry>
 
331
      
 
332
      <varlistentry>
 
333
        <term><option>--no-zeroconf</option></term>
 
334
        <listitem>
 
335
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
 
336
        </listitem>
 
337
      </varlistentry>
 
338
      
270
339
    </variablelist>
271
340
  </refsect1>
272
 
 
 
341
  
273
342
  <refsect1 id="overview">
274
343
    <title>OVERVIEW</title>
275
 
    &OVERVIEW;
 
344
    <xi:include href="overview.xml"/>
276
345
    <para>
277
346
      This program is the server part.  It is a normal server program
278
347
      and will run in a normal system environment, not in an initial
279
 
      RAM disk environment.
 
348
      <acronym>RAM</acronym> disk environment.
280
349
    </para>
281
350
  </refsect1>
282
 
 
 
351
  
283
352
  <refsect1 id="protocol">
284
353
    <title>NETWORK PROTOCOL</title>
285
354
    <para>
292
361
      start a TLS protocol handshake with a slight quirk: the Mandos
293
362
      server program acts as a TLS <quote>client</quote> while the
294
363
      connecting Mandos client acts as a TLS <quote>server</quote>.
295
 
      The Mandos client must supply an OpenPGP certificate, and the
296
 
      fingerprint of this certificate is used by the Mandos server to
297
 
      look up (in a list read from <filename>clients.conf</filename>
298
 
      at start time) which binary blob to give the client.  No other
299
 
      authentication or authorization is done by the server.
 
364
      The Mandos client must supply a TLS public key, and the key ID
 
365
      of this public key is used by the Mandos server to look up (in a
 
366
      list read from <filename>clients.conf</filename> at start time)
 
367
      which binary blob to give the client.  No other authentication
 
368
      or authorization is done by the server.
300
369
    </para>
301
370
    <table>
302
371
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
311
380
        <entry>-><!-- &rarr; --></entry>
312
381
      </row>
313
382
      <row>
314
 
        <entry><quote><literal>1\r\en</literal></quote></entry>
 
383
        <entry><quote><literal>1\r\n</literal></quote></entry>
315
384
        <entry>-><!-- &rarr; --></entry>
316
385
      </row>
317
386
      <row>
322
391
        </emphasis></entry>
323
392
      </row>
324
393
      <row>
325
 
        <entry>OpenPGP public key (part of TLS handshake)</entry>
 
394
        <entry>Public key (part of TLS handshake)</entry>
326
395
        <entry>-><!-- &rarr; --></entry>
327
396
      </row>
328
397
      <row>
337
406
      </row>
338
407
    </tbody></tgroup></table>
339
408
  </refsect1>
340
 
 
 
409
  
341
410
  <refsect1 id="checking">
342
411
    <title>CHECKING</title>
343
412
    <para>
344
413
      The server will, by default, continually check that the clients
345
414
      are still up.  If a client has not been confirmed as being up
346
415
      for some time, the client is assumed to be compromised and is no
347
 
      longer eligible to receive the encrypted password.  The timeout,
348
 
      checker program, and interval between checks can be configured
349
 
      both globally and per client; see <citerefentry>
350
 
      <refentrytitle>mandos.conf</refentrytitle>
351
 
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
 
416
      longer eligible to receive the encrypted password.  (Manual
 
417
      intervention is required to re-enable a client.)  The timeout,
 
418
      extended timeout, checker program, and interval between checks
 
419
      can be configured both globally and per client; see
 
420
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
421
      <manvolnum>5</manvolnum></citerefentry>.
 
422
    </para>
 
423
  </refsect1>
 
424
  
 
425
  <refsect1 id="approval">
 
426
    <title>APPROVAL</title>
 
427
    <para>
 
428
      The server can be configured to require manual approval for a
 
429
      client before it is sent its secret.  The delay to wait for such
 
430
      approval and the default action (approve or deny) can be
 
431
      configured both globally and per client; see <citerefentry>
352
432
      <refentrytitle>mandos-clients.conf</refentrytitle>
353
 
      <manvolnum>5</manvolnum></citerefentry>.
354
 
    </para>
 
433
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
434
      will be approved immediately without delay.
 
435
    </para>
 
436
    <para>
 
437
      This can be used to deny a client its secret if not manually
 
438
      approved within a specified time.  It can also be used to make
 
439
      the server delay before giving a client its secret, allowing
 
440
      optional manual denying of this specific client.
 
441
    </para>
 
442
    
355
443
  </refsect1>
356
 
 
 
444
  
357
445
  <refsect1 id="logging">
358
446
    <title>LOGGING</title>
359
447
    <para>
360
 
      The server will send log messaged with various severity levels
361
 
      to <filename>/dev/log</filename>.  With the
 
448
      The server will send log message with various severity levels to
 
449
      <filename class="devicefile">/dev/log</filename>.  With the
362
450
      <option>--debug</option> option, it will log even more messages,
363
451
      and also show them on the console.
364
452
    </para>
365
453
  </refsect1>
366
 
 
 
454
  
 
455
  <refsect1 id="persistent_state">
 
456
    <title>PERSISTENT STATE</title>
 
457
    <para>
 
458
      Client settings, initially read from
 
459
      <filename>clients.conf</filename>, are persistent across
 
460
      restarts, and run-time changes will override settings in
 
461
      <filename>clients.conf</filename>.  However, if a setting is
 
462
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
463
      <filename>clients.conf</filename>, this will take precedence.
 
464
    </para>
 
465
  </refsect1>
 
466
  
 
467
  <refsect1 id="dbus_interface">
 
468
    <title>D-BUS INTERFACE</title>
 
469
    <para>
 
470
      The server will by default provide a D-Bus system bus interface.
 
471
      This interface will only be accessible by the root user or a
 
472
      Mandos-specific user, if such a user exists.  For documentation
 
473
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
474
    </para>
 
475
  </refsect1>
 
476
  
367
477
  <refsect1 id="exit_status">
368
478
    <title>EXIT STATUS</title>
369
479
    <para>
371
481
      critical error is encountered.
372
482
    </para>
373
483
  </refsect1>
374
 
 
375
 
  <refsect1 id="file">
 
484
  
 
485
  <refsect1 id="environment">
 
486
    <title>ENVIRONMENT</title>
 
487
    <variablelist>
 
488
      <varlistentry>
 
489
        <term><envar>PATH</envar></term>
 
490
        <listitem>
 
491
          <para>
 
492
            To start the configured checker (see <xref
 
493
            linkend="checking"/>), the server uses
 
494
            <filename>/bin/sh</filename>, which in turn uses
 
495
            <varname>PATH</varname> to search for matching commands if
 
496
            an absolute path is not given.  See <citerefentry>
 
497
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
498
            </citerefentry>.
 
499
          </para>
 
500
        </listitem>
 
501
      </varlistentry>
 
502
    </variablelist>
 
503
  </refsect1>
 
504
  
 
505
  <refsect1 id="files">
376
506
    <title>FILES</title>
377
507
    <para>
378
508
      Use the <option>--configdir</option> option to change where
401
531
        </listitem>
402
532
      </varlistentry>
403
533
      <varlistentry>
404
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
405
 
        <listitem>
406
 
          <para>
407
 
            The file containing the process id of
408
 
            <command>&COMMANDNAME;</command>.
409
 
          </para>
410
 
        </listitem>
411
 
      </varlistentry>
412
 
      <varlistentry>
413
 
        <term><filename>/dev/log</filename></term>
 
534
        <term><filename>/run/mandos.pid</filename></term>
 
535
        <listitem>
 
536
          <para>
 
537
            The file containing the process id of the
 
538
            <command>&COMMANDNAME;</command> process started last.
 
539
            <emphasis >Note:</emphasis> If the <filename
 
540
            class="directory">/run</filename> directory does not
 
541
            exist, <filename>/var/run/mandos.pid</filename> will be
 
542
            used instead.
 
543
          </para>
 
544
        </listitem>
 
545
      </varlistentry>
 
546
      <varlistentry>
 
547
        <term><filename
 
548
        class="directory">/var/lib/mandos</filename></term>
 
549
        <listitem>
 
550
          <para>
 
551
            Directory where persistent state will be saved.  Change
 
552
            this with the <option>--statedir</option> option.  See
 
553
            also the <option>--no-restore</option> option.
 
554
          </para>
 
555
        </listitem>
 
556
      </varlistentry>
 
557
      <varlistentry>
 
558
        <term><filename class="devicefile">/dev/log</filename></term>
414
559
        <listitem>
415
560
          <para>
416
561
            The Unix domain socket to where local syslog messages are
418
563
          </para>
419
564
        </listitem>
420
565
      </varlistentry>
 
566
      <varlistentry>
 
567
        <term><filename>/bin/sh</filename></term>
 
568
        <listitem>
 
569
          <para>
 
570
            This is used to start the configured checker command for
 
571
            each client.  See <citerefentry>
 
572
            <refentrytitle>mandos-clients.conf</refentrytitle>
 
573
            <manvolnum>5</manvolnum></citerefentry> for details.
 
574
          </para>
 
575
        </listitem>
 
576
      </varlistentry>
421
577
    </variablelist>
422
578
  </refsect1>
423
 
 
 
579
  
424
580
  <refsect1 id="bugs">
425
581
    <title>BUGS</title>
426
582
    <para>
427
583
      This server might, on especially fatal errors, emit a Python
428
584
      backtrace.  This could be considered a feature.
429
585
    </para>
 
586
    <para>
 
587
      There is no fine-grained control over logging and debug output.
 
588
    </para>
 
589
    <xi:include href="bugs.xml"/>
430
590
  </refsect1>
431
 
 
432
 
  <refsect1 id="examples">
433
 
    <title>EXAMPLES</title>
 
591
  
 
592
  <refsect1 id="example">
 
593
    <title>EXAMPLE</title>
434
594
    <informalexample>
435
595
      <para>
436
596
        Normal invocation needs no options:
437
597
      </para>
438
598
      <para>
439
 
        <userinput>mandos</userinput>
 
599
        <userinput>&COMMANDNAME;</userinput>
440
600
      </para>
441
601
    </informalexample>
442
602
    <informalexample>
443
603
      <para>
444
604
        Run the server in debug mode, read configuration files from
445
 
        the <filename>~/mandos</filename> directory, and use the
446
 
        Zeroconf service name <quote>Test</quote> to not collide with
447
 
        any other official Mandos server on this host:
 
605
        the <filename class="directory">~/mandos</filename> directory,
 
606
        and use the Zeroconf service name <quote>Test</quote> to not
 
607
        collide with any other official Mandos server on this host:
448
608
      </para>
449
609
      <para>
450
610
 
451
611
<!-- do not wrap this line -->
452
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
612
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
453
613
 
454
614
      </para>
455
615
    </informalexample>
461
621
      <para>
462
622
 
463
623
<!-- do not wrap this line -->
464
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
624
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
465
625
 
466
626
      </para>
467
627
    </informalexample>
468
628
  </refsect1>
469
 
 
 
629
  
470
630
  <refsect1 id="security">
471
631
    <title>SECURITY</title>
472
 
    <refsect2>
 
632
    <refsect2 id="server">
473
633
      <title>SERVER</title>
474
634
      <para>
475
 
        Running this &COMMANDNAME; server program should not in itself
476
 
        present any security risk to the host computer running it.
477
 
        The program does not need any special privileges to run, and
478
 
        is designed to run as a non-root user.
 
635
        Running this <command>&COMMANDNAME;</command> server program
 
636
        should not in itself present any security risk to the host
 
637
        computer running it.  The program switches to a non-root user
 
638
        soon after startup.
479
639
      </para>
480
640
    </refsect2>
481
 
    <refsect2>
 
641
    <refsect2 id="clients">
482
642
      <title>CLIENTS</title>
483
643
      <para>
484
644
        The server only gives out its stored data to clients which
485
 
        does have the OpenPGP key of the stored fingerprint.  This is
486
 
        guaranteed by the fact that the client sends its OpenPGP
487
 
        public key in the TLS handshake; this ensures it to be
488
 
        genuine.  The server computes the fingerprint of the key
489
 
        itself and looks up the fingerprint in its list of
490
 
        clients. The <filename>clients.conf</filename> file (see
 
645
        does have the correct key ID of the stored key ID.  This is
 
646
        guaranteed by the fact that the client sends its public key in
 
647
        the TLS handshake; this ensures it to be genuine.  The server
 
648
        computes the key ID of the key itself and looks up the key ID
 
649
        in its list of clients. The <filename>clients.conf</filename>
 
650
        file (see
491
651
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
492
652
        <manvolnum>5</manvolnum></citerefentry>)
493
653
        <emphasis>must</emphasis> be made non-readable by anyone
494
 
        except the user running the server.
 
654
        except the user starting the server (usually root).
495
655
      </para>
496
656
      <para>
497
657
        As detailed in <xref linkend="checking"/>, the status of all
500
660
      </para>
501
661
      <para>
502
662
        For more details on client-side security, see
503
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
663
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
504
664
        <manvolnum>8mandos</manvolnum></citerefentry>.
505
665
      </para>
506
666
    </refsect2>
507
667
  </refsect1>
508
 
 
 
668
  
509
669
  <refsect1 id="see_also">
510
670
    <title>SEE ALSO</title>
 
671
    <para>
 
672
      <citerefentry><refentrytitle>intro</refentrytitle>
 
673
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
674
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
675
      <manvolnum>5</manvolnum></citerefentry>,
 
676
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
677
      <manvolnum>5</manvolnum></citerefentry>,
 
678
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
679
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
680
      <citerefentry><refentrytitle>sh</refentrytitle>
 
681
      <manvolnum>1</manvolnum></citerefentry>
 
682
    </para>
511
683
    <variablelist>
512
684
      <varlistentry>
513
685
        <term>
514
 
          <citerefentry>
515
 
            <refentrytitle>password-request</refentrytitle>
516
 
            <manvolnum>8mandos</manvolnum>
517
 
          </citerefentry>
518
 
        </term>
519
 
        <listitem>
520
 
          <para>
521
 
            This is the actual program which talks to this server.
522
 
            Note that it is normally not invoked directly, and is only
523
 
            run in the initial RAM disk environment, and not on a
524
 
            fully started system.
525
 
          </para>
526
 
        </listitem>
527
 
      </varlistentry>
528
 
      <varlistentry>
529
 
        <term>
530
686
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
531
687
        </term>
532
688
        <listitem>
549
705
      </varlistentry>
550
706
      <varlistentry>
551
707
        <term>
552
 
          <ulink
553
 
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
708
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
554
709
        </term>
555
710
      <listitem>
556
711
        <para>
557
712
          GnuTLS is the library this server uses to implement TLS for
558
713
          communicating securely with the client, and at the same time
559
 
          confidently get the client’s public OpenPGP key.
 
714
          confidently get the client’s public key.
560
715
        </para>
561
716
      </listitem>
562
717
      </varlistentry>
563
718
      <varlistentry>
564
719
        <term>
565
 
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
566
 
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
567
 
          Unicast Addresses</citation>
 
720
          RFC 4291: <citetitle>IP Version 6 Addressing
 
721
          Architecture</citetitle>
568
722
        </term>
569
723
        <listitem>
570
 
          <para>
571
 
            The clients use IPv6 link-local addresses, which are
572
 
            immediately usable since a link-local addresses is
573
 
            automatically assigned to a network interfaces when it is
574
 
            brought up.
575
 
          </para>
 
724
          <variablelist>
 
725
            <varlistentry>
 
726
              <term>Section 2.2: <citetitle>Text Representation of
 
727
              Addresses</citetitle></term>
 
728
              <listitem><para/></listitem>
 
729
            </varlistentry>
 
730
            <varlistentry>
 
731
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
732
              Address</citetitle></term>
 
733
              <listitem><para/></listitem>
 
734
            </varlistentry>
 
735
            <varlistentry>
 
736
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
737
            Addresses</citetitle></term>
 
738
            <listitem>
 
739
              <para>
 
740
                The clients use IPv6 link-local addresses, which are
 
741
                immediately usable since a link-local addresses is
 
742
                automatically assigned to a network interfaces when it
 
743
                is brought up.
 
744
              </para>
 
745
            </listitem>
 
746
            </varlistentry>
 
747
          </variablelist>
576
748
        </listitem>
577
749
      </varlistentry>
578
750
      <varlistentry>
579
751
        <term>
580
 
          <citation>RFC 4346: <citetitle>The Transport Layer Security
581
 
          (TLS) Protocol Version 1.1</citetitle></citation>
 
752
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
753
          Protocol Version 1.2</citetitle>
582
754
        </term>
583
755
      <listitem>
584
756
        <para>
585
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
757
          TLS 1.2 is the protocol implemented by GnuTLS.
586
758
        </para>
587
759
      </listitem>
588
760
      </varlistentry>
589
761
      <varlistentry>
590
762
        <term>
591
 
          <citation>RFC 4880: <citetitle>OpenPGP Message
592
 
          Format</citetitle></citation>
 
763
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
593
764
        </term>
594
765
      <listitem>
595
766
        <para>
599
770
      </varlistentry>
600
771
      <varlistentry>
601
772
        <term>
602
 
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
603
 
          Transport Layer Security</citetitle></citation>
604
 
        </term>
605
 
      <listitem>
606
 
        <para>
607
 
          This is implemented by GnuTLS and used by this server so
608
 
          that OpenPGP keys can be used.
 
773
          RFC 7250: <citetitle>Using Raw Public Keys in Transport
 
774
          Layer Security (TLS) and Datagram Transport Layer Security
 
775
          (DTLS)</citetitle>
 
776
        </term>
 
777
      <listitem>
 
778
        <para>
 
779
          This is implemented by GnuTLS version 3.6.6 and is, if
 
780
          present, used by this server so that raw public keys can be
 
781
          used.
 
782
        </para>
 
783
      </listitem>
 
784
      </varlistentry>
 
785
      <varlistentry>
 
786
        <term>
 
787
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
788
          Security (TLS) Authentication</citetitle>
 
789
        </term>
 
790
      <listitem>
 
791
        <para>
 
792
          This is implemented by GnuTLS before version 3.6.0 and is,
 
793
          if present, used by this server so that OpenPGP keys can be
 
794
          used.
609
795
        </para>
610
796
      </listitem>
611
797
      </varlistentry>
612
798
    </variablelist>
613
799
  </refsect1>
614
800
</refentry>
 
801
<!-- Local Variables: -->
 
802
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
803
<!-- time-stamp-end: "[\"']>" -->
 
804
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
805
<!-- End: -->