Whip::isMethodUsable() - Code Metrics - Inspection of "Add Whip::IPVx constants to Whip, and related docu..." - Vectorface/whip - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bc4c56...65e2e0 )

by Jonathan

created 2016-01-27 18:23 UTC

Whip::isMethodUsable() A

↳ Parent: Whip

Complexity

Conditions	3
Paths	3

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	3

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	3
eloc	6
c	1
b	0
f	0
nc	3
nop	2
dl	0
loc	10
ccs	6
cts	6
cp	1
crap	3
rs	9.4285

<?php

/*
The MIT License (MIT)

Copyright (c) 2015 Vectorface, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/

namespace Vectorface\Whip;

use \Exception;
use Vectorface\Whip\IpRange\IpWhitelist;
use Vectorface\Whip\Request\RequestAdapter;
use Vectorface\Whip\Request\Psr7RequestAdapter;
use Vectorface\Whip\Request\SuperglobalRequestAdapter;
use Psr\Http\Message\ServerRequestInterface;

/**
 * A class for accurately looking up a client's IP address.
 * This class checks a call time configurable list of headers in the $_SERVER
 * superglobal to determine the client's IP address.
 * @copyright Vectorface, Inc 2015
 * @author Daniel Bruce <[email protected]>
 * @author Cory Darby <[email protected]>
 */
class Whip
{
    /** The whitelist key for IPv4 addresses */
    const IPV4 = IpWhitelist::IPV4;

    /** The whitelist key for IPv6 addresses */
    const IPV6 = IpWhitelist::IPV6;

    /** Indicates all header methods will be used. */
    const ALL_METHODS        = 255;
    /** Indicates the REMOTE_ADDR method will be used. */
    const REMOTE_ADDR        = 1;
    /** Indicates a set of possible proxy headers will be used. */
    const PROXY_HEADERS      = 2;
    /** Indicates any CloudFlare specific headers will be used. */
    const CLOUDFLARE_HEADERS = 4;
    /** Indicates any Incapsula specific headers will be used. */
    const INCAPSULA_HEADERS  = 8;
    /** Indicates custom listed headers will be used. */
    const CUSTOM_HEADERS     = 128;

    /** The array of mapped header strings. */
    private static $headers = array(
        self::CUSTOM_HEADERS     => array(),
        self::INCAPSULA_HEADERS  => array(
            'incap-client-ip'
        ),
        self::CLOUDFLARE_HEADERS => array(
            'cf-connecting-ip'
        ),
        self::PROXY_HEADERS      => array(
            'client-ip',
            'x-forwarded-for',
            'x-forwarded',
            'x-cluster-client-ip',
            'forwarded-for',
            'forwarded',
            'x-real-ip',
        ),
    );

    /** the bitmask of enabled methods */
    private $enabled;

    /** the array of IP whitelist ranges to check against */
    private $whitelist;

    /**
     * An object holding the source of addresses we will check
     *
     * @var RequestAdapter
     */
    private $source;

    /**
     * Constructor for the class.
     * @param int $enabled The bitmask of enabled headers.
     * @param array $whitelists The array of IP ranges to be whitelisted.
     * @param mixed $source A supported source of IP data.
     */
    public function __construct($enabled = self::ALL_METHODS, array $whitelists = array(), $source = null)
    {
        $this->enabled   = (int) $enabled;
        if (isset($source)) {
            $this->setSource($source);
        }
        $this->whitelist = array();
        foreach ($whitelists as $header => $ipRanges) {
            $header = $this->normalizeHeaderName($header);
            $this->whitelist[$header] = new IpWhitelist($ipRanges);
        }
    }

    /**
     * Adds a custom header to the list.
     * @param string $header The custom header to add.
     * @return Whip Returns $this.
     */
    public function addCustomHeader($header)
    {
        self::$headers[self::CUSTOM_HEADERS][] = $this->normalizeHeaderName($header);
        return $this;
    }

    /**
     * Sets the source data used to lookup the addresses.
     *
     * @param $source The source array.
     * @return Whip Returns $this.
     */
    public function setSource($source)
    {
        $this->source = $this->getRequestAdapter($source);

        return $this;
    }

