X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FBaseModule.php;h=11f884472e65c448c774d6b8f1576ef986903bac;hb=b0898ada2942e4207b0fb6dfacb8ffbdd3c6945e;hp=65fc8f307c49dbdca624c43dd11072dfa4956a95;hpb=8bdd90066f82a7ff1be36be3c6c3b49800a078c8;p=friendica.git diff --git a/src/BaseModule.php b/src/BaseModule.php index 65fc8f307c..11f884472e 100644 --- a/src/BaseModule.php +++ b/src/BaseModule.php @@ -1,6 +1,6 @@ parameters = $parameters; $this->l10n = $l10n; @@ -67,6 +72,7 @@ abstract class BaseModule implements ICanHandleRequests $this->logger = $logger; $this->profiler = $profiler; $this->server = $server; + $this->response = $response; } /** @@ -96,6 +102,7 @@ abstract class BaseModule implements ICanHandleRequests * e.g. from protocol implementations. * * @param string[] $request The $_REQUEST content + * @return void */ protected function rawContent(array $request = []) { @@ -111,6 +118,7 @@ abstract class BaseModule implements ICanHandleRequests * XML feed or a JSON output. * * @param string[] $request The $_REQUEST content + * @return string */ protected function content(array $request = []): string { @@ -122,8 +130,11 @@ abstract class BaseModule implements ICanHandleRequests * * Extend this method if the module is supposed to process DELETE requests. * Doesn't display any content + * + * @param string[] $request The $_REQUEST content + * @return void */ - protected function delete() + protected function delete(array $request = []) { } @@ -132,8 +143,11 @@ abstract class BaseModule implements ICanHandleRequests * * Extend this method if the module is supposed to process PATCH requests. * Doesn't display any content + * + * @param string[] $request The $_REQUEST content + * @return void */ - protected function patch() + protected function patch(array $request = []) { } @@ -144,10 +158,9 @@ abstract class BaseModule implements ICanHandleRequests * Doesn't display any content * * @param string[] $request The $_REQUEST content - * @param string[] $post The $_POST content - * + * @return void */ - protected function post(array $request = [], array $post = []) + protected function post(array $request = []) { // $this->baseUrl->redirect('module'); } @@ -157,44 +170,41 @@ abstract class BaseModule implements ICanHandleRequests * * Extend this method if the module is supposed to process PUT requests. * Doesn't display any content + * + * @param string[] $request The $_REQUEST content + * @return void */ - protected function put() + protected function put(array $request = []) { } - /** Gets the name of the current class */ - public function getClassName(): string - { - return static::class; - } - /** * {@inheritDoc} */ - public function run(array $post = [], array $request = []): string + public function run(ModuleHTTPException $httpException, array $request = []): ResponseInterface { // @see https://github.com/tootsuite/mastodon/blob/c3aef491d66aec743a3a53e934a494f653745b61/config/initializers/cors.rb - if (substr($request['pagename'] ?? '', 0, 12) == '.well-known/') { - header('Access-Control-Allow-Origin: *'); - header('Access-Control-Allow-Headers: *'); - header('Access-Control-Allow-Methods: ' . Router::GET); - header('Access-Control-Allow-Credentials: false'); - } elseif (substr($request['pagename'] ?? '', 0, 8) == 'profile/') { - header('Access-Control-Allow-Origin: *'); - header('Access-Control-Allow-Headers: *'); - header('Access-Control-Allow-Methods: ' . Router::GET); - header('Access-Control-Allow-Credentials: false'); - } elseif (substr($request['pagename'] ?? '', 0, 4) == 'api/') { - header('Access-Control-Allow-Origin: *'); - header('Access-Control-Allow-Headers: *'); - header('Access-Control-Allow-Methods: ' . implode(',', Router::ALLOWED_METHODS)); - header('Access-Control-Allow-Credentials: false'); - header('Access-Control-Expose-Headers: Link'); - } elseif (substr($request['pagename'] ?? '', 0, 11) == 'oauth/token') { - header('Access-Control-Allow-Origin: *'); - header('Access-Control-Allow-Headers: *'); - header('Access-Control-Allow-Methods: ' . Router::POST); - header('Access-Control-Allow-Credentials: false'); + if (substr($this->args->getQueryString(), 0, 12) == '.well-known/') { + $this->response->setHeader('*', 'Access-Control-Allow-Origin'); + $this->response->setHeader('*', 'Access-Control-Allow-Headers'); + $this->response->setHeader(Router::GET, 'Access-Control-Allow-Methods'); + $this->response->setHeader('false', 'Access-Control-Allow-Credentials'); + } elseif (substr($this->args->getQueryString(), 0, 8) == 'profile/') { + $this->response->setHeader('*', 'Access-Control-Allow-Origin'); + $this->response->setHeader('*', 'Access-Control-Allow-Headers'); + $this->response->setHeader(Router::GET, 'Access-Control-Allow-Methods'); + $this->response->setHeader('false', 'Access-Control-Allow-Credentials'); + } elseif (substr($this->args->getQueryString(), 0, 4) == 'api/') { + $this->response->setHeader('*', 'Access-Control-Allow-Origin'); + $this->response->setHeader('*', 'Access-Control-Allow-Headers'); + $this->response->setHeader(implode(',', Router::ALLOWED_METHODS), 'Access-Control-Allow-Methods'); + $this->response->setHeader('false', 'Access-Control-Allow-Credentials'); + $this->response->setHeader('Link', 'Access-Control-Expose-Headers'); + } elseif (substr($this->args->getQueryString(), 0, 11) == 'oauth/token') { + $this->response->setHeader('*', 'Access-Control-Allow-Origin'); + $this->response->setHeader('*', 'Access-Control-Allow-Headers'); + $this->response->setHeader(Router::POST, 'Access-Control-Allow-Methods'); + $this->response->setHeader('false', 'Access-Control-Allow-Credentials'); } $placeholder = ''; @@ -206,23 +216,23 @@ abstract class BaseModule implements ICanHandleRequests $this->profiler->set(microtime(true) - $timestamp, 'init'); - if ($this->server['REQUEST_METHOD'] === Router::DELETE) { - $this->delete(); - } - - if ($this->server['REQUEST_METHOD'] === Router::PATCH) { - $this->patch(); - } - - if ($this->server['REQUEST_METHOD'] === Router::POST) { - Core\Hook::callAll($this->args->getModuleName() . '_mod_post', $post); - $this->post($request, $post); - } - - if ($this->server['REQUEST_METHOD'] === Router::PUT) { - $this->put(); + switch ($this->args->getMethod()) { + case Router::DELETE: + $this->delete($request); + break; + case Router::PATCH: + $this->patch($request); + break; + case Router::POST: + Core\Hook::callAll($this->args->getModuleName() . '_mod_post', $request); + $this->post($request); + break; + case Router::PUT: + $this->put($request); + break; } + $timestamp = microtime(true); // "rawContent" is especially meant for technical endpoints. // This endpoint doesn't need any theme initialization or other comparable stuff. $this->rawContent($request); @@ -230,14 +240,100 @@ abstract class BaseModule implements ICanHandleRequests try { $arr = ['content' => '']; Hook::callAll(static::class . '_mod_content', $arr); - $content = $arr['content']; - return $content . $this->content($_REQUEST); + $this->response->addContent($arr['content']); + $this->response->addContent($this->content($request)); } catch (HTTPException $e) { - return (new ModuleHTTPException())->content($e); + // In case of System::externalRedirects(), we don't want to prettyprint the exception + // just redirect to the new location + if (($e instanceof HTTPException\FoundException) || + ($e instanceof HTTPException\MovedPermanentlyException) || + ($e instanceof HTTPException\TemporaryRedirectException)) { + throw $e; + } + + $this->response->addContent($httpException->content($e)); + } finally { + $this->profiler->set(microtime(true) - $timestamp, 'content'); + } + + return $this->response->generate(); + } + + /** + * Checks request inputs and sets default parameters + * + * @param array $defaults Associative array of expected request keys and their default typed value. A null + * value will remove the request key from the resulting value array. + * @param array $input Custom REQUEST array, superglobal instead + * + * @return array Request data + */ + protected function checkDefaults(array $defaults, array $input): array + { + $request = []; + + foreach ($defaults as $parameter => $defaultvalue) { + $request[$parameter] = $this->getRequestValue($input, $parameter, $defaultvalue); + } + + foreach ($input ?? [] as $parameter => $value) { + if ($parameter == 'pagename') { + continue; + } + if (!in_array($parameter, array_keys($defaults))) { + $this->logger->notice('Unhandled request field', ['parameter' => $parameter, 'value' => $value, 'command' => $this->args->getCommand()]); + } + } + + $this->logger->debug('Got request parameters', ['request' => $request, 'command' => $this->args->getCommand()]); + return $request; + } + + /** + * Fetch a request value and apply default values and check against minimal and maximal values + * + * @param array $input Input fields + * @param string $parameter Parameter + * @param mixed $default Default + * @param mixed $minimal_value Minimal value + * @param mixed $maximum_value Maximum value + * @return mixed null on error anything else on success (?) + */ + public function getRequestValue(array $input, string $parameter, $default = null, $minimal_value = null, $maximum_value = null) + { + if (is_string($default)) { + $value = (string)($input[$parameter] ?? $default); + } elseif (is_int($default)) { + $value = filter_var($input[$parameter] ?? $default, FILTER_VALIDATE_INT); + if (!is_null($minimal_value)) { + $value = max(filter_var($minimal_value, FILTER_VALIDATE_INT), $value); + } + if (!is_null($maximum_value)) { + $value = min(filter_var($maximum_value, FILTER_VALIDATE_INT), $value); + } + } elseif (is_float($default)) { + $value = filter_var($input[$parameter] ?? $default, FILTER_VALIDATE_FLOAT); + if (!is_null($minimal_value)) { + $value = max(filter_var($minimal_value, FILTER_VALIDATE_FLOAT), $value); + } + if (!is_null($maximum_value)) { + $value = min(filter_var($maximum_value, FILTER_VALIDATE_FLOAT), $value); + } + } elseif (is_array($default)) { + $value = filter_var($input[$parameter] ?? $default, FILTER_DEFAULT, ['flags' => FILTER_FORCE_ARRAY]); + } elseif (is_bool($default)) { + $value = filter_var($input[$parameter] ?? $default, FILTER_VALIDATE_BOOLEAN); + } elseif (is_null($default)) { + $value = $input[$parameter] ?? null; + } else { + $this->logger->notice('Unhandled default value type', ['parameter' => $parameter, 'type' => gettype($default)]); + $value = null; } + + return $value; } - /* + /** * Functions used to protect against Cross-Site Request Forgery * The security token has to base on at least one value that an attacker can't know - here it's the session ID and the private key. * In this implementation, a security token is reusable (if the user submits a form, goes back and resubmits the form, maybe with small changes; @@ -247,17 +343,27 @@ abstract class BaseModule implements ICanHandleRequests * If the new page contains by any chance external elements, then the used security token is exposed by the referrer. * Actually, important actions should not be triggered by Links / GET-Requests at all, but sometimes they still are, * so this mechanism brings in some damage control (the attacker would be able to forge a request to a form of this type, but not to forms of other types). + * + * @param string $typename Type name + * @return string Security hash with timestamp */ - public static function getFormSecurityToken($typename = '') + public static function getFormSecurityToken(string $typename = ''): string { - $user = User::getById(DI::app()->getLoggedInUserId(), ['guid', 'prvkey']); + $user = User::getById(DI::app()->getLoggedInUserId(), ['guid', 'prvkey']); $timestamp = time(); - $sec_hash = hash('whirlpool', ($user['guid'] ?? '') . ($user['prvkey'] ?? '') . session_id() . $timestamp . $typename); + $sec_hash = hash('whirlpool', ($user['guid'] ?? '') . ($user['prvkey'] ?? '') . session_id() . $timestamp . $typename); return $timestamp . '.' . $sec_hash; } - public static function checkFormSecurityToken($typename = '', $formname = 'form_security_token') + /** + * Checks if form's security (CSRF) token is valid. + * + * @param string $typename ??? + * @param string $formname Name of form/field (???) + * @return bool Whether it is valid + */ + public static function checkFormSecurityToken(string $typename = '', string $formname = 'form_security_token'): bool { $hash = null; @@ -289,22 +395,22 @@ abstract class BaseModule implements ICanHandleRequests return ($sec_hash == $x[1]); } - public static function getFormSecurityStandardErrorMessage() + public static function getFormSecurityStandardErrorMessage(): string { - return DI::l10n()->t("The form security token was not correct. This probably happened because the form has been opened for too long \x28>3 hours\x29 before submitting it.") . EOL; + return DI::l10n()->t("The form security token was not correct. This probably happened because the form has been opened for too long \x28>3 hours\x29 before submitting it."); } - public static function checkFormSecurityTokenRedirectOnError($err_redirect, $typename = '', $formname = 'form_security_token') + public static function checkFormSecurityTokenRedirectOnError(string $err_redirect, string $typename = '', string $formname = 'form_security_token') { if (!self::checkFormSecurityToken($typename, $formname)) { Logger::notice('checkFormSecurityToken failed: user ' . DI::app()->getLoggedInUserNickname() . ' - form element ' . $typename); Logger::debug('checkFormSecurityToken failed', ['request' => $_REQUEST]); - notice(self::getFormSecurityStandardErrorMessage()); + DI::sysmsg()->addNotice(self::getFormSecurityStandardErrorMessage()); DI::baseUrl()->redirect($err_redirect); } } - public static function checkFormSecurityTokenForbiddenOnError($typename = '', $formname = 'form_security_token') + public static function checkFormSecurityTokenForbiddenOnError(string $typename = '', string $formname = 'form_security_token') { if (!self::checkFormSecurityToken($typename, $formname)) { Logger::notice('checkFormSecurityToken failed: user ' . DI::app()->getLoggedInUserNickname() . ' - form element ' . $typename); @@ -314,7 +420,7 @@ abstract class BaseModule implements ICanHandleRequests } } - protected static function getContactFilterTabs(string $baseUrl, string $current, bool $displayCommonTab) + protected static function getContactFilterTabs(string $baseUrl, string $current, bool $displayCommonTab): array { $tabs = [ [