Skip to content

Latest commit

 

History

History
489 lines (389 loc) · 14.5 KB

configuration.md

File metadata and controls

489 lines (389 loc) · 14.5 KB
Raw

Configuration Options

Format

The config.php file is a piece of regular PHP source code. This means that you need to follow the rules or the interface will not work.

You can mostly get something working by copying the example lines, just make sure all your strings are quoted and your statements end in a semicolon (;).

All the default values for the configuration are defined in the includes/config.defaults.php file. This file must not be edited. The directives set in config.php will automatically override the default ones.

Directives

These are the available configuration options. They can be set in config.php. Values shown in this documentation are (for most of them) the default values that are set if the configuration is not overriden.

Frontpage

$config['frontpage']['color_mode_enabled'] = true;

Enable or disable color mode. When enabled, the default color mode will match the user preferences, it can also be changed using the bottom right button.

$config['frontpage']['css'] = 'css/style.css';

Defines the path to the CSS file to use.

$config['frontpage']['title'] = 'Looking Glass';

Sets the title that should be displayed.

$config['frontpage']['image'] = null;

Sets the image (logo) that should be displayed. If set to null no image will be shown.

$config['frontpage']['image_width'] = 0;
$config['frontpage']['image_height'] = 0;

Sets the image (logo) width and height. If set to 0, the option will be ignored. Both options or only one of them can be set.

$config['frontpage']['header_link'] = null;

Sets the link used in the header of the page. If set to null no link will be used and the header will not be clickable.

$config['frontpage']['peering_policy_file'] = null;

Sets the path to the peering policy file. If set to null no peering policy will be able to be shown. The peering policy file must be located in a readable location and must contain HTML formatted text.

$config['frontpage']['disclaimer'] = 'Disclaimer example';

Sets the disclaimer that should displayed. If set to null no disclaimer will be shown.

$config['frontpage']['show_title'] = true;

If set to true the previously defined title will be displayed.

$config['frontpage']['show_visitor_ip'] = true;

Defines if the visitor IP address should be displayed.

$config['frontpage']['order'] = array('routers', 'commands', 'parameter', 'buttons');

Sets the order of the sections that are displayed.

$config['frontpage']['router_count'] = 5;

Sets the number of routers to show on the front page before the list scrolls. If set to a positive integer, then that number of routers will be shown, otherwise the list will dynamically scale to show all routers (default is 5 routers).

$config['frontpage']['command_count'] = 5;

Sets the number of commands to show on the front page before the list scrolls. If set to a positive integer, then that number of commands will be shown, otherwise the list will dynamically scale to show all commands (default is dynamic scaling).

$config['frontpage']['additional_html_header'] = '<link rel="icon" href="/static/images/cropped-32x32.png" sizes="32x32" /><link rel="icon" href="/static/images/cropped-192x192.png" sizes="192x192" /><link rel="apple-touch-icon-precomposed" href="/static/images/cropped-180x180.png" /><meta name="msapplication-TileImage" content="/static/images/cropped-270x270.png" />';

Sets additional HTML-Elements between and of index.php

Contact

$config['contact']['name'] = 'Example Support';

Defines the contact name to be displayed. If set to null, no contact will be displayed.

$config['contact']['mail'] = '[email protected]';

Defines the contact email to be displayed. If set to null, no contact will be displayed.

Routers

To define routers that can be used in the interface you need to fill the "routers" array. The index of the router must be unique in this example it will be "router1".There are some pretty generic things to define:

$config['routers']['router1']['host'] = 'r1.example.net';

This defines the FQDN of the router to use. It can also be an IP address.

$config['routers']['router1']['desc'] = 'Example Router 1';

This defines what will be displayed in the interface for the router.

You need to define the type of the router so the looking glass knows how to interact with it.

$config['routers']['router1']['type'] = 'juniper';

The router type can be Juniper, Cisco (IOS or IOS-XR), Arista, Extreme (NetIron), Quagga, BIRD, OpenBGPd, Vyatta/VyOS/EdgeOS, FRRouting or Huawei. You can take a look at the specific documentation for your router. Possible values are:

  • juniper or junos
  • cisco or ios
  • ios-xr or iosxr
  • arista
  • mikrotik or routeros
  • nokia
  • extreme_netiron
  • bird
  • bird2
  • quagga or zebra
  • openbgpd
  • edgeos or vyatta or vyos
  • frr
  • huawei

