File Source for EndDevice.php

<?php
/**
* EndDevice.php
*
* PHP version 5
*
* LICENSE: This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as published
* by the Free Software Foundation.
*
* @package FreeNAC
* @author Seiler Thomas (contributer)
* @author Hector Ortiz (FreeNAC Core Team)
* @copyright 2007 FreeNAC
* @license http://www.gnu.org/copyleft/gpl.html GNU Public License Version 2
* @version SVN: $Id$
* @link http://www.freenac.net
*/
/**
* Health status(es) (Note: The Oxford English Dict defines the plural of status as statuses, but the Latin plural is status
* Pick the one you like the most :) )
*/
define('UNKNOWN',0);
define('OK',1);
define('TRANSITION',4);
define('QUARANTINE',5);
define('INFECTED',6);
/**
* This class represents a row in the systems table in the database.
* In the current version, the host is identified by its mac address.
* This class extends the {@link Common} class.
*/
class EndDevice extends Common
{
protected $mac;
protected $db_row = array();
/** The constructor takes the mac address of the system and creates
* and instance representing that particular system.
* Access is read-only.
* @param object $object A copy of the Request
* @throws Deny if we received an invalid MAC address or if vlan assigned to this device is 0
*/
public function __construct($object)
{
#If we don't receive an object, DENY
if (!$object)
DENY('No object received in constructor');
parent::__construct();
if (($object instanceof VMPSRequest) || ($object instanceof SyslogRequest))
{
# Normalise mac address format by removing spaces, dashes, dots
# and collons, and by converting to lower case.
$mac=$object->mac;
$mac = strtolower(preg_replace('/-|\.|\s|\:/', '', $mac));
# Sanity check - Is this a valid MAC address ???
if (!preg_match("/^[0-9a-f]{12}$/",$mac))
DENY("Invalid MAC address $mac");
if ($mac === '000000000000')
DENY("Invalid MAC address $mac");
# Rewrite mac address according to Cisco convention, XXXX.XXXX.XXXX
$this->mac="$mac[0]$mac[1]$mac[2]$mac[3].$mac[4]$mac[5]$mac[6]$mac[7].$mac[8]$mac[9]$mac[10]$mac[11]";
# Query systems table
$sql_query=<<<EOF
SELECT s.id AS sid, s.health, s.office, s.mac AS mac,
s.name AS hostname, s.description, s.status,
s.r_ip AS ip, s.expiry, s.email_on_connect,
u.id AS uid, u.username,
v.id AS vid, v.default_name AS vlan_name
FROM systems s
LEFT JOIN users u ON s.uid=u.id
LEFT JOIN vlan v ON s.vlan=v.id
WHERE s.mac='{$this->mac}' LIMIT 1;
EOF;
$this->logger->debug($sql_query,3);
#System found in database, fill up the properties
if ($temp=mysql_fetch_one($sql_query))
{
$this->db_row=$temp;
$this->db_row['in_db']=true;
if (!$this->db_row['health'])
$this->db_row['health']=UNKNOWN;
if (($object instanceof VMPSRequest) && ($this->vid == 0))
$this->logger->logit("Note: Device {$this->mac}({$this->hostname}) has vlan zero. It will be blocked");
# DENY('VLAN ID assigned to this EndDevice equals zero');
}
else
{
#Unknown system
$this->db_row['status']=0;
$this->db_row['mac']=$this->mac;
$this->db_row['in_db']=false;
$this->db_row['health']=UNKNOWN;
}
# Save the result of vmpsd_external
if ( $object instanceof SyslogRequest )
{
$this->db_row['vmpsd_external_result'] = $object->vtp;
}
# This bit will be used for hub detection, if enabled
if ($this->conf->detect_hubs && ($object instanceof VMPSRequest))
{
$query = "SELECT id FROM vlan WHERE default_name='{$object->lastvlan}'";
$this->logger->debug($query,3);
$this->db_row['newvlan_id']=v_sql_1_select($query);
if (! $this->db_row['newvlan_id'])
$this->db_row['newvlan_id'] = 0;
}
#Initial values for these vars. They'll be modified at some point in the future in this class
$this->db_row['port_id']=0;
$this->db_row['office_id']=1;
$this->db_row['lastvlan_id']=1;
#Passing of information between objects
$this->setPortID($object->switch_port->getPortID());
$this->setOfficeID($object->switch_port->getOfficeID());
$this->setVlanID($object->switch_port->getLastVlanID());
$this->setAlertSubject($object->switch_port->getAlertSubject());
$this->setAlertMessage($object->switch_port->getAlertMessage());
$this->setNotifyInfo($object->switch_port->getNotifyInfo());
}
else
{
#Object is an unknown instance
DENY('Unknown instance of object passed to the constructor');
}
}
# Policy Checks ------------------------------------------------------------
/**
* Check that the system is not yet expired
* Expiry date like 0000-00-00 00:00:00 is treated as never expire
* @return boolean Tell if the system is expired
*/
public function isExpired()
{
# Check if expiry checks are enabled
if ($this->conf->check_for_expired)
{
# get systems expiry date
$expiry = $this->expiry;
if ($expiry)
{
# 0000-00-00 00:00:00 means no expiry
if(strcmp(trim($expiry),"0000-00-00 00:00:00")==0)
{
return false;
}
# Get the time difference between the current time and the expiry date
$timestamp=date('Y-m-d H:i:s');
$time=time_diff($timestamp,$expiry);
if ((! $time) || ($time<0))
{
return true;
}
}
}
else
{
# Default is not to expire, do on debug1 to flood logs less
#$this->logger->logit("check_for_expired option is not enabled");
$this->logger->debug("check_for_expired option is not enabled");
return false;
}
}
/** Is this EndDevice a Virtual Machine ?
* It is, if the vendor string associated to the first 3 bytes of the mac
* contains "vmware", "parallels" or "microsoft"
* @return boolean Tell whether this EndDevice is a Virtual Machine
*/
public function isVM()
{
# Check if VM checks are enabled
if ($this->conf->vm_lan_like_host)
{
if (stristr($this->getVendor(),"vmware"))
return true; # The original
if (stristr($this->getVendor(),"parallels"))
return true; # Mac VMWare-alike
if (stristr($this->getVendor(),"microsoft"))
return true; # VirtualPC
}
else
{
$this->logger->logit("vm_lan_like_host option is not enabled");
return false;
}
}
/**
* Is this device 'killed'?
* @return boolean Tell if the EndDevice is killed
*/
public function isKilled()
{
if ($this->status==7)
return true;
else
return false;
}
/**
* Is this device 'active'?
* @return boolean Tell if the EndDevice is active
*/
public function isActive()
{
if ($this->status==1)
return true;
else
return false;
}
/**
* Is this device 'unknown'?
* @return boolean Tell if the EndDevice is unknown
*/
public function isUnknown()
{
if ($this->status==0)
return true;
else
return false;
}
/**
* Is this device 'unmanaged'?
* @return boolean Tell if the EndDevice is unmanaged
*/
public function isUnmanaged()
{
if ($this->status==3)
return true;
else
return false;
}
# Information about system -------------------------------------------------
/**
* Return the vendor name associated to first 3 bytes of the mac address
* @return mixed Vendor for this MAC address
*/
public function getVendor()
{
/**
* @todo Implement a vendor Cache in an arry to save an sql statement per request ;-)
*/
$mac=preg_replace('/\./','',$this->mac);
$prefix="$mac[0]$mac[1]$mac[2]$mac[3]$mac[4]$mac[5]";
$query="SELECT vendor FROM ethernet WHERE mac LIKE '%$prefix%';";
$this->logger->debug($query,3);
$vendor=v_sql_1_select($query);
if ( ! $vendor )
return '';
$vendor=rtrim($vendor,',');
return trim($vendor);
}
/**
* Return the Name of the systems' default VLAN
* @return mixed Default VLAN assigned to this device
*/
public function getVlanName()
{
return $this->vlan_name;
}
/**
* Return the vlan id assigned to this EndDevice
* @return mixed vid
*/
public function getVlanID()
{
return $this->vid;
}
/**
* Universal Accessor Method
* We are redirecting all unresolved method calls to this handler,
* so that we can emulate arbitraty accessor methods.
* With this trick, the user can add new fields to the system tables
* and will be able to access them in the policy as
* $system->getDBFieldName() without haveing to change this class
* @throws If the db field does not exist, Log Error and Deny as default action
* @return mixed Property
*/
public function __call($methodName, $parameters) {
# If methodname starts with get
if (substr($methodName,0,3) == "get") {
$dbfieldname = substr($methodName,3);
foreach(array_keys($this->db_row) as $key) {
if (strtolower($key) == strtolower($dbfieldname)) {
if (is_numeric($this->db_row[$key]))
{
if (stristr($this->db_row[$key],'.'))
return $this->db_row[$key];
else if ( $this->db_row[$key] > 0 )
return (int)$this->db_row[$key];
else
return false;
}
else
{
return $this->db_row[$key];
}
}
}
}
$this->logger->debug("Field $methodName doesn't exist",2);
}
/**
* Get the value of one property if it exists
* @param mixed $key Property to lookup
* @return mixed The value of the wanted property, or false if such a property doesn't exist
*/
public function __get($key) //Get the value of one var
{
if (array_key_exists($key,$this->db_row))
{
if (is_numeric($this->db_row[$key]))
{
if (stristr($this->db_row[$key],'.'))
return $this->db_row[$key];
else if ( $this->db_row[$key] > 0 )
return (int)$this->db_row[$key];
else
return false;
}
else
{
return $this->db_row[$key];
}
}
}
/**
* Set the value of one property if it exists
* @param mixed $key Property to lookup
* @param mixed $value Value to set the desired property to
* @throws Deny if there was an attempt to set an unknown property
*/
protected function __set($key,$value) //Set the value of one var
{
if (array_key_exists($key,$this->db_row))
$this->db_row[$key]=$value;
else
$this->logger->debug('Attempting to set an unknown property',2);
}
/**
* Return all properties assigned to this system. This method is here only for debugging purposes, please delete it after
* @return array All properties present
*/
public function getAllProps()
{
return $this->db_row;
}
/**
* This method indicates if a system is in the db. This flag was set in the constructor.
* @return boolean Value of the 'in_db' property
*/
public function inDB()
{
return $this->in_db;
}
/**
* Catch DB inserts.
* Check if the function is called from a postconnect method in an object which is a child of Policy.
* This function should be called from inside the update method. To prevent inserting of code in other methods, new code
* should be added.
* This is a basic checking, in the future this code may be enhanced.
* @return boolean True if function was called from a valid method, false otherwise
*/
function check_calling_method()
{
$backtrace = debug_backtrace();
array_shift($backtrace); //Remove call to check_calling_method from the backtrace;
$ok=0;
#Are we calling from a child of EndDevice which uses CallWrapper?
if ( isset($backtrace[1]['class']) && isset($backtrace[3]['class'])
&& ( (strcasecmp(get_parent_class($this),'EndDevice')) == 0 ) && (strcasecmp($backtrace[3]['class'],'Callwrapper') ==0 ))
{
#If so, do the necessary corrections to our backtrace
$temp=array_shift($backtrace);
$backtrace[0]=$temp;
}
#$this->logger->logit(print_r($backtrace,true));
#$this->logger->logit(get_parent_class($this));
{
#Check if we are using callwrapper
if ( (strcasecmp($backtrace[2]['class'],'Callwrapper')==0) && (strcasecmp($backtrace[2]['function'],'__call')==0))
{
#Check if the class is a child of Policy and if calling method is postconnect
#if ( ( $backtrace[4]['class'] instanceof Policy ) && (strcasecmp($backtrace[4]['function'],'postconnect')!=0) )
if (strcasecmp($backtrace[4]['function'],'postconnect')!=0)
{
$this->logger->logit("{$backtrace[0]['function']} method must only be called from a postconnect, since it changes the database. Pre-connnect can run secondary servers (which have read-only tables), and must not change the DB. This method was called from {$backtrace[4]['function']}. Aborting insert operation",LOG_WARNING);
return false;
}
else
{
$ok++;
}
}
#Not using callwrapper
else if (strcasecmp($backtrace[0]['class'],'EndDevice')==0)
{
#Are we calling from a child of EndDevice?
if ( (strcasecmp($backtrace[1]['function'],'postconnect')) != 0 )
{
#If so, do the necessary corrections to our backtrace
$temp=array_shift($backtrace);
$backtrace[0]=$temp;
}
#Check if the class is a child of Policy and if calling method is postconnect
#if ( (strcasecmp($backtrace[1]['class'],'Policy')==0 ) && (strcasecmp($backtrace[1]['function'],'postconnect')!=0))
if (strcasecmp($backtrace[1]['function'],'postconnect')!=0)
{
$this->logger->logit("{$backtrace[0]['function']} method must only be called from a postconnect, since it changes the database. Pre-connnect can run secondary servers (which have read-only tables), and must not change the DB. This method was called from {$backtrace[4]['function']}. Aborting insert operation",LOG_WARNING);
return false;
}
else
{
$ok++;
}
}
else
{
$this->logger->logit("{$backtrace[0]['function']} method can only be called from a postconnect method, condition not met, aborting insert operation",LOG_WARNING);
return false;
}
}
if ($ok)
return true;
else
return false;
}
/**
* Update EndDevice information in the DB
* @return mixed MAC address and hostname of the updated system, or false if no update was performed
*/
public function update()
{
#Chech if the system is in the DB, and then perform the update
if ($this->check_calling_method() && $this->inDB())
{
#Send an email alert on connect?
if ( ! empty($this->db_row['email_on_connect']) )
{
$this->logger->mailit("{$this->mac}($this->hostname) is connecting to the network",$this->alert_message.$this->alert_subject,$this->db_row['email_on_connect']);
#log2db('info',"{$this->mac}($this->hostname) is connecting to the network");
}
#Check if it's not expired
if ($this->isExpired() && $this->conf->disable_expired_devices)
{

Source for file EndDevice.php