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\Database\DBA;
  38 use Friendica\DI;
  39 use Friendica\Model\User;
  40
  41 class ExAuth
  42 {
  43         private $bDebug;
  44         private $host;
  45
  46         /**
  47          * Create the class
  48          *
  49          */
  50         public function __construct()
  51         {
  52                 $this->bDebug = (int) DI::config()->get('jabber', 'debug');
  53
  54                 openlog('auth_ejabberd', LOG_PID, LOG_USER);
  55
  56                 $this->writeLog(LOG_NOTICE, 'start');
  57         }
  58
  59         /**
  60          * Standard input reading function, executes the auth with the provided
  61          * parameters
  62          *
  63          * @return null
  64          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
  65          */
  66         public function readStdin()
  67         {
  68                 while (!feof(STDIN)) {
  69                         // Quit if the database connection went down
  70                         if (!DBA::connected()) {
  71                                 $this->writeLog(LOG_ERR, 'the database connection went down');
  72                                 return;
  73                         }
  74
  75                         $iHeader = fgets(STDIN, 3);
  76                         if (empty($iHeader)) {
  77                                 $this->writeLog(LOG_ERR, 'empty stdin');
  78                                 return;
  79                         }
  80
  81                         $aLength = unpack('n', $iHeader);
  82                         $iLength = $aLength['1'];
  83
  84                         // No data? Then quit
  85                         if ($iLength == 0) {
  86                                 $this->writeLog(LOG_ERR, 'we got no data, quitting');
  87                                 return;
  88                         }
  89
  90                         // Fetching the data
  91                         $sData = fgets(STDIN, $iLength + 1);
  92                         $this->writeLog(LOG_DEBUG, 'received data: ' . $sData);
  93                         $aCommand = explode(':', $sData);
  94                         if (is_array($aCommand)) {
  95                                 switch ($aCommand[0]) {
  96                                         case 'isuser':
  97                                                 // Check the existance of a given username
  98                                                 $this->isUser($aCommand);
  99                                                 break;
 100                                         case 'auth':
 101                                                 // Check if the givven password is correct
 102                                                 $this->auth($aCommand);
 103                                                 break;
 104                                         case 'setpass':
 105                                                 // We don't accept the setting of passwords here
 106                                                 $this->writeLog(LOG_NOTICE, 'setpass command disabled');
 107                                                 fwrite(STDOUT, pack('nn', 2, 0));
 108                                                 break;
 109                                         default:
 110                                                 // We don't know the given command
 111                                                 $this->writeLog(LOG_NOTICE, 'unknown command ' . $aCommand[0]);
 112                                                 fwrite(STDOUT, pack('nn', 2, 0));
 113                                                 break;
 114                                 }
 115                         } else {
 116                                 $this->writeLog(LOG_NOTICE, 'invalid command string ' . $sData);
 117                                 fwrite(STDOUT, pack('nn', 2, 0));
 118                         }
 119                 }
 120         }
 121
 122         /**
 123          * Check if the given username exists
 124          *
 125          * @param array $aCommand The command array
 126          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 127          */
 128         private function isUser(array $aCommand)
 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 (DI::baseUrl()->getHostname() == $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          * 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          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 177          */
 178         private function checkUser($host, $user, $ssl)
 179         {
 180                 $this->writeLog(LOG_INFO, 'external user check for ' . $user . '@' . $host);
 181
 182                 $url = ($ssl ? 'https' : 'http') . '://' . $host . '/noscrape/' . $user;
 183
 184                 $curlResult = Network::curl($url);
 185
 186                 if (!$curlResult->isSuccess()) {
 187                         return false;
 188                 }
 189
 190                 if ($curlResult->getReturnCode() != 200) {
 191                         return false;
 192                 }
 193
 194                 $json = @json_decode($curlResult->getBody());
 195                 if (!is_object($json)) {
 196                         return false;
 197                 }
 198
 199                 return $json->nick == $user;
 200         }
 201
 202         /**
 203          * Authenticate the given user and password
 204          *
 205          * @param array $aCommand The command array
 206          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 207          */
 208         private function auth(array $aCommand)
 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 (DI::baseUrl()->getHostname() == $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 (DBA::isResult($aUser)) {
 230                                 $uid = $aUser['uid'];
 231                                 $success = User::authenticate($aUser, $aCommand[3], true);
 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 = DI::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          * 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          * Set the hostname for this process
 298          *
 299          * @param string $host The hostname
 300          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 301          */
 302         private function setHost($host)
 303         {
 304                 if (!empty($this->host)) {
 305                         return;
 306                 }
 307
 308                 $this->writeLog(LOG_INFO, 'Hostname for process ' . getmypid() . ' is ' . $host);
 309
 310                 $this->host = $host;
 311
 312                 $lockpath = DI::config()->get('jabber', 'lockpath');
 313                 if (is_null($lockpath)) {
 314                         $this->writeLog(LOG_INFO, 'No lockpath defined.');
 315                         return;
 316                 }
 317
 318                 $file = $lockpath . DIRECTORY_SEPARATOR . $host;
 319                 if (PidFile::isRunningProcess($file)) {
 320                         if (PidFile::killProcess($file)) {
 321                                 $this->writeLog(LOG_INFO, 'Old process was successfully killed');
 322                         } else {
 323                                 $this->writeLog(LOG_ERR, "The old Process wasn't killed in time. We now quit our process.");
 324                                 die();
 325                         }
 326                 }
 327
 328                 // Now it is safe to create the pid file
 329                 PidFile::create($file);
 330                 if (!file_exists($file)) {
 331                         $this->writeLog(LOG_WARNING, 'Logfile ' . $file . " couldn't be created.");
 332                 }
 333         }
 334
 335         /**
 336          * write data to the syslog
 337          *
 338          * @param integer $loglevel The syslog loglevel
 339          * @param string $sMessage The syslog message
 340          */
 341         private function writeLog($loglevel, $sMessage)
 342         {
 343                 if (!$this->bDebug && ($loglevel >= LOG_DEBUG)) {
 344                         return;
 345                 }
 346                 syslog($loglevel, $sMessage);
 347         }
 348
 349         /**
 350          * destroy the class, close the syslog connection.
 351          */
 352         public function __destruct()
 353         {
 354                 $this->writeLog(LOG_NOTICE, 'stop');
 355                 closelog();
 356         }
 357 }