It is also highly recommended to specify a source interface ID to be used by the router when it will try to ping or traceroute a destination. This is done with:

$config['routers']['router1']['source-interface-id'] = 'lo0';

for Cisco (except IOS XR) and Juniper routers (change lo0 with your interface), and with:

$config['routers']['router1']['source-interface-id']['ipv6'] = '2001:db8::1';
$config['routers']['router1']['source-interface-id']['ipv4'] = '192.168.1.1';

for Cisco IOS XR, Extreme NetIron, BIRD and Quagga routers (use your own IP addresses). Omitting the IPv6 or the IPv4 version of the source address will result in the router trying to use the best IP address to contact the destination.

After that you need to set the authentication information for the looking glass to be able to log into the router. For this you select a type of authentication and then supply the needed information.

$config['routers']['router1']['disable_ipv6'] = false;

If set to true, disable the use of IPv6 for the router.

$config['routers']['router1']['disable_ipv4'] = false;

If set to true, disable the use of IPv4 for the router.

$config['routers']['router1']['timeout'] = 30;

Used to set the timeout (in seconds) for the connection to the router. The default value is 30 seconds.

$config['routers']['router1']['bgp_detail'] = false;

If set to true, and supported by the router, display BGP detail output which contains information such as BGP communities, MED, origin, etc. The default value is false.

This parameter can be toggled on Juniper, Extreme (NetIron), BIRD, and OpenBGPd routers.

Cisco (IOS or IOS-XR), Quagga, Vyatta/VyOS/EdgeOS, and FRRouting routers do not support toggleable BGP detail output and will always display BGP detail output for bgp commands, and will never display BGP detail output for as and as-path-regex commands.

Telnet

$config['routers']['router1']['user'] = 'readonlyuser';
$config['routers']['router1']['pass'] = 'readonlypassword';
$config['routers']['router1']['auth'] = 'telnet';

Not tested, considered as unstable and moreover it is not secure. So it is to be avoided.

SSH with Password

$config['routers']['router1']['user'] = 'readonlyuser';
$config['routers']['router1']['pass'] = 'readonlypassword';
$config['routers']['router1']['auth'] = 'ssh-password';

SSH with Key

$config['routers']['router1']['user'] = 'readonlyuser';
$config['routers']['router1']['private_key'] = '/home/user/.ssh/key';
$config['routers']['router1']['pass'] = 'mypassphrase';
$config['routers']['router1']['auth'] = 'ssh-key';

The passphrase option is not needed if the key is not passphrase protected.

Output

$config['output']['show_command'] = true;

Defines if the command used to get the output should be displayed or not.

$config['output']['scroll'] = true;

Defines if the result should be displayed as a scrollable element or a an unscrollable element.

Logs

$config['logs']['file'] = '/var/log/looking-glass.log';

Defines the file where each request on the looking glass will be logged.

$config['logs']['format'] = '[%D] [client: %R] %H > %C';

Defines the format for each log (%D is for the time, %R is for the requester IP address, %H is for the host and %C is for the command).

$config['logs']['auth_debug'] = false;

Enable or disable authentication debug details. The details are written in the logs file.

Filters

$config['filters']['output'][] = '/(client1|client2)/';
$config['filters']['output'][] = '/^NotToShow/';

Defines filters to eliminate some lines from the output. Do not define any filters if there is no nothing to filter.

$config['filters']['output'][] = ['/replacethis/', 'withthis'];

Defines filters that will replace an matched expression with another one.

// Use the unset command if you don't want to use pre-defined filters
// unset $config['filters']['aspath_regexp'];
$config['filters']['aspath_regexp'][] = '.* 64546 .*';

Defines AS path regexp values that must not be executed for some reasons. It can be used to avoid people trying to enter potential harmful AS path regexps.

Pre-defined regexps are the following:

  • .
  • .*
  • .[,]*
  • .[0-9,0-9]*
  • .[0-9,0-9]+

To reset the default filter, the unset command must be used first before adding new values.

Anti-Spam

$config['antispam']['enabled'] = true;

Enable or disable the built-in anti-spam.

$config['antispam']['database_file'] = 'looking-glass.db';

Change the filename of the SQLite database to use for storing anti-spam details.

$config['antispam']['allow_list'] = array(
  '2001:db8::/32',
  '10.0.0.0/8',
  '100.64.0.0/10',
  '172.16.0.0/12',
  '192.168.0.0/16'
);

