friendica/src/Security/FKOAuthDataStore.php

198 lines
5 KiB
PHP
Raw Normal View History

2017-12-04 20:09:23 +01:00
<?php
/**
* @copyright Copyright (C) 2020, Friendica
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
2017-12-04 20:09:23 +01:00
*
*/
2017-12-17 21:34:29 +01:00
namespace Friendica\Security;
2017-12-04 20:09:23 +01:00
2018-10-29 22:20:46 +01:00
use Friendica\Core\Logger;
use Friendica\Database\DBA;
use Friendica\DI;
use Friendica\Util\Strings;
use Friendica\Security\OAuth1\OAuthConsumer;
use Friendica\Security\OAuth1\OAuthDataStore;
use Friendica\Security\OAuth1\OAuthToken;
2017-12-04 20:09:23 +01:00
define('REQUEST_TOKEN_DURATION', 300);
define('ACCESS_TOKEN_DURATION', 31536000);
/**
* Friendica\Security\OAuth1\OAuthDataStore class
2017-12-04 20:09:23 +01:00
*/
class FKOAuthDataStore extends OAuthDataStore
{
/**
* @return string
* @throws \Exception
*/
private static function genToken()
2017-12-04 20:09:23 +01:00
{
return Strings::getRandomHex(32);
2017-12-04 20:09:23 +01:00
}
/**
* @param string $consumer_key key
* @return OAuthConsumer|null
2019-01-06 22:06:53 +01:00
* @throws \Exception
*/
2017-12-05 03:00:47 +01:00
public function lookup_consumer($consumer_key)
2017-12-04 20:09:23 +01:00
{
2018-10-29 22:20:46 +01:00
Logger::log(__function__ . ":" . $consumer_key);
2017-12-17 21:34:29 +01:00
$s = DBA::select('clients', ['client_id', 'pw', 'redirect_uri'], ['client_id' => $consumer_key]);
2018-07-21 04:03:40 +02:00
$r = DBA::toArray($s);
2017-12-04 20:09:23 +01:00
2018-07-21 14:46:04 +02:00
if (DBA::isResult($r)) {
2018-01-31 05:29:05 +01:00
return new OAuthConsumer($r[0]['client_id'], $r[0]['pw'], $r[0]['redirect_uri']);
2017-12-04 20:09:23 +01:00
}
return null;
}
/**
* @param OAuthConsumer $consumer
* @param string $token_type
* @param string $token_id
* @return OAuthToken|null
2019-01-06 22:06:53 +01:00
* @throws \Exception
*/
public function lookup_token(OAuthConsumer $consumer, $token_type, $token_id)
2017-12-04 20:09:23 +01:00
{
Logger::log(__function__ . ":" . $consumer . ", " . $token_type . ", " . $token_id);
2017-12-17 21:34:29 +01:00
$s = DBA::select('tokens', ['id', 'secret', 'scope', 'expires', 'uid'], ['client_id' => $consumer->key, 'scope' => $token_type, 'id' => $token_id]);
2018-07-21 04:03:40 +02:00
$r = DBA::toArray($s);
2018-07-21 14:46:04 +02:00
if (DBA::isResult($r)) {
2018-01-31 05:29:05 +01:00
$ot = new OAuthToken($r[0]['id'], $r[0]['secret']);
$ot->scope = $r[0]['scope'];
2017-12-04 20:09:23 +01:00
$ot->expires = $r[0]['expires'];
$ot->uid = $r[0]['uid'];
return $ot;
}
2017-12-04 20:09:23 +01:00
return null;
}
/**
* @param OAuthConsumer $consumer
* @param OAuthToken $token
* @param string $nonce
* @param int $timestamp
* @return mixed
2019-01-06 22:06:53 +01:00
* @throws \Exception
*/
public function lookup_nonce(OAuthConsumer $consumer, OAuthToken $token, $nonce, int $timestamp)
2017-12-04 20:09:23 +01:00
{
$token = DBA::selectFirst('tokens', ['id', 'secret'], ['client_id' => $consumer->key, 'id' => $nonce, 'expires' => $timestamp]);
2018-07-21 14:46:04 +02:00
if (DBA::isResult($token)) {
2018-01-31 05:29:05 +01:00
return new OAuthToken($token['id'], $token['secret']);
2017-12-04 20:09:23 +01:00
}
return null;
}
/**
* @param OAuthConsumer $consumer
* @param string $callback
* @return OAuthToken|null
2019-01-06 22:06:53 +01:00
* @throws \Exception
*/
public function new_request_token(OAuthConsumer $consumer, $callback = null)
2017-12-04 20:09:23 +01:00
{
2018-10-29 22:20:46 +01:00
Logger::log(__function__ . ":" . $consumer . ", " . $callback);
$key = self::genToken();
$sec = self::genToken();
2017-12-04 20:09:23 +01:00
if ($consumer->key) {
$k = $consumer->key;
} else {
$k = $consumer;
}
$r = DBA::insert(
'tokens',
[
'id' => $key,
'secret' => $sec,
'client_id' => $k,
'scope' => 'request',
'expires' => time() + REQUEST_TOKEN_DURATION
]
2017-12-04 20:09:23 +01:00
);
if (!$r) {
return null;
}
2018-01-31 05:29:05 +01:00
return new OAuthToken($key, $sec);
2017-12-04 20:09:23 +01:00
}
/**
* @param OAuthToken $token token
* @param OAuthConsumer $consumer consumer
* @param string $verifier optional, defult null
* @return OAuthToken
* @throws \Exception
*/
public function new_access_token(OAuthToken $token, OAuthConsumer $consumer, $verifier = null)
2017-12-04 20:09:23 +01:00
{
2018-10-29 22:20:46 +01:00
Logger::log(__function__ . ":" . $token . ", " . $consumer . ", " . $verifier);
2017-12-04 20:09:23 +01:00
// return a new access token attached to this consumer
// for the user associated with this token if the request token
// is authorized
// should also invalidate the request token
$ret = null;
// get user for this verifier
$uverifier = DI::config()->get("oauth", $verifier);
2018-10-29 22:20:46 +01:00
Logger::log(__function__ . ":" . $verifier . "," . $uverifier);
2017-12-04 20:09:23 +01:00
2017-12-17 21:34:29 +01:00
if (is_null($verifier) || ($uverifier !== false)) {
$key = self::genToken();
$sec = self::genToken();
$r = DBA::insert(
'tokens',
[
'id' => $key,
'secret' => $sec,
'client_id' => $consumer->key,
'scope' => 'access',
'expires' => time() + ACCESS_TOKEN_DURATION,
'uid' => $uverifier
]
2017-12-04 20:09:23 +01:00
);
if ($r) {
2018-01-31 05:29:05 +01:00
$ret = new OAuthToken($key, $sec);
2017-12-04 20:09:23 +01:00
}
}
DBA::delete('tokens', ['id' => $token->key]);
2017-12-04 20:09:23 +01:00
if (!is_null($ret) && !is_null($uverifier)) {
DI::config()->delete("oauth", $verifier);
2017-12-04 20:09:23 +01:00
}
return $ret;
}
}