6 * Description: Inserts a jabber chat
15 * jabber password should not be stored on server
16 * jabber password should not be sent between server and browser as soon as the user is logged in
17 * jabber password should not be reconstructible from communication between server and browser as soon as the user is logged in
20 Only store an encrypted version of the jabber password on the server. The encryption key is only available to the browser
21 and not to the server (at least as soon as the user is logged in). It can be stored using the jappix setDB function.
23 This encryption key could be the friendica password, but then this password would be stored in the browser in cleartext.
24 It is better to use a hash of the password.
25 The server should not be able to reconstruct the password, so we can't take the same hash the server stores. But we can
26 use hash("some_prefix"+password). This will however not work with OpenID logins, for this type of login the password must
30 How to discover the jabber addresses of the friendica contacts?
33 Each Friendica site with this addon provides a /jappixmini/ module page. We go through our contacts and retrieve
34 this information every week using a cron hook.
37 We do not want to make the jabber address public.
40 When two friendica users connect using DFRN, the relation gets a DFRN ID and a keypair is generated.
41 Using this keypair, we can provide the jabber address only to contacts:
44 signed_address = openssl_*_encrypt(alice_jabber_address)
45 send signed_address to Bob, who does
46 trusted_address = openssl_*_decrypt(signed_address)
48 encrypted_address = openssl_*_encrypt(bob_jabber_address)
49 reply with encrypted_address to Alice, who does
50 decrypted_address = openssl_*_decrypt(encrypted_address)
51 save decrypted_address
54 GET /jappixmini/?role=%s&signed_address=%s&dfrn_id=%s
57 json({"status":"ok", "encrypted_address":"%s"})
61 function jappixmini_install() {
62 register_hook('plugin_settings', 'addon/jappixmini/jappixmini.php', 'jappixmini_settings');
63 register_hook('plugin_settings_post', 'addon/jappixmini/jappixmini.php', 'jappixmini_settings_post');
65 register_hook('page_end', 'addon/jappixmini/jappixmini.php', 'jappixmini_script');
66 register_hook('authenticate', 'addon/jappixmini/jappixmini.php', 'jappixmini_login');
68 register_hook('cron', 'addon/jappixmini/jappixmini.php', 'jappixmini_cron');
70 // Jappix source download as required by AGPL
71 register_hook('about_hook', 'addon/jappixmini/jappixmini.php', 'jappixmini_download_source');
73 // set standard configuration
74 $info_text = get_config("jappixmini", "infotext");
75 if (!$info_text) set_config("jappixmini", "infotext",
76 "To get the chat working, you need to know a BOSH host which works with your Jabber account. ".
77 "An example of a BOSH server that works for all accounts is https://bind.jappix.com/, but keep ".
78 "in mind that the BOSH server can read along all chat messages. If you know that your Jabber ".
79 "server also provides an own BOSH server, it is much better to use this one!"
82 $bosh_proxy = get_config("jappixmini", "bosh_proxy");
83 if ($bosh_proxy==="") set_config("jappixmini", "bosh_proxy", 1);
87 function jappixmini_uninstall() {
88 unregister_hook('plugin_settings', 'addon/jappixmini/jappixmini.php', 'jappixmini_settings');
89 unregister_hook('plugin_settings_post', 'addon/jappixmini/jappixmini.php', 'jappixmini_settings_post');
91 unregister_hook('page_end', 'addon/jappixmini/jappixmini.php', 'jappixmini_script');
92 unregister_hook('authenticate', 'addon/jappixmini/jappixmini.php', 'jappixmini_login');
94 unregister_hook('cron', 'addon/jappixmini/jappixmini.php', 'jappixmini_cron');
96 unregister_hook('about_hook', 'addon/jappixmini/jappixmini.php', 'jappixmini_download_source');
99 function jappixmini_plugin_admin(&$a, &$o) {
100 // display instructions and warnings on addon settings page for admin
102 if (!file_exists("addon/jappixmini/jappix")) {
103 $o .= '<p><strong>You need to install the Jappix application (see README).</strong></p>';
105 else if (file_exists("addon/jappixmini/jappix/index.php")) {
106 // try to delete automatically
108 unlink("addon/jappixmini/jappix/index.php");
110 catch (Exception $e) {}
112 // warn admin if this is not possible
113 if (file_exists("addon/jappixmini/jappix/index.php"))
114 $o .= '<p><strong style="color:#fff;background-color:#f00">You must delete addon/jappixmini/jappix/index.php (see README).</strong></p>';
116 info("Deleted addon/jappixmini/jappix/index.php automatically.");
117 $o .= '<p>Jappix is installed.</p>';
120 else if (!file_exists("addon/jappixmini/jappix.zip")) {
121 $o .= '<p><strong style="color:#fff;background-color:#f00">The source archive jappix.zip does not exist. This is probably a violation of the Jappix License (see README).</strong></p>';
124 $o .= '<p>Jappix is installed.</p>';
127 // warn if cron job has not yet been executed
128 $cron_run = get_config("jappixmini", "last_cron_execution");
129 if (!$cron_run) $o .= "<p><strong>Warning: The cron job has not yet been executed. If this message is still there after some time (usually 10 minutes), this means that autosubscribe and autoaccept will not work.</strong></p>";
132 $bosh_proxy = intval(get_config("jappixmini", "bosh_proxy"));
133 $bosh_proxy = intval($bosh_proxy) ? ' checked="checked"' : '';
134 $o .= '<label for="jappixmini-proxy">Activate BOSH proxy</label>';
135 $o .= ' <input id="jappixmini-proxy" type="checkbox" name="jappixmini-proxy" value="1"'.$bosh_proxy.' /><br />';
138 $info_text = get_config("jappixmini", "infotext");
139 $o .= '<p><label for="jappixmini-infotext">Info text to help users with configuration (important if you want to provide your own BOSH host!):</label><br />';
140 $o .= '<textarea id="jappixmini-infotext" name="jappixmini-infotext" rows="5" cols="50">'.htmlentities($info_text).'</textarea></p>';
143 $o .= '<input type="submit" name="jappixmini-admin-settings" value="OK" />';
146 function jappixmini_plugin_admin_post(&$a) {
148 $submit = $_REQUEST['jappixmini-admin-settings'];
150 $info_text = $_REQUEST['jappixmini-infotext'];
151 $bosh_proxy = intval($_REQUEST['jappixmini-proxy']);
152 set_config("jappixmini", "infotext", $info_text);
153 set_config("jappixmini", "bosh_proxy", $bosh_proxy);
157 function jappixmini_module() {}
158 function jappixmini_init(&$a) {
159 // module page where other Friendica sites can submit Jabber addresses to and also can query Jabber addresses
162 if (!file_exists("addon/jappixmini/jappix")) killme();
164 $dfrn_id = $_REQUEST["dfrn_id"];
165 if (!$dfrn_id) killme();
167 $role = $_REQUEST["role"];
169 $r = q("SELECT * FROM `contact` WHERE LENGTH(`pubkey`) AND `dfrn-id`='%s' LIMIT 1",
172 if (!count($r)) killme();
174 $encrypt_func = openssl_public_encrypt;
175 $decrypt_func = openssl_public_decrypt;
176 $key = $r[0]["pubkey"];
177 } else if ($role=="prv") {
178 $r = q("SELECT * FROM `contact` WHERE LENGTH(`prvkey`) AND `issued-id`='%s' LIMIT 1",
181 if (!count($r)) killme();
183 $encrypt_func = openssl_private_encrypt;
184 $decrypt_func = openssl_private_decrypt;
185 $key = $r[0]["prvkey"];
192 // save the Jabber address we received
194 $signed_address_hex = $_REQUEST["signed_address"];
195 $signed_address = hex2bin($signed_address_hex);
197 $trusted_address = "";
198 $decrypt_func($signed_address, $trusted_address, $key);
200 $now = intval(time());
201 set_pconfig($uid, "jappixmini", "id:$dfrn_id", "$now:$trusted_address");
202 } catch (Exception $e) {
205 // do not return an address if user deactivated plugin
206 $activated = get_pconfig($uid, 'jappixmini', 'activate');
207 if (!$activated) killme();
209 // return the requested Jabber address
211 $username = get_pconfig($uid, 'jappixmini', 'username');
212 $server = get_pconfig($uid, 'jappixmini', 'server');
213 $address = "$username@$server";
215 $encrypted_address = "";
216 $encrypt_func($address, $encrypted_address, $key);
218 $encrypted_address_hex = bin2hex($encrypted_address);
222 "encrypted_address"=>$encrypted_address_hex
225 $answer_json = json_encode($answer);
228 } catch (Exception $e) {
233 function jappixmini_settings(&$a, &$s) {
234 // addon settings for a user
236 if (!file_exists("addon/jappixmini/jappix")) return;
238 $activate = get_pconfig(local_user(),'jappixmini','activate');
239 $activate = intval($activate) ? ' checked="checked"' : '';
241 $username = get_pconfig(local_user(),'jappixmini','username');
242 $username = htmlentities($username);
243 $server = get_pconfig(local_user(),'jappixmini','server');
244 $server = htmlentities($server);
245 $bosh = get_pconfig(local_user(),'jappixmini','bosh');
246 $bosh = htmlentities($bosh);
247 $password = get_pconfig(local_user(),'jappixmini','password');
248 $autosubscribe = get_pconfig(local_user(),'jappixmini','autosubscribe');
249 $autosubscribe = intval($autosubscribe) ? ' checked="checked"' : '';
250 $autoapprove = get_pconfig(local_user(),'jappixmini','autoapprove');
251 $autoapprove = intval($autoapprove) ? ' checked="checked"' : '';
252 $encrypt = intval(get_pconfig(local_user(),'jappixmini','encrypt'));
253 $encrypt_checked = $encrypt ? ' checked="checked"' : '';
254 $encrypt_disabled = $encrypt ? '' : ' disabled="disabled"';
256 $info_text = get_config("jappixmini", "infotext");
257 $info_text = htmlentities($info_text);
258 $info_text = str_replace("\n", "<br />", $info_text);
261 // load scripts if not yet activated so that password can be saved
262 $a->page['htmlhead'] .= '<script type="text/javascript" src="' . $a->get_baseurl() . '/addon/jappixmini/jappix/php/get.php?t=js&g=mini.xml"></script>'."\r\n";
263 $a->page['htmlhead'] .= '<script type="text/javascript" src="' . $a->get_baseurl() . '/addon/jappixmini/jappix/php/get.php?t=js&f=presence.js~caps.js~name.js~roster.js"></script>'."\r\n";
265 $a->page['htmlhead'] .= '<script type="text/javascript" src="' . $a->get_baseurl() . '/addon/jappixmini/lib.js"></script>'."\r\n";
268 $s .= '<div class="settings-block">';
270 $s .= '<h3>Jappix Mini addon settings</h3>';
272 $s .= '<label for="jappixmini-activate">Activate addon</label>';
273 $s .= ' <input id="jappixmini-activate" type="checkbox" name="jappixmini-activate" value="1"'.$activate.' />';
275 $s .= '<label for="jappixmini-username">Jabber username</label>';
276 $s .= ' <input id="jappixmini-username" type="text" name="jappixmini-username" value="'.$username.'" />';
278 $s .= '<label for="jappixmini-server">Jabber server</label>';
279 $s .= ' <input id="jappixmini-server" type="text" name="jappixmini-server" value="'.$server.'" />';
282 $s .= '<label for="jappixmini-bosh">Jabber BOSH host</label>';
283 $s .= ' <input id="jappixmini-bosh" type="text" name="jappixmini-bosh" value="'.$bosh.'" />';
286 $s .= '<label for="jappixmini-password">Jabber password</label>';
287 $s .= ' <input type="hidden" id="jappixmini-password" name="jappixmini-encrypted-password" value="'.$password.'" />';
288 $s .= ' <input id="jappixmini-clear-password" type="password" value="" onchange="jappixmini_set_password();" />';
290 $onchange = "document.getElementById('jappixmini-friendica-password').disabled = !this.checked;jappixmini_set_password();";
291 $s .= '<label for="jappixmini-encrypt">Encrypt Jabber password with Friendica password (recommended)</label>';
292 $s .= ' <input id="jappixmini-encrypt" type="checkbox" name="jappixmini-encrypt" onchange="'.$onchange.'" value="1"'.$encrypt_checked.' />';
294 $s .= '<label for="jappixmini-friendica-password">Friendica password</label>';
295 $s .= ' <input id="jappixmini-friendica-password" name="jappixmini-friendica-password" type="password" onchange="jappixmini_set_password();" value=""'.$encrypt_disabled.' />';
297 $s .= '<label for="jappixmini-autoapprove">Approve subscription requests from Friendica contacts automatically</label>';
298 $s .= ' <input id="jappixmini-autoapprove" type="checkbox" name="jappixmini-autoapprove" value="1"'.$autoapprove.' />';
300 $s .= '<label for="jappixmini-autosubscribe">Subscribe to Friendica contacts automatically</label>';
301 $s .= ' <input id="jappixmini-autosubscribe" type="checkbox" name="jappixmini-autosubscribe" value="1"'.$autosubscribe.' />';
303 $s .= '<label for="jappixmini-purge">Purge internal list of jabber addresses of contacts</label>';
304 $s .= ' <input id="jappixmini-purge" type="checkbox" name="jappixmini-purge" value="1" />';
306 if ($info_text) $s .= '<br />Configuration help:<p style="margin-left:2em;">'.$info_text.'</p>';
307 $s .= '<input type="submit" name="jappixmini-submit" value="' . t('Submit') . '" />';
308 $s .= ' <input type="button" value="Add contact" onclick="jappixmini_addon_subscribe();" />';
313 $a->page['htmlhead'] .= "<script type=\"text/javascript\">
314 function jappixmini_set_password() {
315 encrypt = document.getElementById('jappixmini-encrypt').checked;
316 password = document.getElementById('jappixmini-password');
317 clear_password = document.getElementById('jappixmini-clear-password');
319 friendica_password = document.getElementById('jappixmini-friendica-password');
321 if (friendica_password) {
322 jappixmini_addon_set_client_secret(friendica_password.value);
323 jappixmini_addon_encrypt_password(clear_password.value, function(encrypted_password){
324 password.value = encrypted_password;
329 password.value = clear_password.value;
333 jQuery(document).ready(function() {
334 encrypt = document.getElementById('jappixmini-encrypt').checked;
335 password = document.getElementById('jappixmini-password');
336 clear_password = document.getElementById('jappixmini-clear-password');
338 jappixmini_addon_decrypt_password(password.value, function(decrypted_password){
339 clear_password.value = decrypted_password;
343 clear_password.value = password.value;
349 function jappixmini_settings_post(&$a,&$b) {
350 // save addon settings for a user
352 if (!file_exists("addon/jappixmini/jappix")) return;
354 if(! local_user()) return;
357 if($_POST['jappixmini-submit']) {
358 $encrypt = intval($b['jappixmini-encrypt']);
360 // check that Jabber password was encrypted with correct Friendica password
361 $friendica_password = trim($b['jappixmini-friendica-password']);
362 $encrypted = hash('whirlpool',$friendica_password);
363 $r = q("SELECT * FROM `user` WHERE `uid`=$uid AND `password`='%s'",
367 info("Wrong friendica password!");
372 $purge = intval($b['jappixmini-purge']);
374 $username = trim($b['jappixmini-username']);
375 $old_username = get_pconfig($uid,'jappixmini','username');
376 if ($username!=$old_username) $purge = 1;
378 $server = trim($b['jappixmini-server']);
379 $old_server = get_pconfig($uid,'jappixmini','server');
380 if ($server!=$old_server) $purge = 1;
382 set_pconfig($uid,'jappixmini','username',$username);
383 set_pconfig($uid,'jappixmini','server',$server);
384 set_pconfig($uid,'jappixmini','bosh',trim($b['jappixmini-bosh']));
385 set_pconfig($uid,'jappixmini','password',trim($b['jappixmini-encrypted-password']));
386 set_pconfig($uid,'jappixmini','autosubscribe',intval($b['jappixmini-autosubscribe']));
387 set_pconfig($uid,'jappixmini','autoapprove',intval($b['jappixmini-autoapprove']));
388 set_pconfig($uid,'jappixmini','activate',intval($b['jappixmini-activate']));
389 set_pconfig($uid,'jappixmini','encrypt',$encrypt);
390 info( 'Jappix Mini settings saved.' );
393 q("DELETE FROM `pconfig` WHERE `uid`=$uid AND `cat`='jappixmini' and `k` LIKE 'id%%'");
394 info( 'List of addresses purged.' );
399 function jappixmini_script(&$a,&$s) {
400 // adds the script to the page header which starts Jappix Mini
402 if (!file_exists("addon/jappixmini/jappix")) return;
403 if(! local_user()) return;
405 $activate = get_pconfig(local_user(),'jappixmini','activate');
406 if (!$activate) return;
408 $a->page['htmlhead'] .= '<script type="text/javascript" src="' . $a->get_baseurl() . '/addon/jappixmini/jappix/php/get.php?t=js&g=mini.xml"></script>'."\r\n";
409 $a->page['htmlhead'] .= '<script type="text/javascript" src="' . $a->get_baseurl() . '/addon/jappixmini/jappix/php/get.php?t=js&f=presence.js~caps.js~name.js~roster.js"></script>'."\r\n";
411 $a->page['htmlhead'] .= '<script type="text/javascript" src="' . $a->get_baseurl() . '/addon/jappixmini/lib.js"></script>'."\r\n";
413 $username = get_pconfig(local_user(),'jappixmini','username');
414 $username = str_replace("'", "\\'", $username);
415 $server = get_pconfig(local_user(),'jappixmini','server');
416 $server = str_replace("'", "\\'", $server);
417 $bosh = get_pconfig(local_user(),'jappixmini','bosh');
418 $bosh = str_replace("'", "\\'", $bosh);
419 $encrypt = get_pconfig(local_user(),'jappixmini','encrypt');
420 $encrypt = intval($encrypt);
421 $password = get_pconfig(local_user(),'jappixmini','password');
422 $password = str_replace("'", "\\'", $password);
424 $autoapprove = get_pconfig(local_user(),'jappixmini','autoapprove');
425 $autoapprove = intval($autoapprove);
426 $autosubscribe = get_pconfig(local_user(),'jappixmini','autosubscribe');
427 $autosubscribe = intval($autosubscribe);
429 // set proxy if necessary
430 $use_proxy = get_config('jappixmini','bosh_proxy');
432 $proxy = $a->get_baseurl().'/addon/jappixmini/proxy.php';
438 // get a list of jabber accounts of the contacts
441 $rows = q("SELECT * FROM `pconfig` WHERE `uid`=$uid AND `cat`='jappixmini' and `k` LIKE 'id%%'");
442 foreach ($rows as $row) {
444 $pos = strpos($key, ":");
445 $dfrn_id = substr($key, $pos+1);
446 $r = q("SELECT `name` FROM `contact` WHERE `uid`=$uid AND `dfrn-id`='%s' OR `issued-id`='%s'",
450 $name = $r[0]["name"];
453 $pos = strpos($value, ":");
454 $address = substr($value, $pos+1);
455 if (!$address) continue;
456 if (!$name) $name = $address;
458 $contacts[$address] = $name;
460 $contacts_json = json_encode($contacts);
463 $r = q("SELECT `username` FROM `user` WHERE `uid`=$uid");
464 $nickname = json_encode($r[0]["username"]);
466 // add javascript to start Jappix Mini
467 $a->page['htmlhead'] .= "<script type=\"text/javascript\">
468 jQuery(document).ready(function() {
469 jappixmini_addon_start('$server', '$username', '$proxy', '$bosh', $encrypt, '$password', $nickname, $contacts_json, $autoapprove, $autosubscribe);
476 function jappixmini_login(&$a, &$o) {
477 // create client secret on login to be able to encrypt jabber passwords
479 if (!file_exists("addon/jappixmini/jappix")) return;
481 // for setDB and str_sha1, needed by jappixmini_addon_set_client_secret
482 $a->page['htmlhead'] .= '<script type="text/javascript" src="' . $a->get_baseurl() . '/addon/jappixmini/jappix/php/get.php?t=js&f=datastore.js~jsjac.js"></script>'."\r\n";
484 // for jappixmini_addon_set_client_secret
485 $a->page['htmlhead'] .= '<script type="text/javascript" src="' . $a->get_baseurl() . '/addon/jappixmini/lib.js"></script>'."\r\n";
487 // save hash of password
488 $o = str_replace("<form ", "<form onsubmit=\"jappixmini_addon_set_client_secret(this.elements['id_password'].value);return true;\" ", $o);
491 function jappixmini_cron(&$a, $d) {
492 // For autosubscribe/autoapprove, we need to maintain a list of jabber addresses of our contacts.
494 set_config("jappixmini", "last_cron_execution", $d);
496 if (!file_exists("addon/jappixmini/jappix")) return;
498 // go through list of users with jabber enabled
499 $users = q("SELECT `uid` FROM `pconfig` WHERE `cat`='jappixmini' AND (`k`='autosubscribe' OR `k`='autoapprove') AND `v`='1'");
500 logger("jappixmini: Update list of contacts' jabber accounts for ".count($users)." users.");
502 foreach ($users as $row) {
505 // for each user, go through list of contacts
506 $contacts = q("SELECT * FROM `contact` WHERE `uid`=%d AND ((LENGTH(`dfrn-id`) AND LENGTH(`pubkey`)) OR (LENGTH(`issued-id`) AND LENGTH(`prvkey`)))", intval($uid));
507 foreach ($contacts as $contact_row) {
508 $request = $contact_row["request"];
509 if (!$request) continue;
511 $dfrn_id = $contact_row["dfrn-id"];
513 $key = $contact_row["pubkey"];
514 $encrypt_func = openssl_public_encrypt;
515 $decrypt_func = openssl_public_decrypt;
518 $dfrn_id = $contact_row["issued-id"];
519 $key = $contact_row["prvkey"];
520 $encrypt_func = openssl_private_encrypt;
521 $decrypt_func = openssl_private_decrypt;
525 // check if jabber address already present
526 $present = get_pconfig($uid, "jappixmini", "id:".$dfrn_id);
527 $now = intval(time());
529 // $present has format "timestamp:jabber_address"
530 $p = strpos($present, ":");
531 $timestamp = intval(substr($present, 0, $p));
533 // do not re-retrieve jabber address if last retrieval
534 // is not older than a week
535 if ($now-$timestamp<3600*24*7) continue;
538 // construct base retrieval address
539 $pos = strpos($request, "/dfrn_request/");
540 if ($pos===false) continue;
542 $base = substr($request, 0, $pos)."/jappixmini?role=$role";
544 // construct own address
545 $username = get_pconfig($uid, 'jappixmini', 'username');
546 if (!$username) continue;
547 $server = get_pconfig($uid, 'jappixmini', 'server');
548 if (!$server) continue;
550 $address = $username."@".$server;
553 $signed_address = "";
554 $encrypt_func($address, $signed_address, $key);
556 // construct request url
557 $signed_address_hex = bin2hex($signed_address);
558 $url = $base."&signed_address=$signed_address_hex&dfrn_id=".urlencode($dfrn_id);
562 $answer_json = fetch_url($url);
565 $answer = json_decode($answer_json);
566 if ($answer->status != "ok") throw new Exception();
568 $encrypted_address_hex = $answer->encrypted_address;
569 if (!$encrypted_address_hex) throw new Exception();
571 $encrypted_address = hex2bin($encrypted_address_hex);
572 if (!$encrypted_address) throw new Exception();
575 $decrypted_address = "";
576 $decrypt_func($encrypted_address, $decrypted_address, $key);
577 if (!$decrypted_address) throw new Exception();
578 } catch (Exception $e) {
579 $decrypted_address = "";
583 set_pconfig($uid, "jappixmini", "id:$dfrn_id", "$now:$decrypted_address");
588 function jappixmini_download_source(&$a,&$b) {
589 // Jappix Mini source download link on About page
591 if (!file_exists("addon/jappixmini/jappix")) return;
593 $b .= '<h1>Jappix Mini</h1>';
594 $b .= '<p>This site uses Jappix Mini by the <a href="'.$a->get_baseurl().'/addon/jappixmini/jappix/AUTHORS">Jappix authors</a>, which is distributed under the terms of the <a href="'.$a->get_baseurl().'/addon/jappixmini/jappix/COPYING">GNU Affero General Public License</a>.</p>';
595 $b .= '<p>You can download the <a href="'.$a->get_baseurl().'/addon/jappixmini/jappix.zip">source code</a>.</p>';