Frypan Anti-spam Service

Jeongkyu Shin ( Needlworks / Pohang University Of Science and Technology / inureyes @ needlworks.org )

Frypan Anti-spam Service (FAS) is an anti-spam service including light-weight anti-spam server / client program.

History

Notification about closing of EOLIN Anti-spam Service by Google in 2010 leads Needlworks decide to develop a new anti-spam service from scratch. Anti-spam project was temporary named as A2, and the name was changed to FAS, which was used for Textcube spam deletion plugin, especially for massive spam bombs. Needlworks started its testing from Jaunary 2011, and launched at Feburary 25, 2011. After tuning and collecting samples, FAS is now working functionally since April 15, 2011.

Installation

You can use EAS/FAS plugin bundled in Textcube package. We will offer plugin here soon, too.

Goal

The goal of FAS Server program is

Notification

Server

FAS Server program runs on ‘codeball’ framework, which is used for Textcube projects. (Note. Current Textcube uses a fraction of codeball, not entirely.)

Download

Public service

We offer the public FAS service via http://antispam.textcube.org/RPC .

Set-up (server / service)

Installation

Decompress and move frypan directory to /apps directory. Modify /etc/urltab for proper access.

Adding request adapters

Move adapters to /apps/frypan/adapters

Adding anti-spam engines

Move engine file to /apps/frypan/engines .

Developing anti-spam engines

FAS supports multiple anti-spam engines. Engines consist of one or some files. Engines does not need to be a PHP file, however the engine adapter should be PHP file. Engine (or engine adapter for other languages) should contain the engine function with same name with file. This is an example.

 1 <?php
 2 /// This is example file for frypan engines. (a.k.a. 'Oil')
 3 ///
 4 /// Each engine should contain the function with same file name.
 5 /// e.g.      XX-example.php
 6 ///           ---=======
 7 ///  Order index  Function name.
 8 ///
 9 /// Return value should be true (it is spam) or false (it is not spam).
10 function example($data) {
11     return false;
12 }
13 ?>

$data contains as many parameter as request adapter supports. For EAS-compatible server, $data contains these values.

Additionally, you can use $data[‘ip’] if client uses renewed FAS plugin.

Function should return true or false.

Developing anti-spam clients

Request should use XML-RPC for EAS-compatible service. If you deploy your own FAS service and clients, you can decide the request specification as you want. Here is a description about default xml-rpc request.

For Working example, please refer the ‘FAS’ client plugin in Textcube. (‘EAS’ for older version)

To read well-formatted version, please read This link.

© 2011-2015. Needlworks / Tatter Network Foundation. / Textcube / Project Tattertools