src/BaseModule.php

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