/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-options.xml

  • Committer: Teddy Hogeborn
  • Date: 2019-02-10 03:50:20 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 370.
  • Revision ID: teddy@recompile.se-20190210035020-nttr1tybgwwixueu
http://bugs.debian.org/879538
http://bugs.debian.org/916673
Show debconf note about new TLS key IDs

If mandos-client did not see TLS keys and had to create them, or if
mandos sees GnuTLS version 3.6.6 or later, show an important notice on
package installation about the importance of adding the new key_id
options to clients.conf on the Mandos server.

* debian/control (Package: mandos, Package: mandos-client): Depend on
                                                            debconf.
* debian/mandos-client.lintian-overrides: Override warnings.
* debian/mandos-client.postinst (create_keys): Show notice if new TLS
                                               key files were created.
* debian/mandos-client.templates: New.
* debian/mandos.lintian-overrides: Override warnings.
* debian/mandos.postinst (configure): If GnuTLS 3.6.6 or later is
                                      detected, show an important
                                      notice (once) about the new
                                      key_id option required in
                                      clients.conf.
* debian/mandos.templates: New.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-options.xml
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
 
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
 
4
 
 
5
<!--
 
6
This file is used by both mandos(8) and mandos.conf(5), since these
 
7
options can be used both on the command line and in the config file.
 
8
 
 
9
It is also used for some texts by mandos-client(8mandos).
 
10
-->
 
11
 
 
12
<section>
 
13
  <title/>
 
14
  
 
15
  <para id="interface">
 
16
    If this is specified, the server will only announce the service
 
17
    and listen to requests on the specified network interface.
 
18
    Default is to use all available interfaces.  <emphasis
 
19
    >Note:</emphasis> a failure to bind to the specified
 
20
    interface is not considered critical, and the server will not
 
21
    exit, but instead continue normally.
 
22
  </para>
 
23
  
 
24
  <para id="address">
 
25
    If this option is used, the server will only listen to the
 
26
    specified IPv6 address.  If a link-local address is specified, an
 
27
    interface should be set, since a link-local address is only valid
 
28
    on a single interface.  By default, the server will listen to all
 
29
    available addresses.  If set, this must normally be an IPv6
 
30
    address; an IPv4 address can only be specified using IPv4-mapped
 
31
    IPv6 address syntax: <quote><systemitem class="ipaddress"
 
32
    >::FFFF:192.0.2.3</systemitem ></quote>.  (Only if IPv6 usage is
 
33
    <emphasis>disabled</emphasis> (see below) must this be an IPv4
 
34
    address.)
 
35
  </para>
 
36
  
 
37
  <para id="port">
 
38
    If this option is used, the server will bind to that port. By
 
39
    default, the server will listen to an arbitrary port given by the
 
40
    operating system.
 
41
  </para>
 
42
  
 
43
  <para id="debug">
 
44
    If the server is run in debug mode, it will run in the foreground
 
45
    and print a lot of debugging information.  The default is to
 
46
    <emphasis>not</emphasis> run in debug mode.
 
47
  </para>
 
48
  
 
49
  <para id="priority">
 
50
    GnuTLS priority string for the <acronym>TLS</acronym> handshake.
 
51
    The default is
 
52
    <quote><literal>SECURE128&#8203;:!CTYPE-X.509&#8203;:+CTYPE-RAWPK&#8203;:!RSA&#8203;:!VERS-ALL&#8203;:+VERS-TLS1.3&#8203;:%PROFILE_ULTRA</literal></quote>
 
53
    when using raw public keys in TLS, and
 
54
    <quote><literal>SECURE256&#8203;:!CTYPE-X.509&#8203;:+CTYPE-OPENPGP&#8203;:!RSA&#8203;:+SIGN-DSA-SHA256</literal></quote>
 
55
    when using OpenPGP keys in TLS,.  See <citerefentry><refentrytitle
 
56
    >gnutls_priority_init</refentrytitle>
 
57
    <manvolnum>3</manvolnum></citerefentry> for the syntax.
 
58
    <emphasis>Warning</emphasis>: changing this may make the
 
59
    <acronym>TLS</acronym> handshake fail, making server-client
 
60
    communication impossible.  Changing this option may also make the
 
61
    network traffic decryptable by an attacker.
 
62
  </para>
 
63
  
 
64
  <para id="servicename">
 
65
    Zeroconf service name.  The default is
 
66
    <quote><literal>Mandos</literal></quote>.  This only needs to be
 
67
    changed if for some reason is would be necessary to run more than
 
68
    one server on the same <emphasis>host</emphasis>.  This would not
 
69
    normally be useful.  If there are name collisions on the same
 
70
    <emphasis>network</emphasis>, the newer server will automatically
 
71
    rename itself to <quote><literal>Mandos #2</literal></quote>, and
 
72
    so on; therefore, this option is not needed in that case.
 
73
  </para>
 
74
  
 
75
  <para id="dbus">
 
76
    This option controls whether the server will provide a D-Bus
 
77
    system bus interface.  The default is to provide such an
 
78
    interface.
 
79
  </para>
 
80
  
 
81
  <para id="ipv6">
 
82
    This option controls whether the server will use IPv6 sockets and
 
83
    addresses.  The default is to use IPv6.  This option should
 
84
    <emphasis>never</emphasis> normally be turned off, <emphasis>even in
 
85
    IPv4-only environments</emphasis>.  This is because <citerefentry>
 
86
    <refentrytitle>mandos-client</refentrytitle>
 
87
    <manvolnum>8mandos</manvolnum></citerefentry> will normally use
 
88
    IPv6 link-local addresses, and will not be able to find or connect
 
89
    to the server if this option is turned off.  <emphasis>Only
 
90
    advanced users should consider changing this option</emphasis>.
 
91
  </para>
 
92
  
 
93
  <para id="restore">
 
94
    This option controls whether the server will restore its state
 
95
    from the last time it ran.  Default is to restore last state.
 
96
  </para>
 
97
  
 
98
  <para id="statedir">
 
99
    Directory to save (and restore) state in.  Default is
 
100
    <quote><filename
 
101
    class="directory">/var/lib/mandos</filename></quote>.
 
102
  </para>
 
103
  
 
104
  <para id="socket">
 
105
    If this option is used, the server will not create a new network
 
106
    socket, but will instead use the supplied file descriptor.  By
 
107
    default, the server will create a new network socket.
 
108
  </para>
 
109
  
 
110
  <para id="foreground">
 
111
    This option will make the server run in the foreground and not
 
112
    write a PID file.  The default is to <emphasis>not</emphasis> run
 
113
    in the foreground, except in <option>debug</option> mode, which
 
114
    implies this option.
 
115
  </para>
 
116
  
 
117
  <para id="zeroconf">
 
118
    This option controls whether the server will announce its
 
119
    existence using Zeroconf.  Default is to use Zeroconf.  If
 
120
    Zeroconf is not used, a <option>port</option> number or a
 
121
    <option>socket</option> is required.
 
122
  </para>
 
123
  
 
124
</section>