/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.conf.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.conf.xml
1
 
<?xml version='1.0' encoding='UTF-8'?>
 
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 CONFNAME "mandos.conf">
6
5
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
7
 
<!ENTITY OVERVIEW SYSTEM "overview.xml">
 
6
<!ENTITY TIMESTAMP "2018-02-08">
 
7
<!ENTITY % common SYSTEM "common.ent">
 
8
%common;
8
9
]>
9
10
 
10
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
12
  <refentryinfo>
12
 
    <title>&CONFNAME;</title>
 
13
    <title>Mandos Manual</title>
13
14
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>&CONFNAME;</productname>
15
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productname>Mandos</productname>
 
16
    <productnumber>&version;</productnumber>
 
17
    <date>&TIMESTAMP;</date>
16
18
    <authorgroup>
17
19
      <author>
18
20
        <firstname>Björn</firstname>
19
21
        <surname>Påhlsson</surname>
20
22
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
23
          <email>belorn@recompile.se</email>
22
24
        </address>
23
25
      </author>
24
26
      <author>
25
27
        <firstname>Teddy</firstname>
26
28
        <surname>Hogeborn</surname>
27
29
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
30
          <email>teddy@recompile.se</email>
29
31
        </address>
30
32
      </author>
31
33
    </authorgroup>
32
34
    <copyright>
33
35
      <year>2008</year>
 
36
      <year>2009</year>
 
37
      <year>2010</year>
 
38
      <year>2011</year>
 
39
      <year>2012</year>
 
40
      <year>2013</year>
 
41
      <year>2014</year>
 
42
      <year>2015</year>
 
43
      <year>2016</year>
 
44
      <year>2017</year>
 
45
      <year>2018</year>
34
46
      <holder>Teddy Hogeborn</holder>
35
47
      <holder>Björn Påhlsson</holder>
36
48
    </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>
 
49
    <xi:include href="legalnotice.xml"/>
60
50
  </refentryinfo>
61
 
 
 
51
  
62
52
  <refmeta>
63
53
    <refentrytitle>&CONFNAME;</refentrytitle>
64
54
    <manvolnum>5</manvolnum>
70
60
      Configuration file for the Mandos server
71
61
    </refpurpose>
72
62
  </refnamediv>
73
 
 
 
63
  
74
64
  <refsynopsisdiv>
75
 
    <synopsis>
76
 
      &CONFPATH;
77
 
    </synopsis>
 
65
    <synopsis>&CONFPATH;</synopsis>
78
66
  </refsynopsisdiv>
79
 
 
 
67
  
80
68
  <refsect1 id="description">
81
69
    <title>DESCRIPTION</title>
82
70
    <para>
83
71
      The file &CONFPATH; is a simple configuration file for
84
72
      <citerefentry><refentrytitle>mandos</refentrytitle>
85
73
      <manvolnum>8</manvolnum></citerefentry>, and is read by it at
86
 
      startup.  The configuration file starts with
87
 
      <quote><literal>[DEFAULT]</literal></quote> on a line by itself,
88
 
      followed by any number of
89
 
      <quote><varname><replaceable>option</replaceable></varname>=<replaceable>value</replaceable></quote>
90
 
      entries, with continuations in the style of RFC 822.
91
 
      <quote><varname><replaceable>option</replaceable></varname>:
92
 
      <replaceable>value</replaceable></quote> is also accepted.  Note
93
 
      that leading whitespace is removed from values.  Lines beginning
94
 
      with <quote>#</quote> or <quote>;</quote> are ignored and may be
95
 
      used to provide comments.
 
74
      startup.  The configuration file starts with <quote><literal
 
75
      >[DEFAULT]</literal></quote> on a line by itself, followed by
 
76
      any number of <quote><varname><replaceable>option</replaceable
 
77
      ></varname>=<replaceable>value</replaceable></quote> entries,
 
78
      with continuations in the style of RFC 822.  <quote><varname
 
79
      ><replaceable>option</replaceable></varname>: <replaceable
 
80
      >value</replaceable></quote> is also accepted.  Note that
 
81
      leading whitespace is removed from values.  Lines beginning with
 
82
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
 
83
      to provide comments.
96
84
    </para>
97
 
 
 
85
    
98
86
  </refsect1>
99
87
  <refsect1>
100
88
    <title>OPTIONS</title>
101
89
    
102
90
    <variablelist>
103
91
      <varlistentry>
104
 
        <term><varname>interface</varname></term>
 
92
        <term><option>interface<literal> = </literal><replaceable
 
93
        >NAME</replaceable></option></term>
105
94
        <listitem>
106
 
          <synopsis><literal>interface = </literal><arg
107
 
          choice="plain"><replaceable>IF</replaceable></arg>
