Tweak for r29770 (yes, some months after it):
[lhc/web/wiklou.git] / includes / ProxyTools.php
index 646f6b5..0f01042 100644 (file)
@@ -1,20 +1,31 @@
 <?php
 /**
  * Functions for dealing with proxies
+ * @file
  */
 
+/**
+ * Extracts the XFF string from the request header
+ * Checks first for "X-Forwarded-For", then "Client-ip"
+ * Note: headers are spoofable
+ * @return string
+ */
 function wfGetForwardedFor() {
        if( function_exists( 'apache_request_headers' ) ) {
                // More reliable than $_SERVER due to case and -/_ folding
-               $set = apache_request_headers();
-               $index = 'X-Forwarded-For';
-               $index2 = 'Client-ip';
+               $set = array ();
+               foreach ( apache_request_headers() as $tempName => $tempValue ) {
+                       $set[ strtoupper( $tempName ) ] = $tempValue;
+               }
+               $index = strtoupper ( 'X-Forwarded-For' );
+               $index2 = strtoupper ( 'Client-ip' );
        } else {
                // Subject to spoofing with headers like X_Forwarded_For
                $set = $_SERVER;
                $index = 'HTTP_X_FORWARDED_FOR';
                $index2 = 'CLIENT-IP';
        }
+
        #Try a couple of headers
        if( isset( $set[$index] ) ) {
                return $set[$index];
@@ -25,56 +36,19 @@ function wfGetForwardedFor() {
        }
 }
 
-function wfGetLastIPfromXFF( $xff ) {
-       if ( $xff ) {
-               // Avoid annoyingly long xff hacks
-               $xff = substr( $xff, 0, 511 );
-               // Look for the last IP, assuming they are separated by commas or spaces
-               $s = ( strrpos($xff, ',') ) ? strrpos($xff, ',') : strrpos($xff, ' ');
-               if ( $s !== false ) {
-                       $last = trim( substr( $xff, $s + 1 ) );
-                       // Make sure it is an IP
-                       $m = preg_match('#\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}#', $last, $last_ip4);
-                       $n = preg_match('#:(:[0-9A-Fa-f]{1,4}){1,7}|[0-9A-Fa-f]{1,4}(:{1,2}[0-9A-Fa-f]{1,4}|::$){1,7}#', $last, $last_ip6);
-                       if ( $m )
-                               $xff_ip = $last_ip4;
-                       else if ( $n ) 
-                               $xff_ip = $last_ip6;
-                       else 
-                               $xff_ip = null;
-               } else {
-                       $xff_ip = null;
-               } 
-       } else {
-               $xff_ip = null;
-       }
-       return $xff_ip;
-}
-
-function wfGetClientIPfromXFF( $xff ) {
-       if ( $xff ) {
-               // Avoid annoyingly long xff hacks
-               $xff = substr( $xff, 0, 511 );
-               // Look for the first IP
-               $m = preg_match('#\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}#', $xff, $first_ip);
-               $n = preg_match('#:(:[0-9A-Fa-f]{1,4}){1,7}|[0-9A-Fa-f]{1,4}(:{1,2}[0-9A-Fa-f]{1,4}|::$){1,7}#', $xff, $first_ip);
-               if ( $m )
-                       $xff_ip = $first_ip4;
-               else if ( $n ) 
-                       $xff_ip = $first_ip6;
-               else 
-                       $xff_ip = null;
-       } else {
-               $xff_ip = null;
-       }
-       return $xff_ip;
-}
-
+/**
+ * Returns the browser/OS data from the request header
+ * Note: headers are spoofable
+ * @return string
+ */
 function wfGetAgent() {
        if( function_exists( 'apache_request_headers' ) ) {
                // More reliable than $_SERVER due to case and -/_ folding
-               $set = apache_request_headers();
-               $index = 'User-Agent';
+               $set = array ();
+               foreach ( apache_request_headers() as $tempName => $tempValue ) {
+                       $set[ strtoupper( $tempName ) ] = $tempValue;
+               }
+               $index = strtoupper ( 'User-Agent' );
        } else {
                // Subject to spoofing with headers like X_Forwarded_For
                $set = $_SERVER;
@@ -87,7 +61,11 @@ function wfGetAgent() {
        }
 }
 
-/** Work out the IP address based on various globals */
+/**
+ * Work out the IP address based on various globals
+ * For trusted proxies, use the XFF client IP (first of the chain)
+ * @return string
+ */
 function wfGetIP() {
        global $wgIP;
 
@@ -113,7 +91,7 @@ function wfGetIP() {
                $xff = array_reverse( $xff );
                $ipchain = array_merge( $ipchain, $xff );
        }
-       
+
        # Step through XFF list and find the last address in the list which is a trusted server
        # Set $ip to the IP address given by that trusted server, unless the address is not sensible (e.g. private)
        foreach ( $ipchain as $i => $curIP ) {
@@ -132,12 +110,19 @@ function wfGetIP() {
        return $ip;
 }
 
+/**
+ * Checks if an IP is a trusted proxy providor
+ * Useful to tell if X-Fowarded-For data is possibly bogus
+ * Squid cache servers for the site and AOL are whitelisted
+ * @param string $ip
+ * @return bool
+ */
 function wfIsTrustedProxy( $ip ) {
        global $wgSquidServers, $wgSquidServersNoPurge;
 
-       if ( in_array( $ip, $wgSquidServers ) || 
-               in_array( $ip, $wgSquidServersNoPurge ) || 
-               wfIsAOLProxy( $ip ) 
+       if ( in_array( $ip, $wgSquidServers ) ||
+               in_array( $ip, $wgSquidServersNoPurge ) ||
+               wfIsAOLProxy( $ip )
        ) {
                $trusted = true;
        } else {
@@ -153,7 +138,7 @@ function wfIsTrustedProxy( $ip ) {
  */
 function wfProxyCheck() {
        global $wgBlockOpenProxies, $wgProxyPorts, $wgProxyScriptPath;
-       global $wgUseMemCached, $wgMemc, $wgProxyMemcExpiry;
+       global $wgMemc, $wgProxyMemcExpiry;
        global $wgProxyKey;
 
        if ( !$wgBlockOpenProxies ) {
@@ -163,14 +148,9 @@ function wfProxyCheck() {
        $ip = wfGetIP();
 
        # Get MemCached key
-       $skip = false;
-       if ( $wgUseMemCached ) {
-               $mcKey = wfMemcKey( 'proxy', 'ip', $ip );
-               $mcValue = $wgMemc->get( $mcKey );
-               if ( $mcValue ) {
-                       $skip = true;
-               }
-       }
+       $mcKey = wfMemcKey( 'proxy', 'ip', $ip );
+       $mcValue = $wgMemc->get( $mcKey );
+       $skip = (bool)$mcValue;
 
        # Fork the processes
        if ( !$skip ) {
@@ -188,14 +168,13 @@ function wfProxyCheck() {
                        exec( "php $params &>/dev/null &" );
                }
                # Set MemCached key
-               if ( $wgUseMemCached ) {
-                       $wgMemc->set( $mcKey, 1, $wgProxyMemcExpiry );
-               }
+               $wgMemc->set( $mcKey, 1, $wgProxyMemcExpiry );
        }
 }
 
 /**
  * Convert a network specification in CIDR notation to an integer network and a number of bits
+ * @return array(string, int)
  */
 function wfParseCIDR( $range ) {
        return IP::parseCIDR( $range );
@@ -203,6 +182,7 @@ function wfParseCIDR( $range ) {
 
 /**
  * Check if an IP address is in the local proxy list
+ * @return bool
  */
 function wfIsLocallyBlockedProxy( $ip ) {
        global $wgProxyList;
@@ -235,8 +215,10 @@ function wfIsLocallyBlockedProxy( $ip ) {
 /**
  * TODO: move this list to the database in a global IP info table incorporating
  * trusted ISP proxies, blocked IP addresses and open proxies.
+ * @return bool
  */
 function wfIsAOLProxy( $ip ) {
+       # From http://webmaster.info.aol.com/proxyinfo.html
        $ranges = array(
                '64.12.96.0/19',
                '149.174.160.0/20',
@@ -277,7 +259,3 @@ function wfIsAOLProxy( $ip ) {
        }
        return false;
 }
-
-
-
-?>