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 info text
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!"
84 function jappixmini_uninstall() {
85 unregister_hook('plugin_settings', 'addon/jappixmini/jappixmini.php', 'jappixmini_settings');
86 unregister_hook('plugin_settings_post', 'addon/jappixmini/jappixmini.php', 'jappixmini_settings_post');
88 unregister_hook('page_end', 'addon/jappixmini/jappixmini.php', 'jappixmini_script');
89 unregister_hook('authenticate', 'addon/jappixmini/jappixmini.php', 'jappixmini_login');
91 unregister_hook('cron', 'addon/jappixmini/jappixmini.php', 'jappixmini_cron');
93 unregister_hook('about_hook', 'addon/jappixmini/jappixmini.php', 'jappixmini_download_source');
96 function jappixmini_plugin_admin(&$a, &$o) {
97 // display instructions and warnings on addon settings page for admin
99 if (!file_exists("addon/jappixmini/jappix")) {
100 $o .= '<p><strong>You need to install the Jappix application, adapted for Friendica (see README).</strong></p>';
102 else if (!file_exists("addon/jappixmini/jappix.zip")) {
103 $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>';
106 $o .= '<p>Jappix is installed.</p>';
110 $o .= '<label for="jappixmini-infotext">Info text to help users with configuration (important if you want to provide your own BOSH host!):</label><br />';
111 $info_text = get_config("jappixmini", "infotext");
112 $o .= '<textarea id="jappixmini-infotext" name="jappixmini-infotext" rows="5" cols="50">'.htmlentities($info_text).'</textarea><br />';
113 $o .= '<input type="submit" name="jappixmini-admin-settings" value="OK" />';
116 function jappixmini_plugin_admin_post(&$a) {
118 $submit = $_REQUEST['jappixmini-admin-settings'];
120 $info_text = $_REQUEST['jappixmini-infotext'];
121 set_config("jappixmini", "infotext", $info_text);
125 function jappixmini_module() {}
126 function jappixmini_init(&$a) {
127 // module page where other Friendica sites can submit Jabber addresses to and also can query Jabber addresses
130 if (!file_exists("addon/jappixmini/jappix")) killme();
132 $dfrn_id = $_REQUEST["dfrn_id"];
133 if (!$dfrn_id) killme();
135 $role = $_REQUEST["role"];
137 $r = q("SELECT * FROM `contact` WHERE LENGTH(`pubkey`) AND `dfrn-id`='%s' LIMIT 1",
140 if (!count($r)) killme();
142 $encrypt_func = openssl_public_encrypt;
143 $decrypt_func = openssl_public_decrypt;
144 $key = $r[0]["pubkey"];
145 } else if ($role=="prv") {
146 $r = q("SELECT * FROM `contact` WHERE LENGTH(`prvkey`) AND `issued-id`='%s' LIMIT 1",
149 if (!count($r)) killme();
151 $encrypt_func = openssl_private_encrypt;
152 $decrypt_func = openssl_private_decrypt;
153 $key = $r[0]["prvkey"];
160 // save the Jabber address we received
162 $signed_address_hex = $_REQUEST["signed_address"];
163 $signed_address = hex2bin($signed_address_hex);
165 $trusted_address = "";
166 $decrypt_func($signed_address, $trusted_address, $key);
168 $now = intval(time());
169 set_pconfig($uid, "jappixmini", "id:$dfrn_id", "$now:$trusted_address");
170 } catch (Exception $e) {
173 // do not return an address if user deactivated plugin
174 $activated = get_pconfig($uid, 'jappixmini', 'activate');
175 if (!$activated) killme();
177 // return the requested Jabber address
179 $username = get_pconfig($uid, 'jappixmini', 'username');
180 $server = get_pconfig($uid, 'jappixmini', 'server');
181 $address = "$username@$server";
183 $encrypted_address = "";
184 $encrypt_func($address, $encrypted_address, $key);
186 $encrypted_address_hex = bin2hex($encrypted_address);
190 "encrypted_address"=>$encrypted_address_hex
193 $answer_json = json_encode($answer);
196 } catch (Exception $e) {
201 function jappixmini_settings(&$a, &$s) {
202 // addon settings for a user
204 if (!file_exists("addon/jappixmini/jappix")) return;
206 $activate = get_pconfig(local_user(),'jappixmini','activate');
207 $activate = intval($activate) ? ' checked="checked"' : '';
209 $username = get_pconfig(local_user(),'jappixmini','username');
210 $username = htmlentities($username);
211 $server = get_pconfig(local_user(),'jappixmini','server');
212 $server = htmlentities($server);
213 $bosh = get_pconfig(local_user(),'jappixmini','bosh');
214 $bosh = htmlentities($bosh);
215 $password = get_pconfig(local_user(),'jappixmini','password');
216 $autosubscribe = get_pconfig(local_user(),'jappixmini','autosubscribe');
217 $autosubscribe = intval($autosubscribe) ? ' checked="checked"' : '';
218 $autoapprove = get_pconfig(local_user(),'jappixmini','autoapprove');
219 $autoapprove = intval($autoapprove) ? ' checked="checked"' : '';
220 $encrypt = intval(get_pconfig(local_user(),'jappixmini','encrypt'));
221 $encrypt_checked = $encrypt ? ' checked="checked"' : '';
222 $encrypt_disabled = $encrypt ? '' : ' disabled="disabled"';
224 $info_text = get_config("jappixmini", "infotext");
225 $info_text = htmlentities($info_text);
226 $info_text = str_replace("\n", "<br />", $info_text);
229 // load scripts if not yet activated so that password can be saved
230 $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";
231 $a->page['htmlhead'] .= '<script type="text/javascript" src="' . $a->get_baseurl() . '/addon/jappixmini/jappix/php/get.php?t=js&f=presence.js"></script>'."\r\n";
233 $a->page['htmlhead'] .= '<script type="text/javascript" src="' . $a->get_baseurl() . '/addon/jappixmini/jappix/php/get.php?t=js&f=caps.js"></script>'."\r\n";
234 $a->page['htmlhead'] .= '<script type="text/javascript" src="' . $a->get_baseurl() . '/addon/jappixmini/jappix/php/get.php?t=js&f=name.js"></script>'."\r\n";
235 $a->page['htmlhead'] .= '<script type="text/javascript" src="' . $a->get_baseurl() . '/addon/jappixmini/jappix/php/get.php?t=js&f=roster.js"></script>'."\r\n";
237 $a->page['htmlhead'] .= '<script type="text/javascript" src="' . $a->get_baseurl() . '/addon/jappixmini/lib.js"></script>'."\r\n";
240 $s .= '<div class="settings-block">';
242 $s .= '<h3>Jappix Mini addon settings</h3>';
244 $s .= '<label for="jappixmini-activate">Activate addon</label>';
245 $s .= ' <input id="jappixmini-activate" type="checkbox" name="jappixmini-activate" value="1"'.$activate.' />';
247 $s .= '<label for="jappixmini-username">Jabber username</label>';
248 $s .= ' <input id="jappixmini-username" type="text" name="jappixmini-username" value="'.$username.'" />';
250 $s .= '<label for="jappixmini-server">Jabber server</label>';
251 $s .= ' <input id="jappixmini-server" type="text" name="jappixmini-server" value="'.$server.'" />';
254 $conf = file_get_contents("addon/jappixmini/jappix/store/conf/main.xml");
255 preg_match("/<bosh_proxy>(.*)<\/bosh_proxy>/", $conf, $matches);
256 if ($matches[1]=="on") {
257 $s .= '<label for="jappixmini-bosh">Jabber BOSH host</label>';
258 $s .= ' <input id="jappixmini-bosh" type="text" name="jappixmini-bosh" value="'.$bosh.'" />';
262 $s .= '<label for="jappixmini-password">Jabber password</label>';
263 $s .= ' <input type="hidden" id="jappixmini-password" name="jappixmini-encrypted-password" value="'.$password.'" />';
264 $s .= ' <input id="jappixmini-clear-password" type="password" value="" onchange="jappixmini_set_password();" />';
266 $onchange = "document.getElementById('jappixmini-friendica-password').disabled = !this.checked;jappixmini_set_password();";
267 $s .= '<label for="jappixmini-encrypt">Encrypt Jabber password with Friendica password (recommended)</label>';
268 $s .= ' <input id="jappixmini-encrypt" type="checkbox" name="jappixmini-encrypt" onchange="'.$onchange.'" value="1"'.$encrypt_checked.' />';
270 $s .= '<label for="jappixmini-friendica-password">Friendica password</label>';
271 $s .= ' <input id="jappixmini-friendica-password" name="jappixmini-friendica-password" type="password" onchange="jappixmini_set_password();" value=""'.$encrypt_disabled.' />';
273 $s .= '<label for="jappixmini-autoapprove">Approve subscription requests from Friendica contacts automatically</label>';
274 $s .= ' <input id="jappixmini-autoapprove" type="checkbox" name="jappixmini-autoapprove" value="1"'.$autoapprove.' />';
276 $s .= '<label for="jappixmini-autosubscribe">Subscribe to Friendica contacts automatically</label>';
277 $s .= ' <input id="jappixmini-autosubscribe" type="checkbox" name="jappixmini-autosubscribe" value="1"'.$autosubscribe.' />';
279 $s .= '<label for="jappixmini-purge">Purge internal list of jabber addresses of contacts</label>';
280 $s .= ' <input id="jappixmini-purge" type="checkbox" name="jappixmini-purge" value="1" />';
282 if ($info_text) $s .= '<br />Configuration help:<p style="margin-left:2em;">'.$info_text.'</p>';
283 $s .= '<input type="submit" name="jappixmini-submit" value="' . t('Submit') . '" />';
284 $s .= ' <input type="button" value="Add contact" onclick="jappixmini_addon_subscribe();" />';
289 $a->page['htmlhead'] .= "<script type=\"text/javascript\">
290 function jappixmini_set_password() {
291 encrypt = document.getElementById('jappixmini-encrypt').checked;
292 password = document.getElementById('jappixmini-password');
293 clear_password = document.getElementById('jappixmini-clear-password');
295 friendica_password = document.getElementById('jappixmini-friendica-password');
297 if (friendica_password) {
298 jappixmini_addon_set_client_secret(friendica_password.value);
299 jappixmini_addon_encrypt_password(clear_password.value, function(encrypted_password){
300 password.value = encrypted_password;
305 password.value = clear_password.value;
309 jQuery(document).ready(function() {
310 encrypt = document.getElementById('jappixmini-encrypt').checked;
311 password = document.getElementById('jappixmini-password');
312 clear_password = document.getElementById('jappixmini-clear-password');
314 jappixmini_addon_decrypt_password(password.value, function(decrypted_password){
315 clear_password.value = decrypted_password;
319 clear_password.value = password.value;
325 function jappixmini_settings_post(&$a,&$b) {
326 // save addon settings for a user
328 if (!file_exists("addon/jappixmini/jappix")) return;
330 if(! local_user()) return;
333 if($_POST['jappixmini-submit']) {
334 $encrypt = intval($b['jappixmini-encrypt']);
336 // check that Jabber password was encrypted with correct Friendica password
337 $friendica_password = trim($b['jappixmini-friendica-password']);
338 $encrypted = hash('whirlpool',$friendica_password);
339 $r = q("SELECT * FROM `user` WHERE `uid`=$uid AND `password`='%s'",
343 info("Wrong friendica password!");
348 $purge = intval($b['jappixmini-purge']);
350 $username = trim($b['jappixmini-username']);
351 $old_username = get_pconfig($uid,'jappixmini','username');
352 if ($username!=$old_username) $purge = 1;
354 $server = trim($b['jappixmini-server']);
355 $old_server = get_pconfig($uid,'jappixmini','server');
356 if ($server!=$old_server) $purge = 1;
358 set_pconfig($uid,'jappixmini','username',$username);
359 set_pconfig($uid,'jappixmini','server',$server);
360 set_pconfig($uid,'jappixmini','bosh',trim($b['jappixmini-bosh']));
361 set_pconfig($uid,'jappixmini','password',trim($b['jappixmini-encrypted-password']));
362 set_pconfig($uid,'jappixmini','autosubscribe',intval($b['jappixmini-autosubscribe']));
363 set_pconfig($uid,'jappixmini','autoapprove',intval($b['jappixmini-autoapprove']));
364 set_pconfig($uid,'jappixmini','activate',intval($b['jappixmini-activate']));
365 set_pconfig($uid,'jappixmini','encrypt',$encrypt);
366 info( 'Jappix Mini settings saved.' );
369 q("DELETE FROM `pconfig` WHERE `uid`=$uid AND `cat`='jappixmini' and `k` LIKE 'id%%'");
370 info( 'List of addresses purged.' );
375 function jappixmini_script(&$a,&$s) {
376 // adds the script to the page header which starts Jappix Mini
378 if (!file_exists("addon/jappixmini/jappix")) return;
379 if(! local_user()) return;
381 $activate = get_pconfig(local_user(),'jappixmini','activate');
382 if (!$activate) return;
384 $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";
385 $a->page['htmlhead'] .= '<script type="text/javascript" src="' . $a->get_baseurl() . '/addon/jappixmini/jappix/php/get.php?t=js&f=presence.js"></script>'."\r\n";
387 $a->page['htmlhead'] .= '<script type="text/javascript" src="' . $a->get_baseurl() . '/addon/jappixmini/jappix/php/get.php?t=js&f=caps.js"></script>'."\r\n";
388 $a->page['htmlhead'] .= '<script type="text/javascript" src="' . $a->get_baseurl() . '/addon/jappixmini/jappix/php/get.php?t=js&f=name.js"></script>'."\r\n";
389 $a->page['htmlhead'] .= '<script type="text/javascript" src="' . $a->get_baseurl() . '/addon/jappixmini/jappix/php/get.php?t=js&f=roster.js"></script>'."\r\n";
391 $a->page['htmlhead'] .= '<script type="text/javascript" src="' . $a->get_baseurl() . '/addon/jappixmini/lib.js"></script>'."\r\n";
393 $username = get_pconfig(local_user(),'jappixmini','username');
394 $username = str_replace("'", "\\'", $username);
395 $server = get_pconfig(local_user(),'jappixmini','server');
396 $server = str_replace("'", "\\'", $server);
397 $bosh = get_pconfig(local_user(),'jappixmini','bosh');
398 $bosh = str_replace("'", "\\'", $bosh);
399 $encrypt = get_pconfig(local_user(),'jappixmini','encrypt');
400 $encrypt = intval($encrypt);
401 $password = get_pconfig(local_user(),'jappixmini','password');
402 $password = str_replace("'", "\\'", $password);
404 $autoapprove = get_pconfig(local_user(),'jappixmini','autoapprove');
405 $autoapprove = intval($autoapprove);
406 $autosubscribe = get_pconfig(local_user(),'jappixmini','autosubscribe');
407 $autosubscribe = intval($autosubscribe);
409 // deactivate bosh host if proxy is off
410 $conf = file_get_contents("addon/jappixmini/jappix/store/conf/main.xml");
411 preg_match("/<bosh_proxy>(.*)<\/bosh_proxy>/", $conf, $matches);
412 if ($matches[1]!="on") {
416 // get a list of jabber accounts of the contacts
419 $rows = q("SELECT * FROM `pconfig` WHERE `uid`=$uid AND `cat`='jappixmini' and `k` LIKE 'id%%'");
420 foreach ($rows as $row) {
422 $pos = strpos($key, ":");
423 $dfrn_id = substr($key, $pos+1);
424 $r = q("SELECT `name` FROM `contact` WHERE `uid`=$uid AND `dfrn-id`='%s' OR `issued-id`='%s'",
428 $name = $r[0]["name"];
431 $pos = strpos($value, ":");
432 $address = substr($value, $pos+1);
433 if (!$address) continue;
434 if (!$name) $name = $address;
436 $contacts[$address] = $name;
438 $contacts_json = json_encode($contacts);
441 $r = q("SELECT `username` FROM `user` WHERE `uid`=$uid");
442 $nickname = json_encode($r[0]["username"]);
444 // add javascript to start Jappix Mini
445 $a->page['htmlhead'] .= "<script type=\"text/javascript\">
446 jQuery(document).ready(function() {
447 jappixmini_addon_start('$server', '$username', '$bosh', $encrypt, '$password', $nickname, $contacts_json, $autoapprove, $autosubscribe);
454 function jappixmini_login(&$a, &$o) {
455 // create client secret on login to be able to encrypt jabber passwords
457 if (!file_exists("addon/jappixmini/jappix")) return;
459 // for setDB, needed by jappixmini_addon_set_client_secret
460 $a->page['htmlhead'] .= '<script type="text/javascript" src="' . $a->get_baseurl() . '/addon/jappixmini/jappix/php/get.php?t=js&f=datastore.js"></script>'."\r\n";
462 // for str_sha1, needed by jappixmini_addon_set_client_secret
463 $a->page['htmlhead'] .= '<script type="text/javascript" src="' . $a->get_baseurl() . '/addon/jappixmini/jappix/php/get.php?t=js&f=jsjac.js"></script>'."\r\n";
465 // for jappixmini_addon_set_client_secret
466 $a->page['htmlhead'] .= '<script type="text/javascript" src="' . $a->get_baseurl() . '/addon/jappixmini/lib.js"></script>'."\r\n";
468 // save hash of password
469 $o = str_replace("<form ", "<form onsubmit=\"jappixmini_addon_set_client_secret(this.elements['id_password'].value);return true;\" ", $o);
472 function jappixmini_cron(&$a, $d) {
473 // For autosubscribe/autoapprove, we need to maintain a list of jabber addresses of our contacts.
475 if (!file_exists("addon/jappixmini/jappix")) return;
477 // go through list of users with jabber enabled
478 $users = q("SELECT `uid` FROM `pconfig` WHERE `cat`='jappixmini' AND (`k`='autosubscribe' OR `k`='autoapprove') AND `v`='1'");
479 logger("jappixmini: Update list of contacts' jabber accounts for ".count($users)." users.");
481 foreach ($users as $row) {
484 // for each user, go through list of contacts
485 $contacts = q("SELECT * FROM `contact` WHERE `uid`=%d AND ((LENGTH(`dfrn-id`) AND LENGTH(`pubkey`)) OR (LENGTH(`issued-id`) AND LENGTH(`prvkey`)))", intval($uid));
486 foreach ($contacts as $contact_row) {
487 $request = $contact_row["request"];
488 if (!$request) continue;
490 $dfrn_id = $contact_row["dfrn-id"];
492 $key = $contact_row["pubkey"];
493 $encrypt_func = openssl_public_encrypt;
494 $decrypt_func = openssl_public_decrypt;
497 $dfrn_id = $contact_row["issued-id"];
498 $key = $contact_row["prvkey"];
499 $encrypt_func = openssl_private_encrypt;
500 $decrypt_func = openssl_private_decrypt;
504 // check if jabber address already present
505 $present = get_pconfig($uid, "jappixmini", "id:".$dfrn_id);
506 $now = intval(time());
508 // $present has format "timestamp:jabber_address"
509 $p = strpos($present, ":");
510 $timestamp = intval(substr($present, 0, $p));
512 // do not re-retrieve jabber address if last retrieval
513 // is not older than a week
514 if ($now-$timestamp<3600*24*7) continue;
517 // construct base retrieval address
518 $pos = strpos($request, "/dfrn_request/");
519 if ($pos===false) continue;
521 $base = substr($request, 0, $pos)."/jappixmini?role=$role";
523 // construct own address
524 $username = get_pconfig($uid, 'jappixmini', 'username');
525 if (!$username) continue;
526 $server = get_pconfig($uid, 'jappixmini', 'server');
527 if (!$server) continue;
529 $address = $username."@".$server;
532 $signed_address = "";
533 $encrypt_func($address, $signed_address, $key);
535 // construct request url
536 $signed_address_hex = bin2hex($signed_address);
537 $url = $base."&signed_address=$signed_address_hex&dfrn_id=".urlencode($dfrn_id);
541 $answer_json = fetch_url($url);
544 $answer = json_decode($answer_json);
545 if ($answer->status != "ok") throw new Exception();
547 $encrypted_address_hex = $answer->encrypted_address;
548 if (!$encrypted_address_hex) throw new Exception();
550 $encrypted_address = hex2bin($encrypted_address_hex);
551 if (!$encrypted_address) throw new Exception();
554 $decrypted_address = "";
555 $decrypt_func($encrypted_address, $decrypted_address, $key);
556 if (!$decrypted_address) throw new Exception();
557 } catch (Exception $e) {
558 $decrypted_address = "";
562 set_pconfig($uid, "jappixmini", "id:$dfrn_id", "$now:$decrypted_address");
567 function jappixmini_download_source(&$a,&$b) {
568 // Jappix Mini source download link on About page
570 if (!file_exists("addon/jappixmini/jappix")) return;
572 $b .= '<h1>Jappix Mini</h1>';
573 $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>';
574 $b .= '<p>You can download the <a href="'.$a->get_baseurl().'/addon/jappixmini/jappix.zip">source code</a>.</p>';