|
<?php defined('SYSPATH') or die('No direct script access.');
|
|
/*
|
|
* This file is part of open source system FreenetIS
|
|
* and it is released under GPLv3 licence.
|
|
*
|
|
* More info about licence can be found:
|
|
* http://www.gnu.org/licenses/gpl-3.0.html
|
|
*
|
|
* More info about project can be found:
|
|
* http://www.freenetis.org/
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* Mikrotik SNMP driver.
|
|
* This class MUST not be initialized directly, use Snmp_Factory!
|
|
*
|
|
* @author Ondrej Fibich
|
|
* @see Abstract_Snmp
|
|
*/
|
|
class Mikrotik_Snmp extends Abstract_Snmp
|
|
{
|
|
|
|
/**
|
|
* Checks if the driver is compactible with the driver.
|
|
*
|
|
* @param string $device_ip Device IP address
|
|
* @return bool Is compactible?
|
|
*/
|
|
public function isCompactibleDriverWith($device_ip)
|
|
{
|
|
if (!valid::ip($device_ip))
|
|
{
|
|
throw new InvalidArgumentException('Wrong IP address of the device');
|
|
}
|
|
|
|
try
|
|
{
|
|
$this->startErrorHandler();
|
|
snmp_set_valueretrieval(SNMP_VALUE_PLAIN);
|
|
$row = snmp2_get(
|
|
$device_ip, $this->comunity, 'iso.3.6.1.2.1.1.1.0',
|
|
$this->timeout, $this->retries
|
|
);
|
|
$this->stopErrorHandler();
|
|
}
|
|
catch (Exception $e)
|
|
{
|
|
return FALSE;
|
|
}
|
|
|
|
if (text::starts_with($row, 'RouterOS'))
|
|
{
|
|
return TRUE;
|
|
}
|
|
else
|
|
{
|
|
return FALSE;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Obtain MAC address of a device with the given IP address from ARP table.
|
|
*
|
|
* @param string $device_ip IP address of the device (we would like to know his MAC)
|
|
* @return string MAC address in format xx:xx:xx:xx:xx:xx
|
|
* @throws Exception On SNMP error or wrong SNMP response
|
|
* @throws InvalidArgumentException On wrong IP address
|
|
*/
|
|
public function getARPMacAddressOf($device_ip)
|
|
{
|
|
if (!valid::ip($device_ip))
|
|
{
|
|
throw new InvalidArgumentException('Wrong IP address of the device');
|
|
}
|
|
|
|
$arp_table = $this->getARPTable();
|
|
|
|
if (array_key_exists($device_ip, $arp_table))
|
|
{
|
|
return $arp_table[$device_ip]->mac_address;
|
|
}
|
|
else
|
|
{
|
|
throw new Exception('Given IP address ' . $device_ip
|
|
. ' not in ARP table on ' . $this->deviceIp);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Obtain MAC address of a device with the given IP address from DHCP server.
|
|
*
|
|
* @param string $device_ip IP address of the device (we would like to know his MAC)
|
|
* @return string MAC address in format xx:xx:xx:xx:xx:xx
|
|
* @throws Exception On SNMP error or wrong SNMP response
|
|
* @throws InvalidArgumentException On wrong IP address
|
|
*/
|
|
public function getDHCPMacAddressOf($device_ip)
|
|
{
|
|
if (!valid::ip($device_ip))
|
|
{
|
|
throw new InvalidArgumentException('Wrong IP address of the device');
|
|
}
|
|
|
|
try
|
|
{
|
|
// obtain
|
|
$this->startErrorHandler();
|
|
snmp_set_valueretrieval(SNMP_VALUE_PLAIN);
|
|
$row = snmp2_get(
|
|
$this->deviceIp, $this->comunity,
|
|
'iso.3.6.1.2.1.9999.1.1.6.4.1.8.' . $device_ip,
|
|
$this->timeout, $this->retries
|
|
);
|
|
$this->stopErrorHandler();
|
|
}
|
|
catch (Exception $e)
|
|
{
|
|
throw new DHCPMacAddressException($e->getTraceAsString());
|
|
}
|
|
|
|
return network::bin2mac($row);
|
|
}
|
|
|
|
/**
|
|
* Obtaint port number with given MAC address.
|
|
*
|
|
* @param string $mac_address MAC address of the device (we would like to know to which port is connected)
|
|
* @return string MAC address in format xx:xx:xx:xx:xx:xx
|
|
* @throws Exception On SNMP error or wrong SNMP response
|
|
* @throws InvalidArgumentException On wrong IP address
|
|
*/
|
|
public function getPortNumberOf($mac_address)
|
|
{
|
|
// is not possible
|
|
return FALSE;
|
|
}
|
|
|
|
/**
|
|
* Obtain names of all network interfaces of device
|
|
*
|
|
* @return array Network interfaces of device
|
|
* @throws Exception On SNMP error or wrong SNMP response
|
|
*/
|
|
public function getIfaces()
|
|
{
|
|
$this->startErrorHandler();
|
|
snmp_set_valueretrieval(SNMP_VALUE_PLAIN);
|
|
$data = snmp2_real_walk(
|
|
$this->deviceIp, $this->comunity,
|
|
'iso.3.6.1.2.1.31.1.1.1.1',
|
|
$this->timeout, $this->retries
|
|
);
|
|
$this->stopErrorHandler();
|
|
|
|
$ifaces = array();
|
|
foreach ($data as $key => $value)
|
|
{
|
|
$oids = explode('.', $key);
|
|
|
|
$iface_id = array_pop($oids);
|
|
|
|
$ifaces[$iface_id] = $value;
|
|
}
|
|
|
|
return $ifaces;
|
|
}
|
|
|
|
/**
|
|
* Obtain current state of device's ports
|
|
*
|
|
* @return array Current states of all ports
|
|
* @throws Exception On SNMP error or wrong SNMP response
|
|
*/
|
|
public function getPortStates()
|
|
{
|
|
return array();
|
|
}
|
|
|
|
/**
|
|
* Obtain ARP table of device
|
|
*
|
|
* @return array Whole ARP table from device
|
|
* @throws Exception On SNMP error or wrong SNMP response
|
|
*/
|
|
public function getARPTable()
|
|
{
|
|
// obtain whole ARP table
|
|
$this->startErrorHandler();
|
|
snmp_set_valueretrieval(SNMP_VALUE_PLAIN);
|
|
$arp_table = snmp2_real_walk(
|
|
$this->deviceIp, $this->comunity,
|
|
'iso.3.6.1.2.1.4.22.1.2',
|
|
$this->timeout, $this->retries
|
|
);
|
|
$this->stopErrorHandler();
|
|
|
|
$ifaces = self::getIfaces();
|
|
|
|
$items = array();
|
|
|
|
foreach ($arp_table as $key => $value)
|
|
{
|
|
$pieces = explode('.', $key);
|
|
|
|
$iface_id = implode('.', array_slice($pieces, -5, 1));
|
|
|
|
if (!array_key_exists($iface_id, $ifaces))
|
|
continue;
|
|
|
|
$mac = network::bin2mac($value);
|
|
|
|
$item = new stdClass();
|
|
|
|
$item->ip_address = implode('.', array_slice($pieces, -4));
|
|
$item->mac_address = $mac;
|
|
$item->iface_name = $ifaces[$iface_id];
|
|
|
|
$items[] = $item;
|
|
}
|
|
|
|
return $items;
|
|
}
|
|
|
|
/**
|
|
* Obtain DHCP leases of device
|
|
*
|
|
* @return array All DHCP leases
|
|
* @throws Exception On SNMP error or wrong SNMP response
|
|
*/
|
|
public function getDHCPLeases()
|
|
{
|
|
// obtain all DHCP leases
|
|
$this->startErrorHandler();
|
|
snmp_set_valueretrieval(SNMP_VALUE_PLAIN);
|
|
$dhcp_leases = snmp2_real_walk(
|
|
$this->deviceIp, $this->comunity,
|
|
'iso.3.6.1.2.1.9999.1.1.6.4.1',
|
|
$this->timeout, $this->retries
|
|
);
|
|
$this->stopErrorHandler();
|
|
|
|
$leases = array();
|
|
$states = array();
|
|
$expires = array();
|
|
|
|
foreach ($dhcp_leases as $key => $value)
|
|
{
|
|
$pieces = explode('.', $key);
|
|
|
|
$index = $pieces[count($pieces)-5];
|
|
|
|
$ip_address = implode('.', array_slice($pieces, -4));
|
|
|
|
switch ($index)
|
|
{
|
|
case 4:
|
|
$states[$ip_address] = ($value == 2) ? 'D' : '';
|
|
break;
|
|
|
|
case 5:
|
|
$expires[$ip_address] = ($value != 4294967295) ? $value : '';
|
|
break;
|
|
|
|
case 8:
|
|
$leases[$ip_address] = network::bin2mac(mb_substr($value, -6));
|
|
break;
|
|
}
|
|
}
|
|
|
|
$items = array();
|
|
|
|
foreach ($leases as $ip_address => $mac_address)
|
|
{
|
|
$item = new stdClass();
|
|
$item->ip_address = $ip_address;
|
|
$item->mac_address = $mac_address;
|
|
$item->state = $states[$ip_address];
|
|
$item->expire = $expires[$ip_address];
|
|
|
|
$items[] = $item;
|
|
}
|
|
|
|
return $items;
|
|
}
|
|
|
|
/**
|
|
* Obtain device's hostname from DHCP leases of device
|
|
*
|
|
* @param string $device_ip IP address to which we will search for hostname
|
|
* @return string Hostname for given IP address
|
|
* @throws Exception On SNMP error or wrong SNMP response
|
|
* @throws InvalidArgumentException On wrong IP address
|
|
*/
|
|
public function getDHCPHostnameOf($device_ip)
|
|
{
|
|
return FALSE;
|
|
}
|
|
|
|
/**
|
|
* Obtain wireless info of device
|
|
*
|
|
* @return array Current wireless info
|
|
* @throws Exception On SNMP error or wrong SNMP response
|
|
*/
|
|
public function getWirelessInfo()
|
|
{
|
|
// obtain all DHCP leases
|
|
$this->startErrorHandler();
|
|
snmp_set_valueretrieval(SNMP_VALUE_PLAIN);
|
|
$wireless_items = snmp2_real_walk(
|
|
$this->deviceIp, $this->comunity,
|
|
'iso.3.6.1.4.1.14988.1.1.1.2.1',
|
|
$this->timeout, $this->retries
|
|
);
|
|
$this->stopErrorHandler();
|
|
|
|
$ifaces = self::getIfaces();
|
|
|
|
$items = array();
|
|
foreach ($wireless_items as $key => $value)
|
|
{
|
|
$pieces = explode('.', $key);
|
|
|
|
$index = $pieces[count($pieces)-8];
|
|
|
|
$iface_id = array_pop($pieces);
|
|
|
|
$i = implode('.', array_slice($pieces, -6));
|
|
|
|
if (!array_key_exists($i, $items))
|
|
{
|
|
$items[$i] = new stdClass ();
|
|
$items[$i]->iface_name = $ifaces[$iface_id];
|
|
}
|
|
|
|
switch ($index)
|
|
{
|
|
// mac address
|
|
case '1':
|
|
$items[$i]->mac_address = network::bin2mac($value);
|
|
break;
|
|
|
|
// signal strength
|
|
case '3':
|
|
$items[$i]->signal = $value;
|
|
break;
|
|
|
|
// tx-rate
|
|
case '8':
|
|
$items[$i]->tx_rate = $value;
|
|
break;
|
|
// rx-rate
|
|
case '9':
|
|
$items[$i]->rx_rate = $value;
|
|
break;
|
|
// uptime
|
|
case '11':
|
|
$items[$i]->uptime = $value;
|
|
break;
|
|
}
|
|
}
|
|
|
|
return $items;
|
|
}
|
|
|
|
/**
|
|
* Obtain MAC table from device
|
|
*
|
|
* @return array Whole MAC table
|
|
* @throws Exception On SNMP error or wrong SNMP response
|
|
*/
|
|
public function getMacTable()
|
|
{
|
|
return array();
|
|
}
|
|
}
|