3 * @file include/security.php
6 use Friendica\Core\Addon;
7 use Friendica\Core\Config;
8 use Friendica\Core\L10n;
9 use Friendica\Core\PConfig;
10 use Friendica\Core\System;
11 use Friendica\Database\DBM;
12 use Friendica\Model\Group;
13 use Friendica\Util\DateTimeFormat;
16 * @brief Calculate the hash that is needed for the "Friendica" cookie
18 * @param array $user Record from "user" table
20 * @return string Hashed data
22 function cookie_hash($user)
24 return(hash("sha256", Config::get("system", "site_prvkey") .
30 * @brief Set the "Friendica" cookie
33 * @param array $user Record from "user" table
35 function new_cookie($time, $user = [])
38 $time = $time + time();
42 $value = json_encode(["uid" => $user["uid"],
43 "hash" => cookie_hash($user),
44 "ip" => $_SERVER['REMOTE_ADDR']]);
49 setcookie("Friendica", $value, $time, "/", "", (Config::get('system', 'ssl_policy') == SSL_POLICY_FULL), true);
53 * @brief Sets the provided user's authenticated session
55 * @todo Should be moved to Friendica\Core\Session once it's created
57 * @param type $user_record
58 * @param type $login_initial
59 * @param type $interactive
60 * @param type $login_refresh
62 function authenticate_success($user_record, $login_initial = false, $interactive = false, $login_refresh = false)
66 $_SESSION['uid'] = $user_record['uid'];
67 $_SESSION['theme'] = $user_record['theme'];
68 $_SESSION['mobile-theme'] = PConfig::get($user_record['uid'], 'system', 'mobile_theme');
69 $_SESSION['authenticated'] = 1;
70 $_SESSION['page_flags'] = $user_record['page-flags'];
71 $_SESSION['my_url'] = System::baseUrl() . '/profile/' . $user_record['nickname'];
72 $_SESSION['my_address'] = $user_record['nickname'] . '@' . substr(System::baseUrl(), strpos(System::baseUrl(), '://') + 3);
73 $_SESSION['addr'] = $_SERVER['REMOTE_ADDR'];
75 $a->user = $user_record;
78 if ($a->user['login_date'] <= NULL_DATE) {
79 $_SESSION['return_url'] = 'profile_photo/new';
80 $a->module = 'profile_photo';
81 info(L10n::t("Welcome ") . $a->user['username'] . EOL);
82 info(L10n::t('Please upload a profile photo.') . EOL);
84 info(L10n::t("Welcome back ") . $a->user['username'] . EOL);
88 $member_since = strtotime($a->user['register_date']);
89 if (time() < ($member_since + ( 60 * 60 * 24 * 14))) {
90 $_SESSION['new_member'] = true;
92 $_SESSION['new_member'] = false;
94 if (strlen($a->user['timezone'])) {
95 date_default_timezone_set($a->user['timezone']);
96 $a->timezone = $a->user['timezone'];
99 $master_record = $a->user;
101 if ((x($_SESSION, 'submanage')) && intval($_SESSION['submanage'])) {
102 $r = dba::fetch_first("SELECT * FROM `user` WHERE `uid` = ? LIMIT 1",
103 intval($_SESSION['submanage'])
105 if (DBM::is_result($r)) {
110 if ($master_record['parent-uid'] == 0) {
111 // First add our own entry
112 $a->identities = [['uid' => $master_record['uid'],
113 'username' => $master_record['username'],
114 'nickname' => $master_record['nickname']]];
116 // Then add all the children
117 $r = dba::select('user', ['uid', 'username', 'nickname'],
118 ['parent-uid' => $master_record['uid'], 'account_removed' => false]);
119 if (DBM::is_result($r)) {
120 $a->identities = array_merge($a->identities, dba::inArray($r));
123 // Just ensure that the array is always defined
126 // First entry is our parent
127 $r = dba::select('user', ['uid', 'username', 'nickname'],
128 ['uid' => $master_record['parent-uid'], 'account_removed' => false]);
129 if (DBM::is_result($r)) {
130 $a->identities = dba::inArray($r);
133 // Then add all siblings
134 $r = dba::select('user', ['uid', 'username', 'nickname'],
135 ['parent-uid' => $master_record['parent-uid'], 'account_removed' => false]);
136 if (DBM::is_result($r)) {
137 $a->identities = array_merge($a->identities, dba::inArray($r));
141 $r = dba::p("SELECT `user`.`uid`, `user`.`username`, `user`.`nickname`
143 INNER JOIN `user` ON `manage`.`mid` = `user`.`uid`
144 WHERE `user`.`account_removed` = 0 AND `manage`.`uid` = ?",
145 $master_record['uid']
147 if (DBM::is_result($r)) {
148 $a->identities = array_merge($a->identities, dba::inArray($r));
151 if ($login_initial) {
152 logger('auth_identities: ' . print_r($a->identities, true), LOGGER_DEBUG);
154 if ($login_refresh) {
155 logger('auth_identities refresh: ' . print_r($a->identities, true), LOGGER_DEBUG);
158 $r = dba::fetch_first("SELECT * FROM `contact` WHERE `uid` = ? AND `self` LIMIT 1", $_SESSION['uid']);
159 if (DBM::is_result($r)) {
162 $_SESSION['cid'] = $a->cid;
165 header('X-Account-Management-Status: active; name="' . $a->user['username'] . '"; id="' . $a->user['nickname'] . '"');
167 if ($login_initial || $login_refresh) {
168 dba::update('user', ['login_date' => DateTimeFormat::utcNow()], ['uid' => $_SESSION['uid']]);
170 // Set the login date for all identities of the user
171 dba::update('user', ['login_date' => DateTimeFormat::utcNow()],
172 ['parent-uid' => $master_record['uid'], 'account_removed' => false]);
175 if ($login_initial) {
176 // If the user specified to remember the authentication, then set a cookie
177 // that expires after one week (the default is when the browser is closed).
178 // The cookie will be renewed automatically.
179 // The week ensures that sessions will expire after some inactivity.
180 if ($_SESSION['remember']) {
181 logger('Injecting cookie for remembered user ' . $_SESSION['remember_user']['nickname']);
182 new_cookie(604800, $user_record);
183 unset($_SESSION['remember']);
187 if ($login_initial) {
188 Addon::callHooks('logged_in', $a->user);
190 if (($a->module !== 'home') && isset($_SESSION['return_url'])) {
191 goaway(System::baseUrl() . '/' . $_SESSION['return_url']);
196 function can_write_wall($owner)
198 static $verified = 0;
200 if (!local_user() && !remote_user()) {
205 if ($uid == $owner) {
210 // use remembered decision and avoid a DB lookup for each and every display item
211 // DO NOT use this function if there are going to be multiple owners
212 // We have a contact-id for an authenticated remote user, this block determines if the contact
213 // belongs to this page owner, and has the necessary permissions to post content
215 if ($verified === 2) {
217 } elseif ($verified === 1) {
222 if (is_array($_SESSION['remote'])) {
223 foreach ($_SESSION['remote'] as $visitor) {
224 if ($visitor['uid'] == $owner) {
225 $cid = $visitor['cid'];
235 $r = q("SELECT `contact`.*, `user`.`page-flags` FROM `contact` INNER JOIN `user` on `user`.`uid` = `contact`.`uid`
236 WHERE `contact`.`uid` = %d AND `contact`.`id` = %d AND `contact`.`blocked` = 0 AND `contact`.`pending` = 0
237 AND `user`.`blockwall` = 0 AND `readonly` = 0 AND ( `contact`.`rel` IN ( %d , %d ) OR `user`.`page-flags` = %d ) LIMIT 1",
240 intval(CONTACT_IS_SHARING),
241 intval(CONTACT_IS_FRIEND),
242 intval(PAGE_COMMUNITY)
245 if (DBM::is_result($r)) {
257 function permissions_sql($owner_id, $remote_verified = false, $groups = null)
259 $local_user = local_user();
260 $remote_user = remote_user();
263 * Construct permissions
265 * default permissions - anonymous user
267 $sql = " AND allow_cid = ''
274 * Profile owner - everything is visible
276 if ($local_user && $local_user == $owner_id) {
278 } elseif ($remote_user) {
280 * Authenticated visitor. Unless pre-verified,
281 * check that the contact belongs to this $owner_id
282 * and load the groups the visitor belongs to.
283 * If pre-verified, the caller is expected to have already
284 * done this and passed the groups into this function.
287 if (!$remote_verified) {
288 $r = q("SELECT id FROM contact WHERE id = %d AND uid = %d AND blocked = 0 LIMIT 1",
289 intval($remote_user),
292 if (DBM::is_result($r)) {
293 $remote_verified = true;
294 $groups = Group::getIdsByContactId($remote_user);
298 if ($remote_verified) {
299 $gs = '<<>>'; // should be impossible to match
301 if (is_array($groups) && count($groups)) {
302 foreach ($groups as $g) {
303 $gs .= '|<' . intval($g) . '>';
308 " AND ( NOT (deny_cid REGEXP '<%d>' OR deny_gid REGEXP '%s')
309 AND ( allow_cid REGEXP '<%d>' OR allow_gid REGEXP '%s' OR ( allow_cid = '' AND allow_gid = '') )
312 intval($remote_user),
314 intval($remote_user),
322 function item_permissions_sql($owner_id, $remote_verified = false, $groups = null)
324 $local_user = local_user();
325 $remote_user = remote_user();
328 * Construct permissions
330 * default permissions - anonymous user
332 $sql = " AND `item`.allow_cid = ''
333 AND `item`.allow_gid = ''
334 AND `item`.deny_cid = ''
335 AND `item`.deny_gid = ''
336 AND `item`.private = 0
339 // Profile owner - everything is visible
340 if ($local_user && ($local_user == $owner_id)) {
342 } elseif ($remote_user) {
344 * Authenticated visitor. Unless pre-verified,
345 * check that the contact belongs to this $owner_id
346 * and load the groups the visitor belongs to.
347 * If pre-verified, the caller is expected to have already
348 * done this and passed the groups into this function.
350 if (!$remote_verified) {
351 $r = q("SELECT id FROM contact WHERE id = %d AND uid = %d AND blocked = 0 LIMIT 1",
352 intval($remote_user),
355 if (DBM::is_result($r)) {
356 $remote_verified = true;
357 $groups = Group::getIdsByContactId($remote_user);
360 if ($remote_verified) {
362 $gs = '<<>>'; // should be impossible to match
364 if (is_array($groups) && count($groups)) {
365 foreach ($groups as $g) {
366 $gs .= '|<' . intval($g) . '>';
371 " AND ( `item`.private = 0 OR ( `item`.private in (1,2) AND `item`.`wall` = 1
372 AND ( NOT (`item`.deny_cid REGEXP '<%d>' OR `item`.deny_gid REGEXP '%s')
373 AND ( `item`.allow_cid REGEXP '<%d>' OR `item`.allow_gid REGEXP '%s' OR ( `item`.allow_cid = '' AND `item`.allow_gid = '')))))
375 intval($remote_user),
377 intval($remote_user),
387 * Functions used to protect against Cross-Site Request Forgery
388 * 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.
389 * In this implementation, a security token is reusable (if the user submits a form, goes back and resubmits the form, maybe with small changes;
390 * or if the security token is used for ajax-calls that happen several times), but only valid for a certain amout of time (3hours).
391 * The "typename" seperates the security tokens of different types of forms. This could be relevant in the following case:
392 * A security token is used to protekt a link from CSRF (e.g. the "delete this profile"-link).
393 * If the new page contains by any chance external elements, then the used security token is exposed by the referrer.
394 * Actually, important actions should not be triggered by Links / GET-Requests at all, but somethimes they still are,
395 * 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).
397 function get_form_security_token($typename = '')
402 $sec_hash = hash('whirlpool', $a->user['guid'] . $a->user['prvkey'] . session_id() . $timestamp . $typename);
404 return $timestamp . '.' . $sec_hash;
407 function check_form_security_token($typename = '', $formname = 'form_security_token')
411 if (!empty($_REQUEST[$formname])) {
412 /// @TODO Careful, not secured!
413 $hash = $_REQUEST[$formname];
416 if (!empty($_SERVER['HTTP_X_CSRF_TOKEN'])) {
417 /// @TODO Careful, not secured!
418 $hash = $_SERVER['HTTP_X_CSRF_TOKEN'];
425 $max_livetime = 10800; // 3 hours
429 $x = explode('.', $hash);
430 if (time() > (IntVal($x[0]) + $max_livetime)) {
434 $sec_hash = hash('whirlpool', $a->user['guid'] . $a->user['prvkey'] . session_id() . $x[0] . $typename);
436 return ($sec_hash == $x[1]);
439 function check_form_security_std_err_msg()
441 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;
444 function check_form_security_token_redirectOnErr($err_redirect, $typename = '', $formname = 'form_security_token')
446 if (!check_form_security_token($typename, $formname)) {
448 logger('check_form_security_token failed: user ' . $a->user['guid'] . ' - form element ' . $typename);
449 logger('check_form_security_token failed: _REQUEST data: ' . print_r($_REQUEST, true), LOGGER_DATA);
450 notice(check_form_security_std_err_msg());
451 goaway(System::baseUrl() . $err_redirect);
455 function check_form_security_token_ForbiddenOnErr($typename = '', $formname = 'form_security_token')
457 if (!check_form_security_token($typename, $formname)) {
459 logger('check_form_security_token failed: user ' . $a->user['guid'] . ' - form element ' . $typename);
460 logger('check_form_security_token failed: _REQUEST data: ' . print_r($_REQUEST, true), LOGGER_DATA);
461 header('HTTP/1.1 403 Forbidden');
467 * @brief Kills the "Friendica" cookie and all session data
469 function nuke_session()
471 new_cookie(-3600); // make sure cookie is deleted on browser close, as a security measure