nextcloud / server

lib/public/AppFramework/Http/TooManyRequestsResponse.php

Indentation +16 added lines, -16 removed lines

@@ -31,22 +31,22 @@
  */
 class TooManyRequestsResponse extends Response {
 
-	/**
-	 * @since 19.0.0
-	 */
-	public function __construct() {
-		parent::__construct();
+    /**
+     * @since 19.0.0
+     */
+    public function __construct() {
+        parent::__construct();
 
-		$this->setContentSecurityPolicy(new ContentSecurityPolicy());
-		$this->setStatus(429);
-	}
+        $this->setContentSecurityPolicy(new ContentSecurityPolicy());
+        $this->setStatus(429);
+    }
 
-	/**
-	 * @return string
-	 * @since 19.0.0
-	 */
-	public function render() {
-		$template = new Template('core', '429', 'blank');
-		return $template->fetchPage();
-	}
+    /**
+     * @return string
+     * @since 19.0.0
+     */
+    public function render() {
+        $template = new Template('core', '429', 'blank');
+        return $template->fetchPage();
+    }
 }

lib/private/legacy/OC_Template.php

Indentation +307 added lines, -307 removed lines

@@ -48,311 +48,311 @@
  */
 class OC_Template extends \OC\Template\Base {
 
-	/** @var string */
-	private $renderAs; // Create a full page?
-
-	/** @var string */
-	private $path; // The path to the template
-
-	/** @var array */
-	private $headers = []; //custom headers
-
-	/** @var string */
-	protected $app; // app id
-
-	protected static $initTemplateEngineFirstRun = true;
-
-	/**
-	 * Constructor
-	 *
-	 * @param string $app app providing the template
-	 * @param string $name of the template file (without suffix)
-	 * @param string $renderAs If $renderAs is set, OC_Template will try to
-	 *                         produce a full page in the according layout. For
-	 *                         now, $renderAs can be set to "guest", "user" or
-	 *                         "admin".
-	 * @param bool $registerCall = true
-	 */
-	public function __construct($app, $name, $renderAs = TemplateResponse::RENDER_AS_BLANK, $registerCall = true) {
-		// Read the selected theme from the config file
-		self::initTemplateEngine($renderAs);
-
-		$theme = OC_Util::getTheme();
-
-		$requestToken = (OC::$server->getSession() && $registerCall) ? \OCP\Util::callRegister() : '';
-
-		$parts = explode('/', $app); // fix translation when app is something like core/lostpassword
-		$l10n = \OC::$server->getL10N($parts[0]);
-		/** @var \OCP\Defaults $themeDefaults */
-		$themeDefaults = \OC::$server->query(\OCP\Defaults::class);
-
-		list($path, $template) = $this->findTemplate($theme, $app, $name);
-
-		// Set the private data
-		$this->renderAs = $renderAs;
-		$this->path = $path;
-		$this->app = $app;
-
-		parent::__construct($template, $requestToken, $l10n, $themeDefaults);
-	}
-
-	/**
-	 * @param string $renderAs
-	 */
-	public static function initTemplateEngine($renderAs) {
-		if (self::$initTemplateEngineFirstRun) {
-
-			//apps that started before the template initialization can load their own scripts/styles
-			//so to make sure this scripts/styles here are loaded first we use OC_Util::addScript() with $prepend=true
-			//meaning the last script/style in this list will be loaded first
-			if (\OC::$server->getSystemConfig()->getValue('installed', false) && $renderAs !== TemplateResponse::RENDER_AS_ERROR && !\OCP\Util::needUpgrade()) {
-				if (\OC::$server->getConfig()->getAppValue('core', 'backgroundjobs_mode', 'ajax') == 'ajax') {
-					OC_Util::addScript('backgroundjobs', null, true);
-				}
-			}
-			OC_Util::addStyle('css-variables', null, true);
-			OC_Util::addStyle('server', null, true);
-			OC_Util::addTranslations('core', null, true);
-
-			if (\OC::$server->getSystemConfig()->getValue('installed', false)) {
-				OC_Util::addScript('merged-template-prepend', null, true);
-				OC_Util::addScript('dist/files_client', null, true);
-				OC_Util::addScript('dist/files_fileinfo', null, true);
-			}
-			OC_Util::addScript('core', 'dist/main', true);
-
-			if (\OC::$server->getRequest()->isUserAgent([\OC\AppFramework\Http\Request::USER_AGENT_IE])) {
-				// shim for the davclient.js library
-				\OCP\Util::addScript('dist/files_iedavclient');
-			}
-
-			self::$initTemplateEngineFirstRun = false;
-		}
-	}
-
-
-	/**
-	 * find the template with the given name
-	 * @param string $name of the template file (without suffix)
-	 *
-	 * Will select the template file for the selected theme.
-	 * Checking all the possible locations.
-	 * @param string $theme
-	 * @param string $app
-	 * @return string[]
-	 */
-	protected function findTemplate($theme, $app, $name) {
-		// Check if it is a app template or not.
-		if ($app !== '') {
-			$dirs = $this->getAppTemplateDirs($theme, $app, OC::$SERVERROOT, OC_App::getAppPath($app));
-		} else {
-			$dirs = $this->getCoreTemplateDirs($theme, OC::$SERVERROOT);
-		}
-		$locator = new \OC\Template\TemplateFileLocator($dirs);
-		$template = $locator->find($name);
-		$path = $locator->getPath();
-		return [$path, $template];
-	}
-
-	/**
-	 * Add a custom element to the header
-	 * @param string $tag tag name of the element
-	 * @param array $attributes array of attributes for the element
-	 * @param string $text the text content for the element. If $text is null then the
-	 * element will be written as empty element. So use "" to get a closing tag.
-	 */
-	public function addHeader($tag, $attributes, $text=null) {
-		$this->headers[]= [
-			'tag' => $tag,
-			'attributes' => $attributes,
-			'text' => $text
-		];
-	}
-
-	/**
-	 * Process the template
-	 * @return string
-	 *
-	 * This function process the template. If $this->renderAs is set, it
-	 * will produce a full page.
-	 */
-	public function fetchPage($additionalParams = null) {
-		$data = parent::fetchPage($additionalParams);
-
-		if ($this->renderAs) {
-			$page = new TemplateLayout($this->renderAs, $this->app);
-
-			if (is_array($additionalParams)) {
-				foreach ($additionalParams as $key => $value) {
-					$page->assign($key, $value);
-				}
-			}
-
-			// Add custom headers
-			$headers = '';
-			foreach (OC_Util::$headers as $header) {
-				$headers .= '<'.\OCP\Util::sanitizeHTML($header['tag']);
-				if (strcasecmp($header['tag'], 'script') === 0 && in_array('src', array_map('strtolower', array_keys($header['attributes'])))) {
-					$headers .= ' defer';
-				}
-				foreach ($header['attributes'] as $name=>$value) {
-					$headers .= ' '.\OCP\Util::sanitizeHTML($name).'="'.\OCP\Util::sanitizeHTML($value).'"';
-				}
-				if ($header['text'] !== null) {
-					$headers .= '>'.\OCP\Util::sanitizeHTML($header['text']).'</'.\OCP\Util::sanitizeHTML($header['tag']).'>';
-				} else {
-					$headers .= '/>';
-				}
-			}
-
-			$page->assign('headers', $headers);
-
-			$page->assign('content', $data);
-			return $page->fetchPage($additionalParams);
-		}
-
-		return $data;
-	}
-
-	/**
-	 * Include template
-	 *
-	 * @param string $file
-	 * @param array|null $additionalParams
-	 * @return string returns content of included template
-	 *
-	 * Includes another template. use <?php echo $this->inc('template'); ?> to
-	 * do this.
-	 */
-	public function inc($file, $additionalParams = null) {
-		return $this->load($this->path.$file.'.php', $additionalParams);
-	}
-
-	/**
-	 * Shortcut to print a simple page for users
-	 * @param string $application The application we render the template for
-	 * @param string $name Name of the template
-	 * @param array $parameters Parameters for the template
-	 * @return boolean|null
-	 */
-	public static function printUserPage($application, $name, $parameters = []) {
-		$content = new OC_Template($application, $name, "user");
-		foreach ($parameters as $key => $value) {
-			$content->assign($key, $value);
-		}
-		print $content->printPage();
-	}
-
-	/**
-	 * Shortcut to print a simple page for admins
-	 * @param string $application The application we render the template for
-	 * @param string $name Name of the template
-	 * @param array $parameters Parameters for the template
-	 * @return bool
-	 */
-	public static function printAdminPage($application, $name, $parameters = []) {
-		$content = new OC_Template($application, $name, "admin");
-		foreach ($parameters as $key => $value) {
-			$content->assign($key, $value);
-		}
-		return $content->printPage();
-	}
-
-	/**
-	 * Shortcut to print a simple page for guests
-	 * @param string $application The application we render the template for
-	 * @param string $name Name of the template
-	 * @param array|string $parameters Parameters for the template
-	 * @return bool
-	 */
-	public static function printGuestPage($application, $name, $parameters = []) {
-		$content = new OC_Template($application, $name, $name === 'error' ? $name : 'guest');
-		foreach ($parameters as $key => $value) {
-			$content->assign($key, $value);
-		}
-		return $content->printPage();
-	}
-
-	/**
-	 * Print a fatal error page and terminates the script
-	 * @param string $error_msg The error message to show
-	 * @param string $hint An optional hint message - needs to be properly escape
-	 * @param int $statusCode
-	 * @suppress PhanAccessMethodInternal
-	 */
-	public static function printErrorPage($error_msg, $hint = '', $statusCode = 500) {
-		if (\OC::$server->getAppManager()->isEnabledForUser('theming') && !\OC_App::isAppLoaded('theming')) {
-			\OC_App::loadApp('theming');
-		}
-
-
-		if ($error_msg === $hint) {
-			// If the hint is the same as the message there is no need to display it twice.
-			$hint = '';
-		}
-
-		http_response_code($statusCode);
-		try {
-			$content = new \OC_Template('', 'error', 'error', false);
-			$errors = [['error' => $error_msg, 'hint' => $hint]];
-			$content->assign('errors', $errors);
-			$content->printPage();
-		} catch (\Exception $e) {
-			$logger = \OC::$server->getLogger();
-			$logger->error("$error_msg $hint", ['app' => 'core']);
-			$logger->logException($e, ['app' => 'core']);
-
-			header('Content-Type: text/plain; charset=utf-8');
-			print("$error_msg $hint");
-		}
-		die();
-	}
-
-	/**
-	 * print error page using Exception details
-	 * @param Exception|Throwable $exception
-	 * @param int $statusCode
-	 * @return bool|string
-	 * @suppress PhanAccessMethodInternal
-	 */
-	public static function printExceptionErrorPage($exception, $statusCode = 503) {
-		http_response_code($statusCode);
-		try {
-			$request = \OC::$server->getRequest();
-			$content = new \OC_Template('', 'exception', 'error', false);
-			$content->assign('errorClass', get_class($exception));
-			$content->assign('errorMsg', $exception->getMessage());
-			$content->assign('errorCode', $exception->getCode());
-			$content->assign('file', $exception->getFile());
-			$content->assign('line', $exception->getLine());
-			$content->assign('trace', $exception->getTraceAsString());
-			$content->assign('debugMode', \OC::$server->getSystemConfig()->getValue('debug', false));
-			$content->assign('remoteAddr', $request->getRemoteAddress());
-			$content->assign('requestID', $request->getId());
-			$content->printPage();
-		} catch (\Exception $e) {
-			try {
-				$logger = \OC::$server->getLogger();
-				$logger->logException($exception, ['app' => 'core']);
-				$logger->logException($e, ['app' => 'core']);
-			} catch (Throwable $e) {
-				// no way to log it properly - but to avoid a white page of death we send some output
-				header('Content-Type: text/plain; charset=utf-8');
-				print("Internal Server Error\n\n");
-				print("The server encountered an internal error and was unable to complete your request.\n");
-				print("Please contact the server administrator if this error reappears multiple times, please include the technical details below in your report.\n");
-				print("More details can be found in the server log.\n");
-
-				// and then throw it again to log it at least to the web server error log
-				throw $e;
-			}
-
-			header('Content-Type: text/plain; charset=utf-8');
-			print("Internal Server Error\n\n");
-			print("The server encountered an internal error and was unable to complete your request.\n");
-			print("Please contact the server administrator if this error reappears multiple times, please include the technical details below in your report.\n");
-			print("More details can be found in the server log.\n");
-		}
-		die();
-	}
+    /** @var string */
+    private $renderAs; // Create a full page?
+
+    /** @var string */
+    private $path; // The path to the template
+
+    /** @var array */
+    private $headers = []; //custom headers
+
+    /** @var string */
+    protected $app; // app id
+
+    protected static $initTemplateEngineFirstRun = true;
+
+    /**
+     * Constructor
+     *
+     * @param string $app app providing the template
+     * @param string $name of the template file (without suffix)
+     * @param string $renderAs If $renderAs is set, OC_Template will try to
+     *                         produce a full page in the according layout. For
+     *                         now, $renderAs can be set to "guest", "user" or
+     *                         "admin".
+     * @param bool $registerCall = true
+     */
+    public function __construct($app, $name, $renderAs = TemplateResponse::RENDER_AS_BLANK, $registerCall = true) {
+        // Read the selected theme from the config file
+        self::initTemplateEngine($renderAs);
+
+        $theme = OC_Util::getTheme();
+
+        $requestToken = (OC::$server->getSession() && $registerCall) ? \OCP\Util::callRegister() : '';
+
+        $parts = explode('/', $app); // fix translation when app is something like core/lostpassword
+        $l10n = \OC::$server->getL10N($parts[0]);
+        /** @var \OCP\Defaults $themeDefaults */
+        $themeDefaults = \OC::$server->query(\OCP\Defaults::class);
+
+        list($path, $template) = $this->findTemplate($theme, $app, $name);
+
+        // Set the private data
+        $this->renderAs = $renderAs;
+        $this->path = $path;
+        $this->app = $app;
+
+        parent::__construct($template, $requestToken, $l10n, $themeDefaults);
+    }
+
+    /**
+     * @param string $renderAs
+     */
+    public static function initTemplateEngine($renderAs) {
+        if (self::$initTemplateEngineFirstRun) {
+
+            //apps that started before the template initialization can load their own scripts/styles
+            //so to make sure this scripts/styles here are loaded first we use OC_Util::addScript() with $prepend=true
+            //meaning the last script/style in this list will be loaded first
+            if (\OC::$server->getSystemConfig()->getValue('installed', false) && $renderAs !== TemplateResponse::RENDER_AS_ERROR && !\OCP\Util::needUpgrade()) {
+                if (\OC::$server->getConfig()->getAppValue('core', 'backgroundjobs_mode', 'ajax') == 'ajax') {
+                    OC_Util::addScript('backgroundjobs', null, true);
+                }
+            }
+            OC_Util::addStyle('css-variables', null, true);
+            OC_Util::addStyle('server', null, true);
+            OC_Util::addTranslations('core', null, true);
+
+            if (\OC::$server->getSystemConfig()->getValue('installed', false)) {
+                OC_Util::addScript('merged-template-prepend', null, true);
+                OC_Util::addScript('dist/files_client', null, true);
+                OC_Util::addScript('dist/files_fileinfo', null, true);
+            }
+            OC_Util::addScript('core', 'dist/main', true);
+
+            if (\OC::$server->getRequest()->isUserAgent([\OC\AppFramework\Http\Request::USER_AGENT_IE])) {
+                // shim for the davclient.js library
+                \OCP\Util::addScript('dist/files_iedavclient');
+            }
+
+            self::$initTemplateEngineFirstRun = false;
+        }
+    }
+
+
+    /**
+     * find the template with the given name
+     * @param string $name of the template file (without suffix)
+     *
+     * Will select the template file for the selected theme.
+     * Checking all the possible locations.
+     * @param string $theme
+     * @param string $app
+     * @return string[]
+     */
+    protected function findTemplate($theme, $app, $name) {
+        // Check if it is a app template or not.
+        if ($app !== '') {
+            $dirs = $this->getAppTemplateDirs($theme, $app, OC::$SERVERROOT, OC_App::getAppPath($app));
+        } else {
+            $dirs = $this->getCoreTemplateDirs($theme, OC::$SERVERROOT);
+        }
+        $locator = new \OC\Template\TemplateFileLocator($dirs);
+        $template = $locator->find($name);
+        $path = $locator->getPath();
+        return [$path, $template];
+    }
+
+    /**
+     * Add a custom element to the header
+     * @param string $tag tag name of the element
+     * @param array $attributes array of attributes for the element
+     * @param string $text the text content for the element. If $text is null then the
+     * element will be written as empty element. So use "" to get a closing tag.
+     */
+    public function addHeader($tag, $attributes, $text=null) {
+        $this->headers[]= [
+            'tag' => $tag,
+            'attributes' => $attributes,
+            'text' => $text
+        ];
+    }
+
+    /**
+     * Process the template
+     * @return string
+     *
+     * This function process the template. If $this->renderAs is set, it
+     * will produce a full page.
+     */
+    public function fetchPage($additionalParams = null) {
+        $data = parent::fetchPage($additionalParams);
+
+        if ($this->renderAs) {
+            $page = new TemplateLayout($this->renderAs, $this->app);
+
+            if (is_array($additionalParams)) {
+                foreach ($additionalParams as $key => $value) {
+                    $page->assign($key, $value);
+                }
+            }
+
+            // Add custom headers
+            $headers = '';
+            foreach (OC_Util::$headers as $header) {
+                $headers .= '<'.\OCP\Util::sanitizeHTML($header['tag']);
+                if (strcasecmp($header['tag'], 'script') === 0 && in_array('src', array_map('strtolower', array_keys($header['attributes'])))) {
+                    $headers .= ' defer';
+                }
+                foreach ($header['attributes'] as $name=>$value) {
+                    $headers .= ' '.\OCP\Util::sanitizeHTML($name).'="'.\OCP\Util::sanitizeHTML($value).'"';
+                }
+                if ($header['text'] !== null) {
+                    $headers .= '>'.\OCP\Util::sanitizeHTML($header['text']).'</'.\OCP\Util::sanitizeHTML($header['tag']).'>';
+                } else {
+                    $headers .= '/>';
+                }
+            }
+
+            $page->assign('headers', $headers);
+
+            $page->assign('content', $data);
+            return $page->fetchPage($additionalParams);
+        }
+
+        return $data;
+    }
+
+    /**
+     * Include template
+     *
+     * @param string $file
+     * @param array|null $additionalParams
+     * @return string returns content of included template
+     *
+     * Includes another template. use <?php echo $this->inc('template'); ?> to
+     * do this.
+     */
+    public function inc($file, $additionalParams = null) {
+        return $this->load($this->path.$file.'.php', $additionalParams);
+    }
+
+    /**
+     * Shortcut to print a simple page for users
+     * @param string $application The application we render the template for
+     * @param string $name Name of the template
+     * @param array $parameters Parameters for the template
+     * @return boolean|null
+     */
+    public static function printUserPage($application, $name, $parameters = []) {
+        $content = new OC_Template($application, $name, "user");
+        foreach ($parameters as $key => $value) {
+            $content->assign($key, $value);
+        }
+        print $content->printPage();
+    }
+
+    /**
+     * Shortcut to print a simple page for admins
+     * @param string $application The application we render the template for
+     * @param string $name Name of the template
+     * @param array $parameters Parameters for the template
+     * @return bool
+     */
+    public static function printAdminPage($application, $name, $parameters = []) {
+        $content = new OC_Template($application, $name, "admin");
+        foreach ($parameters as $key => $value) {
+            $content->assign($key, $value);
+        }
+        return $content->printPage();
+    }
+
+    /**
+     * Shortcut to print a simple page for guests
+     * @param string $application The application we render the template for
+     * @param string $name Name of the template
+     * @param array|string $parameters Parameters for the template
+     * @return bool
+     */
+    public static function printGuestPage($application, $name, $parameters = []) {
+        $content = new OC_Template($application, $name, $name === 'error' ? $name : 'guest');
+        foreach ($parameters as $key => $value) {
+            $content->assign($key, $value);
+        }
+        return $content->printPage();
+    }
+
+    /**
+     * Print a fatal error page and terminates the script
+     * @param string $error_msg The error message to show
+     * @param string $hint An optional hint message - needs to be properly escape
+     * @param int $statusCode
+     * @suppress PhanAccessMethodInternal
+     */
+    public static function printErrorPage($error_msg, $hint = '', $statusCode = 500) {
+        if (\OC::$server->getAppManager()->isEnabledForUser('theming') && !\OC_App::isAppLoaded('theming')) {
+            \OC_App::loadApp('theming');
+        }
+
+
+        if ($error_msg === $hint) {
+            // If the hint is the same as the message there is no need to display it twice.
+            $hint = '';
+        }
+
+        http_response_code($statusCode);
+        try {
+            $content = new \OC_Template('', 'error', 'error', false);
+            $errors = [['error' => $error_msg, 'hint' => $hint]];
+            $content->assign('errors', $errors);
+            $content->printPage();
+        } catch (\Exception $e) {
+            $logger = \OC::$server->getLogger();
+            $logger->error("$error_msg $hint", ['app' => 'core']);
+            $logger->logException($e, ['app' => 'core']);
+
+            header('Content-Type: text/plain; charset=utf-8');
+            print("$error_msg $hint");
+        }
+        die();
+    }
+
+    /**
+     * print error page using Exception details
+     * @param Exception|Throwable $exception
+     * @param int $statusCode
+     * @return bool|string
+     * @suppress PhanAccessMethodInternal
+     */
+    public static function printExceptionErrorPage($exception, $statusCode = 503) {
+        http_response_code($statusCode);
+        try {
+            $request = \OC::$server->getRequest();
+            $content = new \OC_Template('', 'exception', 'error', false);
+            $content->assign('errorClass', get_class($exception));
+            $content->assign('errorMsg', $exception->getMessage());
+            $content->assign('errorCode', $exception->getCode());
+            $content->assign('file', $exception->getFile());
+            $content->assign('line', $exception->getLine());
+            $content->assign('trace', $exception->getTraceAsString());
+            $content->assign('debugMode', \OC::$server->getSystemConfig()->getValue('debug', false));
+            $content->assign('remoteAddr', $request->getRemoteAddress());
+            $content->assign('requestID', $request->getId());
+            $content->printPage();
+        } catch (\Exception $e) {
+            try {
+                $logger = \OC::$server->getLogger();
+                $logger->logException($exception, ['app' => 'core']);
+                $logger->logException($e, ['app' => 'core']);
+            } catch (Throwable $e) {
+                // no way to log it properly - but to avoid a white page of death we send some output
+                header('Content-Type: text/plain; charset=utf-8');
+                print("Internal Server Error\n\n");
+                print("The server encountered an internal error and was unable to complete your request.\n");
+                print("Please contact the server administrator if this error reappears multiple times, please include the technical details below in your report.\n");
+                print("More details can be found in the server log.\n");
+
+                // and then throw it again to log it at least to the web server error log
+                throw $e;
+            }
+
+            header('Content-Type: text/plain; charset=utf-8');
+            print("Internal Server Error\n\n");
+            print("The server encountered an internal error and was unable to complete your request.\n");
+            print("Please contact the server administrator if this error reappears multiple times, please include the technical details below in your report.\n");
+            print("More details can be found in the server log.\n");
+        }
+        die();
+    }
 }

