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\APContact;
28 use Friendica\Model\Contact;
29 use Friendica\Model\Group;
30 use Friendica\Model\User;
31 use Friendica\Network\Probe;
32 use Friendica\Protocol\Diaspora;
33 use Friendica\Protocol\ActivityPub;
34 use Friendica\Util\Crypto;
35 use Friendica\Util\DateTimeFormat;
36 use Friendica\Util\Network;
37 use Friendica\Util\Strings;
38 use Friendica\Util\XML;
40 function dfrn_confirm_post(App $a, $handsfree = null)
43 if (is_array($handsfree)) {
45 * We were called directly from dfrn_request due to automatic friend acceptance.
46 * Any $_POST parameters we may require are supplied in the $handsfree array.
49 $node = $handsfree['node'];
50 $a->interactive = false; // notice() becomes a no-op since nobody is there to see it
51 } elseif ($a->argc > 1) {
56 * Main entry point. Scenario 1. Our user received a friend request notification (perhaps
57 * from another site) and clicked 'Approve'.
58 * $POST['source_url'] is not set. If it is, it indicates Scenario 2.
60 * We may also have been called directly from dfrn_request ($handsfree != null) due to
61 * this being a page type which supports automatic friend acceptance. That is also Scenario 1
62 * since we are operating on behalf of our registered user to approve a friendship.
64 if (empty($_POST['source_url'])) {
65 $uid = defaults($handsfree, 'uid', local_user());
67 notice(L10n::t('Permission denied.') . EOL);
71 $user = DBA::selectFirst('user', [], ['uid' => $uid]);
72 if (!DBA::isResult($user)) {
73 notice(L10n::t('Profile not found.') . EOL);
77 // These data elements may come from either the friend request notification form or $handsfree array.
78 if (is_array($handsfree)) {
79 Logger::log('Confirm in handsfree mode');
80 $dfrn_id = $handsfree['dfrn_id'];
81 $intro_id = $handsfree['intro_id'];
82 $duplex = $handsfree['duplex'];
84 $hidden = intval(defaults($handsfree, 'hidden' , 0));
86 $dfrn_id = Strings::escapeTags(trim(defaults($_POST, 'dfrn_id' , '')));
87 $intro_id = intval(defaults($_POST, 'intro_id' , 0));
88 $duplex = intval(defaults($_POST, 'duplex' , 0));
89 $cid = intval(defaults($_POST, 'contact_id', 0));
90 $hidden = intval(defaults($_POST, 'hidden' , 0));
94 * Ensure that dfrn_id has precedence when we go to find the contact record.
95 * We only want to search based on contact id if there is no dfrn_id,
96 * e.g. for OStatus network followers.
98 if (strlen($dfrn_id)) {
102 Logger::log('Confirming request for dfrn_id (issued) ' . $dfrn_id);
104 Logger::log('Confirming follower with contact_id: ' . $cid);
108 * The other person will have been issued an ID when they first requested friendship.
109 * Locate their record. At this time, their record will have both pending and blocked set to 1.
110 * There won't be any dfrn_id if this is a network follower, so use the contact_id instead.
115 (`issued-id` != '' AND `issued-id` = '%s')
117 (`id` = %d AND `id` != 0)
122 DBA::escape($dfrn_id),
126 if (!DBA::isResult($r)) {
127 Logger::log('Contact not found in DB.');
128 notice(L10n::t('Contact not found.') . EOL);
129 notice(L10n::t('This may occasionally happen if contact was requested by both persons and it has already been approved.') . EOL);
135 $contact_id = $contact['id'];
136 $relation = $contact['rel'];
137 $site_pubkey = $contact['site-pubkey'];
138 $dfrn_confirm = $contact['confirm'];
139 $aes_allow = $contact['aes_allow'];
141 $network = ((strlen($contact['issued-id'])) ? Protocol::DFRN : Protocol::OSTATUS);
143 if ($contact['network']) {
144 $network = $contact['network'];
147 // an empty DFRN-ID tells us that it had been a request via AP from a Friendica contact
148 if (($network === Protocol::DFRN) && empty($dfrn_id) && !empty($contact['hub-verify'])) {
149 $apcontact = APContact::getByURL($contact['url']);
150 if (!empty($apcontact)) {
151 $network = Protocol::ACTIVITYPUB;
155 if ($network === Protocol::DFRN) {
157 * Generate a key pair for all further communications with this person.
158 * We have a keypair for every contact, and a site key for unknown people.
159 * This provides a means to carry on relationships with other people if
160 * any single key is compromised. It is a robust key. We're much more
161 * worried about key leakage than anybody cracking it.
163 $res = Crypto::newKeypair(4096);
165 $private_key = $res['prvkey'];
166 $public_key = $res['pubkey'];
168 // Save the private key. Send them the public key.
169 q("UPDATE `contact` SET `prvkey` = '%s' WHERE `id` = %d AND `uid` = %d",
170 DBA::escape($private_key),
178 * Per the DFRN protocol, we will verify both ends by encrypting the dfrn_id with our
179 * site private key (person on the other end can decrypt it with our site public key).
180 * Then encrypt our profile URL with the other person's site public key. They can decrypt
181 * it with their site private key. If the decryption on the other end fails for either
182 * item, it indicates tampering or key failure on at least one site and we will not be
183 * able to provide a secure communication pathway.
185 * If other site is willing to accept full encryption, (aes_allow is 1 AND we have php5.3
186 * or later) then we encrypt the personal public key we send them using AES-256-CBC and a
187 * random key which is encrypted with their site public key.
190 $src_aes_key = openssl_random_pseudo_bytes(64);
193 openssl_private_encrypt($dfrn_id, $result, $user['prvkey']);
195 $params['dfrn_id'] = bin2hex($result);
196 $params['public_key'] = $public_key;
198 $my_url = System::baseUrl() . '/profile/' . $user['nickname'];
200 openssl_public_encrypt($my_url, $params['source_url'], $site_pubkey);
201 $params['source_url'] = bin2hex($params['source_url']);
203 if ($aes_allow && function_exists('openssl_encrypt')) {
204 openssl_public_encrypt($src_aes_key, $params['aes_key'], $site_pubkey);
205 $params['aes_key'] = bin2hex($params['aes_key']);
206 $params['public_key'] = bin2hex(openssl_encrypt($public_key, 'AES-256-CBC', $src_aes_key));
209 $params['dfrn_version'] = DFRN_PROTOCOL_VERSION;
211 $params['duplex'] = 1;
214 if ($user['page-flags'] == User::PAGE_FLAGS_COMMUNITY) {
218 if ($user['page-flags'] == User::PAGE_FLAGS_PRVGROUP) {
222 Logger::log('Confirm: posting data to ' . $dfrn_confirm . ': ' . print_r($params, true), Logger::DATA);
226 * POST all this stuff to the other site.
227 * Temporarily raise the network timeout to 120 seconds because the default 60
228 * doesn't always give the other side quite enough time to decrypt everything.
232 $res = Network::post($dfrn_confirm, $params, null, $redirects, 120)->getBody();
234 Logger::log(' Confirm: received data: ' . $res, Logger::DATA);
236 // Now figure out what they responded. Try to be robust if the remote site is
237 // having difficulty and throwing up errors of some kind.
239 $leading_junk = substr($res, 0, strpos($res, '<?xml'));
241 $res = substr($res, strpos($res, '<?xml'));
243 // No XML at all, this exchange is messed up really bad.
244 // We shouldn't proceed, because the xml parser might choke,
245 // and $status is going to be zero, which indicates success.
246 // We can hardly call this a success.
247 notice(L10n::t('Response from remote site was not understood.') . EOL);
251 if (strlen($leading_junk) && Config::get('system', 'debugging')) {
252 // This might be more common. Mixed error text and some XML.
253 // If we're configured for debugging, show the text. Proceed in either case.
254 notice(L10n::t('Unexpected response from remote site: ') . EOL . $leading_junk . EOL);
257 if (stristr($res, "<status") === false) {
258 // wrong xml! stop here!
259 Logger::log('Unexpected response posting to ' . $dfrn_confirm);
260 notice(L10n::t('Unexpected response from remote site: ') . EOL . htmlspecialchars($res) . EOL);
264 $xml = XML::parseString($res);
265 $status = (int) $xml->status;
266 $message = XML::unescape($xml->message); // human readable text of what may have gone wrong.
269 info(L10n::t("Confirmation completed successfully.") . EOL);
272 // birthday paradox - generate new dfrn-id and fall through.
273 $new_dfrn_id = Strings::getRandomHex();
274 q("UPDATE contact SET `issued-id` = '%s' WHERE `id` = %d AND `uid` = %d",
275 DBA::escape($new_dfrn_id),
281 notice(L10n::t("Temporary failure. Please wait and try again.") . EOL);
284 notice(L10n::t("Introduction failed or was revoked.") . EOL);
288 if (strlen($message)) {
289 notice(L10n::t('Remote site reported: ') . $message . EOL);
292 if (($status == 0) && $intro_id) {
293 $intro = DBA::selectFirst('intro', ['note'], ['id' => $intro_id]);
294 if (DBA::isResult($intro)) {
295 DBA::update('contact', ['reason' => $intro['note']], ['id' => $contact_id]);
298 // Success. Delete the notification.
299 DBA::delete('intro', ['id' => $intro_id]);
308 * We have now established a relationship with the other site.
309 * Let's make our own personal copy of their profile photo so we don't have
310 * to always load it from their site.
312 * We will also update the contact record with the nature and scope of the relationship.
314 Contact::updateAvatar($contact['photo'], $uid, $contact_id);
316 Logger::log('dfrn_confirm: confirm - imported photos');
318 if ($network === Protocol::DFRN) {
319 $new_relation = Contact::FOLLOWER;
321 if (($relation == Contact::SHARING) || ($duplex)) {
322 $new_relation = Contact::FRIEND;
325 if (($relation == Contact::SHARING) && ($duplex)) {
329 $r = q("UPDATE `contact` SET `rel` = %d,
336 `network` = '%s' WHERE `id` = %d
338 intval($new_relation),
339 DBA::escape(DateTimeFormat::utcNow()),
340 DBA::escape(DateTimeFormat::utcNow()),
343 DBA::escape(Protocol::DFRN),
347 if ($network == Protocol::ACTIVITYPUB) {
348 ActivityPub\Transmitter::sendContactAccept($contact['url'], $contact['hub-verify'], $uid);
349 // Setting "pending" to true on a bidirectional contact request could create a problem when it isn't accepted on the other side
350 // Then we have got a situation where - although one direction is accepted - the contact still appears as pending.
351 // Possibly we need two different "pending" fields, one for incoming, one for outgoing?
352 // This has to be thought over, but for now this here is a better solution.
353 // $pending = $duplex;
359 // $network !== Protocol::DFRN
360 $network = defaults($contact, 'network', Protocol::OSTATUS);
362 $arr = Probe::uri($contact['url'], $network);
364 $notify = defaults($contact, 'notify' , $arr['notify']);
365 $poll = defaults($contact, 'poll' , $arr['poll']);
367 $addr = $arr['addr'];
369 $new_relation = $contact['rel'];
370 $writable = $contact['writable'];
372 if (in_array($network, [Protocol::DIASPORA, Protocol::ACTIVITYPUB])) {
374 $new_relation = Contact::FRIEND;
376 $new_relation = Contact::FOLLOWER;
379 if ($new_relation != Contact::FOLLOWER) {
384 DBA::delete('intro', ['id' => $intro_id]);
386 $fields = ['name-date' => DateTimeFormat::utcNow(),
387 'uri-date' => DateTimeFormat::utcNow(), 'addr' => $addr,
388 'notify' => $notify, 'poll' => $poll, 'blocked' => false,
389 'pending' => $pending, 'network' => $network,
390 'writable' => $writable, 'hidden' => $hidden, 'rel' => $new_relation];
391 DBA::update('contact', $fields, ['id' => $contact_id]);
394 if (!DBA::isResult($r)) {
395 notice(L10n::t('Unable to set contact photo.') . EOL);
398 // reload contact info
399 $contact = DBA::selectFirst('contact', [], ['id' => $contact_id]);
400 if ((isset($new_relation) && $new_relation == Contact::FRIEND)) {
401 if (DBA::isResult($contact) && ($contact['network'] === Protocol::DIASPORA)) {
402 $ret = Diaspora::sendShare($user, $contact);
403 Logger::log('share returns: ' . $ret);
407 Group::addMember(User::getDefaultGroup($uid, $contact["network"]), $contact['id']);
409 if ($network == Protocol::ACTIVITYPUB && $duplex) {
410 ActivityPub\Transmitter::sendActivity('Follow', $contact['url'], $uid);
413 // Let's send our user to the contact editor in case they want to
414 // do anything special with this new friend.
415 if ($handsfree === null) {
416 $a->internalRedirect('contact/' . intval($contact_id));
424 * End of Scenario 1. [Local confirmation of remote friend request].
426 * Begin Scenario 2. This is the remote response to the above scenario.
427 * This will take place on the site that originally initiated the friend request.
428 * In the section above where the confirming party makes a POST and
429 * retrieves xml status information, they are communicating with the following code.
431 if (!empty($_POST['source_url'])) {
432 // We are processing an external confirmation to an introduction created by our user.
433 $public_key = defaults($_POST, 'public_key', '');
434 $dfrn_id = hex2bin(defaults($_POST, 'dfrn_id' , ''));
435 $source_url = hex2bin(defaults($_POST, 'source_url', ''));
436 $aes_key = defaults($_POST, 'aes_key' , '');
437 $duplex = intval(defaults($_POST, 'duplex' , 0));
438 $page = intval(defaults($_POST, 'page' , 0));
440 $forum = (($page == 1) ? 1 : 0);
441 $prv = (($page == 2) ? 1 : 0);
443 Logger::log('dfrn_confirm: requestee contacted: ' . $node);
445 Logger::log('dfrn_confirm: request: POST=' . print_r($_POST, true), Logger::DATA);
447 // If $aes_key is set, both of these items require unpacking from the hex transport encoding.
449 if (!empty($aes_key)) {
450 $aes_key = hex2bin($aes_key);
451 $public_key = hex2bin($public_key);
454 // Find our user's account
455 $user = DBA::selectFirst('user', [], ['nickname' => $node]);
456 if (!DBA::isResult($user)) {
457 $message = L10n::t('No user record found for \'%s\' ', $node);
458 System::xmlExit(3, $message); // failure
462 $my_prvkey = $user['prvkey'];
463 $local_uid = $user['uid'];
466 if (!strstr($my_prvkey, 'PRIVATE KEY')) {
467 $message = L10n::t('Our site encryption key is apparently messed up.');
468 System::xmlExit(3, $message);
473 $decrypted_source_url = "";
474 openssl_private_decrypt($source_url, $decrypted_source_url, $my_prvkey);
477 if (!strlen($decrypted_source_url)) {
478 $message = L10n::t('Empty site URL was provided or URL could not be decrypted by us.');
479 System::xmlExit(3, $message);
483 $contact = DBA::selectFirst('contact', [], ['url' => $decrypted_source_url, 'uid' => $local_uid]);
484 if (!DBA::isResult($contact)) {
485 if (strstr($decrypted_source_url, 'http:')) {
486 $newurl = str_replace('http:', 'https:', $decrypted_source_url);
488 $newurl = str_replace('https:', 'http:', $decrypted_source_url);
491 $contact = DBA::selectFirst('contact', [], ['url' => $newurl, 'uid' => $local_uid]);
492 if (!DBA::isResult($contact)) {
493 // this is either a bogus confirmation (?) or we deleted the original introduction.
494 $message = L10n::t('Contact record was not found for you on our site.');
495 System::xmlExit(3, $message);
496 return; // NOTREACHED
500 $relation = $contact['rel'];
502 // Decrypt all this stuff we just received
504 $foreign_pubkey = $contact['site-pubkey'];
505 $dfrn_record = $contact['id'];
507 if (!$foreign_pubkey) {
508 $message = L10n::t('Site public key not available in contact record for URL %s.', $decrypted_source_url);
509 System::xmlExit(3, $message);
512 $decrypted_dfrn_id = "";
513 openssl_public_decrypt($dfrn_id, $decrypted_dfrn_id, $foreign_pubkey);
515 if (strlen($aes_key)) {
516 $decrypted_aes_key = "";
517 openssl_private_decrypt($aes_key, $decrypted_aes_key, $my_prvkey);
518 $dfrn_pubkey = openssl_decrypt($public_key, 'AES-256-CBC', $decrypted_aes_key);
520 $dfrn_pubkey = $public_key;
523 if (DBA::exists('contact', ['dfrn-id' => $decrypted_dfrn_id])) {
524 $message = L10n::t('The ID provided by your system is a duplicate on our system. It should work if you try again.');
525 System::xmlExit(1, $message); // Birthday paradox - duplicate dfrn-id
529 $r = q("UPDATE `contact` SET `dfrn-id` = '%s', `pubkey` = '%s' WHERE `id` = %d",
530 DBA::escape($decrypted_dfrn_id),
531 DBA::escape($dfrn_pubkey),
534 if (!DBA::isResult($r)) {
535 $message = L10n::t('Unable to set your contact credentials on our system.');
536 System::xmlExit(3, $message);
539 // It's possible that the other person also requested friendship.
540 // If it is a duplex relationship, ditch the issued-id if one exists.
543 q("UPDATE `contact` SET `issued-id` = '' WHERE `id` = %d",
548 // We're good but now we have to scrape the profile photo and send notifications.
549 $contact = DBA::selectFirst('contact', ['photo'], ['id' => $dfrn_record]);
550 if (DBA::isResult($contact)) {
551 $photo = $contact['photo'];
553 $photo = System::baseUrl() . '/images/person-300.jpg';
556 Contact::updateAvatar($photo, $local_uid, $dfrn_record);
558 Logger::log('dfrn_confirm: request - photos imported');
560 $new_relation = Contact::SHARING;
562 if (($relation == Contact::FOLLOWER) || ($duplex)) {
563 $new_relation = Contact::FRIEND;
566 if (($relation == Contact::FOLLOWER) && ($duplex)) {
570 $r = q("UPDATE `contact` SET
579 `network` = '%s' WHERE `id` = %d
581 intval($new_relation),
582 DBA::escape(DateTimeFormat::utcNow()),
583 DBA::escape(DateTimeFormat::utcNow()),
587 DBA::escape(Protocol::DFRN),
590 if (!DBA::isResult($r)) { // indicates schema is messed up or total db failure
591 $message = L10n::t('Unable to update your contact profile details on our system');
592 System::xmlExit(3, $message);
595 // Otherwise everything seems to have worked and we are almost done. Yay!
596 // Send an email notification
598 Logger::log('dfrn_confirm: request: info updated');
601 $r = q("SELECT `contact`.*, `user`.*
603 LEFT JOIN `user` ON `contact`.`uid` = `user`.`uid`
604 WHERE `contact`.`id` = %d
608 if (DBA::isResult($r)) {
611 if ($combined['notify-flags'] & NOTIFY_CONFIRM) {
612 $mutual = ($new_relation == Contact::FRIEND);
614 'type' => NOTIFY_CONFIRM,
615 'notify_flags' => $combined['notify-flags'],
616 'language' => $combined['language'],
617 'to_name' => $combined['username'],
618 'to_email' => $combined['email'],
619 'uid' => $combined['uid'],
620 'link' => System::baseUrl() . '/contact/' . $dfrn_record,
621 'source_name' => ((strlen(stripslashes($combined['name']))) ? stripslashes($combined['name']) : L10n::t('[Name Withheld]')),
622 'source_link' => $combined['url'],
623 'source_photo' => $combined['photo'],
624 'verb' => ($mutual?ACTIVITY_FRIEND:ACTIVITY_FOLLOW),
630 System::xmlExit(0); // Success
631 return; // NOTREACHED
632 ////////////////////// End of this scenario ///////////////////////////////////////////////
635 // somebody arrived here by mistake or they are fishing. Send them to the homepage.
636 $a->internalRedirect();