src/Security/OAuth.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2021, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Security;
  23
  24 use Friendica\Core\Logger;
  25 use Friendica\Database\Database;
  26 use Friendica\Database\DBA;
  27 use Friendica\Module\BaseApi;
  28 use Friendica\Util\DateTimeFormat;
  29
  30 /**
  31  * OAuth Server
  32  */
  33 class OAuth
  34 {
  35         /**
  36          * @var bool|int
  37          */
  38         protected static $current_user_id = 0;
  39         /**
  40          * @var array
  41          */
  42         protected static $current_token = [];
  43
  44         /**
  45          * Get current user id, returns 0 if not logged in
  46          *
  47          * @return int User ID
  48          */
  49         public static function getCurrentUserID()
  50         {
  51                 if (empty(self::$current_user_id)) {
  52                         $token = self::getCurrentApplicationToken();
  53                         if (!empty($token['uid'])) {
  54                                 self::$current_user_id = $token['uid'];
  55                         } else {
  56                                 self::$current_user_id = 0;
  57                         }
  58                 }
  59
  60                 return (int)self::$current_user_id;
  61         }
  62
  63         /**
  64          * Get current application token
  65          *
  66          * @return array token
  67          */
  68         public static function getCurrentApplicationToken()
  69         {
  70                 if (empty(self::$current_token)) {
  71                         self::$current_token = self::getTokenByBearer();
  72                 }
  73
  74                 return self::$current_token;
  75         }
  76
  77         /**
  78          * Get the user token via the Bearer token
  79          *
  80          * @return array User Token
  81          */
  82         private static function getTokenByBearer()
  83         {
  84                 $authorization = $_SERVER['HTTP_AUTHORIZATION'] ?? '';
  85
  86                 if (substr($authorization, 0, 7) != 'Bearer ') {
  87                         return [];
  88                 }
  89
  90                 $condition = ['access_token' => trim(substr($authorization, 7))];
  91
  92                 $token = DBA::selectFirst('application-view', ['uid', 'id', 'name', 'website', 'created_at', 'read', 'write', 'follow', 'push'], $condition);
  93                 if (!DBA::isResult($token)) {
  94                         Logger::warning('Token not found', $condition);
  95                         return [];
  96                 }
  97                 Logger::debug('Token found', $token);
  98                 return $token;
  99         }
 100
 101         /**
 102          * Get the application record via the provided request header fields
 103          *
 104          * @param string $client_id
 105          * @param string $client_secret
 106          * @param string $redirect_uri
 107          * @return array application record
 108          */
 109         public static function getApplication(string $client_id, string $client_secret, string $redirect_uri)
 110         {
 111                 $condition = ['client_id' => $client_id];
 112                 if (!empty($client_secret)) {
 113                         $condition['client_secret'] = $client_secret;
 114                 }
 115                 if (!empty($redirect_uri)) {
 116                         $condition['redirect_uri'] = $redirect_uri;
 117                 }
 118
 119                 $application = DBA::selectFirst('application', [], $condition);
 120                 if (!DBA::isResult($application)) {
 121                         Logger::warning('Application not found', $condition);
 122                         return [];
 123                 }
 124                 return $application;
 125         }
 126
 127         /**
 128          * Check if an token for the application and user exists
 129          *
 130          * @param array $application
 131          * @param integer $uid
 132          * @return boolean
 133          */
 134         public static function existsTokenForUser(array $application, int $uid)
 135         {
 136                 return DBA::exists('application-token', ['application-id' => $application['id'], 'uid' => $uid]);
 137         }
 138
 139         /**
 140          * Fetch the token for the given application and user
 141          *
 142          * @param array $application
 143          * @param integer $uid
 144          * @return array application record
 145          */
 146         public static function getTokenForUser(array $application, int $uid)
 147         {
 148                 return DBA::selectFirst('application-token', [], ['application-id' => $application['id'], 'uid' => $uid]);
 149         }
 150
 151         /**
 152          * Create and fetch an token for the application and user
 153          *
 154          * @param array   $application
 155          * @param integer $uid
 156          * @param string  $scope
 157          * @return array application record
 158          */
 159         public static function createTokenForUser(array $application, int $uid, string $scope)
 160         {
 161                 $code         = bin2hex(random_bytes(32));
 162                 $access_token = bin2hex(random_bytes(32));
 163
 164                 $fields = [
 165                         'application-id' => $application['id'],
 166                         'uid'            => $uid,
 167                         'code'           => $code,
 168                         'access_token'   => $access_token,
 169                         'scopes'         => $scope,
 170                         'read'           => (stripos($scope, BaseApi::SCOPE_READ) !== false),
 171                         'write'          => (stripos($scope, BaseApi::SCOPE_WRITE) !== false),
 172                         'follow'         => (stripos($scope, BaseApi::SCOPE_FOLLOW) !== false),
 173                         'push'           => (stripos($scope, BaseApi::SCOPE_PUSH) !== false),
 174                         'created_at'     => DateTimeFormat::utcNow(DateTimeFormat::MYSQL)];
 175
 176                 foreach ([BaseApi::SCOPE_READ, BaseApi::SCOPE_WRITE, BaseApi::SCOPE_WRITE, BaseApi::SCOPE_PUSH] as $scope) {
 177                         if ($fields[$scope] && !$application[$scope]) {
 178                                 Logger::warning('Requested token scope is not allowed for the application', ['token' => $fields, 'application' => $application]);
 179                         }
 180                 }
 181
 182                 if (!DBA::insert('application-token', $fields, Database::INSERT_UPDATE)) {
 183                         return [];
 184                 }
 185
 186                 return DBA::selectFirst('application-token', [], ['application-id' => $application['id'], 'uid' => $uid]);
 187         }
 188 }