/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-options.xml

  • Committer: Teddy Hogeborn
  • Date: 2019-08-05 21:14:05 UTC
  • Revision ID: teddy@recompile.se-20190805211405-9m6hecekaihpttz9
Override lintian warnings about upgrading from old versions

There are some really things which are imperative that we fix in case
someone were to upgrade from a really old version.  We want to keep
these fixes in the postinst maintainer scripts, even though lintian
complains about such old upgrades not being supported by Debian in
general.  We prefer the code being there, for the sake of the users.

* debian/mandos-client.lintian-overrides
  (maintainer-script-supports-ancient-package-version): New.
  debian/mandos.lintian-overrides
  (maintainer-script-supports-ancient-package-version): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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
    <!-- &#x200b; is Unicode ZERO WIDTH SPACE; allows line breaks -->
 
53
    <quote><literal>SECURE128&#x200b;:!CTYPE-X.509&#x200b;:+CTYPE-RAWPK&#x200b;:!RSA&#x200b;:!VERS-ALL&#x200b;:+VERS-TLS1.3&#x200b;:%PROFILE_ULTRA</literal></quote>
 
54
    when using raw public keys in TLS, and
 
55
    <quote><literal>SECURE256&#x200b;:!CTYPE-X.509&#x200b;:+CTYPE-OPENPGP&#x200b;:!RSA&#x200b;:+SIGN-DSA-SHA256</literal></quote>
 
56
    when using OpenPGP keys in TLS,.  See <citerefentry><refentrytitle
 
57
    >gnutls_priority_init</refentrytitle>
 
58
    <manvolnum>3</manvolnum></citerefentry> for the syntax.
 
59
    <emphasis>Warning</emphasis>: changing this may make the
 
60
    <acronym>TLS</acronym> handshake fail, making server-client
 
61
    communication impossible.  Changing this option may also make the
 
62
    network traffic decryptable by an attacker.
 
63
  </para>
 
64
  
 
65
  <para id="servicename">
 
66
    Zeroconf service name.  The default is
 
67
    <quote><literal>Mandos</literal></quote>.  This only needs to be
 
68
    changed if for some reason is would be necessary to run more than
 
69
    one server on the same <emphasis>host</emphasis>.  This would not
 
70
    normally be useful.  If there are name collisions on the same
 
71
    <emphasis>network</emphasis>, the newer server will automatically
 
72
    rename itself to <quote><literal>Mandos #2</literal></quote>, and
 
73
    so on; therefore, this option is not needed in that case.
 
74
  </para>
 
75
  
 
76
  <para id="dbus">
 
77
    This option controls whether the server will provide a D-Bus
 
78
    system bus interface.  The default is to provide such an
 
79
    interface.
 
80
  </para>
 
81
  
 
82
  <para id="ipv6">
 
83
    This option controls whether the server will use IPv6 sockets and
 
84
    addresses.  The default is to use IPv6.  This option should
 
85
    <emphasis>never</emphasis> normally be turned off, <emphasis>even in
 
86
    IPv4-only environments</emphasis>.  This is because <citerefentry>
 
87
    <refentrytitle>mandos-client</refentrytitle>
 
88
    <manvolnum>8mandos</manvolnum></citerefentry> will normally use
 
89
    IPv6 link-local addresses, and will not be able to find or connect
 
90
    to the server if this option is turned off.  <emphasis>Only
 
91
    advanced users should consider changing this option</emphasis>.
 
92
  </para>
 
93
  
 
94
  <para id="restore">
 
95
    This option controls whether the server will restore its state
 
96
    from the last time it ran.  Default is to restore last state.
 
97
  </para>
 
98
  
 
99
  <para id="statedir">
 
100
    Directory to save (and restore) state in.  Default is
 
101
    <quote><filename
 
102
    class="directory">/var/lib/mandos</filename></quote>.
 
103
  </para>
 
104
  
 
105
  <para id="socket">
 
106
    If this option is used, the server will not create a new network
 
107
    socket, but will instead use the supplied file descriptor.  By
 
108
    default, the server will create a new network socket.
 
109
  </para>
 
110
  
 
111
  <para id="foreground">
 
112
    This option will make the server run in the foreground and not
 
113
    write a PID file.  The default is to <emphasis>not</emphasis> run
 
114
    in the foreground, except in <option>debug</option> mode, which
 
115
    implies this option.
 
116
  </para>
 
117
  
 
118
  <para id="zeroconf">
 
119
    This option controls whether the server will announce its
 
120
    existence using Zeroconf.  Default is to use Zeroconf.  If
 
121
    Zeroconf is not used, a <option>port</option> number or a
 
122
    <option>socket</option> is required.
 
123
  </para>
 
124
  
 
125
</section>