src/BaseModule.php

   1 <?php
   2
   3 namespace Friendica;
   4
   5 use Friendica\Core\Logger;
   6
   7 /**
   8  * All modules in Friendica should extend BaseModule, although not all modules
   9  * need to extend all the methods described here
  10  *
  11  * The filename of the module in src/Module needs to match the class name
  12  * exactly to make the module available.
  13  *
  14  * @author Hypolite Petovan <hypolite@mrpetovan.com>
  15  */
  16 abstract class BaseModule
  17 {
  18         /**
  19          * Initialization method common to both content() and post()
  20          *
  21          * Extend this method if you need to do any shared processing before both
  22          * content() or post()
  23          */
  24         public static function init(array $parameters = [])
  25         {
  26         }
  27
  28         /**
  29          * Module GET method to display raw content from technical endpoints
  30          *
  31          * Extend this method if the module is supposed to return communication data,
  32          * e.g. from protocol implementations.
  33          */
  34         public static function rawContent(array $parameters = [])
  35         {
  36                 // echo '';
  37                 // exit;
  38         }
  39
  40         /**
  41          * Module GET method to display any content
  42          *
  43          * Extend this method if the module is supposed to return any display
  44          * through a GET request. It can be an HTML page through templating or a
  45          * XML feed or a JSON output.
  46          *
  47          * @return string
  48          */
  49         public static function content(array $parameters = [])
  50         {
  51                 $o = '';
  52
  53                 return $o;
  54         }
  55
  56         /**
  57          * Module POST method to process submitted data
  58          *
  59          * Extend this method if the module is supposed to process POST requests.
  60          * Doesn't display any content
  61          */
  62         public static function post(array $parameters = [])
  63         {
  64                 // DI::baseurl()->redirect('module');
  65         }
  66
  67         /**
  68          * Called after post()
  69          *
  70          * Unknown purpose
  71          */
  72         public static function afterpost(array $parameters = [])
  73         {
  74         }
  75
  76         /*
  77          * Functions used to protect against Cross-Site Request Forgery
  78          * 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.
  79          * In this implementation, a security token is reusable (if the user submits a form, goes back and resubmits the form, maybe with small changes;
  80          * or if the security token is used for ajax-calls that happen several times), but only valid for a certain amout of time (3hours).
  81          * The "typename" seperates the security tokens of different types of forms. This could be relevant in the following case:
  82          *    A security token is used to protekt a link from CSRF (e.g. the "delete this profile"-link).
  83          *    If the new page contains by any chance external elements, then the used security token is exposed by the referrer.
  84          *    Actually, important actions should not be triggered by Links / GET-Requests at all, but somethimes they still are,
  85          *    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).
  86          */
  87         public static function getFormSecurityToken($typename = '')
  88         {
  89                 $a = DI::app();
  90
  91                 $timestamp = time();
  92                 $sec_hash = hash('whirlpool', $a->user['guid'] . $a->user['prvkey'] . session_id() . $timestamp . $typename);
  93
  94                 return $timestamp . '.' . $sec_hash;
  95         }
  96
  97         public static function checkFormSecurityToken($typename = '', $formname = 'form_security_token')
  98         {
  99                 $hash = null;
 100
 101                 if (!empty($_REQUEST[$formname])) {
 102                         /// @TODO Careful, not secured!
 103                         $hash = $_REQUEST[$formname];
 104                 }
 105
 106                 if (!empty($_SERVER['HTTP_X_CSRF_TOKEN'])) {
 107                         /// @TODO Careful, not secured!
 108                         $hash = $_SERVER['HTTP_X_CSRF_TOKEN'];
 109                 }
 110
 111                 if (empty($hash)) {
 112                         return false;
 113                 }
 114
 115                 $max_livetime = 10800; // 3 hours
 116
 117                 $a = DI::app();
 118
 119                 $x = explode('.', $hash);
 120                 if (time() > (intval($x[0]) + $max_livetime)) {
 121                         return false;
 122                 }
 123
 124                 $sec_hash = hash('whirlpool', $a->user['guid'] . $a->user['prvkey'] . session_id() . $x[0] . $typename);
 125
 126                 return ($sec_hash == $x[1]);
 127         }
 128
 129         public static function getFormSecurityStandardErrorMessage()
 130         {
 131                 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;
 132         }
 133
 134         public static function checkFormSecurityTokenRedirectOnError($err_redirect, $typename = '', $formname = 'form_security_token')
 135         {
 136                 if (!self::checkFormSecurityToken($typename, $formname)) {
 137                         $a = DI::app();
 138                         Logger::log('checkFormSecurityToken failed: user ' . $a->user['guid'] . ' - form element ' . $typename);
 139                         Logger::log('checkFormSecurityToken failed: _REQUEST data: ' . print_r($_REQUEST, true), Logger::DATA);
 140                         notice(self::getFormSecurityStandardErrorMessage());
 141                         DI::baseUrl()->redirect($err_redirect);
 142                 }
 143         }
 144
 145         public static function checkFormSecurityTokenForbiddenOnError($typename = '', $formname = 'form_security_token')
 146         {
 147                 if (!self::checkFormSecurityToken($typename, $formname)) {
 148                         $a = DI::app();
 149                         Logger::log('checkFormSecurityToken failed: user ' . $a->user['guid'] . ' - form element ' . $typename);
 150                         Logger::log('checkFormSecurityToken failed: _REQUEST data: ' . print_r($_REQUEST, true), Logger::DATA);
 151
 152                         throw new \Friendica\Network\HTTPException\ForbiddenException();
 153                 }
 154         }
 155 }