/mandos/trunk

To get this branch, use:
bzr branch /loggerhead/mandos/trunk
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
1
<?xml version="1.0" encoding="UTF-8"?>
95 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: corrected patterns.
2
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
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.
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
8
171 by Teddy Hogeborn
Renamed "password-request" to "mandos-client".
9
It is also used for some texts by mandos-client(8mandos).
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
10
-->
11
91 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
12
<section>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
13
  <title/>
14
  
15
  <para id="interface">
16
    If this is specified, the server will only announce the service
105 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Only cd to one directory.
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
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
20
    interface is not considered critical, and the server will not
21
    exit, but instead continue normally.
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
22
  </para>
23
  
24
  <para id="address">
95 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: corrected patterns.
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
314 by Teddy Hogeborn
Support not using IPv6 in server:
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.)
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
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
105 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Only cd to one directory.
45
    and print a lot of debugging information.  The default is to
46
    <emphasis>not</emphasis> run in debug mode.
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
47
  </para>
48
  
777 by Teddy Hogeborn
Bug fix for GnuTLS 3: be compatible with old 2048-bit DSA keys.
49
  <para id="priority">
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
50
    GnuTLS priority string for the <acronym>TLS</acronym> handshake.
962 by Teddy Hogeborn
Add support for using raw public keys in TLS (RFC 7250)
51
    The default is
1123 by Teddy Hogeborn
Use hexadecimal unicode character references, not decimal
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>
962 by Teddy Hogeborn
Add support for using raw public keys in TLS (RFC 7250)
54
    when using raw public keys in TLS, and
1123 by Teddy Hogeborn
Use hexadecimal unicode character references, not decimal
55
    <quote><literal>SECURE256&#x200b;:!CTYPE-X.509&#x200b;:+CTYPE-OPENPGP&#x200b;:!RSA&#x200b;:+SIGN-DSA-SHA256</literal></quote>
962 by Teddy Hogeborn
Add support for using raw public keys in TLS (RFC 7250)
56
    when using OpenPGP keys in TLS,.  See <citerefentry><refentrytitle
742 by Teddy Hogeborn
Add ":!RSA" to GnuTLS priority string, to disallow non-DHE kx.
57
    >gnutls_priority_init</refentrytitle>
634 by Teddy Hogeborn
* debian/control (Build-Depends): Changed debhelper version to (>= 9)
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
742 by Teddy Hogeborn
Add ":!RSA" to GnuTLS priority string, to disallow non-DHE kx.
61
    communication impossible.  Changing this option may also make the
62
    network traffic decryptable by an attacker.
634 by Teddy Hogeborn
* debian/control (Build-Depends): Changed debhelper version to (>= 9)
63
  </para>
64
  
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
65
  <para id="servicename">
66
    Zeroconf service name.  The default is
67
    <quote><literal>Mandos</literal></quote>.  This only needs to be
216 by Teddy Hogeborn
* Makefile: Add HTML rules for manual pages.
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
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
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>
314 by Teddy Hogeborn
Support not using IPv6 in server:
75
  
243 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
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>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
81
  
314 by Teddy Hogeborn
Support not using IPv6 in server:
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>
518.2.2 by Teddy Hogeborn
Directory with persistent state can now be changed with the "statedir"
93
  
518.1.1 by Björn Påhlsson
Persistent state: New feature. Client state is now stored when mandos
94
  <para id="restore">
546 by Teddy Hogeborn
* debian/rules (binary-common): Exclude network-hooks.d from
95
    This option controls whether the server will restore its state
96
    from the last time it ran.  Default is to restore last state.
518.1.1 by Björn Påhlsson
Persistent state: New feature. Client state is now stored when mandos
97
  </para>
314 by Teddy Hogeborn
Support not using IPv6 in server:
98
  
518.2.2 by Teddy Hogeborn
Directory with persistent state can now be changed with the "statedir"
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
  
589.1.1 by Teddy Hogeborn
* mandos: Implement "--socket" option.
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
  
606 by Teddy Hogeborn
* mandos: New "--foreground" option.
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
  
707 by Teddy Hogeborn
mandos: New "--no-zeroconf" option. Also make "--socket=0" work.
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
  
91 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
125
</section>