lib/private/AppFramework/Middleware/Security/BruteForceMiddleware.php

Indentation +56 added lines, -56 removed lines

@@ -46,68 +46,68 @@
  * @package OC\AppFramework\Middleware\Security
  */
 class BruteForceMiddleware extends Middleware {
-	/** @var ControllerMethodReflector */
-	private $reflector;
-	/** @var Throttler */
-	private $throttler;
-	/** @var IRequest */
-	private $request;
+    /** @var ControllerMethodReflector */
+    private $reflector;
+    /** @var Throttler */
+    private $throttler;
+    /** @var IRequest */
+    private $request;
 
-	/**
-	 * @param ControllerMethodReflector $controllerMethodReflector
-	 * @param Throttler $throttler
-	 * @param IRequest $request
-	 */
-	public function __construct(ControllerMethodReflector $controllerMethodReflector,
-								Throttler $throttler,
-								IRequest $request) {
-		$this->reflector = $controllerMethodReflector;
-		$this->throttler = $throttler;
-		$this->request = $request;
-	}
+    /**
+     * @param ControllerMethodReflector $controllerMethodReflector
+     * @param Throttler $throttler
+     * @param IRequest $request
+     */
+    public function __construct(ControllerMethodReflector $controllerMethodReflector,
+                                Throttler $throttler,
+                                IRequest $request) {
+        $this->reflector = $controllerMethodReflector;
+        $this->throttler = $throttler;
+        $this->request = $request;
+    }
 
-	/**
-	 * {@inheritDoc}
-	 */
-	public function beforeController($controller, $methodName) {
-		parent::beforeController($controller, $methodName);
+    /**
+     * {@inheritDoc}
+     */
+    public function beforeController($controller, $methodName) {
+        parent::beforeController($controller, $methodName);
 
-		if ($this->reflector->hasAnnotation('BruteForceProtection')) {
-			$action = $this->reflector->getAnnotationParameter('BruteForceProtection', 'action');
-			$this->throttler->sleepDelayOrThrowOnMax($this->request->getRemoteAddress(), $action);
-		}
-	}
+        if ($this->reflector->hasAnnotation('BruteForceProtection')) {
+            $action = $this->reflector->getAnnotationParameter('BruteForceProtection', 'action');
+            $this->throttler->sleepDelayOrThrowOnMax($this->request->getRemoteAddress(), $action);
+        }
+    }
 
-	/**
-	 * {@inheritDoc}
-	 */
-	public function afterController($controller, $methodName, Response $response) {
-		if ($this->reflector->hasAnnotation('BruteForceProtection') && $response->isThrottled()) {
-			$action = $this->reflector->getAnnotationParameter('BruteForceProtection', 'action');
-			$ip = $this->request->getRemoteAddress();
-			$this->throttler->sleepDelay($ip, $action);
-			$this->throttler->registerAttempt($action, $ip, $response->getThrottleMetadata());
-		}
+    /**
+     * {@inheritDoc}
+     */
+    public function afterController($controller, $methodName, Response $response) {
+        if ($this->reflector->hasAnnotation('BruteForceProtection') && $response->isThrottled()) {
+            $action = $this->reflector->getAnnotationParameter('BruteForceProtection', 'action');
+            $ip = $this->request->getRemoteAddress();
+            $this->throttler->sleepDelay($ip, $action);
+            $this->throttler->registerAttempt($action, $ip, $response->getThrottleMetadata());
+        }
 
-		return parent::afterController($controller, $methodName, $response);
-	}
+        return parent::afterController($controller, $methodName, $response);
+    }
 
-	/**
-	 * @param Controller $controller
-	 * @param string $methodName
-	 * @param \Exception $exception
-	 * @throws \Exception
-	 * @return Response
-	 */
-	public function afterException($controller, $methodName, \Exception $exception): Response {
-		if ($exception instanceof MaxDelayReached) {
-			if ($controller instanceof OCSController) {
-				throw new OCSException($exception->getMessage(), Http::STATUS_TOO_MANY_REQUESTS);
-			}
+    /**
+     * @param Controller $controller
+     * @param string $methodName
+     * @param \Exception $exception
+     * @throws \Exception
+     * @return Response
+     */
+    public function afterException($controller, $methodName, \Exception $exception): Response {
+        if ($exception instanceof MaxDelayReached) {
+            if ($controller instanceof OCSController) {
+                throw new OCSException($exception->getMessage(), Http::STATUS_TOO_MANY_REQUESTS);
+            }
 
-			return new TooManyRequestsResponse();
-		}
+            return new TooManyRequestsResponse();
+        }
 
-		throw $exception;
-	}
+        throw $exception;
+    }
 }

