# ARM Research Labs Sniffer Plugin for CommuniGate Pro
- Download the Sniffer Plugin
- Installation
  - Installing on a MS Windows 200x/NT/XP/9x System
  - Installing on a Linux System
  - Installing on a FreeBSD or OpenBSD System
  - Installing from source
- Upgrading to a newer version
- Configuring the Sniffer Plugin
- Testing the Sniffer Plugin
- Command line options
- Integrating the Sniffer Plugin with CommuniGate Pro
- Updating the spam definitions database

Note: The ARM Research Labs Sniffer Plugin is available only for some platforms supported with the CommuniGate Pro server software. Before you order the Sniffer Plugin License, make sure that the available versions of the Sniffer Plugin software run on your CommuniGate Pro Server platform.

Note: The ARM Research Labs Sniffer Plugin requires CommuniGatePro version 5.2.3 or later.

##

Download the ARM Research Labs Sniffer Plugins

  ARM Research Labs Sniffer antispam plugins are available for certain platforms only.

  Operating System | CPU | Download
  --- | --- | ---
  via http | via ftp
  Microsoft Windows NT/2000/XP Microsoft Windows 95/98 | x86 |  |
  Linux (RedHat/Fedora/CentOS, Ubuntu, SuSE) | x86 |  |
  x86_64 |  |
  FreeBSD 7.x | x86 |  |
  x86_64 |  |
  OpenBSD 4.4 or later | x86 |  |
  x86_64 |  |

The current version of the Plugin is 0.1.0.

The current version of the ARM Research Labs Sniffer Engine is 3.0.11.

###

Upgrading to a newer version.

When upgrading the Plugin to a newer version, do the following:

- Stop the current copy of the plugin application via CommuniGate Pro WebAdmin interface.
- Install and configure the new version of the Plugin as described above in this document.

###

Installing on a MS Windows 200x/NT/XP/9x System.

- Open the command-line interface window and change the current directory to the CommuniGate Pro base directory.
- Use any "unzip"-type tool to unpack the `CGPSNF-Win32-Intel.zip` file. The `CGPSNF` directory will be created inside the base directory.
- Proceed with Configuring the Sniffer Plugin.

###

Installing on a Linux System.

- Log in as a super-user (root).
- Change the current directory to the CommuniGate Pro base directory.
- Unpack the Plugin archive with the `gtar` command (or with the `gunzip` and `tar` commands):`
  gunzip CGPSNF-Linux-Intel.tar.gz
  tar -xf CGPSNF-Linux-Intel.tar`
  The `CGPSNF` directory will be created inside the base directory.
- Proceed with Configuring the Sniffer Plugin.

###

Installing on a FreeBSD or OpenBSD System.

- Log in as a super-user (root).
- Change the current directory to the CommuniGate Pro base directory.
- Unpack the Plugin archive with the `gtar` command (or with the `gunzip` and `tar` commands):`
  gunzip CGPSNF-FreeBSD-Intel.tar.gz
  tar -xf CGPSNF-FreeBSD-Intel.tar`
  The `CGPSNF` directory will be created inside the base directory.
- Proceed with Configuring the Sniffer Plugin.

###

Installing from source.

You can build the Sniffer Plugin from source:

- Download the `snf4cgp-X.Y.Z.tar.gz`, where X.Y.Z is the version.
- Extract the sources with the command:`
  tar -xzf snf4cgp-X.Y.Z.tar.gz`
  This creates a directory `snf4cgp-X.Y.Z`.
- Change directory to `snf4cgp-X.Y.Z`:`
  cd snf4cgp-X.Y.Z`
- Configure and build the system:`
  ./configure
  ./make`
- Become super-user (root).
- Create the Sniffer Plugin:`
  make module`
  This creates a Plugin archive named `CGPSNF-X.Y.Z-MODULE.tar.gz`.
- Proceed with Installing the Sniffer Plugin for your system, using the Plugin archive that was created.

###

Configuring the Sniffer Plugin.

In the module directory (`/var/CommuniGate/CGPSNF` on a Linux or Linux-like system):

- Copy the configuration file `
  snf_engine.xml.sample`
  to `
  snf_engine.xml`
  and customize as needed. Please see the ARM Research Labs web site for documentation on the `snf_engine.xml` configuration file.
- Copy `
  identity.xml.sample`
  to `
  identity.xml`
  and edit to include the license ID and authentication attributes of the `<identity> element`.
- Copy `
  getRulebase.sample`
  to `
  getRulebase`
  and edit to include the license ID and authentication:
  - Change the line `
    AUTHENTICATION=authenticationxx`
    to `
    AUTHENTICATION=YOUR_AUTHENTICATION`
    where `YOUR_AUTHENTICATION` is authentication code obtained from ARM Research Labs.
  - Change the line `
    LICENSE_ID=licenseid`
    to `
    LICENSE_ID=YOUR_LICENSE_ID`
    where `YOUR_LICENSE_ID` is license ID obtained from ARM Research Labs.
- Make `getRulebase` executable:`
  chmod 755 getRulebase`
- Copy `
  GBUdbIgnoreList.txt.sample`
  to `
  GBUdbIgnoreList.txt`
  and customize as needed. Please see the ARM Research Labs web site for documentation on the `GBUdbIgnoreList.txt` file.
- Download the Sniffer database:
  - Create the file `UpdateReady.txt` in the plugin directory:`
    touch UpdateReady.txt`
  - Run the `getRulebase` script in the plugin directory:`
    ./getRulebase`
    This downloads the Sniffer database to the plugin directory.
  The `CGPSNF` program automatically updates the Sniffer database as needed.
- Proceed with Testing the Sniffer Plugin.

###

Testing the Sniffer Plugin.

On Windows System:

On a Unix System:

- Change to the module directory:`
  cd /var/CommuniGate/CGPSNF`
- Launch the `CGPSNF` application by typing:`
  ./CGPSNF snf_engine.xml`
  It will report the Plugin version number and build date.
- Type:`
  1 FILE junkmsg.txt`
  the plugin should report that the file is spam.
- Quit `CGPSNF` by typing Ctrl-D.

###

Command Line Options

  The Sniffer Plugin supports the following command-line option (parameters):

  `snf_engine.xml`
    This option tells the Plugin to read the `snf_engine.xml` configuration file.

###

Integrating the Sniffer Plugin with CommuniGate Pro.

Please check the External Filters section of the CommuniGate Pro manual.

Open the General page in the Settings section of the WebAdmin Interface and click the Helpers link. Create the Helper as follows:

Content Filtering
Log Level: |  | Program Path: |
Time-out: |  | Auto-Restart: |

Note: For Windows system the Program Path shold be `CGPSNF\CGPSNF.exe CGPSNF\snf_engine.xml`
Note: On some versions of FreeBSD system you may need to specify the full path to the program, i.e. `/var/CommuniGate/CGPSNF/CGPSNF /var/CommuniGate/CGPSNF/snf_engine.xml`

The recommended Scanning Rule is as follows:

Data | Operation | Parameter
--- | --- | ---
Action | Parameter
| ARM Sniffer

CommuniGate® Pro Guide. Copyright © 1998-2009, Stalker Software, Inc.