    /**
     * Returns the IP address of the client using the given methods.
     * @param mixed $source (optional) The source data. If omitted, the class
     *        will use the value passed to Whip::setSource or fallback to
     *        $_SERVER.
     * @return string Returns the IP address as a string or false if no
     *         IP address could be found.
     */
    public function getIpAddress($source = null)
    {
        $source = $this->getRequestAdapter($this->coalesceSources($source));
        $remoteAddr = $source->getRemoteAddr();
        $requestHeaders = $source->getHeaders();

        foreach (self::$headers as $key => $headers) {
            if (!$this->isMethodUsable($key, $remoteAddr)) {
                continue;
            }
            return $this->extractAddressFromHeaders($requestHeaders, $headers);
        }

        return ($this->enabled & self::REMOTE_ADDR) ? $remoteAddr : false;
    }

    /**
     * Returns the valid IP address or false if no valid IP address was found.
     * @param mixed $source (optional) The source data. If omitted, the class
     *        will use the value passed to Whip::setSource or fallback to
     *        $_SERVER.
     * @return string|false Returns the IP address (as a string) of the client or false
     *         if no valid IP address was found.
     */
    public function getValidIpAddress($source = null)
    {
        $ipAddress = $this->getIpAddress($source);
        if (false === $ipAddress || false === @inet_pton($ipAddress)) {
            return false;
        }
        return $ipAddress;
    }

    /**
     * Normalizes HTTP header name representations.
     *
     * HTTP_MY_HEADER and My-Header would be transformed to my-header.
     *
     * @param string $header The original header name.
     * @return string The normalized header name.
     */
    private function normalizeHeaderName($header)
    {
        if (strpos($header, 'HTTP_') === 0) {
            $header = str_replace('_', '-', substr($header, 5));
        }
        return strtolower($header);
    }

    /**
     * Finds the first element in $headers that is present in $_SERVER and
     * returns the IP address mapped to that value.
     * If the IP address is a list of comma separated values, the last value
     * in the list will be returned.
     * If no IP address is found, we return false.
     * @param array $requestHeaders The request headers to pull data from.
     * @param array $headers The list of headers to check.
     * @return string|false Returns the IP address as a string or false if no IP
     *         IP address was found.
     */
    private function extractAddressFromHeaders($requestHeaders, $headers)
    {
        foreach ($headers as $header) {
            if (!empty($requestHeaders[$header])) {
                $list = explode(',', $requestHeaders[$header]);
                return trim(end($list));
            }
        }
        return false;
    }

    /**
     * Returns whether or not the given method is enabled and usable.
     *
     * This method checks if the method is enabled and whether the method's data
     * is usable given it's IP whitelist.
     *
     * @param string $key The source key.
     * @param string $ipAddress The IP address.
     * @return boolean Returns true if the IP address is whitelisted and false
     *         otherwise. Returns true if the source does not have a whitelist
     *         specified.
     */
    private function isMethodUsable($key, $ipAddress)
    {
        if (!($key & $this->enabled)) {
            return false;
        }
        if (!isset($this->whitelist[$key])) {
            return true;
        }
        return $this->whitelist[$key]->isIpWhitelisted($ipAddress);
    }

    /**
     * Get a source/request adapter for a given source of IP data.
     *
     * @param mixed $source A supported source of request data.
     * @return RequestAdapter A RequestAdapter implementation for the given source.
     */
    private function getRequestAdapter($source)
    {
        if ($source instanceof RequestAdapter) {
            return $source;
        } elseif ($source instanceof ServerRequestInterface) {
            return new Psr7RequestAdapter($source);
        } elseif (is_array($source)) {
            return new SuperglobalRequestAdapter($source);
        }

        throw new \InvalidArgumentException("Unknown IP source.");
    }

    /**
     * Given available sources, get the first available source of IP data.
     *
     * @param mixed $source A source data argument, if available.
     * @return mixed The best available source, after fallbacks.
     */
    private function coalesceSources($source = null)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if (isset($source)) {
            return $source;
        } elseif (isset($this->source)) {
            return $this->source;
        }

        return $_SERVER;
    }
}