108
 
          </synopsis>
109
95
          <xi:include href="mandos-options.xml" xpointer="interface"/>
110
96
        </listitem>
111
97
      </varlistentry>
112
 
 
 
98
      
113
99
      <varlistentry>
114
 
        <term><varname>address</varname></term>
 
100
        <term><option>address<literal> = </literal><replaceable
 
101
          >ADDRESS</replaceable></option></term>
115
102
        <listitem>
116
 
          <synopsis><literal>address = </literal><arg
117
 
          choice="plain"><replaceable>ADDRESS</replaceable></arg>
118
 
          </synopsis>
119
103
          <xi:include href="mandos-options.xml" xpointer="address"/>
120
104
        </listitem>
121
105
      </varlistentry>
122
 
 
 
106
      
123
107
      <varlistentry>
124
 
        <term><varname>port</varname></term>
 
108
        <term><option>port<literal> = </literal><replaceable
 
109
        >NUMBER</replaceable></option></term>
125
110
        <listitem>
126
 
          <synopsis><literal>port = </literal><arg
127
 
          choice="plain"><replaceable>PORT</replaceable></arg>
128
 
          </synopsis>
129
111
          <xi:include href="mandos-options.xml" xpointer="port"/>
130
112
        </listitem>
131
113
      </varlistentry>
132
 
 
 
114
      
133
115
      <varlistentry>
134
 
        <term><varname>debug</varname></term>
 
116
        <term><option>debug<literal> = </literal>{ <literal
 
117
          >1</literal> | <literal>yes</literal> | <literal
 
118
          >true</literal> | <literal>on</literal> | <literal
 
119
          >0</literal> | <literal>no</literal> | <literal
 
120
          >false</literal> | <literal>off</literal> }</option></term>
135
121
        <listitem>
136
 
          <synopsis><literal>debug =</literal><group choice="req">
137
 
            <arg choice="plain">1</arg>
138
 
            <arg choice="plain">yes</arg>
139
 
            <arg choice="plain">true</arg>
140
 
            <arg choice="plain">on</arg>
141
 
            <arg choice="plain">0</arg>
142
 
            <arg choice="plain">no</arg>
143
 
            <arg choice="plain">false</arg>
144
 
            <arg choice="plain">off</arg>
145
 
          </group>
146
 
          </synopsis>
147
122
          <xi:include href="mandos-options.xml" xpointer="debug"/>
148
123
        </listitem>
149
124
      </varlistentry>
150
 
 
 
125
      
151
126
      <varlistentry>
152
 
        <term><varname>priority</varname></term>
 
127
        <term><option>priority<literal> = </literal><replaceable
 
128
        >STRING</replaceable></option></term>
153
129
        <listitem>
154
 
          <synopsis><literal>priority = </literal><arg
155
 
          choice="plain"><replaceable>PRIORITY</replaceable></arg>
156
 
          </synopsis>
157
130
          <xi:include href="mandos-options.xml" xpointer="priority"/>
158
131
        </listitem>
159
132
      </varlistentry>
160
 
 
 
133
      
161
134
      <varlistentry>
162
 
        <term><varname>servicename</varname></term>
163
 
          <synopsis><literal>servicename = </literal><arg
164
 
          choice="plain"><replaceable>NAME</replaceable></arg>
165
 
          </synopsis>
 
135
        <term><option>servicename<literal> = </literal
 
136
        ><replaceable>NAME</replaceable></option></term>
166
137
        <listitem>
167
138
          <xi:include href="mandos-options.xml"
168
139
                      xpointer="servicename"/>
169
140
        </listitem>
170
141
      </varlistentry>
171
142
      
 
143
      <varlistentry>
 
144
        <term><option>use_dbus<literal> = </literal>{ <literal
 
145
          >1</literal> | <literal>yes</literal> | <literal
 
146
          >true</literal> | <literal>on</literal> | <literal
 
147
          >0</literal> | <literal>no</literal> | <literal
 
148
          >false</literal> | <literal>off</literal> }</option></term>
 
149
        <listitem>
 
150
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
151
        </listitem>
 
152
      </varlistentry>
 
153
      
 
154
      <varlistentry>
 
155
        <term><option>use_ipv6<literal> = </literal>{ <literal
 
156
          >1</literal> | <literal>yes</literal> | <literal
 
157
          >true</literal> | <literal>on</literal> | <literal
 
158
          >0</literal> | <literal>no</literal> | <literal
 
159
          >false</literal> | <literal>off</literal> }</option></term>
 
160
        <listitem>
 
161
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
162
        </listitem>
 
163
      </varlistentry>
 
164
      
 
165
      <varlistentry>
 
