SNF V2.x to V3.x Source Distribution Readme

Version 3.x of SNF is a departure from previous versions of Message
Sniffer on many levels. Though the core scanning engine and rulebase
files are the same, the new version uses a client/server model.

The client and server programs connect via TCP/Localhost port 9001.

If this is your first experience with SNF in a *nix environment then
please use the snfv2-3.5-PostfixExample as a guied.

The new SNF engine and client are designed to work in parallel
with prior versions of SNF so that it is easy to switch back if
neede. In general all you need to do to switch between versions is
to swap out the client executable in your scripts that scan messages
with SNF. Be careful to read and understand your configuration!

The SNFClient program is compatible with the old snf program when
used as a scanner.

The SNFServer program takes the place of a persistent instance of SNF
and is required for the new version.

The old program will generally ignore the new program and the new
program will generally ignore the old program.

The easiest way to convert a system from the previous (2-3) version
of SNF to the new version is:

* Copy the source distribution to it's own directory.

* Run . compile in each of the client and source directories.

* Copy the working files to your /var/spool/snfilter directory.

cp SNF_Service/SNFServer.exe /var/spool/snfilter
cp SNF_Client/SNFClient.exe /var/spool/snfilter
cp identity.xml /var/spool/snfilter
cp snf_engine.xml /var/spool/snfilter
cp GBUdbIgnoreList.txt /var/spool/snfilter

* Follow the SNFServer_readme.txt instructions and carefully
configure your snf_engine.xml, identity.xml, and GBUdbIgnoreList.txt
files.

When you are ready to go, launch the SNFServer.exe program with
the full path to the configuration file.

/var/spool/snfilter/SNFServer.exe /var/spool/snfilter/snf_engine.xml

If you run this from the console you will see a handy real-time
monitor.

To cleanly shut down the SNFServer use:

SNFClient.exe -shutdown

__________________________________________________________
IF YOU ARE USING THE snfilter SCRIPT or something similar:

* Modify your snfilter script to call the new SNFClient.exe

SNIFFER_EXE=/var/spool/snfilter/SNFClient.exe

* If your script is designed to inject headers then you could use
the new xheader feature in the new engine. To do this:

** Comment out the section of your script which modifies the message.
** Turn on xheader injection in the snf_engine.xml file

  <xheaders>
  <!-- X-Header formatting and output options -->
      <output mode='inject'/>

_________________________________________
IF YOU ARE USING THE SpamAssassin Plugin:

Adjust your snfilter.pm to point to the new SNFClient.exe 

my $sniffer='SNFClient.exe';

Note: The SNFClient.exe program will accept and ignore the
authentication string so there is no reason to change your
$key.

