Docs For Class Services_ProjectHoneyPot

$accesskey =

[line 91]

Var: Your API access key.
See: Services_ProjectHoneyPot::setAccesskey()
See: Services_ProjectHoneyPot::__construct()
Link: http://www.projecthoneypot.org/httpbl_configure.php
Access: protected
Usedby: Services_ProjectHoneyPot::getHostForLookup()
Usedby: Services_ProjectHoneyPot::__construct()

Type:

string

[ Top ]

$debug = false

[line 111]

Var: Yes (true) or no (false)?
See: Services_ProjectHoneyPot::parseResponse()
See: Services_ProjectHoneyPot::__construct()
Access: protected
Usedby: Services_ProjectHoneyPot::setDebug()
Usedby: Services_ProjectHoneyPot::__construct()

Type:

bool

[ Top ]

$dns_blacklist = 'dnsbl.httpbl.org'

[line 97]

Var: The name of the dnsbl (provided by Project HoneyPot).
See: Services_ProjectHoneyPot::setDnsBlacklist
Access: protected
Usedby: Services_ProjectHoneyPot::getHostForLookup()

Type:

string

[ Top ]

$honeypot =

[line 118]

Var: Not yet used.
See: Services_ProjectHoneyPot::getHoneypot
See: Services_ProjectHoneyPot::setHoneypot
Access: protected
Usedby: Services_ProjectHoneyPot::getHoneyPot()
Usedby: Services_ProjectHoneyPot::setHoneypot()

Type:

string

[ Top ]

$resolver =

[line 104]

Var: A Net_DNS2_Resolver object.
See: Services_ProjectHoneyPot::__construct()
See: Services_ProjectHoneyPot::query()
Access: protected

Type:

Net_DNS2_Resolver

[ Top ]

__construct (Constructor) [line 133]

Services_ProjectHoneyPot __construct(
[string
$accesskey = null], [Net_DNS2_Resolver
$resolver = null], [bool
$debug = null])

Initialize the class.

Throws: Services_ProjectHoneyPot_Exception
Access: public
Uses: Services_ProjectHoneyPot::$debug
Uses: Services_ProjectHoneyPot::$accesskey
Uses: Net_DNS2_Resolver

Parameters:

string	`$accesskey`	—	The accesskey provided by Project HoneyPot.
mixed	`$resolver`	—	'null' or Net_DNS2_Resolver.
bool	`$debug`	—	Enable debug, or maybe not? :-)

[ Top ]

getHoneyPot [line 383]

string|array|null getHoneyPot(
)

Mostly a placeholder for what's to come. Currently we return a honeypot which has been supplied with self::setHoneypot before.

See: self::setHoneypot()
Todo: Implement retrieval of honeypots from projecthoneypot.org.
Access: public
Uses: Services_ProjectHoneyPot::$honeypot

[ Top ]

getHostForLookup [line 328]

string getHostForLookup(
string
$ip)

Builds the host to query.

Access: protected
Uses: Services_ProjectHoneyPot::$dns_blacklist
Uses: Services_ProjectHoneyPot::$accesskey

Parameters:

string $ip — The IP which needs to be resolved.

[ Top ]

makeRequest [line 266]

Services_ProjectHoneyPot_Response_ResultSet makeRequest(
array
$ips)

Make the actual lookup.

See: self::query()
See: Net_DNS2_Resolver::query()
Access: protected
Uses: self::$resolver
Uses: self::getHostForLooup()

Parameters:

array $ips —

[ Top ]

parseResponse [line 349]

Services_ProjectHoneyPot_Response_Result parseResponse(
Net_DNS2_Packet_Response
$respObj)

Parses the response object into a 'readable' format

For a more detailed response description, please see {@see Services_ProjectHoneyPot_Response::parse()}

See: self::query()
Link: http://projecthoneypot.org/httpbl_api.php
Access: protected

Parameters:

object $respObj — Whatever we received from the API.

[ Top ]

query [line 222]

Services_ProjectHoneyPot_Response_ResultSet query(
[string|array
$ip = ''])

Checks if the supplied IP is listed.

See: self::__construct()
Todo: Check multiple if host has 1+ IPs.
Throws: Services_ProjectHoneyPot_Exception
Access: public
Uses: self::$resolver

Parameters:

string|array $ip — IP or hostname. Using an IP is more "expensive" because we will need to resolve it.

[ Top ]

setAccesskey [line 191]

string setAccesskey(
string
$accesskey)

Set the access key necessary to use this service.

See: self::__construct()
Access: public

Parameters:

string $accesskey — Another accesskey.

[ Top ]

setDebug [line 400]

$this setDebug(
boolean
$debug)

Enable debug on runtime.

Throws: InvalidArgumentException
Access: public
Uses: Services_ProjectHoneyPot::$debug

Parameters:

boolean $debug — To debug (true), or not to debug (false)?

[ Top ]

setDnsBlacklist [line 204]

string setDnsBlacklist(
string
$server)

Sets another (than the default) server to query.

Access: public

Parameters:

string $server — The DNS server to query.

[ Top ]

setHoneypot [line 366]

null|string|array setHoneypot(
[string|array
$honeypot = null])

Sets an URL or an array of URLs to use for redirecting later on, if the IP is found 'guilty'. ;-)

Todo: Implement.
Access: public
Uses: Services_ProjectHoneyPot::$honeypot

Parameters:

string|array $honeypot — Set a honeypot (string), or multiple.

[ Top ]

setResolver [line 163]

$this setResolver(
[Net_DNS2_Resolver
$resolver = null])

Set, or create a Net_DNS2_Resolver for internal use.

Throws: Services_ProjectHoneyPot_Exception In case of a wrong object or an error on init.
Access: public
Uses: self::$resolver

Parameters:

mixed $resolver — 'null' or Net_DNS_Resolver

[ Top ]

setResponseFormat [line 177]

$this setResponseFormat(
string
$format)

Set the format to retrieve the info in.

Throws: Services_ProjectHoneyPot_Exception On unknown/unsupported format.
Access: public

Parameters:

string $format — Either 'array' or 'object'.

[ Top ]

Class: Services_ProjectHoneyPot

Class Overview

Author(s):

Version:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$accesskey =

$debug = false

$dns_blacklist = 'dnsbl.httpbl.org'

$honeypot =

$resolver =

Method Detail

__construct (Constructor) [line 133]

Parameters:

getHoneyPot [line 383]

getHostForLookup [line 328]

Parameters:

makeRequest [line 266]

Parameters:

parseResponse [line 349]

Parameters:

query [line 222]

Parameters:

setAccesskey [line 191]

Parameters:

setDebug [line 400]

Parameters:

setDnsBlacklist [line 204]

Parameters:

setHoneypot [line 366]

Parameters:

setResolver [line 163]

Parameters:

setResponseFormat [line 177]

Parameters: