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\DBA;
12 use Friendica\Model\Contact;
13 use Friendica\Model\Group;
14 use Friendica\Util\DateTimeFormat;
15 use Friendica\Model\PermissionSet;
18 * @brief Calculate the hash that is needed for the "Friendica" cookie
20 * @param array $user Record from "user" table
22 * @return string Hashed data
24 function cookie_hash($user)
26 return(hash("sha256", Config::get("system", "site_prvkey") .
32 * @brief Set the "Friendica" cookie
35 * @param array $user Record from "user" table
37 function new_cookie($time, $user = [])
40 $time = $time + time();
44 $value = json_encode(["uid" => $user["uid"],
45 "hash" => cookie_hash($user),
46 "ip" => defaults($_SERVER, 'REMOTE_ADDR', '0.0.0.0')]);
51 setcookie("Friendica", $value, $time, "/", "", (Config::get('system', 'ssl_policy') == SSL_POLICY_FULL), true);
55 * @brief Sets the provided user's authenticated session
57 * @todo Should be moved to Friendica\Core\Session once it's created
59 * @param type $user_record
60 * @param type $login_initial
61 * @param type $interactive
62 * @param type $login_refresh
64 function authenticate_success($user_record, $login_initial = false, $interactive = false, $login_refresh = false)
68 $_SESSION['uid'] = $user_record['uid'];
69 $_SESSION['theme'] = $user_record['theme'];
70 $_SESSION['mobile-theme'] = PConfig::get($user_record['uid'], 'system', 'mobile_theme');
71 $_SESSION['authenticated'] = 1;
72 $_SESSION['page_flags'] = $user_record['page-flags'];
73 $_SESSION['my_url'] = System::baseUrl() . '/profile/' . $user_record['nickname'];
74 $_SESSION['my_address'] = $user_record['nickname'] . '@' . substr(System::baseUrl(), strpos(System::baseUrl(), '://') + 3);
75 $_SESSION['addr'] = defaults($_SERVER, 'REMOTE_ADDR', '0.0.0.0');
77 $a->user = $user_record;
80 if ($a->user['login_date'] <= NULL_DATE) {
81 $_SESSION['return_url'] = 'profile_photo/new';
82 $a->module = 'profile_photo';
83 info(L10n::t("Welcome ") . $a->user['username'] . EOL);
84 info(L10n::t('Please upload a profile photo.') . EOL);
86 info(L10n::t("Welcome back ") . $a->user['username'] . EOL);
90 $member_since = strtotime($a->user['register_date']);
91 if (time() < ($member_since + ( 60 * 60 * 24 * 14))) {
92 $_SESSION['new_member'] = true;
94 $_SESSION['new_member'] = false;
96 if (strlen($a->user['timezone'])) {
97 date_default_timezone_set($a->user['timezone']);
98 $a->timezone = $a->user['timezone'];
101 $master_record = $a->user;
103 if ((x($_SESSION, 'submanage')) && intval($_SESSION['submanage'])) {
104 $user = DBA::selectFirst('user', [], ['uid' => $_SESSION['submanage']]);
105 if (DBA::isResult($user)) {
106 $master_record = $user;
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 (DBA::isResult($r)) {
120 $a->identities = array_merge($a->identities, DBA::toArray($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 (DBA::isResult($r)) {
130 $a->identities = DBA::toArray($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 (DBA::isResult($r)) {
137 $a->identities = array_merge($a->identities, DBA::toArray($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 (DBA::isResult($r)) {
148 $a->identities = array_merge($a->identities, DBA::toArray($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 $contact = DBA::selectFirst('contact', [], ['uid' => $_SESSION['uid'], 'self' => true]);
159 if (DBA::isResult($contact)) {
160 $a->contact = $contact;
161 $a->cid = $contact['id'];
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) {
177 * If the user specified to remember the authentication, then set a cookie
178 * that expires after one week (the default is when the browser is closed).
179 * The cookie will be renewed automatically.
180 * The week ensures that sessions will expire after some inactivity.
182 if (!empty($_SESSION['remember'])) {
183 logger('Injecting cookie for remembered user ' . $a->user['nickname']);
184 new_cookie(604800, $user_record);
185 unset($_SESSION['remember']);
189 if ($login_initial) {
190 Addon::callHooks('logged_in', $a->user);
192 if (($a->module !== 'home') && isset($_SESSION['return_url'])) {
193 goaway(System::baseUrl() . '/' . $_SESSION['return_url']);
198 function can_write_wall($owner)
200 static $verified = 0;
202 if (!local_user() && !remote_user()) {
207 if ($uid == $owner) {
211 if (local_user() && ($owner == 0)) {
216 // use remembered decision and avoid a DB lookup for each and every display item
217 // DO NOT use this function if there are going to be multiple owners
218 // We have a contact-id for an authenticated remote user, this block determines if the contact
219 // belongs to this page owner, and has the necessary permissions to post content
221 if ($verified === 2) {
223 } elseif ($verified === 1) {
228 if (!empty($_SESSION['remote'])) {
229 foreach ($_SESSION['remote'] as $visitor) {
230 if ($visitor['uid'] == $owner) {
231 $cid = $visitor['cid'];
241 $r = q("SELECT `contact`.*, `user`.`page-flags` FROM `contact` INNER JOIN `user` on `user`.`uid` = `contact`.`uid`
242 WHERE `contact`.`uid` = %d AND `contact`.`id` = %d AND `contact`.`blocked` = 0 AND `contact`.`pending` = 0
243 AND `user`.`blockwall` = 0 AND `readonly` = 0 AND ( `contact`.`rel` IN ( %d , %d ) OR `user`.`page-flags` = %d ) LIMIT 1",
246 intval(Contact::SHARING),
247 intval(Contact::FRIEND),
248 intval(Contact::PAGE_COMMUNITY)
251 if (DBA::isResult($r)) {
263 /// @TODO $groups should be array
264 function permissions_sql($owner_id, $remote_verified = false, $groups = null)
266 $local_user = local_user();
267 $remote_user = remote_user();
270 * Construct permissions
272 * default permissions - anonymous user
274 $sql = " AND allow_cid = ''
281 * Profile owner - everything is visible
283 if ($local_user && $local_user == $owner_id) {
286 * Authenticated visitor. Unless pre-verified,
287 * check that the contact belongs to this $owner_id
288 * and load the groups the visitor belongs to.
289 * If pre-verified, the caller is expected to have already
290 * done this and passed the groups into this function.
292 } elseif ($remote_user) {
294 * Authenticated visitor. Unless pre-verified,
295 * check that the contact belongs to this $owner_id
296 * and load the groups the visitor belongs to.
297 * If pre-verified, the caller is expected to have already
298 * done this and passed the groups into this function.
301 if (!$remote_verified) {
302 if (DBA::exists('contact', ['id' => $remote_user, 'uid' => $owner_id, 'blocked' => false])) {
303 $remote_verified = true;
304 $groups = Group::getIdsByContactId($remote_user);
308 if ($remote_verified) {
309 $gs = '<<>>'; // should be impossible to match
311 if (is_array($groups)) {
312 foreach ($groups as $g) {
313 $gs .= '|<' . intval($g) . '>';
318 " AND ( NOT (deny_cid REGEXP '<%d>' OR deny_gid REGEXP '%s')
319 AND ( allow_cid REGEXP '<%d>' OR allow_gid REGEXP '%s' OR ( allow_cid = '' AND allow_gid = '') )
322 intval($remote_user),
324 intval($remote_user),
332 function item_permissions_sql($owner_id, $remote_verified = false, $groups = null)
334 $local_user = local_user();
335 $remote_user = remote_user();
338 * Construct permissions
340 * default permissions - anonymous user
342 $sql = " AND NOT `item`.`private`";
344 // Profile owner - everything is visible
345 if ($local_user && ($local_user == $owner_id)) {
347 } elseif ($remote_user) {
349 * Authenticated visitor. Unless pre-verified,
350 * check that the contact belongs to this $owner_id
351 * and load the groups the visitor belongs to.
352 * If pre-verified, the caller is expected to have already
353 * done this and passed the groups into this function.
355 $set = PermissionSet::get($owner_id, $remote_user, $groups);
358 $sql_set = " OR (`item`.`private` IN (1,2) AND `item`.`wall` AND `item`.`psid` IN (" . implode(',', $set) . "))";
363 $sql = " AND (NOT `item`.`private`" . $sql_set . ")";
370 * Functions used to protect against Cross-Site Request Forgery
371 * 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.
372 * In this implementation, a security token is reusable (if the user submits a form, goes back and resubmits the form, maybe with small changes;
373 * or if the security token is used for ajax-calls that happen several times), but only valid for a certain amout of time (3hours).
374 * The "typename" seperates the security tokens of different types of forms. This could be relevant in the following case:
375 * A security token is used to protekt a link from CSRF (e.g. the "delete this profile"-link).
376 * If the new page contains by any chance external elements, then the used security token is exposed by the referrer.
377 * Actually, important actions should not be triggered by Links / GET-Requests at all, but somethimes they still are,
378 * 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).
380 function get_form_security_token($typename = '')
385 $sec_hash = hash('whirlpool', $a->user['guid'] . $a->user['prvkey'] . session_id() . $timestamp . $typename);
387 return $timestamp . '.' . $sec_hash;
390 function check_form_security_token($typename = '', $formname = 'form_security_token')
394 if (!empty($_REQUEST[$formname])) {
395 /// @TODO Careful, not secured!
396 $hash = $_REQUEST[$formname];
399 if (!empty($_SERVER['HTTP_X_CSRF_TOKEN'])) {
400 /// @TODO Careful, not secured!
401 $hash = $_SERVER['HTTP_X_CSRF_TOKEN'];
408 $max_livetime = 10800; // 3 hours
412 $x = explode('.', $hash);
413 if (time() > (IntVal($x[0]) + $max_livetime)) {
417 $sec_hash = hash('whirlpool', $a->user['guid'] . $a->user['prvkey'] . session_id() . $x[0] . $typename);
419 return ($sec_hash == $x[1]);
422 function check_form_security_std_err_msg()
424 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;
427 function check_form_security_token_redirectOnErr($err_redirect, $typename = '', $formname = 'form_security_token')
429 if (!check_form_security_token($typename, $formname)) {
431 logger('check_form_security_token failed: user ' . $a->user['guid'] . ' - form element ' . $typename);
432 logger('check_form_security_token failed: _REQUEST data: ' . print_r($_REQUEST, true), LOGGER_DATA);
433 notice(check_form_security_std_err_msg());
434 goaway(System::baseUrl() . $err_redirect);
438 function check_form_security_token_ForbiddenOnErr($typename = '', $formname = 'form_security_token')
440 if (!check_form_security_token($typename, $formname)) {
442 logger('check_form_security_token failed: user ' . $a->user['guid'] . ' - form element ' . $typename);
443 logger('check_form_security_token failed: _REQUEST data: ' . print_r($_REQUEST, true), LOGGER_DATA);
444 header('HTTP/1.1 403 Forbidden');
450 * @brief Kills the "Friendica" cookie and all session data
452 function nuke_session()
454 new_cookie(-3600); // make sure cookie is deleted on browser close, as a security measure