External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-10-30 01:43:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

formatnwfilter.html.in: Kill useless spaces in <pre/>

Browse Source 
The <pre/> section is rendered as-is on the page. That is, if all
the lines are prefixed with 4 spaces the rendered page will also
have them. Problem is if we put a box around such <pre/> because
the content might not fix into it.

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
This commit is contained in:
Michal Privoznik 2016-11-11 23:40:27 +01:00
parent f31be1499b
commit 2780c1a866
1 changed files with 105 additions and 105 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

134
docs/formatnwfilter.html.in
View File

@ -61,14 +61,14 @@
the filter <code>clean-traffic</code>. the filter <code>clean-traffic</code>.
</p> </p>
<pre> <pre>
... ...
&lt;devices&gt; &lt;devices&gt;
&lt;interface type='bridge'&gt; &lt;interface type='bridge'&gt;
&lt;mac address='00:16:3e:5d:c7:9e'/&gt; &lt;mac address='00:16:3e:5d:c7:9e'/&gt;
&lt;filterref filter='clean-traffic'/&gt; &lt;filterref filter='clean-traffic'/&gt;
&lt;/interface&gt; &lt;/interface&gt;
&lt;/devices&gt; &lt;/devices&gt;
...</pre> ...</pre>
<p> <p>
Network filters are written in XML and may either contain references Network filters are written in XML and may either contain references
@ -91,16 +91,16 @@
the parameter <code>IP</code> and a dotted IP address as value. the parameter <code>IP</code> and a dotted IP address as value.
</p> </p>
<pre> <pre>
... ...
&lt;devices&gt; &lt;devices&gt;
&lt;interface type='bridge'&gt; &lt;interface type='bridge'&gt;
&lt;mac address='00:16:3e:5d:c7:9e'/&gt; &lt;mac address='00:16:3e:5d:c7:9e'/&gt;
&lt;filterref filter='clean-traffic'&gt; &lt;filterref filter='clean-traffic'&gt;
&lt;parameter name='IP' value='10.0.0.1'/&gt; &lt;parameter name='IP' value='10.0.0.1'/&gt;
&lt;/filterref&gt; &lt;/filterref&gt;
&lt;/interface&gt; &lt;/interface&gt;
&lt;/devices&gt; &lt;/devices&gt;
...</pre> ...</pre>
<p> <p>
In this particular example, the <code>clean-traffic</code> network In this particular example, the <code>clean-traffic</code> network
@ -285,8 +285,8 @@
providing multiple elements for the IP variable is: providing multiple elements for the IP variable is:
</p> </p>
<pre> <pre>
... ...
&lt;devices&gt; &lt;devices&gt;
&lt;interface type='bridge'&gt; &lt;interface type='bridge'&gt;
&lt;mac address='00:16:3e:5d:c7:9e'/&gt; &lt;mac address='00:16:3e:5d:c7:9e'/&gt;
&lt;filterref filter='clean-traffic'&gt; &lt;filterref filter='clean-traffic'&gt;
@ -295,8 +295,8 @@
&lt;parameter name='IP' value='10.0.0.3'/&gt; &lt;parameter name='IP' value='10.0.0.3'/&gt;
&lt;/filterref&gt; &lt;/filterref&gt;
&lt;/interface&gt; &lt;/interface&gt;
&lt;/devices&gt; &lt;/devices&gt;
...</pre> ...</pre>
<p> <p>
This then allows filters to enable multiple IP addresses This then allows filters to enable multiple IP addresses
per interface. Therefore, with the list per interface. Therefore, with the list
@ -304,11 +304,11 @@
individual filtering rules, one for each IP address. individual filtering rules, one for each IP address.
</p> </p>
<pre> <pre>
... ...
&lt;rule action='accept' direction='in' priority='500'&gt; &lt;rule action='accept' direction='in' priority='500'&gt;
&lt;tcp srpipaddr='$IP'/&gt; &lt;tcp srpipaddr='$IP'/&gt;
&lt;/rule&gt; &lt;/rule&gt;
... ...
</pre> </pre>
<p> <p>
<span class="since">Since 0.9.10</span> it is possible to access <span class="since">Since 0.9.10</span> it is possible to access
@ -317,11 +317,11 @@
of the variable DSTPORTS. of the variable DSTPORTS.
</p> </p>
<pre> <pre>
... ...
&lt;rule action='accept' direction='in' priority='500'&gt; &lt;rule action='accept' direction='in' priority='500'&gt;
&lt;udp dstportstart='$DSTPORTS[1]'/&gt; &lt;udp dstportstart='$DSTPORTS[1]'/&gt;
&lt;/rule&gt; &lt;/rule&gt;
... ...
</pre> </pre>
<p> <p>
<span class="since">Since 0.9.10</span> it is possible to create <span class="since">Since 0.9.10</span> it is possible to create
@ -336,29 +336,29 @@
iterators to access their elements. iterators to access their elements.
</p> </p>
<pre> <pre>
... ...
&lt;rule action='accept' direction='in' priority='500'&gt; &lt;rule action='accept' direction='in' priority='500'&gt;
&lt;ip srcipaddr='$SRCIPADDRESSES[@1]' dstportstart='$DSTPORTS[@2]'/&gt; &lt;ip srcipaddr='$SRCIPADDRESSES[@1]' dstportstart='$DSTPORTS[@2]'/&gt;
&lt;/rule&gt; &lt;/rule&gt;
... ...
</pre> </pre>
<p> <p>
In an example we assign concrete values to SRCIPADDRESSES and DSTPORTS In an example we assign concrete values to SRCIPADDRESSES and DSTPORTS
</p> </p>
<pre> <pre>
SRCIPADDRESSES = [ 10.0.0.1, 11.1.2.3 ] SRCIPADDRESSES = [ 10.0.0.1, 11.1.2.3 ]
DSTPORTS = [ 80, 8080 ] DSTPORTS = [ 80, 8080 ]
</pre> </pre>
<p> <p>
Accessing the variables using $SRCIPADDRESSES[@1] and $DSTPORTS[@2] would Accessing the variables using $SRCIPADDRESSES[@1] and $DSTPORTS[@2] would
then result in all combinations of addresses and ports being created: then result in all combinations of addresses and ports being created:
</p> </p>
<pre> <pre>
10.0.0.1, 80 10.0.0.1, 80
10.0.0.1, 8080 10.0.0.1, 8080
11.1.2.3, 80 11.1.2.3, 80
11.1.2.3, 8080 11.1.2.3, 8080
</pre> </pre>
<p> <p>
Accessing the same variables using a single iterator, for example by using Accessing the same variables using a single iterator, for example by using
@ -366,8 +366,8 @@
parallel access to both lists and result in the following combinations: parallel access to both lists and result in the following combinations:
</p> </p>
<pre> <pre>
10.0.0.1, 80 10.0.0.1, 80
11.1.2.3, 8080 11.1.2.3, 8080
</pre> </pre>
<p> <p>
Further, the notation of $VARIABLE is short-hand for $VARIABLE[@0]. The Further, the notation of $VARIABLE is short-hand for $VARIABLE[@0]. The
@ -440,12 +440,12 @@
using the DHCP snooping method: using the DHCP snooping method:
</p> </p>
<pre> <pre>
&lt;interface type='bridge'&gt; &lt;interface type='bridge'&gt;
&lt;source bridge='virbr0'/&gt; &lt;source bridge='virbr0'/&gt;
&lt;filterref filter='clean-traffic'&gt; &lt;filterref filter='clean-traffic'&gt;
&lt;parameter name='CTRL_IP_LEARNING' value='dhcp'/&gt; &lt;parameter name='CTRL_IP_LEARNING' value='dhcp'/&gt;
&lt;/filterref&gt; &lt;/filterref&gt;
&lt;/interface&gt; &lt;/interface&gt;
</pre> </pre>
<h3><a name="nwfelemsReservedVars">Reserved Variables</a></h3> <h3><a name="nwfelemsReservedVars">Reserved Variables</a></h3>
@ -658,10 +658,10 @@
</p> </p>
<pre> <pre>
[...] [...]
&lt;rule action='drop' direction='in'&gt; &lt;rule action='drop' direction='in'&gt;
&lt;protocol match='no' attribute1='value1' attribute2='value2'/&gt; &lt;protocol match='no' attribute1='value1' attribute2='value2'/&gt;
&lt;protocol attribute3='value3'/&gt; &lt;protocol attribute3='value3'/&gt;
&lt;/rule&gt; &lt;/rule&gt;
[...] [...]
</pre> </pre>
<p> <p>
@ -1896,11 +1896,11 @@
turned off for incoming connections to TCP port 12345. turned off for incoming connections to TCP port 12345.
</p> </p>
<pre> <pre>
[...] [...]
&lt;rule direction='in' action='accept' statematch='false'&gt; &lt;rule direction='in' action='accept' statematch='false'&gt;
&lt;tcp dstportstart='12345'/&gt; &lt;tcp dstportstart='12345'/&gt;
&lt;/rule&gt; &lt;/rule&gt;
[...] [...]
</pre> </pre>
<p> <p>
This now allows incoming traffic to TCP port 12345, but would also This now allows incoming traffic to TCP port 12345, but would also
@ -1918,26 +1918,26 @@
time, the following XML fragment can be used to achieve this. time, the following XML fragment can be used to achieve this.
</p> </p>
<pre> <pre>
[...] [...]
&lt;rule action='drop' direction='in' priority='400'&gt; &lt;rule action='drop' direction='in' priority='400'&gt;
&lt;tcp connlimit-above='1'/&gt; &lt;tcp connlimit-above='1'/&gt;
&lt;/rule&gt; &lt;/rule&gt;
&lt;rule action='accept' direction='in' priority='500'&gt; &lt;rule action='accept' direction='in' priority='500'&gt;
&lt;tcp dstportstart='22'/&gt; &lt;tcp dstportstart='22'/&gt;
&lt;/rule&gt; &lt;/rule&gt;
&lt;rule action='drop' direction='out' priority='400'&gt; &lt;rule action='drop' direction='out' priority='400'&gt;
&lt;icmp connlimit-above='1'/&gt; &lt;icmp connlimit-above='1'/&gt;
&lt;/rule&gt; &lt;/rule&gt;
&lt;rule action='accept' direction='out' priority='500'&gt; &lt;rule action='accept' direction='out' priority='500'&gt;
&lt;icmp/&gt; &lt;icmp/&gt;
&lt;/rule&gt; &lt;/rule&gt;
&lt;rule action='accept' direction='out' priority='500'&gt; &lt;rule action='accept' direction='out' priority='500'&gt;
&lt;udp dstportstart='53'/&gt; &lt;udp dstportstart='53'/&gt;
&lt;/rule&gt; &lt;/rule&gt;
&lt;rule action='drop' direction='inout' priority='1000'&gt; &lt;rule action='drop' direction='inout' priority='1000'&gt;
&lt;all/&gt; &lt;all/&gt;
&lt;/rule&gt; &lt;/rule&gt;
[...] [...]
</pre> </pre>
<p> <p>
Note that the rule for the limit has to logically appear Note that the rule for the limit has to logically appear
@ -1958,7 +1958,7 @@
</p> </p>
<pre> <pre>
echo 3 > /proc/sys/net/netfilter/nf_conntrack_icmp_timeout echo 3 > /proc/sys/net/netfilter/nf_conntrack_icmp_timeout
</pre> </pre>
<p> <p>
sets the ICMP connection tracking timeout to 3 seconds. The sets the ICMP connection tracking timeout to 3 seconds. The
@ -2201,12 +2201,12 @@
the domain XML of the <code>test</code> VM could then look like this: the domain XML of the <code>test</code> VM could then look like this:
</p> </p>
<pre> <pre>
[...] [...]
&lt;interface type='bridge'&gt; &lt;interface type='bridge'&gt;
&lt;source bridge='mybridge'/&gt; &lt;source bridge='mybridge'/&gt;
&lt;filterref filter='test-eth0'/&gt; &lt;filterref filter='test-eth0'/&gt;
&lt;/interface&gt; &lt;/interface&gt;
[...] [...]
</pre> </pre>
<p> <p>
@ -2216,15 +2216,15 @@
<code>ICMP</code> rule can be replaced with the following two rules: <code>ICMP</code> rule can be replaced with the following two rules:
</p> </p>
<pre> <pre>
&lt;!-- enable outgoing ICMP echo requests--&gt; &lt;!-- enable outgoing ICMP echo requests--&gt;
&lt;rule action='accept' direction='out'&gt; &lt;rule action='accept' direction='out'&gt;
&lt;icmp type='8'/&gt; &lt;icmp type='8'/&gt;
&lt;/rule&gt; &lt;/rule&gt;
&lt;!-- enable incoming ICMP echo replies--&gt; &lt;!-- enable incoming ICMP echo replies--&gt;
&lt;rule action='accept' direction='in'&gt; &lt;rule action='accept' direction='in'&gt;
&lt;icmp type='0'/&gt; &lt;icmp type='0'/&gt;
&lt;/rule&gt; &lt;/rule&gt;
</pre> </pre>
<h3><a name="nwfwriteexample2nd">Second example custom filter</a></h3> <h3><a name="nwfwriteexample2nd">Second example custom filter</a></h3>
@ -2326,9 +2326,9 @@
the ftp connection with the VM is established. the ftp connection with the VM is established.
</p> </p>
<pre> <pre>
modprobe nf_conntrack_ftp # where available or modprobe nf_conntrack_ftp # where available or
modprobe ip_conntrack_ftp # if above is not available modprobe ip_conntrack_ftp # if above is not available
</pre> </pre>
<p> <p>
If other protocols than ftp are to be used in conjunction with the If other protocols than ftp are to be used in conjunction with the