166
        <term><option>restore<literal> = </literal>{ <literal
 
167
          >1</literal> | <literal>yes</literal> | <literal
 
168
          >true</literal> | <literal>on</literal> | <literal
 
169
          >0</literal> | <literal>no</literal> | <literal
 
170
          >false</literal> | <literal>off</literal> }</option></term>
 
171
        <listitem>
 
172
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
173
        </listitem>
 
174
      </varlistentry>
 
175
      
 
176
      <varlistentry>
 
177
        <term><option>statedir<literal> = </literal><replaceable
 
178
        >DIRECTORY</replaceable></option></term>
 
179
        <listitem>
 
180
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
181
        </listitem>
 
182
      </varlistentry>
 
183
      
 
184
      <varlistentry>
 
185
        <term><option>socket<literal> = </literal><replaceable
 
186
        >NUMBER</replaceable></option></term>
 
187
        <listitem>
 
188
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
189
        </listitem>
 
190
      </varlistentry>
 
191
      
172
192
    </variablelist>
173
193
  </refsect1>
174
194
  
183
203
    <title>BUGS</title>
184
204
    <para>
185
205
      The <literal>[DEFAULT]</literal> is necessary because the Python
186
 
      module <systemitem class="library">ConfigParser</systemitem>
187
 
      requres it.
 
206
      built-in module <systemitem class="library">ConfigParser</systemitem>
 
207
      requires it.
188
208
    </para>
 
209
    <xi:include href="bugs.xml"/>
189
210
  </refsect1>
190
211
  
191
212
  <refsect1 id="example">
192
213
    <title>EXAMPLE</title>
193
214
    <informalexample>
 
215
      <para>
 
216
        No options are actually required:
 
217
      </para>
 
218
      <programlisting>
 
219
[DEFAULT]
 
220
      </programlisting>
 
221
    </informalexample>
 
222
    <informalexample>
 
223
      <para>
 
224
        An example using all the options:
 
225
      </para>
194
226
      <programlisting>
195
227
[DEFAULT]
196
228
# A configuration example
197
229
interface = eth0
198
 
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
 
230
address = fe80::aede:48ff:fe71:f6f2
199
231
port = 1025
200
 
debug = true
201
 
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
202
 
servicename = Mandos
 
232
debug = True
 
233
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA
 
234
servicename = Daena
 
235
use_dbus = False
 
236
use_ipv6 = True
 
237
restore = True
 
238
statedir = /var/lib/mandos
203
239
      </programlisting>
204
240
    </informalexample>
205
241
  </refsect1>
 
242
  
 
243
  <refsect1 id="see_also">
 
244
    <title>SEE ALSO</title>
 
245
    <para>
 
246
      <citerefentry><refentrytitle>intro</refentrytitle>
 
247
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
248
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
 
249
      ><manvolnum>3</manvolnum></citerefentry>,
 
250
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
251
      <manvolnum>8</manvolnum></citerefentry>,
 
252
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
253
      <manvolnum>5</manvolnum></citerefentry>
 
254
    </para>
 
255
    
 
256
    <variablelist>
 
257
      <varlistentry>
 
258
        <term>
 
259
          RFC 4291: <citetitle>IP Version 6 Addressing
 
260
          Architecture</citetitle>
 
261
        </term>
 
262
        <listitem>
 
263
          <variablelist>
 
264
            <varlistentry>
 
265
              <term>Section 2.2: <citetitle>Text Representation of
 
266
              Addresses</citetitle></term>
 
267
              <listitem><para/></listitem>
 
268
            </varlistentry>
 
269
            <varlistentry>
 
270
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
271
              Address</citetitle></term>
 
272
              <listitem><para/></listitem>
 
273
            </varlistentry>
 
274
            <varlistentry>
 
275
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
276
            Addresses</citetitle></term>
 
277
            <listitem>
 
278
              <para>
 
279
                The clients use IPv6 link-local addresses, which are
 
280
                immediately usable since a link-local addresses is
 
281
                automatically assigned to a network interface when it
 
282
                is brought up.
 
283
              </para>
 
284
            </listitem>
 
285
            </varlistentry>
 
286
          </variablelist>
 
287
        </listitem>
 
288
      </varlistentry>
 
289
      <varlistentry>
 
290
        <term>
 
291
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
292
        </term>
 
293
        <listitem>
 
294
          <para>
 
295
            Zeroconf is the network protocol standard used by clients
 
296
            for finding the Mandos server on the local network.
 
297
          </para>
 
298
        </listitem>
 
299
      </varlistentry>
 
300
    </variablelist>
 
301
  </refsect1>
206
302
</refentry>
 
303
<!-- Local Variables: -->
 
304
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
305
<!-- time-stamp-end: "[\"']>" -->
 
306
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
307
<!-- End: -->