List of IP prefixes for which antispam validation won't be performed. This is useful to avoid spam detection for IP addresses known as "safe".

CAPTCHA

$config['captcha']['enabled'] = true;

If set to true, allows the use of a CAPTCHA.

Two types of CAPTCHA are supported:

  • recaptcha from Google
  • hcaptcha
$config['captcha']['type'] = 'recaptcha';
$config['captcha']['apikey'] = 'foobar';
$config['captcha']['secret'] = 'foobar';
$config['captcha']['url'] = 'https://www.google.com/recaptcha/api/siteverify';

To use reCAPTCHA.

$config['captcha']['type'] = 'hcaptcha';
$config['captcha']['apikey'] = 'foobar';
$config['captcha']['secret'] = 'foobar';
$config['captcha']['url'] = 'https://hcaptcha.com/siteverify';

To use hCAPTCHA.

Defines sitekey and secret, it may be named differently in the CAPTCHA documentation.

Routing Instances

!!! note This feature is currently only available for Juniper Junos devices.

$config['routing_instances'] => array(
  'vrf-internet' => 'Internet', 'vrf-mgmt' => 'Management'
);

List of routing instances, also known as routing tables or VRFs, available on all routers. The list is one of key/value pairs. The key is the unique name of the routing instance which will be used in commands sent to routers. The value is the name which will be exposed to the users on selection.

The suffixes such as inet.0 and inet6.0 can be omitted for Juniper devices, only the names of routing instances are needed.

Misc.

$config['misc']['allow_private_asn'] = false;

If set to true, allows the use of private AS numbers.

$config['misc']['allow_private_ip'] = true;

If set to true, allows the use of RFC1918 IPv4 and FD/FC IPv6 as parameters.

$config['misc']['allow_reserved_ip'] = true;

If set to true, allows reserved the use of IPv4 addresses (0.0.0.0/8, 169.254.0.0/16, 192.0.2.0/24 and 224.0.0.0/4) as parameters.

$config['misc']['minimum_prefix_length']['ipv6'] = 0;
$config['misc']['minimum_prefix_length']['ipv4'] = 0;

Set the minimum prefix length for route lookup. If set to 0, the prefix length will not be checked. If the value is greater than zero and lesser than the prefix length for the route given by the user, an error will be displayed.

$config['misc']['enable_http_x_forwarded_for'] = false;

This option will add the support to use the HTTP_X_FORWARDED_FOR header, which should include the user real IP, which then displayed on the page footer. For more info about this header see RFC7239. Because this header is user controlled, it's disabled by default.

Tools

The tools that are used by this software are ping and traceroute for routers based on BIRD and Quagga. However some people might want to be able to customize the way these tools are used.

$config['tools']['ping_options'] = '-A -c 10';

This variable is a string with all ping options to be used.

$config['tools']['ping_source_option'] = '-I';

This variable is a string giving the option to source a ping from an IP address. It should probably not be changed.

$config['tools']['traceroute4'] = 'traceroute -4';
$config['tools']['traceroute6'] = 'traceroute -6';

These variables give the binary with the option to be used to do a traceroute.

$config['tools']['traceroute_options'] = '-A -q1 -N32 -w1 -m15';

This variables is a string with all traceroute options to be used.

$config['tools']['traceroute_source_option'] = '-s';

This vairiable is a string giving the option to source a traceroute from an IP address. it should probably not be changed unless when using another tool to traceroute an destination IP.

Documentation

The documentation configuration should probably not be modified but here are the tweakable options used to define them.

There are 5 available commands and so there are documentation for each one of them.

$config['doc']['bgp']
$config['doc']['as-path-regex']
$config['doc']['as']
$config['doc']['ping']
$config['doc']['traceroute']

Each command has a subset of options to configure its title, its description summary and its detailed description. For example:

$config['doc']['bgp']['command'] = '';
$config['doc']['bgp']['description'] = '';
$config['doc']['bgp']['parameter'] = '';

See the default values for more details.

Disabling Commands

The documentation configuration can also be used to disable commands by setting the title of the command to null. A disabled command will no longer show up in the user interface, and if an attacker tries to send a forged POST request with a disabled command to Looking Glass an error will be returned.

For example, this piece of config would disable as-path-regex commands:

$config['doc']['as-path-regex']['command'] = null;