src/Util/ExAuth.php

   1 <?php
   2
   3 /*
   4  * ejabberd extauth script for the integration with friendica
   5  *
   6  * Originally written for joomla by Dalibor Karlovic <dado@krizevci.info>
   7  * modified for Friendica by Michael Vogel <icarus@dabo.de>
   8  * published under GPL
   9  *
  10  * Latest version of the original script for joomla is available at:
  11  * http://87.230.15.86/~dado/ejabberd/joomla-login
  12  *
  13  * Installation:
  14  *
  15  *      - Change it's owner to whichever user is running the server, ie. ejabberd
  16  *        $ chown ejabberd:ejabberd /path/to/friendica/bin/auth_ejabberd.php
  17  *
  18  *      - Change the access mode so it is readable only to the user ejabberd and has exec
  19  *        $ chmod 700 /path/to/friendica/bin/auth_ejabberd.php
  20  *
  21  *      - Edit your ejabberd.cfg file, comment out your auth_method and add:
  22  *        {auth_method, external}.
  23  *        {extauth_program, "/path/to/friendica/bin/auth_ejabberd.php"}.
  24  *
  25  *      - Restart your ejabberd service, you should be able to login with your friendica auth info
  26  *
  27  * Other hints:
  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)"
  32  *
  33  */
  34
  35 namespace Friendica\Util;
  36
  37 use Friendica\Core\Config;
  38 use Friendica\Core\PConfig;
  39 use Friendica\Database\DBA;
  40 use Friendica\Database\DBM;
  41 use Friendica\Model\User;
  42
  43 require_once 'include/dba.php';
  44
  45 class ExAuth
  46 {
  47         private $bDebug;
  48         private $host;
  49
  50         /**
  51          * @brief Create the class
  52          *
  53          * @param boolean $bDebug Debug mode
  54          */
  55         public function __construct()
  56         {
  57                 $this->bDebug = (int) Config::get('jabber', 'debug');
  58
  59                 openlog('auth_ejabberd', LOG_PID, LOG_USER);
  60
  61                 $this->writeLog(LOG_NOTICE, 'start');
  62         }
  63
  64         /**
  65          * @brief Standard input reading function, executes the auth with the provided
  66          * parameters
  67          *
  68          * @return null
  69          */
  70         public function readStdin()
  71         {
  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');
  76                                 return;
  77                         }
  78
  79                         $iHeader = fgets(STDIN, 3);
  80                         $aLength = unpack('n', $iHeader);
  81                         $iLength = $aLength['1'];
  82
  83                         // No data? Then quit
  84                         if ($iLength == 0) {
  85                                 $this->writeLog(LOG_ERR, 'we got no data, quitting');
  86                                 return;
  87                         }
  88
  89                         // Fetching the data
  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]) {
  95                                         case 'isuser':
  96                                                 // Check the existance of a given username
  97                                                 $this->isUser($aCommand);
  98                                                 break;
  99                                         case 'auth':
 100                                                 // Check if the givven password is correct
 101                                                 $this->auth($aCommand);
 102                                                 break;
 103                                         case 'setpass':
 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));
 107                                                 break;
 108                                         default:
 109                                                 // We don't know the given command
 110                                                 $this->writeLog(LOG_NOTICE, 'unknown command ' . $aCommand[0]);
 111                                                 fwrite(STDOUT, pack('nn', 2, 0));
 112                                                 break;
 113                                 }
 114                         } else {
 115                                 $this->writeLog(LOG_NOTICE, 'invalid command string ' . $sData);
 116                                 fwrite(STDOUT, pack('nn', 2, 0));
 117                         }
 118                 }
 119         }
 120
 121         /**
 122          * @brief Check if the given username exists
 123          *
 124          * @param array $aCommand The command array
 125          */
 126         private function isUser(array $aCommand)
 127         {
 128                 $a = get_app();
 129
 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));
 134                         return;
 135                 }
 136
 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]);
 140
 141                 // Now we check if the given user is valid
 142                 $sUser = str_replace(['%20', '(a)'], [' ', '@'], $aCommand[1]);
 143
 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]);
 148                 } else {
 149                         $found = false;
 150                 }
 151
 152                 // If the hostnames doesn't match or there is some failure, we try to check remotely
 153                 if (!$found) {
 154                         $found = $this->checkUser($aCommand[2], $aCommand[1], true);
 155                 }
 156
 157                 if ($found) {
 158                         // The user is okay
 159                         $this->writeLog(LOG_NOTICE, 'valid user: ' . $sUser);
 160                         fwrite(STDOUT, pack('nn', 2, 1));
 161                 } else {
 162                         // The user isn't okay
 163                         $this->writeLog(LOG_WARNING, 'invalid user: ' . $sUser);
 164                         fwrite(STDOUT, pack('nn', 2, 0));
 165                 }
 166         }
 167
 168         /**
 169          * @brief Check remote user existance via HTTP(S)
 170          *
 171          * @param string $host The hostname
 172          * @param string $user Username
 173          * @param boolean $ssl Should the check be done via SSL?
 174          *
 175          * @return boolean Was the user found?
 176          */
 177         private function checkUser($host, $user, $ssl)
 178         {
 179                 $this->writeLog(LOG_INFO, 'external user check for ' . $user . '@' . $host);
 180
 181                 $url = ($ssl ? 'https' : 'http') . '://' . $host . '/noscrape/' . $user;
 182
 183                 $data = Network::curl($url);
 184
 185                 if (!is_array($data)) {
 186                         return false;
 187                 }
 188
 189                 if ($data['return_code'] != '200') {
 190                         return false;
 191                 }
 192
 193                 $json = @json_decode($data['body']);
 194                 if (!is_object($json)) {
 195                         return false;
 196                 }
 197
 198                 return $json->nick == $user;
 199         }
 200
 201         /**
 202          * @brief Authenticate the given user and password
 203          *
 204          * @param array $aCommand The command array
 205          */
 206         private function auth(array $aCommand)
 207         {
 208                 $a = get_app();
 209
 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));
 214                         return;
 215                 }
 216
 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]);
 220
 221                 // We now check if the password match
 222                 $sUser = str_replace(['%20', '(a)'], [' ', '@'], $aCommand[1]);
 223
 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]);
 227
 228                         $aUser = DBA::selectFirst('user', ['uid', 'password', 'legacy_password'], ['nickname' => $sUser]);
 229                         if (DBM::is_result($aUser)) {
 230                                 $uid = $aUser['uid'];
 231                                 $success = User::authenticate($aUser, $aCommand[3]);
 232                                 $Error = $success === false;
 233                         } else {
 234                                 $this->writeLog(LOG_WARNING, 'user not found: ' . $sUser);
 235                                 $Error = true;
 236                                 $uid = -1;
 237                         }
 238                         if ($Error) {
 239                                 $this->writeLog(LOG_INFO, 'check against alternate password for ' . $sUser . '@' . $aCommand[2]);
 240                                 $sPassword = PConfig::get($uid, 'xmpp', 'password', null, true);
 241                                 $Error = ($aCommand[3] != $sPassword);
 242                         }
 243                 } else {
 244                         $Error = true;
 245                 }
 246
 247                 // If the hostnames doesn't match or there is some failure, we try to check remotely
 248                 if ($Error) {
 249                         $Error = !$this->checkCredentials($aCommand[2], $aCommand[1], $aCommand[3], true);
 250                 }
 251
 252                 if ($Error) {
 253                         $this->writeLog(LOG_WARNING, 'authentification failed for user ' . $sUser . '@' . $aCommand[2]);
 254                         fwrite(STDOUT, pack('nn', 2, 0));
 255                 } else {
 256                         $this->writeLog(LOG_NOTICE, 'authentificated user ' . $sUser . '@' . $aCommand[2]);
 257                         fwrite(STDOUT, pack('nn', 2, 1));
 258                 }
 259         }
 260
 261         /**
 262          * @brief Check remote credentials via HTTP(S)
 263          *
 264          * @param string $host The hostname
 265          * @param string $user Username
 266          * @param string $password Password
 267          * @param boolean $ssl Should the check be done via SSL?
 268          *
 269          * @return boolean Are the credentials okay?
 270          */
 271         private function checkCredentials($host, $user, $password, $ssl)
 272         {
 273                 $this->writeLog(LOG_INFO, 'external credential check for ' . $user . '@' . $host);
 274
 275                 $url = ($ssl ? 'https' : 'http') . '://' . $host . '/api/account/verify_credentials.json?skip_status=true';
 276
 277                 $ch = curl_init();
 278                 curl_setopt($ch, CURLOPT_URL, $url);
 279                 curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
 280                 curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
 281                 curl_setopt($ch, CURLOPT_HEADER, true);
 282                 curl_setopt($ch, CURLOPT_NOBODY, true);
 283                 curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
 284                 curl_setopt($ch, CURLOPT_USERPWD, $user . ':' . $password);
 285
 286                 curl_exec($ch);
 287                 $curl_info = @curl_getinfo($ch);
 288                 $http_code = $curl_info['http_code'];
 289                 curl_close($ch);
 290
 291                 $this->writeLog(LOG_INFO, 'external auth for ' . $user . '@' . $host . ' returned ' . $http_code);
 292
 293                 return $http_code == 200;
 294         }
 295
 296         /**
 297          * @brief Set the hostname for this process
 298          *
 299          * @param string $host The hostname
 300          */
 301         private function setHost($host)
 302         {
 303                 if (!empty($this->host)) {
 304                         return;
 305                 }
 306
 307                 $this->writeLog(LOG_INFO, 'Hostname for process ' . getmypid() . ' is ' . $host);
 308
 309                 $this->host = $host;
 310
 311                 $lockpath = Config::get('jabber', 'lockpath');
 312                 if (is_null($lockpath)) {
 313                         $this->writeLog(LOG_INFO, 'No lockpath defined.');
 314                         return;
 315                 }
 316
 317                 $file = $lockpath . DIRECTORY_SEPARATOR . $host;
 318                 if (PidFile::isRunningProcess($file)) {
 319                         if (PidFile::killProcess($file)) {
 320                                 $this->writeLog(LOG_INFO, 'Old process was successfully killed');
 321                         } else {
 322                                 $this->writeLog(LOG_ERR, "The old Process wasn't killed in time. We now quit our process.");
 323                                 die();
 324                         }
 325                 }
 326
 327                 // Now it is safe to create the pid file
 328                 PidFile::create($file);
 329                 if (!file_exists($file)) {
 330                         $this->writeLog(LOG_WARNING, 'Logfile ' . $file . " couldn't be created.");
 331                 }
 332         }
 333
 334         /**
 335          * @brief write data to the syslog
 336          *
 337          * @param integer $loglevel The syslog loglevel
 338          * @param string $sMessage The syslog message
 339          */
 340         private function writeLog($loglevel, $sMessage)
 341         {
 342                 if (!$this->bDebug && ($loglevel >= LOG_DEBUG)) {
 343                         return;
 344                 }
 345                 syslog($loglevel, $sMessage);
 346         }
 347
 348         /**
 349          * @brief destroy the class, close the syslog connection.
 350          */
 351         public function __destruct()
 352         {
 353                 $this->writeLog(LOG_NOTICE, 'stop');
 354                 closelog();
 355         }
 356 }