test/classes/IpAllowDenyTest.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * tests for PhpMyAdmin\IpAllowDeny
   5  *
   6  * @package PhpMyAdmin-test
   7  */
   8 declare(strict_types=1);
   9
  10 namespace PhpMyAdmin\Tests;
  11
  12 use PhpMyAdmin\Core;
  13 use PhpMyAdmin\IpAllowDeny;
  14 use PHPUnit\Framework\TestCase;
  15
  16 /**
  17  * PhpMyAdmin\Tests\IpAllowDenyTest class
  18  *
  19  * this class is for testing PhpMyAdmin\IpAllowDeny
  20  *
  21  * @package PhpMyAdmin-test
  22  */
  23 class IpAllowDenyTest extends TestCase
  24 {
  25     /**
  26      * @var IpAllowDeny
  27      */
  28     private $ipAllowDeny;
  29
  30     /**
  31      * Prepares environment for the test.
  32      *
  33      * @return void
  34      */
  35     protected function setUp(): void
  36     {
  37         $GLOBALS['cfg']['Server']['user'] = "pma_username";
  38         $GLOBALS['cfg']['Server']['AllowDeny']['rules'][]
  39             = "allow % 255.255.255.0/4";
  40         $GLOBALS['cfg']['Server']['AllowDeny']['rules'][]
  41             = "allow % from 255.255.2.0/4";
  42         $GLOBALS['cfg']['Server']['AllowDeny']['rules'][]
  43             = "allow % from 2001:4998:c:a0d:0000:0000:4998:1020";
  44         $GLOBALS['cfg']['Server']['AllowDeny']['rules'][]
  45             = "allow % from 2001:4998:c:a0d:0000:0000:4998:[1001-2010]";
  46         $GLOBALS['cfg']['Server']['AllowDeny']['rules'][]
  47             = "allow % from 2001:4998:c:a0d:0000:0000:4998:3020/24";
  48         $GLOBALS['cfg']['Server']['AllowDeny']['rules'][] = "deny % 255.255.0.0/8";
  49         $GLOBALS['cfg']['Server']['AllowDeny']['rules'][]
  50             = "deny % from 255.255.0.0/8";
  51
  52         $this->ipAllowDeny = new IpAllowDeny();
  53     }
  54
  55     /**
  56      * Test for Core::getIp
  57      *
  58      * @param string $remote   remote
  59      * @param string $header   header
  60      * @param string $expected expected result
  61      * @param string $proxyip  proxyip
  62      *
  63      * @return void
  64      *
  65      * @dataProvider proxyIPs
  66      */
  67     public function testGetIp($remote, $header, $expected, $proxyip = null): void
  68     {
  69         unset($_SERVER['REMOTE_ADDR']);
  70         unset($_SERVER['TEST_FORWARDED_HEADER']);
  71         $GLOBALS['cfg']['TrustedProxies'] = [];
  72
  73         if ($remote !== null) {
  74             $_SERVER['REMOTE_ADDR'] = $remote;
  75         }
  76
  77         if ($header !== null) {
  78             if ($proxyip === null) {
  79                 $proxyip = $remote;
  80             }
  81             $GLOBALS['cfg']['TrustedProxies'][$proxyip] = 'TEST_FORWARDED_HEADER';
  82             $_SERVER['TEST_FORWARDED_HEADER'] = $header;
  83         }
  84
  85         $this->assertEquals(
  86             $expected,
  87             Core::getIp()
  88         );
  89
  90         unset($_SERVER['REMOTE_ADDR']);
  91         unset($_SERVER['TEST_FORWARDED_HEADER']);
  92         $GLOBALS['cfg']['TrustedProxies'] = [];
  93     }
  94
  95     /**
  96      * Data provider for Core::getIp tests
  97      *
  98      * @return array
  99      */
 100     public function proxyIPs()
 101     {
 102         return [
 103             // Nothing set
 104             [
 105                 null,
 106                 null,
 107                 false,
 108             ],
 109             // Remote IP set
 110             [
 111                 '101.0.0.25',
 112                 null,
 113                 '101.0.0.25',
 114             ],
 115             // Proxy
 116             [
 117                 '101.0.0.25',
 118                 '192.168.10.10',
 119                 '192.168.10.10',
 120             ],
 121             // Several proxies
 122             [
 123                 '101.0.0.25',
 124                 '192.168.10.1, 192.168.100.100',
 125                 '192.168.10.1',
 126             ],
 127             // Invalid proxy
 128             [
 129                 '101.0.0.25',
 130                 'invalid',
 131                 false,
 132             ],
 133             // Direct IP with proxy enabled
 134             [
 135                 '101.0.0.25',
 136                 '192.168.10.10',
 137                 '101.0.0.25',
 138                 '10.10.10.10',
 139             ],
 140         ];
 141     }
 142
 143     /**
 144      * Test for ipMaskTest
 145      *
 146      * @return void
 147      */
 148     public function testIpMaskTest()
 149     {
 150         //IPV4 testing
 151         $testRange = "255.255.0.0/8";
 152         $ipToTest = "10.0.0.0";
 153         $this->assertEquals(
 154             false,
 155             $this->ipAllowDeny->ipMaskTest($testRange, $ipToTest)
 156         );
 157
 158         $testRange = "255.255.0.0/4";
 159         $ipToTest = "255.3.0.0";
 160         $this->assertEquals(
 161             true,
 162             $this->ipAllowDeny->ipMaskTest($testRange, $ipToTest)
 163         );
 164
 165         $testRange = "255.255.0.[0-10]";
 166         $ipToTest = "255.3.0.3";
 167         $this->assertEquals(
 168             false,
 169             $this->ipAllowDeny->ipMaskTest($testRange, $ipToTest)
 170         );
 171         $ipToTest = "255.3.0.12";
 172         $this->assertEquals(
 173             false,
 174             $this->ipAllowDeny->ipMaskTest($testRange, $ipToTest)
 175         );
 176
 177         //IPV6 testing
 178         //not range
 179         $ipToTest = "2001:4998:c:a0d:0000:0000:4998:1020";
 180         $testRange = "2001:4998:c:a0d:0000:0000:4998:1020";
 181         $this->assertEquals(
 182             true,
 183             $this->ipAllowDeny->ipMaskTest($testRange, $ipToTest)
 184         );
 185         $ipToTest = "2001:4998:c:a0d:0000:0000:4998:1020";
 186         $testRange = "2001:4998:c:a0d:0000:0000:4998:2020";
 187         $this->assertEquals(
 188             false,
 189             $this->ipAllowDeny->ipMaskTest($testRange, $ipToTest)
 190         );
 191
 192         //range
 193         $ipToTest = "2001:4998:c:a0d:0000:0000:4998:1020";
 194         $testRange = "2001:4998:c:a0d:0000:0000:4998:[1001-2010]";
 195         $this->assertEquals(
 196             true,
 197             $this->ipAllowDeny->ipMaskTest($testRange, $ipToTest)
 198         );
 199         $ipToTest = "2001:4998:c:a0d:0000:0000:4998:3020";
 200         $testRange = "2001:4998:c:a0d:0000:0000:4998:[1001-2010]";
 201         $this->assertEquals(
 202             false,
 203             $this->ipAllowDeny->ipMaskTest($testRange, $ipToTest)
 204         );
 205
 206         //CDIR
 207         $ipToTest = "2001:4998:c:a0d:0000:0000:4998:1020";
 208         $testRange = "2001:4998:c:a0d:0000:0000:4998:[1001-2010]";
 209         $this->assertEquals(
 210             true,
 211             $this->ipAllowDeny->ipMaskTest($testRange, $ipToTest)
 212         );
 213         $ipToTest = "2001:4998:c:a0d:0000:0000:4998:1000";
 214         $testRange = "2001:4998:c:a0d:0000:0000:4998:3020/24";
 215         $this->assertEquals(
 216             false,
 217             $this->ipAllowDeny->ipMaskTest($testRange, $ipToTest)
 218         );
 219     }
 220
 221     /**
 222      * Test for allowDeny
 223      *
 224      * @return void
 225      */
 226     public function testAllowDeny()
 227     {
 228         $_SERVER['REMOTE_ADDR'] = "";
 229         $this->assertEquals(
 230             false,
 231             $this->ipAllowDeny->allow()
 232         );
 233
 234         $_SERVER['REMOTE_ADDR'] = "255.0.1.0";
 235         $this->assertEquals(
 236             true,
 237             $this->ipAllowDeny->allow()
 238         );
 239         $_SERVER['REMOTE_ADDR'] = "10.0.0.0";
 240         $this->assertEquals(
 241             false,
 242             $this->ipAllowDeny->allow()
 243         );
 244
 245         $_SERVER['REMOTE_ADDR'] = "255.255.0.1";
 246         $this->assertEquals(
 247             true,
 248             $this->ipAllowDeny->deny()
 249         );
 250         $_SERVER['REMOTE_ADDR'] = "255.124.0.5";
 251         $this->assertEquals(
 252             true,
 253             $this->ipAllowDeny->deny()
 254         );
 255         $_SERVER['REMOTE_ADDR'] = "122.124.0.5";
 256         $this->assertEquals(
 257             false,
 258             $this->ipAllowDeny->deny()
 259         );
 260
 261         //IPV6
 262         $_SERVER['REMOTE_ADDR'] = "2001:4998:c:a0d:0000:0000:4998:1020";
 263         $this->assertEquals(
 264             true,
 265             $this->ipAllowDeny->allow()
 266         );
 267         $_SERVER['REMOTE_ADDR'] = "2001:4998:c:a0d:0000:0000:4998:1000";
 268         $this->assertEquals(
 269             false,
 270             $this->ipAllowDeny->allow()
 271         );
 272         $_SERVER['REMOTE_ADDR'] = "2001:4998:c:a0d:0000:0000:4998:1020";
 273         $this->assertEquals(
 274             true,
 275             $this->ipAllowDeny->allow()
 276         );
 277     }
 278 }