An open API service indexing awesome lists of open source software.

https://github.com/ddspringle/http-bl-cfml

I provide a CFML interface for the Project Honey Pot http:BL DNS blacklist (https://www.projecthoneypot.org/httpbl_api.php)
https://github.com/ddspringle/http-bl-cfml

Last synced: 4 months ago
JSON representation

I provide a CFML interface for the Project Honey Pot http:BL DNS blacklist (https://www.projecthoneypot.org/httpbl_api.php)

Awesome Lists containing this project

README

          

# http:BL CFML
This repository includes a CFC called httpBLService.cfc that makes use of the Project Honey Pot http:BL DNS Blacklist - this blacklist maintains the IP addresses of known spammers, email harvesters and other suspicious activities.

## Usage

To use this wrapper, simply initialize it with your 12-alpha character access key provided by Project Honey Pot, as follows:

// get the httpBLService
httpBLService = createObject( 'component', 'httpBLService').init( accessKey = '[ACCESS_KEY]' [, debug=true] );

If you pass the optional argument `debug=true` then any error that occurs during DNS lookup will be rethrown instead of ignored.

You then call the service with the IP address you wish to check, as follows:

// get the structure as a variable from the httpBL service
returnStruct = httpBLService.checkIp( ipAddress = [IP_ADDRESS] );

The checkIp function returns a struct with the following keys:

daysSinceLastActivity: the days since this IP address was last seen hitting a honey pot
threatScore: the threat posed by this IP address, from 0 - 255 (see the http:BL API docs for more details)
visitorType: this is a numeric representation of what the visitor did to get flagged in the blacklist
comment: additional details on the visitor type

**NOTE**: You should [read the http:BL API documentation](https://www.projecthoneypot.org/httpbl_api.php) for more information on what these values mean. Some key things to know is that a visitor type of zero (0) indentifies a known search engine (so don't block those if you want to be indexed) and a vistor type of 42 (arbitrary - wrapper defined) identifies an IP that was *not* found in the blacklist.

## Compatibility

* Adobe ColdFusion 11+
* Lucee 4.5+

If you're on an older version/different engine of ColdFusion, or just prefer to use tags instead of script, then check out the implementation of the http:BL DNS service by Jay Bigam: [http:bl_CFML](http://sidfishes.wordpress.com/2014/07/31/httpbl_cfml-a-project-honeypot-blacklist-implementation-for-coldfusion)

## Bugs and Feature Requests

If you find any bugs or have a feature you'd like to see implemented in this code, please use the issues area here on GitHub to log them.

## Contributing

This project is actively being maintained and monitored by Denard Springle. If you would like to contribute to this project please feel free to fork, modify and send a pull request!

## License

The use and distribution terms for this software are covered by the Apache Software License 2.0 (http://www.apache.org/licenses/LICENSE-2.0).