4 * ejabberd extauth script for the integration with friendica
6 * Originally written for joomla by Dalibor Karlovic <dado@krizevci.info>
7 * modified for Friendica by Michael Vogel <icarus@dabo.de>
10 * Latest version of the original script for joomla is available at:
11 * http://87.230.15.86/~dado/ejabberd/joomla-login
15 * - Change it's owner to whichever user is running the server, ie. ejabberd
16 * $ chown ejabberd:ejabberd /path/to/friendica/include/auth_ejabberd.php
18 * - Change the access mode so it is readable only to the user ejabberd and has exec
19 * $ chmod 700 /path/to/friendica/include/auth_ejabberd.php
21 * - Edit your ejabberd.cfg file, comment out your auth_method and add:
22 * {auth_method, external}.
23 * {extauth_program, "/path/to/friendica/include/auth_ejabberd.php"}.
25 * - Restart your ejabberd service, you should be able to login with your friendica auth info
28 * - if your users have a space or a @ in their nickname, they'll run into trouble
29 * registering with any client so they should be instructed to replace these chars
30 * " " (space) is replaced with "%20"
31 * "@" is replaced with "(a)"
37 if (sizeof($_SERVER["argv"]) == 0)
40 $directory = dirname($_SERVER["argv"][0]);
42 if (substr($directory, 0, 1) != "/")
43 $directory = $_SERVER["PWD"]."/".$directory;
45 $directory = realpath($directory."/..");
48 require_once("boot.php");
56 @include(".htconfig.php");
57 require_once("include/dba.php");
58 $db = new dba($db_host, $db_user, $db_pass, $db_data);
59 unset($db_host, $db_user, $db_pass, $db_data);
62 // the logfile to which to write, should be writeable by the user which is running the server
63 $sLogFile = get_config('jabber','logfile');
65 // set true to debug if needed
66 $bDebug = get_config('jabber','debug');
68 $oAuth = new exAuth($sLogFile, $bDebug);
77 * @brief Create the class and do the authentification studd
79 * @param string $sLogFile The logfile name
80 * @param boolean $bDebug Debug mode
82 public function __construct($sLogFile, $bDebug) {
86 $this->sLogFile = $sLogFile;
87 $this->bDebug = $bDebug;
89 // Open the logfile if the logfile name is defined
90 if ($this->sLogFile != '')
91 $this->rLogFile = fopen($this->sLogFile, "a") or die("Error opening log file: ". $this->sLogFile);
93 $this->writeLog("[exAuth] start");
95 // We are connected to the SQL server and are having a log file.
97 // Quit if the database connection went down
98 if (!$db->connected()) {
99 $this->writeDebugLog("[debug] the database connection went down");
103 $iHeader = fgets(STDIN, 3);
104 $aLength = unpack("n", $iHeader);
105 $iLength = $aLength["1"];
107 // No data? Then quit
109 $this->writeDebugLog("[debug] we got no data");
114 $sData = fgets(STDIN, $iLength + 1);
115 $this->writeDebugLog("[debug] received data: ". $sData);
116 $aCommand = explode(":", $sData);
117 if (is_array($aCommand)) {
118 switch ($aCommand[0]) {
120 // Check the existance of a given username
121 $this->isuser($aCommand);
124 // Check if the givven password is correct
125 $this->auth($aCommand);
128 // We don't accept the setting of passwords here
129 $this->writeLog("[exAuth] setpass command disabled");
130 fwrite(STDOUT, pack("nn", 2, 0));
133 // We don't know the given command
134 $this->writeLog("[exAuth] unknown command ". $aCommand[0]);
135 fwrite(STDOUT, pack("nn", 2, 0));
139 $this->writeDebugLog("[debug] invalid command string");
140 fwrite(STDOUT, pack("nn", 2, 0));
146 * @brief Check if the given username exists
148 * @param array $aCommand The command array
150 private function isuser($aCommand) {
153 // Check if there is a username
154 if (!isset($aCommand[1])) {
155 $this->writeLog("[exAuth] invalid isuser command, no username given");
156 fwrite(STDOUT, pack("nn", 2, 0));
160 // Now we check if the given user is valid
161 $sUser = str_replace(array("%20", "(a)"), array(" ", "@"), $aCommand[1]);
162 $this->writeDebugLog("[debug] checking isuser for ". $sUser."@".$aCommand[2]);
164 // Does the hostname match? So we try directly
165 if ($a->get_hostname() == $aCommand[2]) {
166 $sQuery = "SELECT `uid` FROM `user` WHERE `nickname`='".dbesc($sUser)."'";
167 $this->writeDebugLog("[debug] using query ". $sQuery);
169 $found = dbm::is_result($r);
174 // If the hostnames doesn't match or there is some failure, we try to check remotely
176 $found = $this->check_user($aCommand[2], $aCommand[1], true);
181 $this->writeLog("[exAuth] valid user: ". $sUser);
182 fwrite(STDOUT, pack("nn", 2, 1));
184 // The user isn't okay
185 $this->writeLog("[exAuth] invalid user: ". $sUser);
186 fwrite(STDOUT, pack("nn", 2, 0));
191 * @brief Check remote user existance via HTTP(S)
193 * @param string $host The hostname
194 * @param string $user Username
195 * @param boolean $ssl Should the check be done via SSL?
197 * @return boolean Was the user found?
199 private function check_user($host, $user, $ssl) {
201 $url = ($ssl ? "https":"http")."://".$host."/noscrape/".$user;
203 $data = z_fetch_url($url);
205 if (!is_array($data))
208 if ($data["return_code"] != "200")
211 $json = @json_decode($data["body"]);
212 if (!is_object($json))
215 return($json->nick == $user);
219 * @brief Authenticate the givven user and password
221 * @param array $aCommand The command array
223 private function auth($aCommand) {
226 // check user authentication
227 if (sizeof($aCommand) != 4) {
228 $this->writeLog("[exAuth] invalid auth command, data missing");
229 fwrite(STDOUT, pack("nn", 2, 0));
233 // We now check if the password match
234 $sUser = str_replace(array("%20", "(a)"), array(" ", "@"), $aCommand[1]);
235 $this->writeDebugLog("[debug] doing auth for ".$sUser."@".$aCommand[2]);
237 // Does the hostname match? So we try directly
238 if ($a->get_hostname() == $aCommand[2]) {
239 $sQuery = "SELECT `uid`, `password` FROM `user` WHERE `nickname`='".dbesc($sUser)."'";
240 $this->writeDebugLog("[debug] using query ". $sQuery);
241 if ($oResult = q($sQuery)) {
242 $uid = $oResult[0]["uid"];
243 $Error = ($oResult[0]["password"] != hash('whirlpool',$aCommand[3]));
245 $this->writeLog("[MySQL] invalid query: ". $sQuery);
250 $oConfig = q("SELECT `v` FROM `pconfig` WHERE `uid` = %d AND `cat` = 'xmpp' AND `k`='password' LIMIT 1;", intval($uid));
251 $this->writeLog("[exAuth] got password ".$oConfig[0]["v"]);
252 $Error = ($aCommand[3] != $oConfig[0]["v"]);
258 // If the hostnames doesn't match or there is some failure, we try to check remotely
260 $Error = !$this->check_credentials($aCommand[2], $aCommand[1], $aCommand[3], true);
264 $this->writeLog("[exAuth] authentification failed for user ".$sUser."@". $aCommand[2]);
265 fwrite(STDOUT, pack("nn", 2, 0));
267 $this->writeLog("[exAuth] authentificated user ".$sUser."@".$aCommand[2]);
268 fwrite(STDOUT, pack("nn", 2, 1));
273 * @brief Check remote credentials via HTTP(S)
275 * @param string $host The hostname
276 * @param string $user Username
277 * @param string $password Password
278 * @param boolean $ssl Should the check be done via SSL?
280 * @return boolean Are the credentials okay?
282 private function check_credentials($host, $user, $password, $ssl) {
283 $this->writeDebugLog("[debug] check credentials for user ".$user." on ".$host);
285 $url = ($ssl ? "https":"http")."://".$host."/api/account/verify_credentials.json";
288 curl_setopt($ch, CURLOPT_URL, $url);
289 curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
290 curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
291 curl_setopt($ch, CURLOPT_HEADER, true);
292 curl_setopt($ch, CURLOPT_NOBODY, true);
293 curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
294 curl_setopt($ch, CURLOPT_USERPWD, $user.':'.$password);
296 $header = curl_exec($ch);
297 $curl_info = @curl_getinfo($ch);
298 $http_code = $curl_info["http_code"];
301 $this->writeDebugLog("[debug] got HTTP code ".$http_code);
303 return ($http_code == 200);
307 * @brief write data to the logfile
309 * @param string $sMessage The logfile message
311 private function writeLog($sMessage) {
312 if (is_resource($this->rLogFile))
313 fwrite($this->rLogFile, date("r")." ".$sMessage."\n");
317 * @brief write debug data to the logfile
319 * @param string $sMessage The logfile message
321 private function writeDebugLog($sMessage) {
323 $this->writeLog($sMessage);
327 * @brief destroy the class
329 public function __destruct() {
330 // close the log file
331 $this->writeLog("[exAuth] stop");
333 if (is_resource($this->rLogFile))
334 fclose($this->rLogFile);