done implementing omudpspoof

This is now a "good" rsyslog output module, working as usual. I've also
sorted out some reentrency issues. Code is clean and ready to be tested
in practice ;)

1 files changed, 37 insertions, 4 deletions

diff --git a/doc/omudpspoof.html b/doc/omudpspoof.html
index 7715b80c..e5f963c7 100644
--- a/doc/omudpspoof.html
+++ b/doc/omudpspoof.html
@@ -12,13 +12,29 @@
 <p><b>Available Since</b>: 5.1.3</p>
 <p><b>Description</b>:</p>
 <p>This module is similar to the regular UDP forwarder, but permits to
-spoof the sender address.
+spoof the sender address. Also, it enables to circle through a number of
+source ports.
 <p><b>Configuration Directives</b>:</p>
 <ul>
+<li><b>$ActionUDPSpoofSourceNameTemplate</b> &lt;templatename&gt;<br>
+This MUST be specified. It is the name of the template that contains a
+numerical IP address that is to be used as the source system IP address.
+While it may often be a constant value, it can be generated as usual via the
+property replacer, as long as it is a valid IPv4 address.
+<li><b>$ActionUDPSpoofTargetHost</b> &lt;hostname&gt;<br>
+Host that the messages shall be sent to.
+<li><b>$ActionUDPSpoofTargetPort</b> &lt;port&gt;<br>
+Remote port that the messages shall be sent to.
 <li><b>$ActionUDPSpoofDefaultTemplate</b> &lt;templatename&gt;<br>
 This setting instructs omudpspoof to use a template different from the
 default template for all of its actions that do not have a template specified
 explicitely.
+<li><b>$ActionUDPSpoofSourcePortStart</b> &lt;number&gt;<br>
+Specifies the start value for circeling the source ports. Must be less than or
+equal to the end value. Default is 32000.
+<li><b>$ActionUDPSpoofSourcePortEnd</b> &lt;number&gt;<br>
+Specifies the ending value for circeling the source ports. Must be less than or
+equal to the start value. Default is 42000.
 </ul>
 <b>Caveats/Known Bugs:</b>
 <ul>
@@ -27,11 +43,28 @@ know via the rsyslog mailing list.
 </ul>
 <p><b>Sample:</b></p>
 <p>The following sample forwards all syslog messages in unmodified form to the
-remote server server.example.com. The sender address 192.0.2.1 is used.
+remote server server.example.com. The sender address 192.0.2.1 with the fixed
+source port 514 is used.
+</p>
+<textarea rows="8" cols="80">$ModLoad omudpspoof
+$template spoofaddr,"192.0.2.1"
+$template spooftemplate,"%rawmsg%"
+$ActionUDPSpoofSourceNameTemplate spoofaddr
+$ActionUDPSpoofTargetHost server.example.com
+$ActionUDPSpoofSourcePortStart 514
+$ActionUDPSpoofSourcePortEnd 514
+*.*&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; :omudpspoof:;spooftemplate
+</textarea>
+<p>The following sample is similar to the first, but uses as many defaults as possible.
+In that sample, a source port in the range 32000..42000 is used. The message is formatted
+according to rsyslog's canned default forwarding format. Note that if any parameters
+have been changed, the previously set defaults will be used!
 </p>
 <textarea rows="5" cols="80">$ModLoad omudpspoof
-$template spooftemplate,"192.0.2.1 %rawmsg%"
-*.*&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; :omudpspoof:server.example.com;spooftemplate
+$template spoofaddr,"192.0.2.1"
+$ActionUDPSpoofSourceNameTemplate spoofaddr
+$ActionUDPSpoofTargetHost server.example.com
+*.*&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; :omudpspoof:
 </textarea>
 <p>[<a href="rsyslog_conf.html">rsyslog.conf overview</a>]
 [<a href="manual.html">manual index</a>] [<a href="http://www.rsyslog.com/">rsyslog site</a>]</p>