1		<?php
2
3		/*
4		The MIT License (MIT)
5
6		Copyright (c) 2015 Vectorface, Inc.
7
8		Permission is hereby granted, free of charge, to any person obtaining a copy
9		of this software and associated documentation files (the "Software"), to deal
10		in the Software without restriction, including without limitation the rights
11		to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12		copies of the Software, and to permit persons to whom the Software is
13		furnished to do so, subject to the following conditions:
14
15		The above copyright notice and this permission notice shall be included in
16		all copies or substantial portions of the Software.
17
18		THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19		IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20		FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21		AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22		LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23		OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24		THE SOFTWARE.
25		*/
26
27		namespace Vectorface\Whip;
28
29		use \Exception;
30		use Vectorface\Whip\IpRange\IpWhitelist;
31		use Vectorface\Whip\Request\RequestAdapter;
32		use Vectorface\Whip\Request\Psr7RequestAdapter;
33		use Vectorface\Whip\Request\SuperglobalRequestAdapter;
34		use Psr\Http\Message\ServerRequestInterface;
35
36		/**
37		* A class for accurately looking up a client's IP address.
38		* This class checks a call time configurable list of headers in the $_SERVER
39		* superglobal to determine the client's IP address.
40		* @copyright Vectorface, Inc 2015
41		* @author Daniel Bruce <[email protected]>
42		* @author Cory Darby <[email protected]>
43		*/
44		class Whip
45		{
46		/** The whitelist key for IPv4 addresses */
47		const IPV4 = IpWhitelist::IPV4;
48
49		/** The whitelist key for IPv6 addresses */
50		const IPV6 = IpWhitelist::IPV6;
51
52		/** Indicates all header methods will be used. */
53		const ALL_METHODS = 255;
54		/** Indicates the REMOTE_ADDR method will be used. */
55		const REMOTE_ADDR = 1;
56		/** Indicates a set of possible proxy headers will be used. */
57		const PROXY_HEADERS = 2;
58		/** Indicates any CloudFlare specific headers will be used. */
59		const CLOUDFLARE_HEADERS = 4;
60		/** Indicates any Incapsula specific headers will be used. */
61		const INCAPSULA_HEADERS = 8;
62		/** Indicates custom listed headers will be used. */
63		const CUSTOM_HEADERS = 128;
64
65		/** The array of mapped header strings. */
66		private static $headers = array(
67		self::CUSTOM_HEADERS => array(),
68		self::INCAPSULA_HEADERS => array(
69		'incap-client-ip'
70		),
71		self::CLOUDFLARE_HEADERS => array(
72		'cf-connecting-ip'
73		),
74		self::PROXY_HEADERS => array(
75		'client-ip',
76		'x-forwarded-for',
77		'x-forwarded',
78		'x-cluster-client-ip',
79		'forwarded-for',
80		'forwarded',
81		'x-real-ip',
82		),
83		);
84
85		/** the bitmask of enabled methods */
86		private $enabled;
87
88		/** the array of IP whitelist ranges to check against */
89		private $whitelist;
90
91		/**
92		* An object holding the source of addresses we will check
93		*
94		* @var RequestAdapter
95		*/
96		private $source;
97
98		/**
99		* Constructor for the class.
100		* @param int $enabled The bitmask of enabled headers.
101		* @param array $whitelists The array of IP ranges to be whitelisted.
102		* @param mixed $source A supported source of IP data.
103		*/
104	22	public function __construct($enabled = self::ALL_METHODS, array $whitelists = array(), $source = null)
105		{
106	22	$this->enabled = (int) $enabled;
107	22	if (isset($source)) {
108	16	$this->setSource($source);
109	15	}
110	21	$this->whitelist = array();
111	21	foreach ($whitelists as $header => $ipRanges) {
112	12	$header = $this->normalizeHeaderName($header);
113	12	$this->whitelist[$header] = new IpWhitelist($ipRanges);
114	21	}
115	21	}
116
117		/**
118		* Adds a custom header to the list.
119		* @param string $header The custom header to add.
120		* @return Whip Returns $this.
121		*/
122	1	public function addCustomHeader($header)
123		{
124	1	self::$headers[self::CUSTOM_HEADERS][] = $this->normalizeHeaderName($header);
125	1	return $this;
126		}
127
128		/**
129		* Sets the source data used to lookup the addresses.
130		*
131		* @param $source The source array.
132		* @return Whip Returns $this.
133		*/
134	20	public function setSource($source)
135		{
136	20	$this->source = $this->getRequestAdapter($source);
137
138	19	return $this;
139		}
140
141		/**
142		* Returns the IP address of the client using the given methods.
143		* @param mixed $source (optional) The source data. If omitted, the class
144		* will use the value passed to Whip::setSource or fallback to
145		* $_SERVER.
146		* @return string Returns the IP address as a string or false if no
147		* IP address could be found.
148		*/
149	21	public function getIpAddress($source = null)
150		{
151	21	$source = $this->getRequestAdapter($this->coalesceSources($source));
152	21	$remoteAddr = $source->getRemoteAddr();
153	21	$requestHeaders = $source->getHeaders();
154
155	21	foreach (self::$headers as $key => $headers) {
156	21	if (!$this->isMethodUsable($key, $remoteAddr)) {
157	19	continue;
158		}
159	11	return $this->extractAddressFromHeaders($requestHeaders, $headers);
160	10	}
161
162	10	return ($this->enabled & self::REMOTE_ADDR) ? $remoteAddr : false;
163		}
164
165		/**
166		* Returns the valid IP address or false if no valid IP address was found.
167		* @param mixed $source (optional) The source data. If omitted, the class
168		* will use the value passed to Whip::setSource or fallback to
169		* $_SERVER.
170		* @return string\|false Returns the IP address (as a string) of the client or false
171		* if no valid IP address was found.
172		*/
173	4	public function getValidIpAddress($source = null)
174		{
175	4	$ipAddress = $this->getIpAddress($source);
176	4	if (false === $ipAddress \|\| false === @inet_pton($ipAddress)) {
177	1	return false;
178		}
179	3	return $ipAddress;
180		}
181
182		/**
183		* Normalizes HTTP header name representations.
184		*
185		* HTTP_MY_HEADER and My-Header would be transformed to my-header.
186		*
187		* @param string $header The original header name.
188		* @return string The normalized header name.
189		*/
190	12	private function normalizeHeaderName($header)
191		{
192	12	if (strpos($header, 'HTTP_') === 0) {
193	1	$header = str_replace('_', '-', substr($header, 5));
194	1	}
195	12	return strtolower($header);
196		}
197
198		/**
199		* Finds the first element in $headers that is present in $_SERVER and
200		* returns the IP address mapped to that value.
201		* If the IP address is a list of comma separated values, the last value
202		* in the list will be returned.
203		* If no IP address is found, we return false.
204		* @param array $requestHeaders The request headers to pull data from.
205		* @param array $headers The list of headers to check.
206		* @return string\|false Returns the IP address as a string or false if no IP
207		* IP address was found.
208		*/
209	11	private function extractAddressFromHeaders($requestHeaders, $headers)
210		{
211	11	foreach ($headers as $header) {
212	10	if (!empty($requestHeaders[$header])) {
213	9	$list = explode(',', $requestHeaders[$header]);
214	9	return trim(end($list));
215		}
216	10	}
217	2	return false;
218		}
219
220		/**
221		* Returns whether or not the given method is enabled and usable.
222		*
223		* This method checks if the method is enabled and whether the method's data
224		* is usable given it's IP whitelist.
225		*
226		* @param string $key The source key.
227		* @param string $ipAddress The IP address.
228		* @return boolean Returns true if the IP address is whitelisted and false
229		* otherwise. Returns true if the source does not have a whitelist
230		* specified.
231		*/
232	21	private function isMethodUsable($key, $ipAddress)
233		{
234	21	if (!($key & $this->enabled)) {
235	19	return false;
236		}
237	15	if (!isset($this->whitelist[$key])) {
238	3	return true;
239		}
240	12	return $this->whitelist[$key]->isIpWhitelisted($ipAddress);
241		}
242
243		/**
244		* Get a source/request adapter for a given source of IP data.
245		*
246		* @param mixed $source A supported source of request data.
247		* @return RequestAdapter A RequestAdapter implementation for the given source.
248		*/
249	22	private function getRequestAdapter($source)
250		{
251	22	if ($source instanceof RequestAdapter) {
252	19	return $source;
253	22	} elseif ($source instanceof ServerRequestInterface) {
254	1	return new Psr7RequestAdapter($source);
255	21	} elseif (is_array($source)) {
256	20	return new SuperglobalRequestAdapter($source);
257		}
258
259	1	throw new \InvalidArgumentException("Unknown IP source.");
260		}
261
262		/**
263		* Given available sources, get the first available source of IP data.
264		*
265		* @param mixed $source A source data argument, if available.
266		* @return mixed The best available source, after fallbacks.
267		*/
268	21	private function coalesceSources($source = null)
		0 ignored issues – show Coding Style introduced 2015-12-21 03:02 UTC by Report Bug Copy Issue Report `coalesceSources` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
269		{
270	21	if (isset($source)) {
271	1	return $source;
272	21	} elseif (isset($this->source)) {
273	19	return $this->source;
274		}
275
276	2	return $_SERVER;
277		}
278		}
279

Vectorface / whip

Push — master ( bc4c56...65e2e0 )

Whip::isMethodUsable() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like