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>';
109 // warn if cron job has not yet been executed
110 $cron_run = get_config("jappixmini", "last_cron_execution");
111 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>";
114 $o .= '<label for="jappixmini-infotext">Info text to help users with configuration (important if you want to provide your own BOSH host!):</label><br />';
115 $info_text = get_config("jappixmini", "infotext");
116 $o .= '<textarea id="jappixmini-infotext" name="jappixmini-infotext" rows="5" cols="50">'.htmlentities($info_text).'</textarea><br />';
117 $o .= '<input type="submit" name="jappixmini-admin-settings" value="OK" />';
120 function jappixmini_plugin_admin_post(&$a) {
122 $submit = $_REQUEST['jappixmini-admin-settings'];
124 $info_text = $_REQUEST['jappixmini-infotext'];
125 set_config("jappixmini", "infotext", $info_text);
129 function jappixmini_module() {}
130 function jappixmini_init(&$a) {
131 // module page where other Friendica sites can submit Jabber addresses to and also can query Jabber addresses
134 if (!file_exists("addon/jappixmini/jappix")) killme();
136 $dfrn_id = $_REQUEST["dfrn_id"];
137 if (!$dfrn_id) killme();
139 $role = $_REQUEST["role"];
141 $r = q("SELECT * FROM `contact` WHERE LENGTH(`pubkey`) AND `dfrn-id`='%s' LIMIT 1",
144 if (!count($r)) killme();
146 $encrypt_func = openssl_public_encrypt;
147 $decrypt_func = openssl_public_decrypt;
148 $key = $r[0]["pubkey"];
149 } else if ($role=="prv") {
150 $r = q("SELECT * FROM `contact` WHERE LENGTH(`prvkey`) AND `issued-id`='%s' LIMIT 1",
153 if (!count($r)) killme();
155 $encrypt_func = openssl_private_encrypt;
156 $decrypt_func = openssl_private_decrypt;
157 $key = $r[0]["prvkey"];
164 // save the Jabber address we received
166 $signed_address_hex = $_REQUEST["signed_address"];
167 $signed_address = hex2bin($signed_address_hex);
169 $trusted_address = "";
170 $decrypt_func($signed_address, $trusted_address, $key);
172 $now = intval(time());
173 set_pconfig($uid, "jappixmini", "id:$dfrn_id", "$now:$trusted_address");
174 } catch (Exception $e) {
177 // do not return an address if user deactivated plugin
178 $activated = get_pconfig($uid, 'jappixmini', 'activate');
179 if (!$activated) killme();
181 // return the requested Jabber address
183 $username = get_pconfig($uid, 'jappixmini', 'username');
184 $server = get_pconfig($uid, 'jappixmini', 'server');
185 $address = "$username@$server";
187 $encrypted_address = "";
188 $encrypt_func($address, $encrypted_address, $key);
190 $encrypted_address_hex = bin2hex($encrypted_address);
194 "encrypted_address"=>$encrypted_address_hex
197 $answer_json = json_encode($answer);
200 } catch (Exception $e) {
205 function jappixmini_settings(&$a, &$s) {
206 // addon settings for a user
208 if (!file_exists("addon/jappixmini/jappix")) return;
210 $activate = get_pconfig(local_user(),'jappixmini','activate');
211 $activate = intval($activate) ? ' checked="checked"' : '';
213 $username = get_pconfig(local_user(),'jappixmini','username');
214 $username = htmlentities($username);
215 $server = get_pconfig(local_user(),'jappixmini','server');
216 $server = htmlentities($server);
217 $bosh = get_pconfig(local_user(),'jappixmini','bosh');
218 $bosh = htmlentities($bosh);
219 $password = get_pconfig(local_user(),'jappixmini','password');
220 $autosubscribe = get_pconfig(local_user(),'jappixmini','autosubscribe');
221 $autosubscribe = intval($autosubscribe) ? ' checked="checked"' : '';
222 $autoapprove = get_pconfig(local_user(),'jappixmini','autoapprove');
223 $autoapprove = intval($autoapprove) ? ' checked="checked"' : '';
224 $encrypt = intval(get_pconfig(local_user(),'jappixmini','encrypt'));
225 $encrypt_checked = $encrypt ? ' checked="checked"' : '';
226 $encrypt_disabled = $encrypt ? '' : ' disabled="disabled"';
228 $info_text = get_config("jappixmini", "infotext");
229 $info_text = htmlentities($info_text);
230 $info_text = str_replace("\n", "<br />", $info_text);
233 // load scripts if not yet activated so that password can be saved
234 $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";
235 $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";
237 $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";
238 $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";
239 $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";
241 $a->page['htmlhead'] .= '<script type="text/javascript" src="' . $a->get_baseurl() . '/addon/jappixmini/lib.js"></script>'."\r\n";
244 $s .= '<div class="settings-block">';
246 $s .= '<h3>Jappix Mini addon settings</h3>';
248 $s .= '<label for="jappixmini-activate">Activate addon</label>';
249 $s .= ' <input id="jappixmini-activate" type="checkbox" name="jappixmini-activate" value="1"'.$activate.' />';
251 $s .= '<label for="jappixmini-username">Jabber username</label>';
252 $s .= ' <input id="jappixmini-username" type="text" name="jappixmini-username" value="'.$username.'" />';
254 $s .= '<label for="jappixmini-server">Jabber server</label>';
255 $s .= ' <input id="jappixmini-server" type="text" name="jappixmini-server" value="'.$server.'" />';
258 $conf = file_get_contents("addon/jappixmini/jappix/store/conf/main.xml");
259 preg_match("/<bosh_proxy>(.*)<\/bosh_proxy>/", $conf, $matches);
260 if ($matches[1]=="on") {
261 $s .= '<label for="jappixmini-bosh">Jabber BOSH host</label>';
262 $s .= ' <input id="jappixmini-bosh" type="text" name="jappixmini-bosh" value="'.$bosh.'" />';
266 $s .= '<label for="jappixmini-password">Jabber password</label>';
267 $s .= ' <input type="hidden" id="jappixmini-password" name="jappixmini-encrypted-password" value="'.$password.'" />';
268 $s .= ' <input id="jappixmini-clear-password" type="password" value="" onchange="jappixmini_set_password();" />';
270 $onchange = "document.getElementById('jappixmini-friendica-password').disabled = !this.checked;jappixmini_set_password();";
271 $s .= '<label for="jappixmini-encrypt">Encrypt Jabber password with Friendica password (recommended)</label>';
272 $s .= ' <input id="jappixmini-encrypt" type="checkbox" name="jappixmini-encrypt" onchange="'.$onchange.'" value="1"'.$encrypt_checked.' />';
274 $s .= '<label for="jappixmini-friendica-password">Friendica password</label>';
275 $s .= ' <input id="jappixmini-friendica-password" name="jappixmini-friendica-password" type="password" onchange="jappixmini_set_password();" value=""'.$encrypt_disabled.' />';
277 $s .= '<label for="jappixmini-autoapprove">Approve subscription requests from Friendica contacts automatically</label>';
278 $s .= ' <input id="jappixmini-autoapprove" type="checkbox" name="jappixmini-autoapprove" value="1"'.$autoapprove.' />';
280 $s .= '<label for="jappixmini-autosubscribe">Subscribe to Friendica contacts automatically</label>';
281 $s .= ' <input id="jappixmini-autosubscribe" type="checkbox" name="jappixmini-autosubscribe" value="1"'.$autosubscribe.' />';
283 $s .= '<label for="jappixmini-purge">Purge internal list of jabber addresses of contacts</label>';
284 $s .= ' <input id="jappixmini-purge" type="checkbox" name="jappixmini-purge" value="1" />';
286 if ($info_text) $s .= '<br />Configuration help:<p style="margin-left:2em;">'.$info_text.'</p>';
287 $s .= '<input type="submit" name="jappixmini-submit" value="' . t('Submit') . '" />';
288 $s .= ' <input type="button" value="Add contact" onclick="jappixmini_addon_subscribe();" />';
293 $a->page['htmlhead'] .= "<script type=\"text/javascript\">
294 function jappixmini_set_password() {
295 encrypt = document.getElementById('jappixmini-encrypt').checked;
296 password = document.getElementById('jappixmini-password');
297 clear_password = document.getElementById('jappixmini-clear-password');
299 friendica_password = document.getElementById('jappixmini-friendica-password');
301 if (friendica_password) {
302 jappixmini_addon_set_client_secret(friendica_password.value);
303 jappixmini_addon_encrypt_password(clear_password.value, function(encrypted_password){
304 password.value = encrypted_password;
309 password.value = clear_password.value;
313 jQuery(document).ready(function() {
314 encrypt = document.getElementById('jappixmini-encrypt').checked;
315 password = document.getElementById('jappixmini-password');
316 clear_password = document.getElementById('jappixmini-clear-password');
318 jappixmini_addon_decrypt_password(password.value, function(decrypted_password){
319 clear_password.value = decrypted_password;
323 clear_password.value = password.value;
329 function jappixmini_settings_post(&$a,&$b) {
330 // save addon settings for a user
332 if (!file_exists("addon/jappixmini/jappix")) return;
334 if(! local_user()) return;
337 if($_POST['jappixmini-submit']) {
338 $encrypt = intval($b['jappixmini-encrypt']);
340 // check that Jabber password was encrypted with correct Friendica password
341 $friendica_password = trim($b['jappixmini-friendica-password']);
342 $encrypted = hash('whirlpool',$friendica_password);
343 $r = q("SELECT * FROM `user` WHERE `uid`=$uid AND `password`='%s'",
347 info("Wrong friendica password!");
352 $purge = intval($b['jappixmini-purge']);
354 $username = trim($b['jappixmini-username']);
355 $old_username = get_pconfig($uid,'jappixmini','username');
356 if ($username!=$old_username) $purge = 1;
358 $server = trim($b['jappixmini-server']);
359 $old_server = get_pconfig($uid,'jappixmini','server');
360 if ($server!=$old_server) $purge = 1;
362 set_pconfig($uid,'jappixmini','username',$username);
363 set_pconfig($uid,'jappixmini','server',$server);
364 set_pconfig($uid,'jappixmini','bosh',trim($b['jappixmini-bosh']));
365 set_pconfig($uid,'jappixmini','password',trim($b['jappixmini-encrypted-password']));
366 set_pconfig($uid,'jappixmini','autosubscribe',intval($b['jappixmini-autosubscribe']));
367 set_pconfig($uid,'jappixmini','autoapprove',intval($b['jappixmini-autoapprove']));
368 set_pconfig($uid,'jappixmini','activate',intval($b['jappixmini-activate']));
369 set_pconfig($uid,'jappixmini','encrypt',$encrypt);
370 info( 'Jappix Mini settings saved.' );
373 q("DELETE FROM `pconfig` WHERE `uid`=$uid AND `cat`='jappixmini' and `k` LIKE 'id%%'");
374 info( 'List of addresses purged.' );
379 function jappixmini_script(&$a,&$s) {
380 // adds the script to the page header which starts Jappix Mini
382 if (!file_exists("addon/jappixmini/jappix")) return;
383 if(! local_user()) return;
385 $activate = get_pconfig(local_user(),'jappixmini','activate');
386 if (!$activate) return;
388 $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";
389 $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";
391 $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";
392 $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";
393 $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";
395 $a->page['htmlhead'] .= '<script type="text/javascript" src="' . $a->get_baseurl() . '/addon/jappixmini/lib.js"></script>'."\r\n";
397 $username = get_pconfig(local_user(),'jappixmini','username');
398 $username = str_replace("'", "\\'", $username);
399 $server = get_pconfig(local_user(),'jappixmini','server');
400 $server = str_replace("'", "\\'", $server);
401 $bosh = get_pconfig(local_user(),'jappixmini','bosh');
402 $bosh = str_replace("'", "\\'", $bosh);
403 $encrypt = get_pconfig(local_user(),'jappixmini','encrypt');
404 $encrypt = intval($encrypt);
405 $password = get_pconfig(local_user(),'jappixmini','password');
406 $password = str_replace("'", "\\'", $password);
408 $autoapprove = get_pconfig(local_user(),'jappixmini','autoapprove');
409 $autoapprove = intval($autoapprove);
410 $autosubscribe = get_pconfig(local_user(),'jappixmini','autosubscribe');
411 $autosubscribe = intval($autosubscribe);
413 // deactivate bosh host if proxy is off
414 $conf = file_get_contents("addon/jappixmini/jappix/store/conf/main.xml");
415 preg_match("/<bosh_proxy>(.*)<\/bosh_proxy>/", $conf, $matches);
416 if ($matches[1]!="on") {
420 // get a list of jabber accounts of the contacts
423 $rows = q("SELECT * FROM `pconfig` WHERE `uid`=$uid AND `cat`='jappixmini' and `k` LIKE 'id%%'");
424 foreach ($rows as $row) {
426 $pos = strpos($key, ":");
427 $dfrn_id = substr($key, $pos+1);
428 $r = q("SELECT `name` FROM `contact` WHERE `uid`=$uid AND `dfrn-id`='%s' OR `issued-id`='%s'",
432 $name = $r[0]["name"];
435 $pos = strpos($value, ":");
436 $address = substr($value, $pos+1);
437 if (!$address) continue;
438 if (!$name) $name = $address;
440 $contacts[$address] = $name;
442 $contacts_json = json_encode($contacts);
445 $r = q("SELECT `username` FROM `user` WHERE `uid`=$uid");
446 $nickname = json_encode($r[0]["username"]);
448 // add javascript to start Jappix Mini
449 $a->page['htmlhead'] .= "<script type=\"text/javascript\">
450 jQuery(document).ready(function() {
451 jappixmini_addon_start('$server', '$username', '$bosh', $encrypt, '$password', $nickname, $contacts_json, $autoapprove, $autosubscribe);
458 function jappixmini_login(&$a, &$o) {
459 // create client secret on login to be able to encrypt jabber passwords
461 if (!file_exists("addon/jappixmini/jappix")) return;
463 // for setDB, needed by jappixmini_addon_set_client_secret
464 $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";
466 // for str_sha1, needed by jappixmini_addon_set_client_secret
467 $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";
469 // for jappixmini_addon_set_client_secret
470 $a->page['htmlhead'] .= '<script type="text/javascript" src="' . $a->get_baseurl() . '/addon/jappixmini/lib.js"></script>'."\r\n";
472 // save hash of password
473 $o = str_replace("<form ", "<form onsubmit=\"jappixmini_addon_set_client_secret(this.elements['id_password'].value);return true;\" ", $o);
476 function jappixmini_cron(&$a, $d) {
477 // For autosubscribe/autoapprove, we need to maintain a list of jabber addresses of our contacts.
479 set_config("jappixmini", "last_cron_execution", $d);
481 if (!file_exists("addon/jappixmini/jappix")) return;
483 // go through list of users with jabber enabled
484 $users = q("SELECT `uid` FROM `pconfig` WHERE `cat`='jappixmini' AND (`k`='autosubscribe' OR `k`='autoapprove') AND `v`='1'");
485 logger("jappixmini: Update list of contacts' jabber accounts for ".count($users)." users.");
487 foreach ($users as $row) {
490 // for each user, go through list of contacts
491 $contacts = q("SELECT * FROM `contact` WHERE `uid`=%d AND ((LENGTH(`dfrn-id`) AND LENGTH(`pubkey`)) OR (LENGTH(`issued-id`) AND LENGTH(`prvkey`)))", intval($uid));
492 foreach ($contacts as $contact_row) {
493 $request = $contact_row["request"];
494 if (!$request) continue;
496 $dfrn_id = $contact_row["dfrn-id"];
498 $key = $contact_row["pubkey"];
499 $encrypt_func = openssl_public_encrypt;
500 $decrypt_func = openssl_public_decrypt;
503 $dfrn_id = $contact_row["issued-id"];
504 $key = $contact_row["prvkey"];
505 $encrypt_func = openssl_private_encrypt;
506 $decrypt_func = openssl_private_decrypt;
510 // check if jabber address already present
511 $present = get_pconfig($uid, "jappixmini", "id:".$dfrn_id);
512 $now = intval(time());
514 // $present has format "timestamp:jabber_address"
515 $p = strpos($present, ":");
516 $timestamp = intval(substr($present, 0, $p));
518 // do not re-retrieve jabber address if last retrieval
519 // is not older than a week
520 if ($now-$timestamp<3600*24*7) continue;
523 // construct base retrieval address
524 $pos = strpos($request, "/dfrn_request/");
525 if ($pos===false) continue;
527 $base = substr($request, 0, $pos)."/jappixmini?role=$role";
529 // construct own address
530 $username = get_pconfig($uid, 'jappixmini', 'username');
531 if (!$username) continue;
532 $server = get_pconfig($uid, 'jappixmini', 'server');
533 if (!$server) continue;
535 $address = $username."@".$server;
538 $signed_address = "";
539 $encrypt_func($address, $signed_address, $key);
541 // construct request url
542 $signed_address_hex = bin2hex($signed_address);
543 $url = $base."&signed_address=$signed_address_hex&dfrn_id=".urlencode($dfrn_id);
547 $answer_json = fetch_url($url);
550 $answer = json_decode($answer_json);
551 if ($answer->status != "ok") throw new Exception();
553 $encrypted_address_hex = $answer->encrypted_address;
554 if (!$encrypted_address_hex) throw new Exception();
556 $encrypted_address = hex2bin($encrypted_address_hex);
557 if (!$encrypted_address) throw new Exception();
560 $decrypted_address = "";
561 $decrypt_func($encrypted_address, $decrypted_address, $key);
562 if (!$decrypted_address) throw new Exception();
563 } catch (Exception $e) {
564 $decrypted_address = "";
568 set_pconfig($uid, "jappixmini", "id:$dfrn_id", "$now:$decrypted_address");
573 function jappixmini_download_source(&$a,&$b) {
574 // Jappix Mini source download link on About page
576 if (!file_exists("addon/jappixmini/jappix")) return;
578 $b .= '<h1>Jappix Mini</h1>';
579 $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>';
580 $b .= '<p>You can download the <a href="'.$a->get_baseurl().'/addon/jappixmini/jappix.zip">source code</a>.</p>';