5 use Friendica\Core\Logger;
8 * All modules in Friendica should extend BaseModule, although not all modules
9 * need to extend all the methods described here
11 * The filename of the module in src/Module needs to match the class name
12 * exactly to make the module available.
14 * @author Hypolite Petovan <hypolite@mrpetovan.com>
16 abstract class BaseModule
19 * Initialization method common to both content() and post()
21 * Extend this method if you need to do any shared processing before both
24 public static function init(array $parameters = [])
29 * Module GET method to display raw content from technical endpoints
31 * Extend this method if the module is supposed to return communication data,
32 * e.g. from protocol implementations.
34 public static function rawContent(array $parameters = [])
41 * Module GET method to display any content
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.
49 public static function content(array $parameters = [])
57 * Module POST method to process submitted data
59 * Extend this method if the module is supposed to process POST requests.
60 * Doesn't display any content
62 public static function post(array $parameters = [])
64 // $a = self::getApp();
65 // $a->internalRedirect('module');
73 public static function afterpost(array $parameters = [])
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).
88 public static function getFormSecurityToken($typename = '')
93 $sec_hash = hash('whirlpool', $a->user['guid'] . $a->user['prvkey'] . session_id() . $timestamp . $typename);
95 return $timestamp . '.' . $sec_hash;
98 public static function checkFormSecurityToken($typename = '', $formname = 'form_security_token')
102 if (!empty($_REQUEST[$formname])) {
103 /// @TODO Careful, not secured!
104 $hash = $_REQUEST[$formname];
107 if (!empty($_SERVER['HTTP_X_CSRF_TOKEN'])) {
108 /// @TODO Careful, not secured!
109 $hash = $_SERVER['HTTP_X_CSRF_TOKEN'];
116 $max_livetime = 10800; // 3 hours
120 $x = explode('.', $hash);
121 if (time() > (intval($x[0]) + $max_livetime)) {
125 $sec_hash = hash('whirlpool', $a->user['guid'] . $a->user['prvkey'] . session_id() . $x[0] . $typename);
127 return ($sec_hash == $x[1]);
130 public static function getFormSecurityStandardErrorMessage()
132 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;
135 public static function checkFormSecurityTokenRedirectOnError($err_redirect, $typename = '', $formname = 'form_security_token')
137 if (!self::checkFormSecurityToken($typename, $formname)) {
139 Logger::log('checkFormSecurityToken failed: user ' . $a->user['guid'] . ' - form element ' . $typename);
140 Logger::log('checkFormSecurityToken failed: _REQUEST data: ' . print_r($_REQUEST, true), Logger::DATA);
141 notice(self::getFormSecurityStandardErrorMessage());
142 DI::baseUrl()->redirect($err_redirect);
146 public static function checkFormSecurityTokenForbiddenOnError($typename = '', $formname = 'form_security_token')
148 if (!self::checkFormSecurityToken($typename, $formname)) {
150 Logger::log('checkFormSecurityToken failed: user ' . $a->user['guid'] . ' - form element ' . $typename);
151 Logger::log('checkFormSecurityToken failed: _REQUEST data: ' . print_r($_REQUEST, true), Logger::DATA);
153 throw new \Friendica\Network\HTTPException\ForbiddenException();