3 * @file mod/dfrn_confirm.php
4 * @brief Module: dfrn_confirm
5 * Purpose: Friendship acceptance for DFRN contacts
7 * There are two possible entry points and three scenarios.
9 * 1. A form was submitted by our user approving a friendship that originated elsewhere.
10 * This may also be called from dfrn_request to automatically approve a friendship.
12 * 2. We may be the target or other side of the conversation to scenario 1, and will
13 * interact with that process on our own user's behalf.
15 * @see PDF with dfrn specs: https://github.com/friendica/friendica/blob/master/spec/dfrn2.pdf
16 * You also find a graphic which describes the confirmation process at
17 * https://github.com/friendica/friendica/blob/master/spec/dfrn2_contact_confirmation.png
21 use Friendica\Core\Config;
22 use Friendica\Core\L10n;
23 use Friendica\Core\Logger;
24 use Friendica\Core\Protocol;
25 use Friendica\Core\System;
26 use Friendica\Database\DBA;
27 use Friendica\Model\Contact;
28 use Friendica\Model\Group;
29 use Friendica\Model\User;
30 use Friendica\Network\Probe;
31 use Friendica\Util\Crypto;
32 use Friendica\Util\DateTimeFormat;
33 use Friendica\Util\Network;
34 use Friendica\Util\Strings;
35 use Friendica\Util\XML;
37 function dfrn_confirm_post(App $a, $handsfree = null)
40 if (is_array($handsfree)) {
42 * We were called directly from dfrn_request due to automatic friend acceptance.
43 * Any $_POST parameters we may require are supplied in the $handsfree array.
46 $node = $handsfree['node'];
47 $a->interactive = false; // notice() becomes a no-op since nobody is there to see it
48 } elseif ($a->argc > 1) {
53 * Main entry point. Scenario 1. Our user received a friend request notification (perhaps
54 * from another site) and clicked 'Approve'.
55 * $POST['source_url'] is not set. If it is, it indicates Scenario 2.
57 * We may also have been called directly from dfrn_request ($handsfree != null) due to
58 * this being a page type which supports automatic friend acceptance. That is also Scenario 1
59 * since we are operating on behalf of our registered user to approve a friendship.
61 if (empty($_POST['source_url'])) {
62 $uid = defaults($handsfree, 'uid', local_user());
64 notice(L10n::t('Permission denied.') . EOL);
68 $user = DBA::selectFirst('user', [], ['uid' => $uid]);
69 if (!DBA::isResult($user)) {
70 notice(L10n::t('Profile not found.') . EOL);
74 // These data elements may come from either the friend request notification form or $handsfree array.
75 if (is_array($handsfree)) {
76 Logger::log('Confirm in handsfree mode');
77 $dfrn_id = $handsfree['dfrn_id'];
78 $intro_id = $handsfree['intro_id'];
79 $duplex = $handsfree['duplex'];
81 $hidden = intval(defaults($handsfree, 'hidden' , 0));
83 $dfrn_id = Strings::escapeTags(trim(defaults($_POST, 'dfrn_id' , '')));
84 $intro_id = intval(defaults($_POST, 'intro_id' , 0));
85 $duplex = intval(defaults($_POST, 'duplex' , 0));
86 $cid = intval(defaults($_POST, 'contact_id', 0));
87 $hidden = intval(defaults($_POST, 'hidden' , 0));
91 * Ensure that dfrn_id has precedence when we go to find the contact record.
92 * We only want to search based on contact id if there is no dfrn_id,
93 * e.g. for OStatus network followers.
95 if (strlen($dfrn_id)) {
99 Logger::log('Confirming request for dfrn_id (issued) ' . $dfrn_id);
101 Logger::log('Confirming follower with contact_id: ' . $cid);
105 * The other person will have been issued an ID when they first requested friendship.
106 * Locate their record. At this time, their record will have both pending and blocked set to 1.
107 * There won't be any dfrn_id if this is a network follower, so use the contact_id instead.
112 (`issued-id` != '' AND `issued-id` = '%s')
114 (`id` = %d AND `id` != 0)
119 DBA::escape($dfrn_id),
123 if (!DBA::isResult($r)) {
124 Logger::log('Contact not found in DB.');
125 notice(L10n::t('Contact not found.') . EOL);
126 notice(L10n::t('This may occasionally happen if contact was requested by both persons and it has already been approved.') . EOL);
132 $contact_id = $contact['id'];
133 $relation = $contact['rel'];
134 $site_pubkey = $contact['site-pubkey'];
135 $dfrn_confirm = $contact['confirm'];
136 $aes_allow = $contact['aes_allow'];
137 $protocol = $contact['network'];
140 * Generate a key pair for all further communications with this person.
141 * We have a keypair for every contact, and a site key for unknown people.
142 * This provides a means to carry on relationships with other people if
143 * any single key is compromised. It is a robust key. We're much more
144 * worried about key leakage than anybody cracking it.
146 $res = Crypto::newKeypair(4096);
148 $private_key = $res['prvkey'];
149 $public_key = $res['pubkey'];
151 // Save the private key. Send them the public key.
152 $fields = ['prvkey' => $private_key, 'protocol' => Protocol::DFRN];
153 DBA::update('contact', $fields, ['id' => $contact_id]);
158 * Per the DFRN protocol, we will verify both ends by encrypting the dfrn_id with our
159 * site private key (person on the other end can decrypt it with our site public key).
160 * Then encrypt our profile URL with the other person's site public key. They can decrypt
161 * it with their site private key. If the decryption on the other end fails for either
162 * item, it indicates tampering or key failure on at least one site and we will not be
163 * able to provide a secure communication pathway.
165 * If other site is willing to accept full encryption, (aes_allow is 1 AND we have php5.3
166 * or later) then we encrypt the personal public key we send them using AES-256-CBC and a
167 * random key which is encrypted with their site public key.
170 $src_aes_key = openssl_random_pseudo_bytes(64);
173 openssl_private_encrypt($dfrn_id, $result, $user['prvkey']);
175 $params['dfrn_id'] = bin2hex($result);
176 $params['public_key'] = $public_key;
178 $my_url = System::baseUrl() . '/profile/' . $user['nickname'];
180 openssl_public_encrypt($my_url, $params['source_url'], $site_pubkey);
181 $params['source_url'] = bin2hex($params['source_url']);
183 if ($aes_allow && function_exists('openssl_encrypt')) {
184 openssl_public_encrypt($src_aes_key, $params['aes_key'], $site_pubkey);
185 $params['aes_key'] = bin2hex($params['aes_key']);
186 $params['public_key'] = bin2hex(openssl_encrypt($public_key, 'AES-256-CBC', $src_aes_key));
189 $params['dfrn_version'] = DFRN_PROTOCOL_VERSION;
191 $params['duplex'] = 1;
194 if ($user['page-flags'] == User::PAGE_FLAGS_COMMUNITY) {
198 if ($user['page-flags'] == User::PAGE_FLAGS_PRVGROUP) {
202 Logger::log('Confirm: posting data to ' . $dfrn_confirm . ': ' . print_r($params, true), Logger::DATA);
206 * POST all this stuff to the other site.
207 * Temporarily raise the network timeout to 120 seconds because the default 60
208 * doesn't always give the other side quite enough time to decrypt everything.
212 $res = Network::post($dfrn_confirm, $params, [], 120)->getBody();
214 Logger::log(' Confirm: received data: ' . $res, Logger::DATA);
216 // Now figure out what they responded. Try to be robust if the remote site is
217 // having difficulty and throwing up errors of some kind.
219 $leading_junk = substr($res, 0, strpos($res, '<?xml'));
221 $res = substr($res, strpos($res, '<?xml'));
223 // No XML at all, this exchange is messed up really bad.
224 // We shouldn't proceed, because the xml parser might choke,
225 // and $status is going to be zero, which indicates success.
226 // We can hardly call this a success.
227 notice(L10n::t('Response from remote site was not understood.') . EOL);
231 if (strlen($leading_junk) && Config::get('system', 'debugging')) {
232 // This might be more common. Mixed error text and some XML.
233 // If we're configured for debugging, show the text. Proceed in either case.
234 notice(L10n::t('Unexpected response from remote site: ') . EOL . $leading_junk . EOL);
237 if (stristr($res, "<status") === false) {
238 // wrong xml! stop here!
239 Logger::log('Unexpected response posting to ' . $dfrn_confirm);
240 notice(L10n::t('Unexpected response from remote site: ') . EOL . htmlspecialchars($res) . EOL);
244 $xml = XML::parseString($res);
245 $status = (int) $xml->status;
246 $message = XML::unescape($xml->message); // human readable text of what may have gone wrong.
249 info(L10n::t("Confirmation completed successfully.") . EOL);
252 // birthday paradox - generate new dfrn-id and fall through.
253 $new_dfrn_id = Strings::getRandomHex();
254 q("UPDATE contact SET `issued-id` = '%s' WHERE `id` = %d AND `uid` = %d",
255 DBA::escape($new_dfrn_id),
261 notice(L10n::t("Temporary failure. Please wait and try again.") . EOL);
264 notice(L10n::t("Introduction failed or was revoked.") . EOL);
268 if (strlen($message)) {
269 notice(L10n::t('Remote site reported: ') . $message . EOL);
272 if (($status == 0) && $intro_id) {
273 $intro = DBA::selectFirst('intro', ['note'], ['id' => $intro_id]);
274 if (DBA::isResult($intro)) {
275 DBA::update('contact', ['reason' => $intro['note']], ['id' => $contact_id]);
278 // Success. Delete the notification.
279 DBA::delete('intro', ['id' => $intro_id]);
287 * We have now established a relationship with the other site.
288 * Let's make our own personal copy of their profile photo so we don't have
289 * to always load it from their site.
291 * We will also update the contact record with the nature and scope of the relationship.
293 Contact::updateAvatar($contact['photo'], $uid, $contact_id);
295 Logger::log('dfrn_confirm: confirm - imported photos');
297 $new_relation = Contact::FOLLOWER;
299 if (($relation == Contact::SHARING) || ($duplex)) {
300 $new_relation = Contact::FRIEND;
303 if (($relation == Contact::SHARING) && ($duplex)) {
307 $r = q("UPDATE `contact` SET `rel` = %d,
314 `network` = '%s' WHERE `id` = %d
316 intval($new_relation),
317 DBA::escape(DateTimeFormat::utcNow()),
318 DBA::escape(DateTimeFormat::utcNow()),
321 DBA::escape(Protocol::DFRN),
325 // reload contact info
326 $contact = DBA::selectFirst('contact', [], ['id' => $contact_id]);
328 Group::addMember(User::getDefaultGroup($uid, $contact["network"]), $contact['id']);
330 // Let's send our user to the contact editor in case they want to
331 // do anything special with this new friend.
332 if ($handsfree === null) {
333 $a->internalRedirect('contact/' . intval($contact_id));
341 * End of Scenario 1. [Local confirmation of remote friend request].
343 * Begin Scenario 2. This is the remote response to the above scenario.
344 * This will take place on the site that originally initiated the friend request.
345 * In the section above where the confirming party makes a POST and
346 * retrieves xml status information, they are communicating with the following code.
348 if (!empty($_POST['source_url'])) {
349 // We are processing an external confirmation to an introduction created by our user.
350 $public_key = defaults($_POST, 'public_key', '');
351 $dfrn_id = hex2bin(defaults($_POST, 'dfrn_id' , ''));
352 $source_url = hex2bin(defaults($_POST, 'source_url', ''));
353 $aes_key = defaults($_POST, 'aes_key' , '');
354 $duplex = intval(defaults($_POST, 'duplex' , 0));
355 $page = intval(defaults($_POST, 'page' , 0));
357 $forum = (($page == 1) ? 1 : 0);
358 $prv = (($page == 2) ? 1 : 0);
360 Logger::log('dfrn_confirm: requestee contacted: ' . $node);
362 Logger::log('dfrn_confirm: request: POST=' . print_r($_POST, true), Logger::DATA);
364 // If $aes_key is set, both of these items require unpacking from the hex transport encoding.
366 if (!empty($aes_key)) {
367 $aes_key = hex2bin($aes_key);
368 $public_key = hex2bin($public_key);
371 // Find our user's account
372 $user = DBA::selectFirst('user', [], ['nickname' => $node]);
373 if (!DBA::isResult($user)) {
374 $message = L10n::t('No user record found for \'%s\' ', $node);
375 System::xmlExit(3, $message); // failure
379 $my_prvkey = $user['prvkey'];
380 $local_uid = $user['uid'];
383 if (!strstr($my_prvkey, 'PRIVATE KEY')) {
384 $message = L10n::t('Our site encryption key is apparently messed up.');
385 System::xmlExit(3, $message);
390 $decrypted_source_url = "";
391 openssl_private_decrypt($source_url, $decrypted_source_url, $my_prvkey);
394 if (!strlen($decrypted_source_url)) {
395 $message = L10n::t('Empty site URL was provided or URL could not be decrypted by us.');
396 System::xmlExit(3, $message);
400 $contact = DBA::selectFirst('contact', [], ['url' => $decrypted_source_url, 'uid' => $local_uid]);
401 if (!DBA::isResult($contact)) {
402 if (strstr($decrypted_source_url, 'http:')) {
403 $newurl = str_replace('http:', 'https:', $decrypted_source_url);
405 $newurl = str_replace('https:', 'http:', $decrypted_source_url);
408 $contact = DBA::selectFirst('contact', [], ['url' => $newurl, 'uid' => $local_uid]);
409 if (!DBA::isResult($contact)) {
410 // this is either a bogus confirmation (?) or we deleted the original introduction.
411 $message = L10n::t('Contact record was not found for you on our site.');
412 System::xmlExit(3, $message);
413 return; // NOTREACHED
417 $relation = $contact['rel'];
419 // Decrypt all this stuff we just received
421 $foreign_pubkey = $contact['site-pubkey'];
422 $dfrn_record = $contact['id'];
424 if (!$foreign_pubkey) {
425 $message = L10n::t('Site public key not available in contact record for URL %s.', $decrypted_source_url);
426 System::xmlExit(3, $message);
429 $decrypted_dfrn_id = "";
430 openssl_public_decrypt($dfrn_id, $decrypted_dfrn_id, $foreign_pubkey);
432 if (strlen($aes_key)) {
433 $decrypted_aes_key = "";
434 openssl_private_decrypt($aes_key, $decrypted_aes_key, $my_prvkey);
435 $dfrn_pubkey = openssl_decrypt($public_key, 'AES-256-CBC', $decrypted_aes_key);
437 $dfrn_pubkey = $public_key;
440 if (DBA::exists('contact', ['dfrn-id' => $decrypted_dfrn_id])) {
441 $message = L10n::t('The ID provided by your system is a duplicate on our system. It should work if you try again.');
442 System::xmlExit(1, $message); // Birthday paradox - duplicate dfrn-id
446 $r = q("UPDATE `contact` SET `dfrn-id` = '%s', `pubkey` = '%s' WHERE `id` = %d",
447 DBA::escape($decrypted_dfrn_id),
448 DBA::escape($dfrn_pubkey),
451 if (!DBA::isResult($r)) {
452 $message = L10n::t('Unable to set your contact credentials on our system.');
453 System::xmlExit(3, $message);
456 // It's possible that the other person also requested friendship.
457 // If it is a duplex relationship, ditch the issued-id if one exists.
460 q("UPDATE `contact` SET `issued-id` = '' WHERE `id` = %d",
465 // We're good but now we have to scrape the profile photo and send notifications.
466 $contact = DBA::selectFirst('contact', ['photo'], ['id' => $dfrn_record]);
467 if (DBA::isResult($contact)) {
468 $photo = $contact['photo'];
470 $photo = System::baseUrl() . '/images/person-300.jpg';
473 Contact::updateAvatar($photo, $local_uid, $dfrn_record);
475 Logger::log('dfrn_confirm: request - photos imported');
477 $new_relation = Contact::SHARING;
479 if (($relation == Contact::FOLLOWER) || ($duplex)) {
480 $new_relation = Contact::FRIEND;
483 if (($relation == Contact::FOLLOWER) && ($duplex)) {
487 $r = q("UPDATE `contact` SET
496 `network` = '%s' WHERE `id` = %d
498 intval($new_relation),
499 DBA::escape(DateTimeFormat::utcNow()),
500 DBA::escape(DateTimeFormat::utcNow()),
504 DBA::escape(Protocol::DFRN),
507 if (!DBA::isResult($r)) { // indicates schema is messed up or total db failure
508 $message = L10n::t('Unable to update your contact profile details on our system');
509 System::xmlExit(3, $message);
512 // Otherwise everything seems to have worked and we are almost done. Yay!
513 // Send an email notification
515 Logger::log('dfrn_confirm: request: info updated');
518 $r = q("SELECT `contact`.*, `user`.*
520 LEFT JOIN `user` ON `contact`.`uid` = `user`.`uid`
521 WHERE `contact`.`id` = %d
525 if (DBA::isResult($r)) {
528 if ($combined['notify-flags'] & NOTIFY_CONFIRM) {
529 $mutual = ($new_relation == Contact::FRIEND);
531 'type' => NOTIFY_CONFIRM,
532 'notify_flags' => $combined['notify-flags'],
533 'language' => $combined['language'],
534 'to_name' => $combined['username'],
535 'to_email' => $combined['email'],
536 'uid' => $combined['uid'],
537 'link' => System::baseUrl() . '/contact/' . $dfrn_record,
538 'source_name' => ((strlen(stripslashes($combined['name']))) ? stripslashes($combined['name']) : L10n::t('[Name Withheld]')),
539 'source_link' => $combined['url'],
540 'source_photo' => $combined['photo'],
541 'verb' => ($mutual?ACTIVITY_FRIEND:ACTIVITY_FOLLOW),
547 System::xmlExit(0); // Success
548 return; // NOTREACHED
549 ////////////////////// End of this scenario ///////////////////////////////////////////////
552 // somebody arrived here by mistake or they are fishing. Send them to the homepage.
553 $a->internalRedirect();