You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-15">
  5. <title>CommuniGate Pro: ARM Research Labs Sniffer Antispam Plugin</title>
  6. <link rel="stylesheet" href="GuideStyle.css" type="text/css" />
  7. <link rel="stylesheet" href="AdminStyle.css" type="text/css" />
  8. </head>
  9. <body>
  10. <table border="0" cellPadding="0" cellSpacing="0" width="100%">
  11. <tr>
  12. <td class="tabBodyOuter">
  13. <table class="tabBody" width="100%" cellspacing="0"
  14. cellpadding="0">
  15. <tr>
  16. <td>
  17. <h1>ARM Research Labs Sniffer Plugin for CommuniGate
  18. Pro</h1>
  19. <div class="guideTOC">
  20. <ul>
  21. <table class="tabBody" width="100%" cellspacing="0"
  22. cellpadding="0">
  23. <li><a href="#Download">Download the Sniffer Plugin</a>
  24. <li><a href="#Install" name=Install>Installation</a>
  25. <ul>
  26. <li><a href="#WIN32">Installing on a MS Windows
  27. 200x/NT/XP/9x system</a>
  28. <li><a href="#Linux">Installing on a Linux
  29. system</a>
  30. <li><a href="#FreeBSD">Installing on a FreeBSD
  31. system</a>
  32. <li><a href="#OpenBSD">Installing on an OpenBSD
  33. system</a>
  34. <li><a href="#Source">Installing from source</a>
  35. </ul>
  36. <li><a href="#Upgrading">Upgrading to a newer
  37. version</a>
  38. <li><a href="#Config">Configuring the Sniffer
  39. Plugin</a>
  40. <li><a href="#Test">Testing the Sniffer Plugin</a>
  41. <li><a href="#Options">Command line options</a>
  42. <li><a href="#Integrate">Integrating the Sniffer
  43. Plugin with CommuniGate Pro</a>
  44. <li><a href="#Update">Updating the spam definitions
  45. database</a>
  46. </ul>
  47. </div>
  48. </td>
  49. </tr>
  50. </table>
  51. </tr>
  52. </table>
  53. </tr>
  54. </td>
  55. </table>
  56. <p><b>Note:</b> The ARM Research Labs Sniffer Plugin is not available
  57. on platforms. Before you order the Sniffer License, make sure that
  58. the available versions of the Sniffer Plugin software run on your
  59. CommuniGate Pro Server platform.</p>
  60. <h2><hr><a name="Download"></a>Download the ARM Research Labs Sniffer Plugins</h2>
  61. <dl><dd>
  62. <p>ARM Research Labs Sniffer antispam plugins are available for certain platforms only.</p>
  63. <table class="guideTable" border=1 cellspacing=0 cellpadding=1>
  64. <tr bgcolor="#cccccc">
  65. <th nowrap rowspan=2 width=50%>Operating System</th>
  66. <th nowrap rowspan=2>CPU</th>
  67. <th nowrap colspan=2>Download</th>
  68. </tr>
  69. <tr bgcolor="#cccccc">
  70. <th nowrap>via<br>http</th>
  71. <th nowrap>via<br>ftp</th>
  72. </tr>
  73. <tr>
  74. <td align=center>Microsoft Windows NT/2000/XP<BR>Microsoft Windows 95/98</td>
  75. <td align=center>x86</td>
  76. <td align=center><a HREF="http://www.armresearch.com/message-sniffer/download/CGPSNF-Win32-Intel.zip">
  77. <img src="DownLoad.gif" border=0 width=16 height=16></a></td>
  78. <td align=center><img src="DisabledDownLoad.gif" border=0 width=16 height=16></td>
  79. </tr>
  80. <tr>
  81. <td align=center rowspan=2>Linux (RedHat/Fedora/CentOS, Ubuntu, SuSE)</TD>
  82. <td align=center>x86</td>
  83. <td align=center><a
  84. HREF="http://www.armresearch.com/message-sniffer/download/CGPSNF-Linux-Intel.tar.gz">
  85. <img src="DownLoad.gif" border=0 width=16 height=16></a></td>
  86. <td align=center><img src="DisabledDownLoad.gif" border=0 width=16 height=16></td>
  87. <tr>
  88. <td align=center>x86_64</td>
  89. <td align=center><a href="http://www.armresearch.com/message-sniffer/download/CGPSNF-Linux-x86_64.tar.gz">
  90. <img src="DownLoad.gif" border=0 width=16 height=16></a></td>
  91. <td align=center><img src="DisabledDownLoad.gif" border=0 width=16 height=16></td>
  92. </tr>
  93. <tr>
  94. <td align=center rowspan=2>FreeBSD 7.x</td>
  95. <td align=center>x86</td>
  96. <td align=center><a href="http://www.armresearch.com/message-sniffer/download/CGPSNF-FreeBSD7.x-Intel.tar.gz">
  97. <img src="DownLoad.gif" border=0 width=16 height=16></a></td>
  98. <td align=center><img src="DisabledDownLoad.gif" border=0 width=16 height=16></td>
  99. <tr>
  100. <td align=center>x86_64</td>
  101. <td align=center><a href="http://www.armresearch.com/message-sniffer/download/CGPSNF-FreeBSD7.x-x86_64.tar.gz">
  102. <img src="DownLoad.gif" border=0 width=16 height=16></a></td>
  103. <td align=center><img src="DisabledDownLoad.gif" border=0 width=16 height=16></td>
  104. </tr>
  105. <tr>
  106. <td align=center rowspan=2>OpenBSD 4.4 or later</td>
  107. <td align=center>x86</td>
  108. <td align=center><a href="http://www.armresearch.com/message-sniffer/download/CGPSNF-OpenBSD4.4-Intel.tar.gz">
  109. <img src="DownLoad.gif" border=0 width=16 height=16></a></td>
  110. <td align=center><img src="DisabledDownLoad.gif" border=0 width=16 height=16></td>
  111. <tr>
  112. <td align=center>x86_64</td>
  113. <td align=center><a href="http://www.armresearch.com/message-sniffer/download/CGPSNF-OpenBSD4.4-x86_64.tar.gz">
  114. <img src="DownLoad.gif" border=0 width=16 height=16></a></td>
  115. <td align=center><img src="DisabledDownLoad.gif" border=0 width=16 height=16></td>
  116. </tr>
  117. </table>
  118. </dl>
  119. <p>Downloads by ftp are not available</p>
  120. <p>The current version of the Plugin is 0.1.0.</p>
  121. <p>The current version of the ARM Research Labs Sniffer Engine is 3.0.11.</p>
  122. <h3><hr/><a name=Upgrading></a>Upgrading to a newer version.</h3>
  123. <p>When upgrading the Plugin to a newer version, do the following:</p>
  124. <ul>
  125. <li>Stop any running copy of the Sniffer Plugin application via
  126. CommuniGate Pro WebAdmin interface.
  127. <li>Install and configure the new version of the Sniffer Plugin as
  128. described in this document.
  129. </ul>
  130. <h3><hr><a name="WIN32"></a>Installing on a MS Windows 200x/NT/XP/9x system.</h3>
  131. <ul>
  132. <li>Open the command-line interface window and
  133. change the current directory to the CommuniGate Pro <I>base directory</I>.
  134. <li>Use any &quot;unzip&quot;-compatible tool to unpack the
  135. <tt>CGPSNF-Win32-Intel.zip</tt> file. The <tt>CGPSNF</tt> directory will be created inside the <I>base directory</I>.
  136. <li>Proceed with <a HREF="#Config">Configuring the Sniffer Plugin</a>.
  137. </ul>
  138. <h3><hr><a name=Linux></a>Installing on a Linux system.</h3>
  139. <ul>
  140. <li>Log in as a super-user (root).
  141. <li>Change the current directory to the CommuniGate Pro <I>base directory</I>.
  142. <li>Unpack the Plugin archive with the <tt>tar</tt> command:<tt><br>
  143. &nbsp;&nbsp;tar -xzf CGPSNF-Linux-Intel.tar.gz</tt><br>
  144. The <tt>CGPSNF</tt> directory will be created inside the <I>base directory</I>.
  145. <li>Proceed with <a HREF="#Config">Configuring the Sniffer Plugin</a>.
  146. </ul>
  147. <h3><hr><a name=FreeBSD></a>Installing on a FreeBSD system.</h3>
  148. <ul>
  149. <li>Log in as a super-user (root).
  150. <li>Change the current directory to the CommuniGate Pro <I>base directory</I>.
  151. <li>Unpack the Plugin archive with the <tt>tar</tt> command:<tt><br>
  152. &nbsp;&nbsp;tar -xzf CGPSNF-FreeBSD-Intel.tar.gz</tt><br>
  153. The <tt>CGPSNF</tt> directory will be created inside the <I>base directory</I>.
  154. <li>Proceed with <a HREF="#Config">Configuring the Sniffer Plugin</a>.
  155. </ul>
  156. <h3><hr><a name=OpenBSD></a>Installing on an OpenBSD system.</h3>
  157. <ul>
  158. <li>Log in as a super-user (root).
  159. <li>Change the current directory to the CommuniGate Pro <I>base directory</I>.
  160. <li>Unpack the Plugin archive with the <tt>tar</tt> command:<tt><br>
  161. &nbsp;&nbsp;tar -xzf CGPSNF-OpenBSD-Intel.tar.gz</tt><br>
  162. The <tt>CGPSNF</tt> directory will be created inside the <I>base directory</I>.
  163. <li>Proceed with <a HREF="#Config">Configuring the Sniffer Plugin</a>.
  164. </ul>
  165. <h3><hr><a name=Source></a>Installing from source.</h3>
  166. You can build the Sniffer Plugin from source:
  167. <ul>
  168. <li>Download the <tt>snf4cgp-X.Y.Z.tar.gz</tt>, where X.Y.Z is the
  169. version.
  170. <li>Extract the sources with the command:<tt><br>
  171. &nbsp;&nbsp;tar -xzf snf4cgp-X.Y.Z.tar.gz</tt><br>
  172. This creates a directory <tt>snf4cgp-X.Y.Z</tt>.
  173. <li>Change directory to <tt>snf4cgp-X.Y.Z</tt>:<tt><br>
  174. &nbsp;&nbsp;cd snf4cgp-X.Y.Z</tt><br>
  175. <li>Configure and build the system:<tt><br>
  176. &nbsp;&nbsp;./configure<br>
  177. &nbsp;&nbsp;./make</tt><br>
  178. <li>Become super-user (root).
  179. <li>Create the Sniffer Plugin:<tt><br> &nbsp;&nbsp;make
  180. module</tt><br> This creates a Plugin archive
  181. named <tt>CGPSNF-X.Y.Z-MODULE.tar.gz</tt>.
  182. <li>Proceed with <a HREF="#Install">Installing the Sniffer
  183. Plugin</a> for your system, using the Plugin archive that was
  184. created.
  185. </ul>
  186. <h3><hr><a name=Config></a>Configuring the Sniffer Plugin.</h3>
  187. <p>In the module directory (<tt>/var/CommuniGate/CGPSNF</tt> on a
  188. Linux or Linux-like system):</p>
  189. <ul>
  190. <li>Copy the configuration file <tt><br>
  191. &nbsp;&nbsp;snf_engine.xml.sample</tt><br> to <tt><br>
  192. &nbsp;&nbsp;snf_engine.xml</tt><br> and customize as
  193. needed. Please see the <a href="http://www.armresearch.com">ARM
  194. Research Labs web site</a> for documentation on
  195. the <tt>snf_engine.xml</tt> configuration file.<br>
  196. <li>Copy <tt><br>
  197. &nbsp;&nbsp;identity.xml.sample</tt><br> to <tt><br>
  198. &nbsp;&nbsp;identity.xml</tt><br> and edit to include the
  199. license ID and authentication attributes of
  200. the <tt>&lt;identity&gt; element</tt>.<br>
  201. <li>Copy <tt><br>
  202. &nbsp;&nbsp;getRulebase.sample</tt><br> to <tt><br>
  203. &nbsp;&nbsp;getRulebase</tt><br> and edit to include the
  204. license ID and authentication:
  205. <ul>
  206. <li>Change the line <tt><br>
  207. &nbsp;&nbsp;AUTHENTICATION=authenticationxx</tt><br>
  208. to <tt><br>
  209. &nbsp;&nbsp;AUTHENTICATION=YOUR_AUTHENTICATION</tt><br>
  210. where <tt>YOUR_AUTHENTICATION</tt> is authentication code
  211. obtained from ARM Research Labs.</LI>
  212. <li>Change the line <tt><br>
  213. &nbsp;&nbsp;LICENSE_ID=licenseid</tt><br> to <tt><br>
  214. &nbsp;&nbsp;LICENSE_ID=YOUR_LICENSE_ID</tt><br>
  215. where <tt>YOUR_LICENSE_ID</tt> is license ID obtained from
  216. ARM Research Labs.</LI>
  217. </ul>
  218. <li>Make <tt>getRulebase</tt> executable:<tt><br>
  219. &nbsp;&nbsp;chmod 755 getRulebase</tt><br>
  220. <li>Copy <tt><br>
  221. &nbsp;&nbsp;GBUdbIgnoreList.txt.sample</tt><br> to <tt><br>
  222. &nbsp;&nbsp;GBUdbIgnoreList.txt</tt><br> and customize as
  223. needed. Please see the
  224. <a href="http://www.armresearch.com">ARM Research Labs web
  225. site</a> for documentation on the <tt>GBUdbIgnoreList.txt</tt>
  226. file.<br>
  227. <li>Download the Sniffer database:
  228. <ul>
  229. <li>Create the file <tt>UpdateReady.txt</tt> in the plugin directory:<tt><br>
  230. &nbsp;&nbsp;touch UpdateReady.txt</tt><br>
  231. </LI>
  232. <li>Run the <tt>getRulebase</tt> script in the plugin
  233. directory:<tt><br>
  234. &nbsp;&nbsp;./getRulebase</tt><br>
  235. This downloads the Sniffer database to the plugin directory.
  236. </ul>
  237. The <B><tt>CGPSNF</tt></B> program automatically updates the
  238. Sniffer database as needed.
  239. <li>Proceed with <a HREF="#Test">Testing the Sniffer Plugin</a>.
  240. </ul>
  241. <h3><hr><a name=Test></a>Testing the Sniffer Plugin.</h3>
  242. <p>On Windows System:</p>
  243. <ul>
  244. <li> Change to the module directory:<tt><br>
  245. &nbsp;&nbsp;cd \CommuniGatePro\CGPSNF</tt><br>
  246. <li>Launch the <tt>CGPSNF.exe</tt> application by typing:<tt><br>
  247. &nbsp;&nbsp;CGPSNF.exe</tt><br>
  248. It will report the Plugin version number and build date.<br>
  249. <li>Type:<tt><br>
  250. &nbsp;&nbsp;1 FILE junkmsg.msg</tt><br>
  251. The plugin should report that the file is spam.
  252. <li>Quit <tt>CGPSNF.exe</tt> by typing Ctrl-Z.
  253. </ul>
  254. <p>On a Unix System:</p>
  255. <ul>
  256. <li> Change to the module directory:<tt><br>
  257. &nbsp;&nbsp;cd /var/CommuniGate/CGPSNF</tt><br>
  258. <li>Launch the <tt>CGPSNF</tt> application by typing:<tt><br>
  259. &nbsp;&nbsp;./CGPSNF</tt><br>
  260. It will report the Plugin version number and build date.<br>
  261. <li>Type:<tt><br>
  262. &nbsp;&nbsp;1 FILE junkmsg.txt</tt><br>
  263. the plugin should report that the file is spam.
  264. <li>Quit <tt>CGPSNF</tt> by typing Ctrl-D.
  265. </ul>
  266. <h3><hr><a name="Options"></a>Command Line Options</h3>
  267. <dl>
  268. <dd>
  269. The Sniffer Plugin supports the following command-line option
  270. (parameters):
  271. <dl>
  272. <p><dt><tt>path_to_config_file</tt></dt></p>
  273. <dd>This option tells the Plugin to read the configuration from
  274. <tt>path_to_config_file</tt>.
  275. </dd>
  276. </dl>
  277. </dl>
  278. <h3><hr><a name=Integrate></a>Integrating the Sniffer Plugin with CommuniGate Pro.</h3>
  279. Please check
  280. the <a HREF="http://www.communigate.com/CommuniGatePro/VirusScan.html#Launch">External
  281. Filters</a> section of the CommuniGate Pro manual.
  282. <p>Open the General page in the Settings section of the WebAdmin
  283. Interface and click the Helpers link. Create the Helper as follows:</p>
  284. <center class="WebAdmin"><form action="Null.html">
  285. <table class="settingsBox" cellpadding="3" width="90%">
  286. <caption>Content Filtering</caption>
  287. <tr><td BGCOLOR="#EEEEEE">
  288. <table class="settingsBox" WIDTH="100%" BORDER="0" CELLSPACING=1 CELLPADDING=0>
  289. <tr>
  290. <td align="right"><select name="U3"><option value="0">Disabled</option><option value="1" selected="selected">Enabled</option></select></td>
  291. <td><input name="N3" value="ARM Sniffer" size="15" maxlength="200" type="text" /></td>
  292. <td colspan=2 align=center></td>
  293. </tr><tr>
  294. <td align="right" width="25%">Log Level:</td><td><select name="L3"><option value="0">Crashes Only</option><option value="1">Failures</option><option value="2">Major &amp; Failures</option><option value="3">Problems</option><option value="4" selected="selected">Low Level</option><option value="5">All Info</option></select></td>
  295. <td align="right" width="25%">Program Path:</td><td><input name="P3"
  296. value="CGPSNF/CGPSNF" size="30" maxlength="255" type="text" /></td>
  297. </tr><tr>
  298. <td align=RIGHT>Time-out:</td><td><select name="T0"><option VALUE=0>disabled<option VALUE="15">15 seconds<option VALUE="30">30 seconds<option VALUE="60">minute<option VALUE="120">2 minutes<option VALUE="180">3 minutes<option VALUE="300" SELECTED>5 minutes<option VALUE="600">10 minutes<option VALUE="900">15 minutes<option VALUE="1800">30 minutes<option VALUE="3600">hour</select></td>
  299. <td align=RIGHT>Auto-Restart:</td><td><select name="A0"><option VALUE=0>disabled<option VALUE="5">5 seconds<option VALUE="7">7 seconds<option VALUE="10">10 seconds<option VALUE="15">15 seconds<option VALUE="30">30 seconds<option VALUE="60" SELECTED>minute<option VALUE="120">2 minutes<option VALUE="180">3 minutes<option VALUE="300">5 minutes<option VALUE="600">10 minutes<option VALUE="900">15 minutes<option VALUE="1800">30 minutes<option VALUE="3600">hour<option VALUE="7200">2 hours<option VALUE="10800">3 hours<option VALUE="21600">6 hours</select></td>
  300. </tr>
  301. </table></td></tr>
  302. </table></FORM></center>
  303. <B>Note:</B> For Windows system the Program Path shold be
  304. <tt>CGPSNF\CGPSNF.exe</tt><br>
  305. <B>Note:</B> On some versions of FreeBSD system you may need to
  306. specify the full path to the program,
  307. i.e. <tt>/var/CommuniGate/CGPSNF/CGPSNF</tt>
  308. <p>The recommended Scanning Rule is as follows:</p>
  309. <center class="WebAdmin"><form action="Null.html">
  310. <table class="settingsBox" cellpadding="3" width="90%">
  311. <tr align="left">
  312. <th>Data</th>
  313. <th>Operation</th>
  314. <th>Parameter</th>
  315. </tr>
  316. <tr>
  317. <td>
  318. <select name="c2"><option VALUE="0" selected>---<option VALUE="12">Message Size</select>
  319. </td><td>
  320. <select name="o2"><option VALUE="0" selected>is<option VALUE="4">greater than</select>
  321. </td><td>
  322. <INPUT TYPE="text" name="p2" VALUE="" SIZE="20" MAXLENGTH="1024">
  323. </td>
  324. </tr>
  325. <tr align="left">
  326. <th>Action</th>
  327. <th colspan="2">Parameter</th>
  328. </tr>
  329. <tr valign=TOP>
  330. <td><select name="a0"><option VALUE="0">---<option VALUE="6">Stop Processing<option VALUE="17" selected>ExternalFilter</select>
  331. </td><td><textarea name="r0" rows="4" cols="40">ARM Sniffer</textarea>
  332. </td>
  333. </tr>
  334. <tr valign=top>
  335. <td><select name="a1"><option value="0" selected>---<option value="7">Stop Processing</select></td>
  336. <td colspan="2"><textarea name="r1" rows="4" cols="40"></textarea></td>
  337. </tr>
  338. </table></form></center>
  339. <hr/>
  340. </body>
  341. </html>