* * 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, either version 3 of the License, or (at your * option) any later version. Please see LICENSE.txt at the top level of * the source code distribution for details. */ use App\Models\Device; use App\Models\DeviceGroup; use App\Models\PortsFdb; use App\Models\Sensor; use Illuminate\Database\Eloquent\Builder; use Illuminate\Routing\Router; use LibreNMS\Alerting\QueryBuilderParser; use LibreNMS\Config; use LibreNMS\Exceptions\InvalidIpException; use LibreNMS\Util\IPv4; function api_success($result, $result_name, $message = null, $code = 200, $count = null, $extra = null) { if (isset($result) && !isset($result_name)) { return api_error(500, 'Result name not specified'); } $output = ['status' => 'ok']; if (isset($result)) { $output[$result_name] = $result; } if (isset($message) && $message != '') { $output['message'] = $message; } if (!isset($count) && is_array($result)) { $count = count($result); } if (isset($count)) { $output['count'] = $count; } if (isset($extra)) { $output = array_merge($output, $extra); } return response()->json($output, $code, [], JSON_PRETTY_PRINT); } // end api_success() function api_success_noresult($code, $message = null) { return api_success(null, null, $message, $code); } // end api_success_noresult function api_error($statusCode, $message) { return response()->json([ 'status' => 'error', 'message' => $message ], $statusCode, [], JSON_PRETTY_PRINT); } // end api_error() function api_not_found() { return api_error(404, "This API route doesn't exist."); } function api_get_graph(array $vars) { global $dur; // Needed for callback within graph code $auth = '1'; $base64_output = ''; // prevent ugly error for undefined graphs from being passed to the user list($type, $subtype) = extract_graph_type($vars['type']); if (!is_file(base_path("includes/html/graphs/$type/auth.inc.php"))) { return api_error(400, 'Invalid graph type'); } ob_start(); rrdtool_initialize(false); include 'includes/html/graphs/graph.inc.php'; rrdtool_close(); $image = ob_get_contents(); ob_end_clean(); if ($vars['output'] === 'base64') { return api_success(['image' => $base64_output, 'content-type' => get_image_type()], 'image'); } return response($image, 200, ['Content-Type' => get_image_type()]); } function check_bill_permission($bill_id, $callback) { if (!bill_permitted($bill_id)) { return api_error(403, 'Insufficient permissions to access this bill'); } return $callback($bill_id); } function check_device_permission($device_id, $callback = null) { if (!device_permitted($device_id)) { return api_error(403, 'Insufficient permissions to access this device'); } return is_callable($callback) ? $callback($device_id) : true; } function check_port_permission($port_id, $device_id, $callback) { if (!device_permitted($device_id) && !port_permitted($port_id, $device_id)) { return api_error(403, 'Insufficient permissions to access this port'); } return $callback($port_id); } function get_graph_by_port_hostname(\Illuminate\Http\Request $request, $ifname = null, $type = 'port_bits') { // This will return a graph for a given port by the ifName $hostname = $request->route('hostname'); $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); $vars = [ 'port' => $ifname ?: $request->route('ifname'), 'type' => $request->route('type', $type), 'output' => $request->get('output', 'display'), 'width' => $request->get('width', 1075), 'height' => $request->get('height', 300), ]; if ($request->has('from')) { $vars['from'] = $request->get('from'); } if ($request->has('to')) { $vars['to'] = $request->get('to'); } $port = $request->get('ifDescr') ? 'ifDescr' : 'ifName'; $vars['id'] = dbFetchCell("SELECT `P`.`port_id` FROM `ports` AS `P` JOIN `devices` AS `D` ON `P`.`device_id` = `D`.`device_id` WHERE `D`.`device_id`=? AND `P`.`$port`=? AND `deleted` = 0 LIMIT 1", [$device_id, $vars['port']]); return check_port_permission($vars['id'], $device_id, function () use ($vars) { return api_get_graph($vars); }); } function get_port_stats_by_port_hostname(\Illuminate\Http\Request $request) { $ifName = $request->route('ifname'); // handle %2f in paths and pass to get_graph_by_port_hostname if needed if (str_contains($ifName, '/')) { $parts = explode('/', $request->path()); if (isset($parts[5])) { $ifName = urldecode($parts[5]); if (isset($parts[6])) { return get_graph_by_port_hostname($request, $ifName, $parts[6]); } } } // This will return port stats based on a devices hostname and ifName $hostname = $request->route('hostname'); $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); $port = dbFetchRow('SELECT * FROM `ports` WHERE `device_id`=? AND `ifName`=? AND `deleted` = 0', [$device_id, $ifName]); return check_port_permission($port['port_id'], $device_id, function () use ($request, $port) { $in_rate = $port['ifInOctets_rate'] * 8; $out_rate = $port['ifOutOctets_rate'] * 8; $port['in_rate'] = formatRates($in_rate); $port['out_rate'] = formatRates($out_rate); $port['in_perc'] = number_format($in_rate / $port['ifSpeed'] * 100, 2, '.', ''); $port['out_perc'] = number_format($out_rate / $port['ifSpeed'] * 100, 2, '.', ''); $port['in_pps'] = format_bi($port['ifInUcastPkts_rate']); $port['out_pps'] = format_bi($port['ifOutUcastPkts_rate']); //only return requested columns if ($request->has('columns')) { $cols = explode(",", $request->get('columns')); foreach (array_keys($port) as $c) { if (!in_array($c, $cols)) { unset($port[$c]); } } } return api_success($port, 'port'); }); } function get_graph_generic_by_hostname(\Illuminate\Http\Request $request) { // This will return a graph type given a device id. $hostname = $request->route('hostname'); $sensor_id = $request->route('sensor_id'); $vars = []; $vars['type'] = $request->route('type', 'device_uptime'); $vars['output'] = $request->get('output', 'display'); if (isset($sensor_id)) { $vars['id'] = $sensor_id; if (str_contains($vars['type'], '_wireless')) { $vars['type'] = str_replace('device_', '', $vars['type']); } else { // If this isn't a wireless graph we need to fix the name. $vars['type'] = str_replace('device_', 'sensor_', $vars['type']); } } // use hostname as device_id if it's all digits $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); $device = device_by_id_cache($device_id); $vars['device'] = $device['device_id']; return check_device_permission($device_id, function () use ($request, $device, $vars) { if ($request->has('from')) { $vars['from'] = $request->get('from'); } if ($request->has('to')) { $vars['to'] = $request->get('to'); } $vars['width'] = $request->get('width', 1075); $vars['height'] = $request->get('height', 300); return api_get_graph($vars); }); } function list_locations() { $locations = dbFetchRows("SELECT `locations`.* FROM `locations` WHERE `locations`.`location` IS NOT NULL"); $total_locations = count($locations); if ($total_locations == 0) { return api_error(404, 'Locations do not exist'); } return api_success($locations, 'locations'); } function get_device(\Illuminate\Http\Request $request) { // return details of a single device $hostname = $request->route('hostname'); // use hostname as device_id if it's all digits $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); // find device matching the id $device = device_by_id_cache($device_id); if (!$device) { return api_error(404, "Device $hostname does not exist"); } return check_device_permission($device_id, function () use ($device) { $host_id = get_vm_parent_id($device); if (is_numeric($host_id)) { $device = array_merge($device, ['parent_id' => $host_id]); } return api_success([$device], 'devices'); }); } function list_devices(\Illuminate\Http\Request $request) { // This will return a list of devices $order = $request->get('order'); $type = $request->get('type'); $query = $request->get('query'); $param = []; if (empty($order)) { $order = 'hostname'; } if (stristr($order, ' desc') === false && stristr($order, ' asc') === false) { $order = 'd.`'.$order.'` ASC'; } $select = " d.*, GROUP_CONCAT(dd.device_id) AS dependency_parent_id, GROUP_CONCAT(dd.hostname) AS dependency_parent_hostname, `location`, `lat`, `lng` "; $join = " LEFT JOIN `device_relationships` AS dr ON dr.`child_device_id` = d.`device_id` LEFT JOIN `devices` AS dd ON dr.`parent_device_id` = dd.`device_id` LEFT JOIN `locations` ON `locations`.`id` = `d`.`location_id`"; if ($type == 'all' || empty($type)) { $sql = '1'; } elseif ($type == 'active') { $sql = "`d`.`ignore`='0' AND `d`.`disabled`='0'"; } elseif ($type == 'location') { $sql = "`locations`.`location` LIKE '%".$query."%'"; } elseif ($type == 'hostname') { $sql = "`d`.`hostname` LIKE '%".$query."%'"; } elseif ($type == 'ignored') { $sql = "`d`.`ignore`='1' AND `d`.`disabled`='0'"; } elseif ($type == 'up') { $sql = "`d`.`status`='1' AND `d`.`ignore`='0' AND `d`.`disabled`='0'"; } elseif ($type == 'down') { $sql = "`d`.`status`='0' AND `d`.`ignore`='0' AND `d`.`disabled`='0'"; } elseif ($type == 'disabled') { $sql = "`d`.`disabled`='1'"; } elseif ($type == 'os') { $sql = "`d`.`os`=?"; $param[] = $query; } elseif ($type == 'mac') { $join .= " LEFT JOIN `ports` AS p ON d.`device_id` = p.`device_id` LEFT JOIN `ipv4_mac` AS m ON p.`port_id` = m.`port_id` "; $sql = "m.`mac_address`=?"; $select .= ",p.* "; $param[] = $query; } elseif ($type == 'ipv4') { $join .= " LEFT JOIN `ports` AS p ON d.`device_id` = p.`device_id` LEFT JOIN `ipv4_addresses` AS a ON p.`port_id` = a.`port_id` "; $sql = "a.`ipv4_address`=?"; $select .= ",p.* "; $param[] = $query; } elseif ($type == 'ipv6') { $join .= " LEFT JOIN `ports` AS p ON d.`device_id` = p.`device_id` LEFT JOIN `ipv6_addresses` AS a ON p.`port_id` = a.`port_id` "; $sql = "a.`ipv6_address`=? OR a.`ipv6_compressed`=?"; $select .= ",p.* "; $param = [$query, $query]; } else { $sql = '1'; } if (!Auth::user()->hasGlobalRead()) { $sql .= " AND `d`.`device_id` IN (SELECT device_id FROM devices_perms WHERE user_id = ?)"; $param[] = Auth::id(); } $devices = []; $dev_query = "SELECT $select FROM `devices` AS d $join WHERE $sql GROUP BY d.`hostname` ORDER BY $order"; foreach (dbFetchRows($dev_query, $param) as $device) { $host_id = get_vm_parent_id($device); $device['ip'] = inet6_ntop($device['ip']); if (is_numeric($host_id)) { $device['parent_id'] = $host_id; } $devices[] = $device; } return api_success($devices, 'devices'); } function add_device(\Illuminate\Http\Request $request) { // This will add a device using the data passed encoded with json // FIXME: Execution flow through this function could be improved $data = json_decode($request->getContent(), true); $additional = []; // keep scrutinizer from complaining about snmpver not being set for all execution paths $snmpver = 'v2c'; if (empty($data)) { return api_error(400, 'No information has been provided to add this new device'); } if (empty($data['hostname'])) { return api_error(400, 'Missing the device hostname'); } $hostname = $data['hostname']; $port = $data['port'] ?: Config::get('snmp.port'); $transport = $data['transport'] ?: 'udp'; $poller_group = $data['poller_group'] ?: 0; $force_add = $data['force_add'] ? true : false; $snmp_disable = ($data['snmp_disable']); if ($snmp_disable) { $additional = [ 'sysName' => $data['sysName'] ?: '', 'os' => $data['os'] ?: 'ping', 'hardware' => $data['hardware'] ?: '', 'snmp_disable' => 1, ]; } elseif ($data['version'] == 'v1' || $data['version'] == 'v2c') { if ($data['community']) { Config::set('snmp.community', [$data['community']]); } $snmpver = $data['version']; } elseif ($data['version'] == 'v3') { $v3 = [ 'authlevel' => $data['authlevel'], 'authname' => $data['authname'], 'authpass' => $data['authpass'], 'authalgo' => $data['authalgo'], 'cryptopass' => $data['cryptopass'], 'cryptoalgo' => $data['cryptoalgo'], ]; $v3_config = Config::get('snmp.v3'); array_unshift($v3_config, $v3); Config::set('snmp.v3', $v3_config); $snmpver = 'v3'; } else { return api_error(400, 'You haven\'t specified an SNMP version to use'); } try { $device_id = addHost($hostname, $snmpver, $port, $transport, $poller_group, $force_add, 'ifIndex', $additional); } catch (Exception $e) { return api_error(500, $e->getMessage()); } return api_success_noresult(201, "Device $hostname ($device_id) has been added successfully"); } function del_device(\Illuminate\Http\Request $request) { // This will add a device using the data passed encoded with json $hostname = $request->route('hostname'); if (empty($hostname)) { return api_error(400, 'No hostname has been provided to delete'); } // allow deleting by device_id or hostname $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); $device = null; if ($device_id) { // save the current details for returning to the client on successful delete $device = device_by_id_cache($device_id); } if (!$device) { return api_error(404, "Device $hostname not found"); } $response = delete_device($device_id); if (empty($response)) { // FIXME: Need to provide better diagnostics out of delete_device return api_error(500, 'Device deletion failed'); } // deletion succeeded - include old device details in response return api_success([$device], 'devices', $response); } function get_vlans(\Illuminate\Http\Request $request) { $hostname = $request->route('hostname'); if (empty($hostname)) { return api_error(500, 'No hostname has been provided'); } $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); $device = null; if ($device_id) { // save the current details for returning to the client on successful delete $device = device_by_id_cache($device_id); } if (!$device) { return api_error(404, "Device $hostname not found"); } return check_device_permission($device_id, function ($device_id) { $vlans = dbFetchRows('SELECT vlan_vlan,vlan_domain,vlan_name,vlan_type,vlan_mtu FROM vlans WHERE `device_id` = ?', [$device_id]); return api_success($vlans, 'vlans'); }); } function show_endpoints(\Illuminate\Http\Request $request, Router $router) { $output = []; $base = str_replace('api/v0', '', $request->url()); foreach ($router->getRoutes() as $route) { /** @var \Illuminate\Routing\Route $route */ if (starts_with($route->getPrefix(), 'api/v0') && $route->getName()) { $output[$route->getName()] = $base . $route->uri(); } } ksort($output); return response()->json($output, 200, [], JSON_PRETTY_PRINT|JSON_UNESCAPED_SLASHES); } function list_bgp(\Illuminate\Http\Request $request) { $sql = ''; $sql_params = []; $hostname = $request->get('hostname'); $asn = $request->get('asn'); $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); if (is_numeric($device_id)) { $sql = ' AND `devices`.`device_id` = ?'; $sql_params[] = $device_id; } if (!empty($asn)) { $sql = ' AND `devices`.`bgpLocalAs` = ?'; $sql_params[] = $asn; } $bgp_sessions = dbFetchRows("SELECT `bgpPeers`.* FROM `bgpPeers` LEFT JOIN `devices` ON `bgpPeers`.`device_id` = `devices`.`device_id` WHERE `bgpPeerState` IS NOT NULL AND `bgpPeerState` != '' $sql", $sql_params); $total_bgp_sessions = count($bgp_sessions); if (!is_numeric($total_bgp_sessions)) { return api_error(500, 'Error retrieving bgpPeers'); } return api_success($bgp_sessions, 'bgp_sessions'); } function get_bgp(\Illuminate\Http\Request $request) { $bgpPeerId = $request->route('id'); if (!is_numeric($bgpPeerId)) { return api_error(400, 'Invalid id has been provided'); } $bgp_session = dbFetchRows("SELECT * FROM `bgpPeers` WHERE `bgpPeerState` IS NOT NULL AND `bgpPeerState` != '' AND bgpPeer_id = ?", [$bgpPeerId]); $bgp_session_count = count($bgp_session); if (!is_numeric($bgp_session_count)) { return api_error(500, 'Error retrieving BGP peer'); } if ($bgp_session_count == 0) { return api_error(404, "BGP peer $bgpPeerId does not exist"); } return api_success($bgp_session, 'bgp_session'); } function list_cbgp(\Illuminate\Http\Request $request) { $sql = ''; $sql_params = []; $hostname = $request->get('hostname'); $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); if (is_numeric($device_id)) { $permission = check_device_permission($device_id); if ($permission !== true) { return $permission; // permission error } $sql = " AND `devices`.`device_id` = ?"; $sql_params[] = $device_id; } if (!Auth::user()->hasGlobalRead()) { $sql .= " AND `bgpPeers_cbgp`.`device_id` IN (SELECT device_id FROM devices_perms WHERE user_id = ?)"; $sql_params[] = Auth::id(); } $bgp_counters = dbFetchRows("SELECT `bgpPeers_cbgp`.* FROM `bgpPeers_cbgp` LEFT JOIN `devices` ON `bgpPeers_cbgp`.`device_id` = `devices`.`device_id` WHERE `bgpPeers_cbgp`.`device_id` IS NOT NULL $sql", $sql_params); $total_bgp_counters = count($bgp_counters); if ($total_bgp_counters == 0) { return api_error(404, 'BGP counters does not exist'); } return api_success($bgp_counters, 'bgp_counters'); } function list_ospf(\Illuminate\Http\Request $request) { $sql = ''; $sql_params = []; $hostname = $request->get('hostname'); $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); if (is_numeric($device_id)) { $sql = ' AND `device_id`=?'; $sql_params = [$device_id]; } $ospf_neighbours = dbFetchRows("SELECT * FROM ospf_nbrs WHERE `ospfNbrState` IS NOT NULL AND `ospfNbrState` != '' $sql", $sql_params); $total_ospf_neighbours = count($ospf_neighbours); if (!is_numeric($total_ospf_neighbours)) { return api_error(500, 'Error retrieving ospf_nbrs'); } return api_success($ospf_neighbours, 'ospf_neighbours'); } function get_graph_by_portgroup(\Illuminate\Http\Request $request) { $group = $request->route('group'); $id = $request->route('id'); $vars = [ 'output' => $request->get('output', 'display'), 'width' => $request->get('width', 1075), 'height' => $request->get('height', 300), 'type' => 'multiport_bits_separate', ]; if ($request->has('from')) { $vars['from'] = $request->get('from'); } if ($request->has('to')) { $vars['to'] = $request->get('to'); } if (empty($id)) { $ports = get_ports_from_type(explode(',', $group)); $if_list = implode(',', array_pluck($ports, 'port_id')); } else { $if_list = $id; } $vars['id'] = $if_list; return api_get_graph($vars); } function get_components(\Illuminate\Http\Request $request) { $hostname = $request->route('hostname'); // Do some filtering if the user requests. $options = []; // Add the rest of the options with an equals query foreach ($request->all() as $k => $v) { $options['filter'][$k] = ['=', $v]; } // We need to specify the label as this is a LIKE query if ($request->has('label')) { // set a label like filter $options['filter']['label'] = ['LIKE', $request->get('label')]; } // use hostname as device_id if it's all digits $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); return check_device_permission($device_id, function ($device_id) use ($options) { $COMPONENT = new LibreNMS\Component(); $components = $COMPONENT->getComponents($device_id, $options); return api_success($components[$device_id], 'components'); }); } function add_components(\Illuminate\Http\Request $request) { $hostname = $request->route('hostname'); $ctype = $request->route('type'); // use hostname as device_id if it's all digits $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); $COMPONENT = new LibreNMS\Component(); $component = $COMPONENT->createComponent($device_id, $ctype); return api_success($component, 'components'); } function edit_components(\Illuminate\Http\Request $request) { $hostname = $request->route('hostname'); $data = json_decode($request->getContent(), true); // use hostname as device_id if it's all digits $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); $COMPONENT = new LibreNMS\Component(); if (!$COMPONENT->setComponentPrefs($device_id, $data)) { return api_error(500, 'Components could not be edited.'); } return api_success_noresult(200); } function delete_components(\Illuminate\Http\Request $request) { $cid = $request->route('component'); $COMPONENT = new LibreNMS\Component(); if ($COMPONENT->deleteComponent($cid)) { return api_success_noresult(200); } else { return api_error(500, 'Components could not be deleted.'); } } function get_graphs(\Illuminate\Http\Request $request) { $hostname = $request->route('hostname'); // use hostname as device_id if it's all digits $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); return check_device_permission($device_id, function ($device_id) { $graphs = []; $graphs[] = [ 'desc' => 'Poller Time', 'name' => 'device_poller_perf', ]; $graphs[] = [ 'desc' => 'Ping Response', 'name' => 'device_ping_perf', ]; foreach (dbFetchRows('SELECT * FROM device_graphs WHERE device_id = ? ORDER BY graph', [$device_id]) as $graph) { $desc = Config::get("graph_types.device.{$graph['graph']}.descr"); $graphs[] = [ 'desc' => $desc, 'name' => 'device_'.$graph['graph'], ]; } return api_success($graphs, 'graphs'); }); } function list_available_health_graphs(\Illuminate\Http\Request $request) { $hostname = $request->route('hostname'); $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); return check_device_permission($device_id, function ($device_id) use ($request) { $input_type = $request->route('type'); if ($input_type) { $type = preg_replace('/^device_/', '', $input_type); } $sensor_id = $request->route('sensor_id'); $graphs = []; if (isset($type)) { if (isset($sensor_id)) { $graphs = dbFetchRows('SELECT * FROM `sensors` WHERE `sensor_id` = ?', [$sensor_id]); } else { foreach (dbFetchRows('SELECT `sensor_id`, `sensor_descr` FROM `sensors` WHERE `device_id` = ? AND `sensor_class` = ? AND `sensor_deleted` = 0', [$device_id, $type]) as $graph) { $graphs[] = [ 'sensor_id' => $graph['sensor_id'], 'desc' => $graph['sensor_descr'], ]; } } } else { foreach (dbFetchRows('SELECT `sensor_class` FROM `sensors` WHERE `device_id` = ? AND `sensor_deleted` = 0 GROUP BY `sensor_class`', [$device_id]) as $graph) { $graphs[] = [ 'desc' => ucfirst($graph['sensor_class']), 'name' => 'device_' . $graph['sensor_class'], ]; } $device = Device::find($device_id); if ($device) { if ($device->processors()->count() > 0) { array_push($graphs, [ 'desc' => 'Processors', 'name' => 'device_processor' ]); } if ($device->storage()->count() > 0) { array_push($graphs, [ 'desc' => 'Storage', 'name' => 'device_storage' ]); } if ($device->mempools()->count() > 0) { array_push($graphs, [ 'desc' => 'Memory Pools', 'name' => 'device_mempool' ]); } } } return api_success($graphs, 'graphs'); }); } function list_available_wireless_graphs(\Illuminate\Http\Request $request) { $hostname = $request->route('hostname'); $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); return check_device_permission($device_id, function ($device_id) use ($request) { $input_type = $request->route('type'); if ($input_type) { list(, , $type) = explode('_', $input_type); } $sensor_id = $request->route('sensor_id'); $graphs = []; if (isset($type)) { if (isset($sensor_id)) { $graphs = dbFetchRows('SELECT * FROM `wireless_sensors` WHERE `sensor_id` = ?', [$sensor_id]); } else { foreach (dbFetchRows('SELECT `sensor_id`, `sensor_descr` FROM `wireless_sensors` WHERE `device_id` = ? AND `sensor_class` = ? AND `sensor_deleted` = 0', [$device_id, $type]) as $graph) { $graphs[] = [ 'sensor_id' => $graph['sensor_id'], 'desc' => $graph['sensor_descr'], ]; } } } else { foreach (dbFetchRows('SELECT `sensor_class` FROM `wireless_sensors` WHERE `device_id` = ? AND `sensor_deleted` = 0 GROUP BY `sensor_class`', [$device_id]) as $graph) { $graphs[] = [ 'desc' => ucfirst($graph['sensor_class']), 'name' => 'device_wireless_'.$graph['sensor_class'], ]; } } return api_success($graphs, 'graphs'); }); } function get_port_graphs(\Illuminate\Http\Request $request) { $hostname = $request->route('hostname'); $columns = $request->get('columns', 'ifName'); if ($validate = validate_column_list($columns, 'ports') !== true) { return $validate; } // use hostname as device_id if it's all digits $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); $sql = ''; $params = [$device_id]; if (!device_permitted($device_id)) { $sql = 'AND `port_id` IN (select `port_id` from `ports_perms` where `user_id` = ?)'; array_push($params, Auth::id()); } $ports = dbFetchRows("SELECT $columns FROM `ports` WHERE `device_id` = ? AND `deleted` = '0' $sql ORDER BY `ifIndex`", $params); return api_success($ports, 'ports'); } function get_device_ip_addresses(\Illuminate\Http\Request $request) { $hostname = $request->route('hostname'); // use hostname as device_id if it's all digits $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); return check_device_permission($device_id, function ($device_id) { $ipv4 = dbFetchRows("SELECT `ipv4_addresses`.* FROM `ipv4_addresses` JOIN `ports` ON `ports`.`port_id`=`ipv4_addresses`.`port_id` WHERE `ports`.`device_id` = ? AND `deleted` = 0", [$device_id]); $ipv6 = dbFetchRows("SELECT `ipv6_addresses`.* FROM `ipv6_addresses` JOIN `ports` ON `ports`.`port_id`=`ipv6_addresses`.`port_id` WHERE `ports`.`device_id` = ? AND `deleted` = 0", [$device_id]); $ip_addresses_count = count(array_merge($ipv4, $ipv6)); if ($ip_addresses_count == 0) { return api_error(404, "Device $device_id does not have any IP addresses"); } return api_success(array_merge($ipv4, $ipv6), 'addresses'); }); } function get_port_ip_addresses(\Illuminate\Http\Request $request) { $port_id = $request->route('portid'); return check_port_permission($port_id, null, function ($port_id) { $ipv4 = dbFetchRows("SELECT * FROM `ipv4_addresses` WHERE `port_id` = ?", [$port_id]); $ipv6 = dbFetchRows("SELECT * FROM `ipv6_addresses` WHERE `port_id` = ?", [$port_id]); $ip_addresses_count = count(array_merge($ipv4, $ipv6)); if ($ip_addresses_count == 0) { return api_error(404, "Port $port_id does not have any IP addresses"); } return api_success(array_merge($ipv4, $ipv6), 'addresses'); }); } function get_network_ip_addresses(\Illuminate\Http\Request $request) { $network_id = $request->route('id'); $ipv4 = dbFetchRows("SELECT * FROM `ipv4_addresses` WHERE `ipv4_network_id` = ?", [$network_id]); $ipv6 = dbFetchRows("SELECT * FROM `ipv6_addresses` WHERE `ipv6_network_id` = ?", [$network_id]); $ip_addresses_count = count(array_merge($ipv4, $ipv6)); if ($ip_addresses_count == 0) { return api_error(404, "IP network $network_id does not exist or is empty"); } return api_success(array_merge($ipv4, $ipv6), 'addresses'); } function get_port_info(\Illuminate\Http\Request $request) { $port_id = $request->route('portid'); return check_port_permission($port_id, null, function ($port_id) { // use hostname as device_id if it's all digits $port = dbFetchRows("SELECT * FROM `ports` WHERE `port_id` = ? AND `deleted` = 0", [$port_id]); return api_success($port, 'port'); }); } function get_all_ports(\Illuminate\Http\Request $request) { $columns = $request->get('columns', 'port_id, ifName'); if ($validate = validate_column_list($columns, 'ports') !== true) { return $validate; } $params = []; $sql = ''; if (!Auth::user()->hasGlobalRead()) { $sql = ' AND (device_id IN (SELECT device_id FROM devices_perms WHERE user_id = ?) OR port_id IN (SELECT port_id FROM ports_perms WHERE user_id = ?))'; array_push($params, Auth::id()); array_push($params, Auth::id()); } $ports = dbFetchRows("SELECT $columns FROM `ports` WHERE `deleted` = 0 $sql", $params); return api_success($ports, 'ports'); } function get_port_stack(\Illuminate\Http\Request $request) { $hostname = $request->route('hostname'); // use hostname as device_id if it's all digits $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); return check_device_permission($device_id, function ($device_id) use ($request) { if ($request->get('valid_mappings')) { $mappings = dbFetchRows("SELECT * FROM `ports_stack` WHERE (`device_id` = ? AND `ifStackStatus` = 'active' AND (`port_id_high` != '0' AND `port_id_low` != '0')) ORDER BY `port_id_high`", [$device_id]); } else { $mappings = dbFetchRows("SELECT * FROM `ports_stack` WHERE `device_id` = ? AND `ifStackStatus` = 'active' ORDER BY `port_id_high`", [$device_id]); } return api_success($mappings, 'mappings'); }); } function list_alert_rules(\Illuminate\Http\Request $request) { $id = $request->route('id'); $sql = ''; $param = []; if ($id > 0) { $sql = 'WHERE id=?'; $param = [$id]; } $rules = dbFetchRows("SELECT * FROM `alert_rules` $sql", $param); return api_success($rules, 'rules'); } function list_alerts(\Illuminate\Http\Request $request) { $id = $request->route('id'); $sql = "SELECT `D`.`hostname`, `A`.*, `R`.`severity` FROM `alerts` AS `A`, `devices` AS `D`, `alert_rules` AS `R` WHERE `D`.`device_id` = `A`.`device_id` AND `A`.`rule_id` = `R`.`id` "; $sql .= 'AND `A`.`state` IN '; if ($request->has('state')) { $param = explode(',', $request->get('state')); } else { $param = [1]; } $sql .= dbGenPlaceholders(count($param)); if ($id > 0) { $param[] = $id; $sql .= 'AND `A`.id=?'; } $severity = $request->get('severity'); if ($severity) { if (in_array($severity, ['ok', 'warning', 'critical'])) { $param[] = $severity; $sql .= ' AND `R`.severity=?'; } } $order = 'timestamp desc'; if ($request->has('order')) { list($sort_column, $sort_order) = explode(' ', $request->get('order'), 2); if (($res = validate_column_list($sort_column, 'alerts')) !== true) { return $res; } if (in_array($sort_order, ['asc', 'desc'])) { $order = $request->get('order'); } } $sql .= ' ORDER BY A.'.$order; $alerts = dbFetchRows($sql, $param); return api_success($alerts, 'alerts'); } function add_edit_rule(\Illuminate\Http\Request $request) { $data = json_decode($request->getContent(), true); if (json_last_error() || !is_array($data)) { return api_error(500, "We couldn't parse the provided json"); } $rule_id = $data['rule_id']; $tmp_devices = (array)$data['devices']; $groups = (array)$data['groups']; if (empty($tmp_devices) && !isset($rule_id)) { return api_error(400, 'Missing the devices or global device (-1)'); } $devices = []; foreach ($tmp_devices as $device) { if ($device == "-1") { continue; } $devices[] = (ctype_digit($device) || is_int($device)) ? $device : getidbyname($device); } if (isset($data['builder'])) { // accept inline json or json as a string $builder = is_array($data['builder']) ? json_encode($data['builder']) : $data['builder']; } else { $builder = $data['rule']; } if (empty($builder)) { return api_error(400, 'Missing the alert builder rule'); } $name = $data['name']; if (empty($name)) { return api_error(400, 'Missing the alert rule name'); } $severity = $data['severity']; $sevs = [ 'ok', 'warning', 'critical', ]; if (!in_array($severity, $sevs)) { return api_error(400, 'Missing the severity'); } $disabled = $data['disabled']; if ($disabled != '0' && $disabled != '1') { $disabled = 0; } $count = $data['count']; $mute = $data['mute']; $delay = $data['delay']; $override_query = $data['override_query']; $adv_query = $data['adv_query']; $delay_sec = convert_delay($delay); if ($mute == 1) { $mute = true; } else { $mute = false; } $extra = [ 'mute' => $mute, 'count' => $count, 'delay' => $delay_sec, 'options' => [ 'override_query' => $override_query ], ]; $extra_json = json_encode($extra); if ($override_query === 'on') { $query = $adv_query; } else { $query = QueryBuilderParser::fromJson($builder)->toSql(); if (empty($query)) { return api_error(500, "We couldn't parse your rule"); } } if (!isset($rule_id)) { if (dbFetchCell('SELECT `name` FROM `alert_rules` WHERE `name`=?', [$name]) == $name) { return api_error(500, 'Addition failed : Name has already been used'); } } elseif (dbFetchCell("SELECT name FROM alert_rules WHERE name=? AND id !=? ", [$name, $rule_id]) == $name) { return api_error(500, 'Update failed : Invalid rule id'); } if (is_numeric($rule_id)) { if (!(dbUpdate(['name' => $name, 'builder' => $builder, 'query' => $query, 'severity' => $severity, 'disabled' => $disabled, 'extra' => $extra_json], 'alert_rules', 'id=?', [$rule_id]) >= 0)) { return api_error(500, 'Failed to update existing alert rule'); } } elseif (!$rule_id = dbInsert(['name' => $name, 'builder' => $builder, 'query' => $query, 'severity' => $severity, 'disabled' => $disabled, 'extra' => $extra_json], 'alert_rules')) { return api_error(500, 'Failed to create new alert rule'); } dbSyncRelationship('alert_device_map', 'rule_id', $rule_id, 'device_id', $devices); dbSyncRelationship('alert_group_map', 'rule_id', $rule_id, 'group_id', $groups); return api_success_noresult(200); } function delete_rule(\Illuminate\Http\Request $request) { $rule_id = $request->route('id'); if (is_numeric($rule_id)) { if (dbDelete('alert_rules', '`id` = ? LIMIT 1', [$rule_id])) { return api_success_noresult(200, 'Alert rule has been removed'); } else { return api_success_noresult(200, 'No alert rule by that ID'); } } return api_error(400, 'Invalid rule id has been provided'); } function ack_alert(\Illuminate\Http\Request $request) { $alert_id = $request->route('id'); $data = json_decode($request->getContent(), true); if (!is_numeric($alert_id)) { return api_error(400, 'Invalid alert has been provided'); } $alert = dbFetchRow('SELECT note, info FROM alerts WHERE id=?', [$alert_id]); $note = $alert['note']; $info = json_decode($alert['info'], true); if (!empty($note)) { $note .= PHP_EOL; } $note .= date(Config::get('dateformat.long')) . " - Ack (" . Auth::user()->username . ") {$data['note']}"; $info['until_clear'] = $data['until_clear']; $info = json_encode($info); if (dbUpdate(['state' => 2, 'note' => $note, 'info' => $info], 'alerts', '`id` = ? LIMIT 1', [$alert_id])) { return api_success_noresult(200, 'Alert has been acknowledged'); } else { return api_success_noresult(200, 'No Alert by that ID'); } } function unmute_alert(\Illuminate\Http\Request $request) { $alert_id = $request->route('id'); $data = json_decode($request->getContent(), true); if (!is_numeric($alert_id)) { return api_error(400, 'Invalid alert has been provided'); } $alert = dbFetchRow('SELECT note, info FROM alerts WHERE id=?', [$alert_id]); $note = $alert['note']; if (!empty($note)) { $note .= PHP_EOL; } $note .= date(Config::get('dateformat.long')) . " - Ack (" . Auth::user()->username . ") {$data['note']}"; if (dbUpdate(['state' => 1, 'note' => $note], 'alerts', '`id` = ? LIMIT 1', [$alert_id])) { return api_success_noresult(200, 'Alert has been unmuted'); } else { return api_success_noresult(200, 'No alert by that ID'); } } function get_inventory(\Illuminate\Http\Request $request) { $hostname = $request->route('hostname'); // use hostname as device_id if it's all digits $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); return check_device_permission($device_id, function ($device_id) use ($request) { $sql = ''; $params = []; if ($request->get('entPhysicalClass')) { $sql .= ' AND entPhysicalClass=?'; $params[] = $request->get('entPhysicalClass'); } if ($request->get('entPhysicalContainedIn')) { $sql .= ' AND entPhysicalContainedIn=?'; $params[] = $request->get('entPhysicalContainedIn'); } else { $sql .= ' AND entPhysicalContainedIn="0"'; } if (!is_numeric($device_id)) { return api_error(400, 'Invalid device provided'); } $sql .= ' AND `device_id`=?'; $params[] = $device_id; $inventory = dbFetchRows("SELECT * FROM `entPhysical` WHERE 1 $sql", $params); return api_success($inventory, 'inventory'); }); } function search_oxidized(\Illuminate\Http\Request $request) { $search_in_conf_textbox = $request->route('searchstring'); $result = search_oxidized_config($search_in_conf_textbox); if (!$result) { return api_error(404, "Received no data from Oxidized"); } else { return api_success($result, 'nodes'); } } function list_oxidized(\Illuminate\Http\Request $request) { $hostname = $request->route('hostname'); $devices = []; $device_types = "'" . implode("','", Config::get('oxidized.ignore_types')) . "'"; $device_os = "'" . implode("','", Config::get('oxidized.ignore_os')) . "'"; $sql = ''; $params = []; if ($hostname) { $sql = " AND hostname = ?"; $params = [$hostname]; } foreach (dbFetchRows("SELECT hostname,sysname,sysDescr,hardware,os,locations.location,ip AS ip FROM `devices` LEFT JOIN locations ON devices.location_id = locations.id LEFT JOIN devices_attribs AS `DA` ON devices.device_id = DA.device_id AND `DA`.attrib_type='override_Oxidized_disable' WHERE `disabled`='0' AND `ignore` = 0 AND (DA.attrib_value = 'false' OR DA.attrib_value IS NULL) AND (`type` NOT IN ($device_types) AND `os` NOT IN ($device_os)) $sql", $params) as $device) { // Convert from packed value to human value $device['ip'] = inet6_ntop($device['ip']); // Pre-populate the group with the default if (Config::get('oxidized.group_support') === true && !empty(Config::get('oxidized.default_group'))) { $device['group'] = Config::get('oxidized.default_group'); } foreach (Config::get('oxidized.maps') as $maps_column => $maps) { // Based on Oxidized group support we can apply groups by setting group_support to true if ($maps_column == "group" && Config::get('oxidized.group_support', true) !== true) { continue; } foreach ($maps as $field_type => $fields) { foreach ($fields as $field) { if (isset($field['regex']) && preg_match($field['regex'].'i', $device[$field_type])) { $device[$maps_column] = $field[$maps_column]; break; } elseif (isset($field['match']) && $field['match'] == $device[$field_type]) { $device[$maps_column] = $field[$maps_column]; break; } } } } // We remap certain device OS' that have different names with Oxidized models $models = [ 'arista_eos' => 'eos', 'vyos' => 'vyatta', 'slms' => 'zhoneolt', 'fireware' => 'firewareos', ]; $device['os'] = str_replace(array_keys($models), array_values($models), $device['os']); unset($device['location']); unset($device['sysname']); unset($device['sysDescr']); unset($device['hardware']); $devices[] = $device; } return response()->json($devices, 200, [], JSON_PRETTY_PRINT); } function list_bills(\Illuminate\Http\Request $request) { $bills = []; $bill_id = $request->route('bill_id'); $bill_ref = $request->get('ref'); $bill_custid = $request->get('custid'); $period = $request->get('period'); $param = []; $sql = ''; if (!empty($bill_custid)) { $sql .= '`bill_custid` = ?'; $param[] = $bill_custid; } elseif (!empty($bill_ref)) { $sql .= '`bill_ref` = ?'; $param[] = $bill_ref; } elseif (is_numeric($bill_id)) { $sql .= '`bill_id` = ?'; $param[] = $bill_id; } else { $sql = '1'; } if (!Auth::user()->hasGlobalRead()) { $sql .= ' AND `bill_id` IN (SELECT `bill_id` FROM `bill_perms` WHERE `user_id` = ?)'; $param[] = Auth::id(); } if ($period === 'previous') { $select = "SELECT bills.bill_name, bills.bill_notes, bill_history.*, bill_history.traf_total as total_data, bill_history.traf_in as total_data_in, bill_history.traf_out as total_data_out "; $query = 'FROM `bills` INNER JOIN (SELECT bill_id, MAX(bill_hist_id) AS bill_hist_id FROM bill_history WHERE bill_dateto < NOW() AND bill_dateto > subdate(NOW(), 40) GROUP BY bill_id) qLastBills ON bills.bill_id = qLastBills.bill_id INNER JOIN bill_history ON qLastBills.bill_hist_id = bill_history.bill_hist_id '; } else { $select = "SELECT bills.*, IF(bills.bill_type = 'CDR', bill_cdr, bill_quota) AS bill_allowed "; $query = "FROM `bills`\n"; } foreach (dbFetchRows("$select $query WHERE $sql ORDER BY `bill_name`", $param) as $bill) { $rate_data = $bill; $allowed = ''; $used = ''; $percent = ''; $overuse = ''; if ($bill['bill_type'] == "cdr") { $allowed = format_si($bill['bill_cdr'])."bps"; $used = format_si($rate_data['rate_95th'])."bps"; $percent = round(($rate_data['rate_95th'] / $bill['bill_cdr']) * 100, 2); $overuse = $rate_data['rate_95th'] - $bill['bill_cdr']; $overuse = (($overuse <= 0) ? "-" : format_si($overuse)); } elseif ($bill['bill_type'] == "quota") { $allowed = format_bytes_billing($bill['bill_quota']); $used = format_bytes_billing($rate_data['total_data']); $percent = round(($rate_data['total_data'] / ($bill['bill_quota'])) * 100, 2); $overuse = $rate_data['total_data'] - $bill['bill_quota']; $overuse = (($overuse <= 0) ? "-" : format_bytes_billing($overuse)); } $bill['allowed'] = $allowed; $bill['used'] = $used; $bill['percent'] = $percent; $bill['overuse'] = $overuse; $bill['ports'] = dbFetchRows("SELECT `D`.`device_id`,`P`.`port_id`,`P`.`ifName` FROM `bill_ports` AS `B`, `ports` AS `P`, `devices` AS `D` WHERE `B`.`bill_id` = ? AND `P`.`port_id` = `B`.`port_id` AND `D`.`device_id` = `P`.`device_id`", [$bill["bill_id"]]); $bills[] = $bill; } return api_success($bills, 'bills'); } function get_bill_graph(\Illuminate\Http\Request $request) { $bill_id = $request->route('bill_id'); $graph_type = $request->route('graph_type'); if ($graph_type == 'monthly') { $graph_type = 'historicmonthly'; } $vars = [ 'type' => "bill_$graph_type", 'id' => $bill_id, 'width' => $request->get('width', 1075), 'height' => $request->get('height', 300), ]; return check_bill_permission($bill_id, function () use ($vars) { return api_get_graph($vars); }); } function get_bill_graphdata(\Illuminate\Http\Request $request) { $bill_id = $request->route('bill_id'); return check_bill_permission($bill_id, function ($bill_id) use ($request) { $graph_type = $request->route('graph_type'); if ($graph_type == 'bits') { $from = $request->get('from', time() - 60 * 60 * 24); $to = $request->get('to', time()); $reducefactor = $request->get('reducefactor'); $graph_data = getBillingBitsGraphData($bill_id, $from, $to, $reducefactor); } elseif ($graph_type == 'monthly') { $graph_data = getHistoricTransferGraphData($bill_id); } if (!isset($graph_data)) { return api_error(400, "Unsupported graph type $graph_type"); } else { return api_success($graph_data, 'graph_data'); } }); } function get_bill_history(\Illuminate\Http\Request $request) { $bill_id = $request->route('bill_id'); return check_bill_permission($bill_id, function ($bill_id) { $result = dbFetchRows('SELECT * FROM `bill_history` WHERE `bill_id` = ? ORDER BY `bill_datefrom` DESC LIMIT 24', [$bill_id]); return api_success($result, 'bill_history'); }); } function get_bill_history_graph(\Illuminate\Http\Request $request) { $bill_id = $request->route('bill_id'); $bill_hist_id = $request->route('bill_hist_id'); $graph_type = $request->route('graph_type'); $vars = [ 'type' => "bill_$graph_type", 'id' => $bill_id, 'bill_hist_id' => $bill_hist_id, 'width' => $request->get('width', 1075), 'height' => $request->get('height', 300), ]; switch ($graph_type) { case 'bits': $vars['type'] = "bill_historicbits"; $vars['reducefactor'] = $request->get('reducefactor'); break; case 'day': case 'hour': $vars['imgtype'] = $graph_type; $vars['type'] = "bill_historictransfer"; break; default: return api_error(400, "Unknown Graph Type $graph_type"); } return check_bill_permission($bill_id, function () use ($vars) { return api_get_graph($vars); }); } function get_bill_history_graphdata(\Illuminate\Http\Request $request) { $bill_id = $request->route('bill_id'); return check_bill_permission($bill_id, function ($bill_id) use ($request) { $bill_hist_id = $request->route('bill_hist_id'); $graph_type = $request->route('graph_type'); switch ($graph_type) { case 'bits': $reducefactor = $request->get('reducefactor'); $graph_data = getBillingHistoryBitsGraphData($bill_id, $bill_hist_id, $reducefactor); break; case 'day': case 'hour': $graph_data = getBillingBandwidthGraphData($bill_id, $bill_hist_id, null, null, $graph_type); break; } return !isset($graph_data) ? api_error(400, "Unsupported graph type $graph_type") : api_success($graph_data, 'graph_data'); }); } function delete_bill(\Illuminate\Http\Request $request) { $bill_id = $request->route('bill_id'); if ($bill_id < 1) { return api_error(400, 'Could not remove bill with id '.$bill_id.'. Invalid id'); } $res = dbDelete('bills', '`bill_id` = ? LIMIT 1', [ $bill_id ]); if ($res == 1) { dbDelete('bill_ports', '`bill_id` = ? ', [ $bill_id ]); dbDelete('bill_data', '`bill_id` = ? ', [ $bill_id ]); dbDelete('bill_history', '`bill_id` = ? ', [ $bill_id ]); dbDelete('bill_history', '`bill_id` = ? ', [ $bill_id ]); dbDelete('bill_perms', '`bill_id` = ? ', [ $bill_id ]); return api_success_noresult(200, 'Bill has been removed'); } return api_error(400, 'Could not remove bill with id '.$bill_id); } function check_bill_key_value($bill_key, $bill_value) { $bill_types = ['quota', 'cdr']; switch ($bill_key) { case "bill_type": if (!in_array($bill_value, $bill_types)) { return api_error(400, "Invalid value for $bill_key: $bill_value. Allowed: quota,cdr"); } break; case "bill_cdr": if (!is_numeric($bill_value)) { return api_error(400, "Invalid value for $bill_key. Must be numeric."); } break; case "bill_day": if ($bill_value < 1 || $bill_value > 31) { return api_error(400, "Invalid value for $bill_key. range: 1-31"); } break; case "bill_quota": if (!is_numeric($bill_value)) { return api_error(400, "Invalid value for $bill_key. Must be numeric"); } break; default: } return true; } function create_edit_bill(\Illuminate\Http\Request $request) { $data = json_decode($request->getContent(), true); if (!$data) { return api_error(500, 'Invalid JSON data'); } //check ports $ports_add = null; if (array_key_exists('ports', $data)) { $ports_add = []; $ports = $data['ports']; foreach ($ports as $port_id) { $result = dbFetchRows('SELECT port_id FROM `ports` WHERE `port_id` = ? LIMIT 1', [ $port_id ]); $result = $result[0]; if (!is_array($result) || !array_key_exists('port_id', $result)) { return api_error(500, 'Port ' . $port_id . ' does not exists'); } $ports_add[] = $port_id; } } $bill = []; //find existing bill for update $bill_id = (int)$data['bill_id']; $bills = dbFetchRows("SELECT * FROM `bills` WHERE `bill_id` = $bill_id LIMIT 1"); // update existing bill if (is_array($bills) && count($bills) == 1) { $bill = $bills[0]; foreach ($data as $bill_key => $bill_value) { $res = check_bill_key_value($bill_key, $bill_value); if ($res === true) { $bill[$bill_key] = $bill_value; } else { return $res; } } $update_data = [ 'bill_name' => $bill['bill_name'], 'bill_type' => $bill['bill_type'], 'bill_cdr' => $bill['bill_cdr'], 'bill_day' => $bill['bill_day'], 'bill_quota' => $bill['bill_quota'], 'bill_custid' => $bill['bill_custid'], 'bill_ref' => $bill['bill_ref'], 'bill_notes' => $bill['bill_notes'] ]; $update = dbUpdate($update_data, 'bills', 'bill_id=?', [$bill_id]); if ($update === false || $update < 0) { return api_error(500, 'Failed to update existing bill'); } } else { // create new bill if (array_key_exists('bill_id', $data)) { return api_error(500, 'Argument bill_id is not allowed on bill create (auto assigned)'); } $bill_keys = [ 'bill_name', 'bill_type', 'bill_cdr', 'bill_day', 'bill_quota', 'bill_custid', 'bill_ref', 'bill_notes' ]; if ($data['bill_type'] == 'quota') { $data['bill_cdr'] = 0; } if ($data['bill_type'] == 'cdr') { $data['bill_quota'] = 0; } $missing_keys = ''; $missing = array_diff_key(array_flip($bill_keys), $data); if (count($missing) > 0) { foreach ($missing as $missing_key => $dummy) { $missing_keys .= " $missing_key"; } return api_error(500, 'Missing parameters: ' . $missing_keys); } foreach ($bill_keys as $bill_key) { $res = check_bill_key_value($bill_key, $data[$bill_key]); if ($res === true) { $bill[$bill_key] = $data[$bill_key]; } else { return $res; } } $bill_id = dbInsert( [ 'bill_name' => $bill['bill_name'], 'bill_type' => $bill['bill_type'], 'bill_cdr' => $bill['bill_cdr'], 'bill_day' => $bill['bill_day'], 'bill_quota' => $bill['bill_quota'], 'bill_custid' => $bill['bill_custid'], 'bill_ref' => $bill['bill_ref'], 'bill_notes' => $bill['bill_notes'] ], 'bills' ); if ($bill_id === null) { return api_error(500, 'Failed to create new bill'); } } // set previously checked ports if (is_array($ports_add)) { dbDelete('bill_ports', "`bill_id` = $bill_id"); if (count($ports_add) > 0) { foreach ($ports_add as $port_id) { dbInsert([ 'bill_id' => $bill_id, 'port_id' => $port_id, 'bill_port_autoadded' => 0 ], 'bill_ports'); } } } return api_success($bill_id, 'bill_id'); } function update_device(\Illuminate\Http\Request $request) { $hostname = $request->route('hostname'); // use hostname as device_id if it's all digits $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); $data = json_decode($request->getContent(), true); $bad_fields = ['device_id','hostname']; if (empty($data['field'])) { return api_error(400, 'Device field to patch has not been supplied'); } elseif (in_array($data['field'], $bad_fields)) { return api_error(500, 'Device field is not allowed to be updated'); } if (is_array($data['field']) && is_array($data['data'])) { foreach ($data['field'] as $tmp_field) { if (in_array($tmp_field, $bad_fields)) { return api_error(500, 'Device field is not allowed to be updated'); } } if (count($data['field']) == count($data['data'])) { $update = []; for ($x=0; $x= 0) { return api_success_noresult(200, 'Device fields have been updated'); } else { return api_error(500, 'Device fields failed to be updated'); } } else { return api_error(500, 'Device fields failed to be updated as the number of fields ('.count($data['field']).') does not match the supplied data ('.count($data['data']).')'); } } elseif (dbUpdate([$data['field'] => $data['data']], 'devices', '`device_id`=?', [$device_id]) >= 0) { return api_success_noresult(200, 'Device ' . $data['field'] . ' field has been updated'); } else { return api_error(500, 'Device ' . $data['field'] . ' field failed to be updated'); } } function rename_device(\Illuminate\Http\Request $request) { $hostname = $request->route('hostname'); $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); $new_hostname = $request->route('new_hostname'); $new_device = getidbyname($new_hostname); if (empty($new_hostname)) { return api_error(500, 'Missing new hostname'); } elseif ($new_device) { return api_error(500, 'Device failed to rename, new hostname already exists'); } else { if (renamehost($device_id, $new_hostname, 'api') == '') { return api_success_noresult(200, 'Device has been renamed'); } else { return api_error(500, 'Device failed to be renamed'); } } } function get_device_groups(\Illuminate\Http\Request $request) { $hostname = $request->route('hostname'); if ($hostname) { $device = ctype_digit($hostname) ? Device::find($hostname) : Device::findByHostname($hostname); if (is_null($device)) { return api_error(404, 'Device not found'); } $query = $device->groups(); } else { $query = DeviceGroup::query(); } $groups = $query->hasAccess(Auth::user())->orderBy('name')->get(); if ($groups->isEmpty()) { return api_error(404, 'No device groups found'); } return api_success($groups->makeHidden('pivot')->toArray(), 'groups', 'Found ' . $groups->count() . ' device groups'); } function get_devices_by_group(\Illuminate\Http\Request $request) { $name = $request->route('name'); if (!$name) { return api_error(400, 'No device group name provided'); } $device_group = ctype_digit($name) ? DeviceGroup::find($name) : DeviceGroup::where('name', $name)->first(); if (empty($device_group)) { return api_error(404, 'Device group not found'); } $devices = $device_group->devices()->get($request->get('full') ? ['*'] : ['devices.device_id']); if ($devices->isEmpty()) { return api_error(404, 'No devices found in group ' . $name); } return api_success($devices->makeHidden('pivot')->toArray(), 'devices'); } function list_vrf(\Illuminate\Http\Request $request) { $sql = ''; $sql_params = []; $hostname = $request->get('hostname'); $vrfname = $request->get('vrfname'); $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); if (is_numeric($device_id)) { $permission = check_device_permission($device_id); if ($permission !== true) { return $permission; } $sql = " AND `devices`.`device_id`=?"; $sql_params = [$device_id]; } if (!empty($vrfname)) { $sql = " AND `vrfs`.`vrf_name`=?"; $sql_params = [$vrfname]; } if (!Auth::user()->hasGlobalRead()) { $sql .= " AND `vrfs`.`device_id` IN (SELECT device_id FROM devices_perms WHERE user_id = ?)"; $sql_params[] = Auth::id(); } $vrfs = dbFetchRows("SELECT `vrfs`.* FROM `vrfs` LEFT JOIN `devices` ON `vrfs`.`device_id` = `devices`.`device_id` WHERE `vrfs`.`vrf_name` IS NOT NULL $sql", $sql_params); $total_vrfs = count($vrfs); if ($total_vrfs == 0) { return api_error(404, 'VRFs do not exist'); } return api_success($vrfs, 'vrfs'); } function get_vrf(\Illuminate\Http\Request $request) { $vrfId = $request->route('id'); if (!is_numeric($vrfId)) { return api_error(400, 'Invalid id has been provided'); } $vrf = dbFetchRows("SELECT * FROM `vrfs` WHERE `vrf_id` IS NOT NULL AND `vrf_id` = ?", [$vrfId]); $vrf_count = count($vrf); if ($vrf_count == 0) { return api_error(404, "VRF $vrfId does not exist"); } return api_success($vrf, 'vrf'); } function list_ipsec(\Illuminate\Http\Request $request) { $hostname = $request->route('hostname'); // use hostname as device_id if it's all digits $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); if (!is_numeric($device_id)) { return api_error(400, "No valid hostname or device ID provided"); } $ipsec = dbFetchRows("SELECT `D`.`hostname`, `I`.* FROM `ipsec_tunnels` AS `I`, `devices` AS `D` WHERE `I`.`device_id`=? AND `D`.`device_id` = `I`.`device_id`", [$device_id]); return api_success($ipsec, 'ipsec'); } function list_vlans(\Illuminate\Http\Request $request) { $sql = ''; $sql_params = []; $hostname = $request->get('hostname'); $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); if (is_numeric($device_id)) { $permission = check_device_permission($device_id); if ($permission !== true) { return $permission; } $sql = " AND `devices`.`device_id` = ?"; $sql_params[] = $device_id; } if (!Auth::user()->hasGlobalRead()) { $sql .= " AND `vlans`.`device_id` IN (SELECT device_id FROM devices_perms WHERE user_id = ?)"; $sql_params[] = Auth::id(); } $vlans = dbFetchRows("SELECT `vlans`.* FROM `vlans` LEFT JOIN `devices` ON `vlans`.`device_id` = `devices`.`device_id` WHERE `vlans`.`vlan_vlan` IS NOT NULL $sql", $sql_params); $vlans_count = count($vlans); if ($vlans_count == 0) { return api_error(404, 'VLANs do not exist'); } return api_success($vlans, 'vlans'); } function list_links(\Illuminate\Http\Request $request) { $hostname = $request->route('hostname'); $sql = ''; $sql_params = []; $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); if (is_numeric($device_id)) { $permission = check_device_permission($device_id); if ($permission !== true) { return $permission; } $sql = " AND `links`.`local_device_id`=?"; $sql_params = [$device_id]; } if (!Auth::user()->hasGlobalRead()) { $sql .= " AND `links`.`local_device_id` IN (SELECT device_id FROM devices_perms WHERE user_id = ?)"; $sql_params[] = Auth::id(); } $links = dbFetchRows("SELECT `links`.* FROM `links` LEFT JOIN `devices` ON `links`.`local_device_id` = `devices`.`device_id` WHERE `links`.`id` IS NOT NULL $sql", $sql_params); $total_links = count($links); if ($total_links == 0) { return api_error(404, 'Links do not exist'); } return api_success($links, 'links'); } function get_link(\Illuminate\Http\Request $request) { $linkId = $request->route('id'); if (!is_numeric($linkId)) { return api_error(400, 'Invalid id has been provided'); } $link = dbFetchRows("SELECT * FROM `links` WHERE `id` IS NOT NULL AND `id` = ?", [$linkId]); $link_count = count($link); if ($link_count == 0) { return api_error(404, "Link $linkId does not exist"); } return api_success($link, 'link'); } function get_fdb(\Illuminate\Http\Request $request) { $hostname = $request->route('hostname'); if (empty($hostname)) { return api_error(500, 'No hostname has been provided'); } $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); $device = null; if ($device_id) { // save the current details for returning to the client on successful delete $device = Device::find($device_id); } if (!$device) { return api_error(404, "Device $hostname not found"); } return check_device_permission($device_id, function () use ($device) { if ($device) { $fdb = $device->portsFdb; return api_success($fdb, 'ports_fdb'); } return api_error(404, 'Device does not exist'); }); } function list_fdb(\Illuminate\Http\Request $request) { $mac = $request->route('mac'); $fdb = PortsFdb::hasAccess(Auth::user()) ->when(!empty($mac), function (Builder $query) use ($mac) { return $query->where('mac_address', $mac); }) ->get(); if ($fdb->isEmpty()) { return api_error(404, 'Fdb do not exist'); } return api_success($fdb, 'ports_fdb'); } function list_sensors() { $sensors = Sensor::hasAccess(Auth::user())->get(); $total_sensors = $sensors->count(); if ($total_sensors == 0) { return api_error(404, 'Sensors do not exist'); } return api_success($sensors, 'sensors'); } function list_ip_addresses() { $ipv4_addresses = dbFetchRows("SELECT * FROM `ipv4_addresses`"); $ipv6_addresses = dbFetchRows("SELECT * FROM `ipv6_addresses`"); $ip_addresses_count = count(array_merge($ipv4_addresses, $ipv6_addresses)); if ($ip_addresses_count == 0) { return api_error(404, 'IP addresses do not exist'); } return api_success(array_merge($ipv4_addresses, $ipv6_addresses), 'ip_addresses'); } function list_ip_networks() { $ipv4_networks = dbFetchRows("SELECT * FROM `ipv4_networks`"); $ipv6_networks = dbFetchRows("SELECT * FROM `ipv6_networks`"); $ip_networks_count = count(array_merge($ipv4_networks, $ipv6_networks)); if ($ip_networks_count == 0) { return api_error(404, 'IP networks do not exist'); } return api_success(array_merge($ipv4_networks, $ipv6_networks), 'ip_networks'); } function list_arp(\Illuminate\Http\Request $request) { $ip = $request->route('ip'); $cidr = $request->route('cidr'); $hostname = $request->get('device'); if (empty($ip)) { return api_error(400, "No valid IP provided"); } elseif ($ip === "all" && empty($hostname)) { return api_error(400, "Device argument is required when requesting all entries"); } if ($ip === "all") { $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); $arp = dbFetchRows("SELECT `ipv4_mac`.* FROM `ipv4_mac` LEFT JOIN `ports` ON `ipv4_mac`.`port_id` = `ports`.`port_id` WHERE `ports`.`device_id` = ?", [$device_id]); } elseif ($cidr) { try { $ip = new IPv4("$ip/$cidr"); $arp = dbFetchRows( 'SELECT * FROM `ipv4_mac` WHERE (inet_aton(`ipv4_address`) & ?) = ?', [ip2long($ip->getNetmask()), ip2long($ip->getNetworkAddress())] ); } catch (InvalidIpException $e) { return api_error(400, "Invalid Network Address"); } } else { $arp = dbFetchRows("SELECT * FROM `ipv4_mac` WHERE `ipv4_address`=?", [$ip]); } return api_success($arp, 'arp'); } function list_services(\Illuminate\Http\Request $request) { $where = []; $params = []; // Filter by State if ($request->has('state')) { $where[] = '`service_status`=?'; $params[] = $request->get('state'); $where[] = "`service_disabled`='0'"; $where[] = "`service_ignore`='0'"; if (!is_numeric($request->get('state'))) { return api_error(400, "No valid service state provided, valid option is 0=Ok, 1=Warning, 2=Critical"); } } //Filter by Type if ($request->has('type')) { $where[] = '`service_type` LIKE ?'; $params[] = $request->get('type'); } //GET by Host $hostname = $request->route('hostname'); if ($hostname) { $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); $where[] = '`device_id` = ?'; $params[] = $device_id; if (!is_numeric($device_id)) { return api_error(500, "No valid hostname or device id provided"); } } $query = 'SELECT * FROM `services`'; if (!empty($where)) { $query .= ' WHERE ' . implode(' AND ', $where); } $query .= ' ORDER BY `service_ip`'; $services = [dbFetchRows($query, $params)]; // double array for backwards compat :( return api_success($services, 'services'); } function list_logs(\Illuminate\Http\Request $request, Router $router) { $type = $router->current()->getName(); $hostname = $request->route('hostname'); $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); $count_query = 'SELECT COUNT(*)'; $param = []; if ($type === 'list_eventlog') { $query = ' FROM eventlog LEFT JOIN `devices` ON `eventlog`.`device_id`=`devices`.`device_id` WHERE 1'; $full_query = 'SELECT `devices`.`hostname`, `devices`.`sysName`, `eventlog`.`device_id` as `host`, `eventlog`.*'; // inject host for backward compat $timestamp = 'datetime'; } elseif ($type === 'list_syslog') { $query = ' FROM syslog LEFT JOIN `devices` ON `syslog`.`device_id`=`devices`.`device_id` WHERE 1'; $full_query = 'SELECT `devices`.`hostname`, `devices`.`sysName`, `syslog`.*'; $timestamp = 'timestamp'; } elseif ($type === 'list_alertlog') { $query = ' FROM alert_log LEFT JOIN `devices` ON `alert_log`.`device_id`=`devices`.`device_id` WHERE 1'; $full_query = 'SELECT `devices`.`hostname`, `devices`.`sysName`, `alert_log`.*'; $timestamp = 'time_logged'; } elseif ($type === 'list_authlog') { $query = ' FROM authlog WHERE 1'; $full_query = 'SELECT `authlog`.*'; $timestamp = 'datetime'; } else { $query = ' FROM eventlog LEFT JOIN `devices` ON `eventlog`.`device_id`=`devices`.`device_id` WHERE 1'; $full_query = 'SELECT `devices`.`hostname`, `devices`.`sysName`, `eventlog`.*'; $timestamp = 'datetime'; } $start = (int)$request->get('start', 0); $limit = (int)$request->get('limit', 50); $from = $request->get('from'); $to = $request->get('to'); if (is_numeric($device_id)) { $query .= " AND `devices`.`device_id` = ?"; $param[] = $device_id; } if ($from) { $query .= " AND $timestamp >= ?"; $param[] = $from; } if ($to) { $query .= " AND $timestamp <= ?"; $param[] = $to; } $count_query = $count_query . $query; $count = dbFetchCell($count_query, $param); $full_query = $full_query . $query . " ORDER BY $timestamp ASC LIMIT $start,$limit"; $logs = dbFetchRows($full_query, $param); if ($type === 'list_alertlog') { foreach ($logs as $index => $log) { $logs[$index]['details'] = json_decode(gzuncompress($log['details']), true); } } return api_success($logs, 'logs', null, 200, null, ['total' => $count]); } function validate_column_list($columns, $tableName) { static $schema; if (is_null($schema)) { $schema = new \LibreNMS\DB\Schema(); } $column_names = is_array($columns) ? $columns : explode(',', $columns); $valid_columns = $schema->getColumns($tableName); $invalid_columns = array_diff(array_map('trim', $column_names), $valid_columns); if (count($invalid_columns) > 0) { return api_error(400, 'Invalid columns: ' . join(',', $invalid_columns)); } return true; } function add_service_for_host(\Illuminate\Http\Request $request) { $hostname = $request->route('hostname'); // use hostname as device_id if it's all digits $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); $data = json_decode($request->getContent(), true); $missing_fields = []; // Check if some required fields are empty if (empty($data['type'])) { $missing_fields[] = 'type'; } if (empty($data['ip'])) { $missing_fields[] = 'ip'; } // Print error if required fields are missing if (!empty($missing_fields)) { return api_error(400, sprintf("Service field%s %s missing: %s.", ((sizeof($missing_fields)>1)?'s':''), ((sizeof($missing_fields)>1)?'are':'is'), implode(', ', $missing_fields))); } if (!filter_var($data['ip'], FILTER_VALIDATE_IP)) { return api_error(400, 'service_ip is not a valid IP address.'); } // Check if service type exists if (!in_array($data['type'], list_available_services())) { return api_error(400, "The service " . $data['type'] . " does not exist.\n Available service types: " . implode(', ', list_available_services())); } // Get parameters $service_type = $data['type']; $service_ip = $data['ip']; $service_desc = $data['desc'] ? $data['desc'] : ''; $service_param = $data['param'] ? $data['param'] : ''; $service_ignore = $data['ignore'] ? true : false; // Default false // Set the service $service_id = add_service($device_id, $service_type, $service_desc, $service_ip, $service_param, (int)$service_ignore); if ($service_id != false) { return api_success_noresult(201, "Service $service_type has been added to device $hostname (#$service_id)"); } return api_error(500, 'Failed to add the service'); } /** * Display Librenms Instance Info */ function server_info() { $versions = version_info(); return api_success([ $versions ], 'system'); }