diff options
| -rw-r--r-- | README.md | 4 | ||||
| -rw-r--r-- | config.php.example | 14 | ||||
| -rw-r--r-- | routers/bird.php | 98 | ||||
| -rw-r--r-- | routers/router.php | 17 |
4 files changed, 123 insertions, 10 deletions
@@ -20,7 +20,7 @@ execute some commands on routers. The output is sent back to the user. For now this looking glass is quite simple. Here you have some features: * Interface using Javascript and AJAX calls (needs a decent browser) - * Support of Cisco and Juniper routers + * Support of BIRD, Cisco and Juniper routers * Support of Telnet and SSH connection to routers using password authentication and SSH keys. * Configurable list of routers @@ -31,7 +31,7 @@ For now this looking glass is quite simple. Here you have some features: And here is a list of what this looking glass should be able to do in the future: - * Support of Quagga, BIRD and more routers + * Support of Quagga and more routers * Support of other types of authentication * Configurable list of allowed commands diff --git a/config.php.example b/config.php.example index 0749398..bc123e3 100644 --- a/config.php.example +++ b/config.php.example @@ -61,4 +61,18 @@ $config['routers']['router2']['type'] = 'juniper'; // The router description to be displayed in the router list $config['routers']['router2']['desc'] = 'Example\'s Router 2'; +// Router based on BIRD +// The hostname or the IP address +$config['routers']['router3']['host'] = 'r3.example.net'; +// The user to use to connect to the router +$config['routers']['router3']['user'] = 'birduser'; +// The password of the given user +$config['routers']['router3']['pass'] = 'birduserpassword'; +// The authentication mecanism to use (can be ssh-password or ssh-key) +$config['routers']['router3']['auth'] = 'ssh-password'; +// The router type (can only be bird) +$config['routers']['router3']['type'] = 'bird'; +// The router description to be displayed in the router list +$config['routers']['router3']['desc'] = 'Example\'s Router 3'; + // End of config.php diff --git a/routers/bird.php b/routers/bird.php new file mode 100644 index 0000000..55f7ff9 --- /dev/null +++ b/routers/bird.php @@ -0,0 +1,98 @@ +<?php + +/* + * Looking Glass - An easy to deploy Looking Glass + * Copyright (C) 2014 Guillaume Mazoyer <gmazoyer@gravitons.in> + * + * 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. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +require_once 'router.php'; +require_once 'utils.php'; + +final class Bird extends Router { + protected function build_commands($command, $parameters) { + $commands = array(); + + switch ($command) { + case 'bgp': + if (match_ipv4($parameters)) { + $commands[] = 'birdc'; + $commands[] = 'show route for '.$parameters; + $commands[] = 'exit'; + } else if (match_ipv6($parameters)) { + $commands[] = 'birdc6'; + $commands[] = 'show route for '.$parameters; + $commands[] = 'exit'; + } else { + throw new Exception('The parameter is not an IPv4/IPv6 address.'); + } + break; + + case 'as-path-regex': + if (match_aspath_regex($parameters)) { + $commands[] = 'birdc'; + $commands[] = 'show route where bgp_path ~ [= '.$parameters.' =]'; + $commands[] = 'exit'; + $commands[] = 'birdc6'; + $commands[] = 'show route where bgp_path ~ [= '.$parameters.' =]'; + $commands[] = 'exit'; + } else { + throw new Exception('The parameter is not an AS-Path regular expression like ".*XXXX YYYY.*".'); + } + break; + + case 'as': + if (match_as($parameters)) { + $commands[] = 'birdc'; + $commands[] = 'show route where bgp_path ~ [= '.$parameters.' =]'; + $commands[] = 'exit'; + $commands[] = 'birdc6'; + $commands[] = 'show route where bgp_path ~ [= '.$parameters.' =]'; + $commands[] = 'exit'; + } else { + throw new Exception('The parameter is not an AS number.'); + } + break; + + case 'ping': + if (match_ipv4($parameters)) { + $commands[] = 'ping -A -c 10 '.$parameters; + } else if (match_ipv6($parameters)) { + $commands[] = 'ping6 -A -c 10 '.$parameters; + } else { + throw new Exception('The parameter is not an IPv4/IPv6 address.'); + } + break; + + case 'traceroute': + if (match_ipv4($parameters)) { + $commands[] = 'traceroute -4 -A -q1 -N32 -w1 -m15 '.$parameters; + } else if (match_ipv6($parameters)) { + $commands[] = 'traceroute -6 -A -q1 -N32 -w1 -m15 '.$parameters; + } else { + throw new Exception('The parameter is not an IPv4/IPv6 address.'); + } + break; + + default: + throw new Exception('Command not supported.'); + } + + return $commands; + } +} + +// End of bird.php diff --git a/routers/router.php b/routers/router.php index 1c8441a..b47d2d3 100644 --- a/routers/router.php +++ b/routers/router.php @@ -20,6 +20,7 @@ */ require_once 'config.php'; +require_once 'bird.php'; require_once 'cisco.php'; require_once 'juniper.php'; require_once 'utils.php'; @@ -53,16 +54,13 @@ abstract class Router { foreach ($commands as $selected) { $data .= $auth->send_command($selected); - } - } catch (Exception $e) { - throw $e; - } finally { - $auth->disconnect(); - - foreach ($commands as $selected) { log_to_file('[client: '.$this->requester.'] '.$this->config['host']. '> '.$selected); } + + $auth->disconnect(); + } catch (Exception $e) { + throw $e; } return $data; @@ -73,7 +71,10 @@ abstract class Router { $router_config = $config['routers'][$id]; - switch ($router_config['type']) { + switch (strtolower($router_config['type'])) { + case 'bird': + return new Bird($router_config, $id, $requester); + case 'cisco': case 'ios': return new Cisco($router_config, $id, $requester); |