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/scripts/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/scripts/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/script/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)"
35 namespace Friendica\Util;
37 use Friendica\Core\Config;
38 use Friendica\Core\PConfig;
39 use Friendica\Database\DBM;
40 use Friendica\Model\User;
43 require_once 'include/dba.php';
51 * @brief Create the class
53 * @param boolean $bDebug Debug mode
55 public function __construct()
57 $this->bDebug = (int) Config::get('jabber', 'debug');
59 openlog('auth_ejabberd', LOG_PID, LOG_USER);
61 $this->writeLog(LOG_NOTICE, 'start');
65 * @brief Standard input reading function, executes the auth with the provided
70 public function readStdin()
72 while (!feof(STDIN)) {
73 // Quit if the database connection went down
74 if (!dba::connected()) {
75 $this->writeLog(LOG_ERR, 'the database connection went down');
79 $iHeader = fgets(STDIN, 3);
80 $aLength = unpack('n', $iHeader);
81 $iLength = $aLength['1'];
85 $this->writeLog(LOG_ERR, 'we got no data, quitting');
90 $sData = fgets(STDIN, $iLength + 1);
91 $this->writeLog(LOG_DEBUG, 'received data: ' . $sData);
92 $aCommand = explode(':', $sData);
93 if (is_array($aCommand)) {
94 switch ($aCommand[0]) {
96 // Check the existance of a given username
97 $this->isUser($aCommand);
100 // Check if the givven password is correct
101 $this->auth($aCommand);
104 // We don't accept the setting of passwords here
105 $this->writeLog(LOG_NOTICE, 'setpass command disabled');
106 fwrite(STDOUT, pack('nn', 2, 0));
109 // We don't know the given command
110 $this->writeLog(LOG_NOTICE, 'unknown command ' . $aCommand[0]);
111 fwrite(STDOUT, pack('nn', 2, 0));
115 $this->writeLog(LOG_NOTICE, 'invalid command string ' . $sData);
116 fwrite(STDOUT, pack('nn', 2, 0));
122 * @brief Check if the given username exists
124 * @param array $aCommand The command array
126 private function isUser(array $aCommand)
130 // Check if there is a username
131 if (!isset($aCommand[1])) {
132 $this->writeLog(LOG_NOTICE, 'invalid isuser command, no username given');
133 fwrite(STDOUT, pack('nn', 2, 0));
137 // We only allow one process per hostname. So we set a lock file
138 // Problem: We get the firstname after the first auth - not before
139 $this->setHost($aCommand[2]);
141 // Now we check if the given user is valid
142 $sUser = str_replace(array('%20', '(a)'), array(' ', '@'), $aCommand[1]);
144 // Does the hostname match? So we try directly
145 if ($a->get_hostname() == $aCommand[2]) {
146 $this->writeLog(LOG_INFO, 'internal user check for ' . $sUser . '@' . $aCommand[2]);
147 $found = dba::exists('user', ['nickname' => $sUser]);
152 // If the hostnames doesn't match or there is some failure, we try to check remotely
154 $found = $this->checkUser($aCommand[2], $aCommand[1], true);
159 $this->writeLog(LOG_NOTICE, 'valid user: ' . $sUser);
160 fwrite(STDOUT, pack('nn', 2, 1));
162 // The user isn't okay
163 $this->writeLog(LOG_WARNING, 'invalid user: ' . $sUser);
164 fwrite(STDOUT, pack('nn', 2, 0));
169 * @brief Check remote user existance via HTTP(S)
171 * @param string $host The hostname
172 * @param string $user Username
173 * @param boolean $ssl Should the check be done via SSL?
175 * @return boolean Was the user found?
177 private function checkUser($host, $user, $ssl)
179 $this->writeLog(LOG_INFO, 'external user check for ' . $user . '@' . $host);
181 $url = ($ssl ? 'https' : 'http') . '://' . $host . '/noscrape/' . $user;
183 $data = z_fetch_url($url);
185 if (!is_array($data)) {
189 if ($data['return_code'] != '200') {
193 $json = @json_decode($data['body']);
194 if (!is_object($json)) {
198 return $json->nick == $user;
202 * @brief Authenticate the given user and password
204 * @param array $aCommand The command array
206 private function auth(array $aCommand)
210 // check user authentication
211 if (sizeof($aCommand) != 4) {
212 $this->writeLog(LOG_NOTICE, 'invalid auth command, data missing');
213 fwrite(STDOUT, pack('nn', 2, 0));
217 // We only allow one process per hostname. So we set a lock file
218 // Problem: We get the firstname after the first auth - not before
219 $this->setHost($aCommand[2]);
221 // We now check if the password match
222 $sUser = str_replace(array('%20', '(a)'), array(' ', '@'), $aCommand[1]);
224 // Does the hostname match? So we try directly
225 if ($a->get_hostname() == $aCommand[2]) {
226 $this->writeLog(LOG_INFO, 'internal auth for ' . $sUser . '@' . $aCommand[2]);
228 $aUser = dba::select('user', ['uid', 'password'], ['nickname' => $sUser], ['limit' => 1]);
229 if (DBM::is_result($aUser)) {
230 $uid = User::authenticate($aUser, $aCommand[3]);
231 $Error = $uid === false;
233 $this->writeLog(LOG_WARNING, 'user not found: ' . $sUser);
238 $this->writeLog(LOG_INFO, 'check against alternate password for ' . $sUser . '@' . $aCommand[2]);
239 $sPassword = PConfig::get($uid, 'xmpp', 'password', null, true);
240 $Error = ($aCommand[3] != $sPassword);
246 // If the hostnames doesn't match or there is some failure, we try to check remotely
248 $Error = !$this->checkCredentials($aCommand[2], $aCommand[1], $aCommand[3], true);
252 $this->writeLog(LOG_WARNING, 'authentification failed for user ' . $sUser . '@' . $aCommand[2]);
253 fwrite(STDOUT, pack('nn', 2, 0));
255 $this->writeLog(LOG_NOTICE, 'authentificated user ' . $sUser . '@' . $aCommand[2]);
256 fwrite(STDOUT, pack('nn', 2, 1));
261 * @brief Check remote credentials via HTTP(S)
263 * @param string $host The hostname
264 * @param string $user Username
265 * @param string $password Password
266 * @param boolean $ssl Should the check be done via SSL?
268 * @return boolean Are the credentials okay?
270 private function checkCredentials($host, $user, $password, $ssl)
272 $this->writeLog(LOG_INFO, 'external credential check for ' . $user . '@' . $host);
274 $url = ($ssl ? 'https' : 'http') . '://' . $host . '/api/account/verify_credentials.json?skip_status=true';
277 curl_setopt($ch, CURLOPT_URL, $url);
278 curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
279 curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
280 curl_setopt($ch, CURLOPT_HEADER, true);
281 curl_setopt($ch, CURLOPT_NOBODY, true);
282 curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
283 curl_setopt($ch, CURLOPT_USERPWD, $user . ':' . $password);
286 $curl_info = @curl_getinfo($ch);
287 $http_code = $curl_info['http_code'];
290 $this->writeLog(LOG_INFO, 'external auth for ' . $user . '@' . $host . ' returned ' . $http_code);
292 return $http_code == 200;
296 * @brief Set the hostname for this process
298 * @param string $host The hostname
300 private function setHost($host)
302 if (!empty($this->host)) {
306 $this->writeLog(LOG_INFO, 'Hostname for process ' . getmypid() . ' is ' . $host);
310 $lockpath = Config::get('jabber', 'lockpath');
311 if (is_null($lockpath)) {
315 $file = $lockpath . DIRECTORY_SEPARATOR . $host;
316 if (Pidfile::isRunningProcess($file)) {
317 if (PidFile::killProcess($file)) {
318 $this->writeLog(LOG_INFO, 'Old process was successfully killed');
320 $this->writeLog(LOG_ERR, "The old Process wasn't killed in time. We now quit our process.");
325 // Now it is safe to create the pid file
326 Pidfile::create($file);
330 * @brief write data to the syslog
332 * @param integer $loglevel The syslog loglevel
333 * @param string $sMessage The syslog message
335 private function writeLog($loglevel, $sMessage)
337 if (!$this->bDebug && ($loglevel >= LOG_DEBUG)) {
340 syslog($loglevel, $sMessage);
344 * @brief destroy the class, close the syslog connection.
346 public function __destruct()
348 $this->writeLog(LOG_NOTICE, 'stop');