/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: Björn Påhlsson
  • Date: 2008-07-20 02:52:20 UTC
  • Revision ID: belorn@braxen-20080720025220-r5u0388uy9iu23h6
Added following support:
Pluginbased client handler
rewritten Mandos client
       Avahi instead of udp server discovery
       openpgp encrypted key support
Passprompt stand alone application for direct console input
Added logging for Mandos server

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