lib/private/Security/Bruteforce/Throttler.php

Indentation +295 added lines, -295 removed lines

@@ -52,299 +52,299 @@
  * @package OC\Security\Bruteforce
  */
 class Throttler {
-	public const LOGIN_ACTION = 'login';
-	public const MAX_DELAY = 25;
-	public const MAX_DELAY_MS = 25000; // in milliseconds
-	public const MAX_ATTEMPTS = 10;
-
-	/** @var IDBConnection */
-	private $db;
-	/** @var ITimeFactory */
-	private $timeFactory;
-	/** @var ILogger */
-	private $logger;
-	/** @var IConfig */
-	private $config;
-
-	/**
-	 * @param IDBConnection $db
-	 * @param ITimeFactory $timeFactory
-	 * @param ILogger $logger
-	 * @param IConfig $config
-	 */
-	public function __construct(IDBConnection $db,
-								ITimeFactory $timeFactory,
-								ILogger $logger,
-								IConfig $config) {
-		$this->db = $db;
-		$this->timeFactory = $timeFactory;
-		$this->logger = $logger;
-		$this->config = $config;
-	}
-
-	/**
-	 * Convert a number of seconds into the appropriate DateInterval
-	 *
-	 * @param int $expire
-	 * @return \DateInterval
-	 */
-	private function getCutoff(int $expire): \DateInterval {
-		$d1 = new \DateTime();
-		$d2 = clone $d1;
-		$d2->sub(new \DateInterval('PT' . $expire . 'S'));
-		return $d2->diff($d1);
-	}
-
-	/**
-	 *  Calculate the cut off timestamp
-	 *
-	 * @param float $maxAgeHours
-	 * @return int
-	 */
-	private function getCutoffTimestamp(float $maxAgeHours = 12.0): int {
-		return (new \DateTime())
-			->sub($this->getCutoff((int) ($maxAgeHours * 3600)))
-			->getTimestamp();
-	}
-
-	/**
-	 * Register a failed attempt to bruteforce a security control
-	 *
-	 * @param string $action
-	 * @param string $ip
-	 * @param array $metadata Optional metadata logged to the database
-	 * @suppress SqlInjectionChecker
-	 */
-	public function registerAttempt(string $action,
-									string $ip,
-									array $metadata = []): void {
-		// No need to log if the bruteforce protection is disabled
-		if ($this->config->getSystemValue('auth.bruteforce.protection.enabled', true) === false) {
-			return;
-		}
-
-		$ipAddress = new IpAddress($ip);
-		$values = [
-			'action' => $action,
-			'occurred' => $this->timeFactory->getTime(),
-			'ip' => (string)$ipAddress,
-			'subnet' => $ipAddress->getSubnet(),
-			'metadata' => json_encode($metadata),
-		];
-
-		$this->logger->notice(
-			sprintf(
-				'Bruteforce attempt from "%s" detected for action "%s".',
-				$ip,
-				$action
-			),
-			[
-				'app' => 'core',
-			]
-		);
-
-		$qb = $this->db->getQueryBuilder();
-		$qb->insert('bruteforce_attempts');
-		foreach ($values as $column => $value) {
-			$qb->setValue($column, $qb->createNamedParameter($value));
-		}
-		$qb->execute();
-	}
-
-	/**
-	 * Check if the IP is whitelisted
-	 *
-	 * @param string $ip
-	 * @return bool
-	 */
-	private function isIPWhitelisted(string $ip): bool {
-		if ($this->config->getSystemValue('auth.bruteforce.protection.enabled', true) === false) {
-			return true;
-		}
-
-		$keys = $this->config->getAppKeys('bruteForce');
-		$keys = array_filter($keys, function ($key) {
-			return 0 === strpos($key, 'whitelist_');
-		});
-
-		if (filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4)) {
-			$type = 4;
-		} elseif (filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6)) {
-			$type = 6;
-		} else {
-			return false;
-		}
-
-		$ip = inet_pton($ip);
-
-		foreach ($keys as $key) {
-			$cidr = $this->config->getAppValue('bruteForce', $key, null);
-
-			$cx = explode('/', $cidr);
-			$addr = $cx[0];
-			$mask = (int)$cx[1];
-
-			// Do not compare ipv4 to ipv6
-			if (($type === 4 && !filter_var($addr, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4)) ||
-				($type === 6 && !filter_var($addr, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6))) {
-				continue;
-			}
-
-			$addr = inet_pton($addr);
-
-			$valid = true;
-			for ($i = 0; $i < $mask; $i++) {
-				$part = ord($addr[(int)($i/8)]);
-				$orig = ord($ip[(int)($i/8)]);
-
-				$bitmask = 1 << (7 - ($i % 8));
-
-				$part = $part & $bitmask;
-				$orig = $orig & $bitmask;
-
-				if ($part !== $orig) {
-					$valid = false;
-					break;
-				}
-			}
-
-			if ($valid === true) {
-				return true;
-			}
-		}
-
-		return false;
-	}
-
-	/**
-	 * Get the throttling delay (in milliseconds)
-	 *
-	 * @param string $ip
-	 * @param string $action optionally filter by action
-	 * @param float $maxAgeHours
-	 * @return int
-	 */
-	public function getAttempts(string $ip, string $action = '', float $maxAgeHours = 12): int {
-		$ipAddress = new IpAddress($ip);
-		if ($this->isIPWhitelisted((string)$ipAddress)) {
-			return 0;
-		}
-
-		$cutoffTime = $this->getCutoffTimestamp($maxAgeHours);
-
-		$qb = $this->db->getQueryBuilder();
-		$qb->select($qb->func()->count('*', 'attempts'))
-			->from('bruteforce_attempts')
-			->where($qb->expr()->gt('occurred', $qb->createNamedParameter($cutoffTime)))
-			->andWhere($qb->expr()->eq('subnet', $qb->createNamedParameter($ipAddress->getSubnet())));
-
-		if ($action !== '') {
-			$qb->andWhere($qb->expr()->eq('action', $qb->createNamedParameter($action)));
-		}
-
-		$result = $qb->execute();
-		$row = $result->fetch();
-		$result->closeCursor();
-
-		return (int) $row['attempts'];
-	}
-
-	/**
-	 * Get the throttling delay (in milliseconds)
-	 *
-	 * @param string $ip
-	 * @param string $action optionally filter by action
-	 * @return int
-	 */
-	public function getDelay(string $ip, string $action = ''): int {
-		$attempts = $this->getAttempts($ip, $action);
-		if ($attempts === 0) {
-			return 0;
-		}
-
-		$firstDelay = 0.1;
-		if ($attempts > self::MAX_ATTEMPTS) {
-			// Don't ever overflow. Just assume the maxDelay time:s
-			return self::MAX_DELAY_MS;
-		}
-
-		$delay = $firstDelay * 2**$attempts;
-		if ($delay > self::MAX_DELAY) {
-			return self::MAX_DELAY_MS;
-		}
-		return (int) \ceil($delay * 1000);
-	}
-
-	/**
-	 * Reset the throttling delay for an IP address, action and metadata
-	 *
-	 * @param string $ip
-	 * @param string $action
-	 * @param array $metadata
-	 */
-	public function resetDelay(string $ip, string $action, array $metadata): void {
-		$ipAddress = new IpAddress($ip);
-		if ($this->isIPWhitelisted((string)$ipAddress)) {
-			return;
-		}
-
-		$cutoffTime = $this->getCutoffTimestamp();
-
-		$qb = $this->db->getQueryBuilder();
-		$qb->delete('bruteforce_attempts')
-			->where($qb->expr()->gt('occurred', $qb->createNamedParameter($cutoffTime)))
-			->andWhere($qb->expr()->eq('subnet', $qb->createNamedParameter($ipAddress->getSubnet())))
-			->andWhere($qb->expr()->eq('action', $qb->createNamedParameter($action)))
-			->andWhere($qb->expr()->eq('metadata', $qb->createNamedParameter(json_encode($metadata))));
-
-		$qb->execute();
-	}
-
-	/**
-	 * Reset the throttling delay for an IP address
-	 *
-	 * @param string $ip
-	 */
-	public function resetDelayForIP($ip) {
-		$cutoffTime = $this->getCutoffTimestamp();
-
-		$qb = $this->db->getQueryBuilder();
-		$qb->delete('bruteforce_attempts')
-			->where($qb->expr()->gt('occurred', $qb->createNamedParameter($cutoffTime)))
-			->andWhere($qb->expr()->eq('ip', $qb->createNamedParameter($ip)));
-
-		$qb->execute();
-	}
-
-	/**
-	 * Will sleep for the defined amount of time
-	 *
-	 * @param string $ip
-	 * @param string $action optionally filter by action
-	 * @return int the time spent sleeping
-	 */
-	public function sleepDelay(string $ip, string $action = ''): int {
-		$delay = $this->getDelay($ip, $action);
-		usleep($delay * 1000);
-		return $delay;
-	}
-
-	/**
-	 * Will sleep for the defined amount of time unless maximum was reached in the last 30 minutes
-	 * In this case a "429 Too Many Request" exception is thrown
-	 *
-	 * @param string $ip
-	 * @param string $action optionally filter by action
-	 * @return int the time spent sleeping
-	 * @throws MaxDelayReached when reached the maximum
-	 */
-	public function sleepDelayOrThrowOnMax(string $ip, string $action = ''): int {
-		$delay = $this->getDelay($ip, $action);
-		if (($delay === self::MAX_DELAY_MS) && $this->getAttempts($ip, $action, 0.5) > self::MAX_ATTEMPTS) {
-			// If the ip made too many attempts within the last 30 mins we don't execute anymore
-			throw new MaxDelayReached('Reached maximum delay');
-		}
-		usleep($delay * 1000);
-		return $delay;
-	}
+    public const LOGIN_ACTION = 'login';
+    public const MAX_DELAY = 25;
+    public const MAX_DELAY_MS = 25000; // in milliseconds
+    public const MAX_ATTEMPTS = 10;
+
+    /** @var IDBConnection */
+    private $db;
+    /** @var ITimeFactory */
+    private $timeFactory;
+    /** @var ILogger */
+    private $logger;
+    /** @var IConfig */
+    private $config;
+
+    /**
+     * @param IDBConnection $db
+     * @param ITimeFactory $timeFactory
+     * @param ILogger $logger
+     * @param IConfig $config
+     */
+    public function __construct(IDBConnection $db,
+                                ITimeFactory $timeFactory,
+                                ILogger $logger,
+                                IConfig $config) {
+        $this->db = $db;
+        $this->timeFactory = $timeFactory;
+        $this->logger = $logger;
+        $this->config = $config;
+    }
+
+    /**
+     * Convert a number of seconds into the appropriate DateInterval
+     *
+     * @param int $expire
+     * @return \DateInterval
+     */
+    private function getCutoff(int $expire): \DateInterval {
+        $d1 = new \DateTime();
+        $d2 = clone $d1;
+        $d2->sub(new \DateInterval('PT' . $expire . 'S'));
+        return $d2->diff($d1);
+    }
+
+    /**
+     *  Calculate the cut off timestamp
+     *
+     * @param float $maxAgeHours
+     * @return int
+     */
+    private function getCutoffTimestamp(float $maxAgeHours = 12.0): int {
+        return (new \DateTime())
+            ->sub($this->getCutoff((int) ($maxAgeHours * 3600)))
+            ->getTimestamp();
+    }
+
+    /**
+     * Register a failed attempt to bruteforce a security control
+     *
+     * @param string $action
+     * @param string $ip
+     * @param array $metadata Optional metadata logged to the database
+     * @suppress SqlInjectionChecker
+     */
+    public function registerAttempt(string $action,
+                                    string $ip,
+                                    array $metadata = []): void {
+        // No need to log if the bruteforce protection is disabled
+        if ($this->config->getSystemValue('auth.bruteforce.protection.enabled', true) === false) {
+            return;
+        }
+
+        $ipAddress = new IpAddress($ip);
+        $values = [
+            'action' => $action,
+            'occurred' => $this->timeFactory->getTime(),
+            'ip' => (string)$ipAddress,
+            'subnet' => $ipAddress->getSubnet(),
+            'metadata' => json_encode($metadata),
+        ];
+
+        $this->logger->notice(
+            sprintf(
+                'Bruteforce attempt from "%s" detected for action "%s".',
+                $ip,
+                $action
+            ),
+            [
+                'app' => 'core',
+            ]
+        );
+
+        $qb = $this->db->getQueryBuilder();
+        $qb->insert('bruteforce_attempts');
+        foreach ($values as $column => $value) {
+            $qb->setValue($column, $qb->createNamedParameter($value));
+        }
+        $qb->execute();
+    }
+
+    /**
+     * Check if the IP is whitelisted
+     *
+     * @param string $ip
+     * @return bool
+     */
+    private function isIPWhitelisted(string $ip): bool {
+        if ($this->config->getSystemValue('auth.bruteforce.protection.enabled', true) === false) {
+            return true;
+        }
+
+        $keys = $this->config->getAppKeys('bruteForce');
+        $keys = array_filter($keys, function ($key) {
+            return 0 === strpos($key, 'whitelist_');
+        });
+
+        if (filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4)) {
+            $type = 4;
+        } elseif (filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6)) {
+            $type = 6;
+        } else {
+            return false;
+        }
+
+        $ip = inet_pton($ip);
+
+        foreach ($keys as $key) {
+            $cidr = $this->config->getAppValue('bruteForce', $key, null);
+
+            $cx = explode('/', $cidr);
+            $addr = $cx[0];
+            $mask = (int)$cx[1];
+
+            // Do not compare ipv4 to ipv6
+            if (($type === 4 && !filter_var($addr, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4)) ||
+                ($type === 6 && !filter_var($addr, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6))) {
+                continue;
+            }
+
+            $addr = inet_pton($addr);
+
+            $valid = true;
+            for ($i = 0; $i < $mask; $i++) {
+                $part = ord($addr[(int)($i/8)]);
+                $orig = ord($ip[(int)($i/8)]);
+
+                $bitmask = 1 << (7 - ($i % 8));
+
+                $part = $part & $bitmask;
+                $orig = $orig & $bitmask;
+
+                if ($part !== $orig) {
+                    $valid = false;
+                    break;
+                }
+            }
+
+            if ($valid === true) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * Get the throttling delay (in milliseconds)
+     *
+     * @param string $ip
+     * @param string $action optionally filter by action
+     * @param float $maxAgeHours
+     * @return int
+     */
+    public function getAttempts(string $ip, string $action = '', float $maxAgeHours = 12): int {
+        $ipAddress = new IpAddress($ip);
+        if ($this->isIPWhitelisted((string)$ipAddress)) {
+            return 0;
+        }
+
+        $cutoffTime = $this->getCutoffTimestamp($maxAgeHours);
+
+        $qb = $this->db->getQueryBuilder();
+        $qb->select($qb->func()->count('*', 'attempts'))
+            ->from('bruteforce_attempts')
+            ->where($qb->expr()->gt('occurred', $qb->createNamedParameter($cutoffTime)))
+            ->andWhere($qb->expr()->eq('subnet', $qb->createNamedParameter($ipAddress->getSubnet())));
+
+        if ($action !== '') {
+            $qb->andWhere($qb->expr()->eq('action', $qb->createNamedParameter($action)));
+        }
+
+        $result = $qb->execute();
+        $row = $result->fetch();
+        $result->closeCursor();
+
+        return (int) $row['attempts'];
+    }
+
+    /**
+     * Get the throttling delay (in milliseconds)
+     *
+     * @param string $ip
+     * @param string $action optionally filter by action
+     * @return int
+     */
+    public function getDelay(string $ip, string $action = ''): int {
+        $attempts = $this->getAttempts($ip, $action);
+        if ($attempts === 0) {
+            return 0;
+        }
+
+        $firstDelay = 0.1;
+        if ($attempts > self::MAX_ATTEMPTS) {
+            // Don't ever overflow. Just assume the maxDelay time:s
+            return self::MAX_DELAY_MS;
+        }
+
+        $delay = $firstDelay * 2**$attempts;
+        if ($delay > self::MAX_DELAY) {
+            return self::MAX_DELAY_MS;
+        }
+        return (int) \ceil($delay * 1000);
+    }
+
+    /**
+     * Reset the throttling delay for an IP address, action and metadata
+     *
+     * @param string $ip
+     * @param string $action
+     * @param array $metadata
+     */
+    public function resetDelay(string $ip, string $action, array $metadata): void {
+        $ipAddress = new IpAddress($ip);
+        if ($this->isIPWhitelisted((string)$ipAddress)) {
+            return;
+        }
+
+        $cutoffTime = $this->getCutoffTimestamp();
+
+        $qb = $this->db->getQueryBuilder();
+        $qb->delete('bruteforce_attempts')
+            ->where($qb->expr()->gt('occurred', $qb->createNamedParameter($cutoffTime)))
+            ->andWhere($qb->expr()->eq('subnet', $qb->createNamedParameter($ipAddress->getSubnet())))
+            ->andWhere($qb->expr()->eq('action', $qb->createNamedParameter($action)))
+            ->andWhere($qb->expr()->eq('metadata', $qb->createNamedParameter(json_encode($metadata))));
+
+        $qb->execute();
+    }
+
+    /**
+     * Reset the throttling delay for an IP address
+     *
+     * @param string $ip
+     */
+    public function resetDelayForIP($ip) {
+        $cutoffTime = $this->getCutoffTimestamp();
+
+        $qb = $this->db->getQueryBuilder();
+        $qb->delete('bruteforce_attempts')
+            ->where($qb->expr()->gt('occurred', $qb->createNamedParameter($cutoffTime)))
+            ->andWhere($qb->expr()->eq('ip', $qb->createNamedParameter($ip)));
+
+        $qb->execute();
+    }
+
+    /**
+     * Will sleep for the defined amount of time
+     *
+     * @param string $ip
+     * @param string $action optionally filter by action
+     * @return int the time spent sleeping
+     */
+    public function sleepDelay(string $ip, string $action = ''): int {
+        $delay = $this->getDelay($ip, $action);
+        usleep($delay * 1000);
+        return $delay;
+    }
+
+    /**
+     * Will sleep for the defined amount of time unless maximum was reached in the last 30 minutes
+     * In this case a "429 Too Many Request" exception is thrown
+     *
+     * @param string $ip
+     * @param string $action optionally filter by action
+     * @return int the time spent sleeping
+     * @throws MaxDelayReached when reached the maximum
+     */
+    public function sleepDelayOrThrowOnMax(string $ip, string $action = ''): int {
+        $delay = $this->getDelay($ip, $action);
+        if (($delay === self::MAX_DELAY_MS) && $this->getAttempts($ip, $action, 0.5) > self::MAX_ATTEMPTS) {
+            // If the ip made too many attempts within the last 30 mins we don't execute anymore
+            throw new MaxDelayReached('Reached maximum delay');
+        }
+        usleep($delay * 1000);
+        return $delay;
+    }
 }

