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");
53 $a = new App(dirname(__DIR__));
56 @include(".htconfig.php");
57 require_once("include/dba.php");
58 dba::connect($db_host, $db_user, $db_pass, $db_data);
59 unset($db_host, $db_user, $db_pass, $db_data);
61 // the logfile to which to write, should be writeable by the user which is running the server
62 $sLogFile = get_config('jabber','logfile');
64 // set true to debug if needed
65 $bDebug = get_config('jabber','debug');
67 $oAuth = new exAuth($sLogFile, $bDebug);
76 * @brief Create the class and do the authentification studd
78 * @param string $sLogFile The logfile name
79 * @param boolean $bDebug Debug mode
81 public function __construct($sLogFile, $bDebug) {
83 $this->sLogFile = $sLogFile;
84 $this->bDebug = $bDebug;
86 // Open the logfile if the logfile name is defined
87 if ($this->sLogFile != '')
88 $this->rLogFile = fopen($this->sLogFile, "a") || die("Error opening log file: ". $this->sLogFile);
90 $this->writeLog("[exAuth] start");
92 // We are connected to the SQL server and are having a log file.
94 // Quit if the database connection went down
95 if (!dba::connected()) {
96 $this->writeDebugLog("[debug] the database connection went down");
100 $iHeader = fgets(STDIN, 3);
101 $aLength = unpack("n", $iHeader);
102 $iLength = $aLength["1"];
104 // No data? Then quit
106 $this->writeDebugLog("[debug] we got no data");
111 $sData = fgets(STDIN, $iLength + 1);
112 $this->writeDebugLog("[debug] received data: ". $sData);
113 $aCommand = explode(":", $sData);
114 if (is_array($aCommand)) {
115 switch ($aCommand[0]) {
117 // Check the existance of a given username
118 $this->isuser($aCommand);
121 // Check if the givven password is correct
122 $this->auth($aCommand);
125 // We don't accept the setting of passwords here
126 $this->writeLog("[exAuth] setpass command disabled");
127 fwrite(STDOUT, pack("nn", 2, 0));
130 // We don't know the given command
131 $this->writeLog("[exAuth] unknown command ". $aCommand[0]);
132 fwrite(STDOUT, pack("nn", 2, 0));
136 $this->writeDebugLog("[debug] invalid command string");
137 fwrite(STDOUT, pack("nn", 2, 0));
143 * @brief Check if the given username exists
145 * @param array $aCommand The command array
147 private function isuser($aCommand) {
150 // Check if there is a username
151 if (!isset($aCommand[1])) {
152 $this->writeLog("[exAuth] invalid isuser command, no username given");
153 fwrite(STDOUT, pack("nn", 2, 0));
157 // Now we check if the given user is valid
158 $sUser = str_replace(array("%20", "(a)"), array(" ", "@"), $aCommand[1]);
159 $this->writeDebugLog("[debug] checking isuser for ". $sUser."@".$aCommand[2]);
161 // Does the hostname match? So we try directly
162 if ($a->get_hostname() == $aCommand[2]) {
163 $sQuery = "SELECT `uid` FROM `user` WHERE `nickname`='".dbesc($sUser)."'";
164 $this->writeDebugLog("[debug] using query ". $sQuery);
166 $found = dbm::is_result($r);
171 // If the hostnames doesn't match or there is some failure, we try to check remotely
173 $found = $this->check_user($aCommand[2], $aCommand[1], true);
178 $this->writeLog("[exAuth] valid user: ". $sUser);
179 fwrite(STDOUT, pack("nn", 2, 1));
181 // The user isn't okay
182 $this->writeLog("[exAuth] invalid user: ". $sUser);
183 fwrite(STDOUT, pack("nn", 2, 0));
188 * @brief Check remote user existance via HTTP(S)
190 * @param string $host The hostname
191 * @param string $user Username
192 * @param boolean $ssl Should the check be done via SSL?
194 * @return boolean Was the user found?
196 private function check_user($host, $user, $ssl) {
198 $url = ($ssl ? "https":"http")."://".$host."/noscrape/".$user;
200 $data = z_fetch_url($url);
202 if (!is_array($data))
205 if ($data["return_code"] != "200")
208 $json = @json_decode($data["body"]);
209 if (!is_object($json))
212 return($json->nick == $user);
216 * @brief Authenticate the givven user and password
218 * @param array $aCommand The command array
220 private function auth($aCommand) {
223 // check user authentication
224 if (sizeof($aCommand) != 4) {
225 $this->writeLog("[exAuth] invalid auth command, data missing");
226 fwrite(STDOUT, pack("nn", 2, 0));
230 // We now check if the password match
231 $sUser = str_replace(array("%20", "(a)"), array(" ", "@"), $aCommand[1]);
232 $this->writeDebugLog("[debug] doing auth for ".$sUser."@".$aCommand[2]);
234 // Does the hostname match? So we try directly
235 if ($a->get_hostname() == $aCommand[2]) {
236 $sQuery = "SELECT `uid`, `password` FROM `user` WHERE `nickname`='".dbesc($sUser)."'";
237 $this->writeDebugLog("[debug] using query ". $sQuery);
238 if ($oResult = q($sQuery)) {
239 $uid = $oResult[0]["uid"];
240 $Error = ($oResult[0]["password"] != hash('whirlpool',$aCommand[3]));
242 $this->writeLog("[MySQL] invalid query: ". $sQuery);
247 $oConfig = q("SELECT `v` FROM `pconfig` WHERE `uid` = %d AND `cat` = 'xmpp' AND `k`='password' LIMIT 1;", intval($uid));
248 $this->writeLog("[exAuth] got password ".$oConfig[0]["v"]);
249 $Error = ($aCommand[3] != $oConfig[0]["v"]);
255 // If the hostnames doesn't match or there is some failure, we try to check remotely
257 $Error = !$this->check_credentials($aCommand[2], $aCommand[1], $aCommand[3], true);
261 $this->writeLog("[exAuth] authentification failed for user ".$sUser."@". $aCommand[2]);
262 fwrite(STDOUT, pack("nn", 2, 0));
264 $this->writeLog("[exAuth] authentificated user ".$sUser."@".$aCommand[2]);
265 fwrite(STDOUT, pack("nn", 2, 1));
270 * @brief Check remote credentials via HTTP(S)
272 * @param string $host The hostname
273 * @param string $user Username
274 * @param string $password Password
275 * @param boolean $ssl Should the check be done via SSL?
277 * @return boolean Are the credentials okay?
279 private function check_credentials($host, $user, $password, $ssl) {
280 $this->writeDebugLog("[debug] check credentials for user ".$user." on ".$host);
282 $url = ($ssl ? "https":"http")."://".$host."/api/account/verify_credentials.json";
285 curl_setopt($ch, CURLOPT_URL, $url);
286 curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
287 curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
288 curl_setopt($ch, CURLOPT_HEADER, true);
289 curl_setopt($ch, CURLOPT_NOBODY, true);
290 curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
291 curl_setopt($ch, CURLOPT_USERPWD, $user.':'.$password);
293 $header = curl_exec($ch);
294 $curl_info = @curl_getinfo($ch);
295 $http_code = $curl_info["http_code"];
298 $this->writeDebugLog("[debug] got HTTP code ".$http_code);
300 return ($http_code == 200);
304 * @brief write data to the logfile
306 * @param string $sMessage The logfile message
308 private function writeLog($sMessage) {
309 if (is_resource($this->rLogFile))
310 fwrite($this->rLogFile, date("r")." ".$sMessage."\n");
314 * @brief write debug data to the logfile
316 * @param string $sMessage The logfile message
318 private function writeDebugLog($sMessage) {
320 $this->writeLog($sMessage);
324 * @brief destroy the class
326 public function __destruct() {
327 // close the log file
328 $this->writeLog("[exAuth] stop");
330 if (is_resource($this->rLogFile))
331 fclose($this->rLogFile);