commit fa5dd793086cfbebbb73f6759ed862c003b1f6ab Author: dqos <8611981+dqos@users.noreply.github.com> Date: Sat Jan 15 19:40:44 2022 +0100 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a2d9a85 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ + +.idea +config.php +www.bat diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..a612ad9 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/LookingGlass.php b/LookingGlass.php new file mode 100644 index 0000000..9f28782 --- /dev/null +++ b/LookingGlass.php @@ -0,0 +1,328 @@ + array("pipe", "r"), + 1 => array("pipe", "w"), + 2 => array("pipe", "w") + ); + + // sanitize + remove single quotes + $host = str_replace('\'', '', filter_var($host, FILTER_SANITIZE_URL)); + // execute command + $process = proc_open("{$cmd} '{$host}'", $spec, $pipes, null); + + // check pipe exists + if (!is_resource($process)) { + return false; + } + + // check for mtr/traceroute + if (strpos($cmd, 'mtr') !== false) { + $type = 'mtr'; + } elseif (strpos($cmd, 'traceroute') !== false) { + $type = 'traceroute'; + } else { + $type = ''; + } + + $fail = 0; + $match = 0; + $traceCount = 0; + $lastFail = 'start'; + // iterate stdout + while (($str = fgets($pipes[1], 4096)) != null) { + // check for output buffer + if (ob_get_level() == 0) { + ob_start(); + } + + // fix RDNS XSS (outputs non-breakble space correctly) + $str = htmlspecialchars(trim($str)); + + // correct output for mtr + if ($type === 'mtr') { + if ($match < 10 && preg_match('/^[0-9]\. /', $str, $string)) { + $str = preg_replace('/^[0-9]\. /', '  ' . $string[0], $str); + $match++; + } else { + $str = preg_replace('/^[0-9]{2}\. /', ' ' . substr($str, 0, 4), $str); + } + } + // correct output for traceroute + elseif ($type === 'traceroute') { + if ($match < 10 && preg_match('/^[0-9] /', $str, $string)) { + $str = preg_replace('/^[0-9] /', ' ' . $string[0], $str); + $match++; + } + // check for consecutive failed hops + if (strpos($str, '* * *') !== false) { + $fail++; + if ($lastFail !== 'start' + && ($traceCount - 1) === $lastFail + && $fail >= $failCount + ) { + echo str_pad($str . '
-- Traceroute timed out --
', 4096, ' ', STR_PAD_RIGHT); + break; + } + $lastFail = $traceCount; + } + $traceCount++; + } + + // pad string for live output + echo str_pad($str . '
', 4096, ' ', STR_PAD_RIGHT); + + // flush output buffering + @ob_flush(); + flush(); + } + + // iterate stderr + while (($err = fgets($pipes[2], 4096)) != null) { + // check for IPv6 hostname passed to IPv4 command, and vice versa + if (strpos($err, 'Name or service not known') !== false || strpos($err, 'unknown host') !== false) { + echo 'Unauthorized request'; + break; + } + } + + $status = proc_get_status($process); + if ($status['running'] == true) { + // close pipes that are still open + foreach ($pipes as $pipe) { + fclose($pipe); + } + // retrieve parent pid + $ppid = $status['pid']; + // use ps to get all the children of this process + $pids = preg_split('/\s+/', `ps -o pid --no-heading --ppid $ppid`); + // kill remaining processes + foreach($pids as $pid) { + if (is_numeric($pid)) { + posix_kill($pid, 9); + } + } + proc_close($process); + } + return true; + } +} diff --git a/README.md b/README.md new file mode 100644 index 0000000..bb11a59 --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# Looking Glass +Modern, simple and fresh looking glass based on Bootstrap 5 and PHP 7. A looking glass is a network utility which is +made user-friendly for everyone to use. It allows you to execute network related commands within a remote network, usually that of an ISP. + +![](screenshot.png) + +### Demo +[See it in action here!](https://lg-nl-oum.hybula.net/) + +### Features +- Bootstrap 5 UI. +- Real time command output using JavaScript. +- Supports ping/ping6, traceroute/traceroute6 and mtr/mtr6. +- Easy to customize and to configure. +- DNS checking to prevent unnecessary executions. + +### Requirements +- Any Linux distribution, this has been tested on RHEL. +- PHP 7.1 or higher. +- IPv6 connectivity if you want to use the v6 equivalents. +- Root access. + +### Installatio +nFor this installation we will assume that we are working on AlmaLinux 8 OS. Warning: This guide does not cover any security hardening or rate limiting. + +1. Install the required network tools: `dnf install mtr traceroute -y`. +2. Install the web server with PHP (by default it will install 7.2): `dnf install httpd mod_ssl php -y`. +3. Enable and start Apache/PHP-FPM: `systemctl enable httpd; systemctl enable php-fpm` and `systemctl start httpd; systemctl start php-fpm`. +4. Let's help MTR to work, execute the following command: `ln -s /usr/sbin/mtr /usr/bin/mtr` and also mtr helper called mtr-packet: `ln -s /usr/sbin/mtr-packet /usr/bin/mtr-packet`. +5. You *must* configure SELinux before this all works, or you can disable SELinux using `setenforce 0` and possibly make it permanent: `nano /etc/selinux/config` change to `SELINUX=disabled`. +6. Upload the contents of the ZIP to /var/www/html/. +7. Rename config.dist.php to config.php and adjust the settings. +8. (Optional) You might want to enable SSL using LetsEncrypt, take a look at [acme.sh](https://github.com/acmesh-official/acme.sh). + +### Customization +If you open up config.dist.php you will see that there are some features that allows you to customize the looking glass, this includes a custom CSS override. +You may also extend the looking glass with a custom block. + +### TODO +- Move to Composer; +- Software-based rate limiting; +- Implement a template engine, for advanced customization; +- Switch to WebSockets. + +### License +Mozilla Public License Version 2.0 diff --git a/backend.php b/backend.php new file mode 100644 index 0000000..5147bcc --- /dev/null +++ b/backend.php @@ -0,0 +1,45 @@ +Company Looking Glass'; +// Define the URL where the logo points to; +const LG_LOGO_URL = 'https://github.com/hybula/lookingglass/'; + +// Define a custom CSS file which can be used to style the LG, set false to disable, else point to the CSS file; +const LG_CSS_OVERRIDES = false; + +// Enable or disable blocks/parts of the LG, set false to hide a part; +const LG_BLOCK_NETWORK = true; +const LG_BLOCK_LOOKINGGLAS = true; +const LG_BLOCK_SPEEDTEST = true; +// This enables the custom block, which you can use to add something custom to the LG; +const LG_BLOCK_CUSTOM = false; + +// Define a file here which will be used to display the custom block, can be PHP too which outputs HTML; +const LG_CUSTOM_HTML = __DIR__.'/custom.html.php'; +// Define a file here which will be loaded on top of the index file, this can be used to do some post logic; +const LG_CUSTOM_PHP = __DIR__.'/custom.post.php'; + +// Define the location of this network, usually a city and a country; +const LG_LOCATION = 'Amsterdam, Netherlands'; +// Define the facility where the network is located, usually a data center; +const LG_FACILITY = 'Nikhef'; +// Define a direct link to more information about the facility, this should be a link to PeeringDB; +const LG_FACILITY_URL = 'https://www.peeringdb.com/fac/18'; +// Define an IPv4 for testing; +const LG_IPV4 = '127.0.0.1'; +// Define an IPv6 for testing; +const LG_IPV6 = '::1'; + +// Define the methods that can be used by visitors to test it out; +const LG_METHODS = ['ping', 'ping6', 'mtr', 'mtr6', 'traceroute', 'traceroute6']; + +// Define other looking glasses, this is useful if you have multiple networks and looking glasses; +const LG_LOCATIONS = [ + 'Location A' => 'https://github.com/hybula/lookingglass/', + 'Location B' => 'https://github.com/hybula/lookingglass/', + 'Location C' => 'https://github.com/hybula/lookingglass/', +]; + +// Enable the iPerf info inside the speedtest block, set to false to disable; +const LG_SPEEDTEST_IPERF = true; +// Define the label of an incoming iPerf test; +const LG_SPEEDTEST_LABEL_INCOMING = 'iPerf3 Incoming'; +// Define the command to use to test incoming speed using iPerf, preferable iPerf3; +const LG_SPEEDTEST_CMD_INCOMING = 'iperf3 -4 -c hostname -p 5201 -P 4'; +// Define the label of an outgoing iPerf test; +const LG_SPEEDTEST_LABEL_OUTGOING = 'iPerf3 Outgoing'; +// Define the command to use to test outgoing speed using iPerf, preferable iPerf3; +const LG_SPEEDTEST_CMD_OUTGOING = 'iperf3 -4 -c hostname -p 5201 -P 4 -R'; +// Define speedtest files with URLs to the actual files; +const LG_SPEEDTEST_FILES = [ + '100M' => 'https://github.com/hybula/lookingglass/', + '1G' => 'https://github.com/hybula/lookingglass/', + '10G' => 'https://github.com/hybula/lookingglass/' +]; + +// Define if you require visitors to agree with the Terms, set false to disable; +const LG_TERMS = 'https://github.com/hybula/lookingglass/'; diff --git a/index.php b/index.php new file mode 100644 index 0000000..9fb515b --- /dev/null +++ b/index.php @@ -0,0 +1,305 @@ + + + + + + + + + <?php echo LG_TITLE; ?> + + '; } ?> + + + +
+ +
+
+ + + +
+
+ +
+
+ +
+ + +
+
+
+

Network

+ +
+
+ +
+ + Map + + +
    + $link) { ?> +
    • + +
+ +
+
+
+ +
+ + PeeringDB +
+
+
+ +
+
+ +
+ + +
+
+
+ +
+ + +
+
+
+ +
+ + +
+
+
+ +
+
+
+ + + +
+
+
+

Looking Glass

+
+ + +
+
+
+ Target + +
+
+
+
+ + +
+
+
+ +
+ +
+ > + +
+ + +
+ + '.$errorMessage.'
'; ?> + + + + +
+
+
+ + + +
+
+
+

Speedtest

+ + +
+
+ +

+ +
+
+ +

+ +
+
+ + +
+ +
+ $link) { ?> + + +
+
+ +
+
+
+ + + + + + + + + + + + + + + + + diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..84860ff Binary files /dev/null and b/screenshot.png differ