Spacing +8 added lines, -8 removed lines

@@ -91,7 +91,7 @@ 
 	private function getCutoff(int $expire): \DateInterval {
 		$d1 = new \DateTime();
 		$d2 = clone $d1;
-		$d2->sub(new \DateInterval('PT' . $expire . 'S'));
+		$d2->sub(new \DateInterval('PT'.$expire.'S'));
 		return $d2->diff($d1);
 	}
 
@@ -127,7 +127,7 @@ 
 		$values = [
 			'action' => $action,
 			'occurred' => $this->timeFactory->getTime(),
-			'ip' => (string)$ipAddress,
+			'ip' => (string) $ipAddress,
 			'subnet' => $ipAddress->getSubnet(),
 			'metadata' => json_encode($metadata),
 		];
@@ -163,7 +163,7 @@ 
 		}
 
 		$keys = $this->config->getAppKeys('bruteForce');
-		$keys = array_filter($keys, function ($key) {
+		$keys = array_filter($keys, function($key) {
 			return 0 === strpos($key, 'whitelist_');
 		});
 
@@ -182,7 +182,7 @@ 
 
 			$cx = explode('/', $cidr);
 			$addr = $cx[0];
-			$mask = (int)$cx[1];
+			$mask = (int) $cx[1];
 
 			// Do not compare ipv4 to ipv6
 			if (($type === 4 && !filter_var($addr, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4)) ||
@@ -194,8 +194,8 @@ 
 
 			$valid = true;
 			for ($i = 0; $i < $mask; $i++) {
-				$part = ord($addr[(int)($i/8)]);
-				$orig = ord($ip[(int)($i/8)]);
+				$part = ord($addr[(int) ($i / 8)]);
+				$orig = ord($ip[(int) ($i / 8)]);
 
 				$bitmask = 1 << (7 - ($i % 8));
 
@@ -226,7 +226,7 @@ 
 	 */
 	public function getAttempts(string $ip, string $action = '', float $maxAgeHours = 12): int {
 		$ipAddress = new IpAddress($ip);
-		if ($this->isIPWhitelisted((string)$ipAddress)) {
+		if ($this->isIPWhitelisted((string) $ipAddress)) {
 			return 0;
 		}
 
@@ -284,7 +284,7 @@ 
 	 */
 	public function resetDelay(string $ip, string $action, array $metadata): void {
 		$ipAddress = new IpAddress($ip);
-		if ($this->isIPWhitelisted((string)$ipAddress)) {
+		if ($this->isIPWhitelisted((string) $ipAddress)) {
 			return;
 		}