-- ------------------------------------------
-- Friendica 2021.06-dev (Siberian Iris)
--- DB_UPDATE_VERSION 1417
+-- DB_UPDATE_VERSION 1418
-- ------------------------------------------
`read` boolean COMMENT 'Read scope',
`write` boolean COMMENT 'Write scope',
`follow` boolean COMMENT 'Follow scope',
+ `push` boolean COMMENT 'Push scope',
PRIMARY KEY(`id`),
UNIQUE INDEX `client_id` (`client_id`)
) DEFAULT COLLATE utf8mb4_general_ci COMMENT='OAuth application';
`read` boolean COMMENT 'Read scope',
`write` boolean COMMENT 'Write scope',
`follow` boolean COMMENT 'Follow scope',
+ `push` boolean COMMENT 'Push scope',
PRIMARY KEY(`application-id`,`uid`),
INDEX `uid_id` (`uid`,`application-id`),
FOREIGN KEY (`application-id`) REFERENCES `application` (`id`) ON UPDATE RESTRICT ON DELETE CASCADE,
`application-token`.`scopes` AS `scopes`,
`application-token`.`read` AS `read`,
`application-token`.`write` AS `write`,
- `application-token`.`follow` AS `follow`
+ `application-token`.`follow` AS `follow`,
+ `application-token`.`push` AS `push`
FROM `application-token`
INNER JOIN `application` ON `application-token`.`application-id` = `application`.`id`;
System::jsonError(401, $errorobj->toArray());
}
+ public function Forbidden(string $error = '')
+ {
+ $error = $error ?: DI::l10n()->t('Token is not authorized with a valid user or is missing a required scope');
+ $error_description = '';
+ $errorobj = New \Friendica\Object\Api\Mastodon\Error($error, $error_description);
+
+ System::jsonError(403, $errorobj->toArray());
+ }
+
public function InternalError(string $error = '')
{
$error = $error ?: DI::l10n()->t('Internal Server Error');
{
public static function rawContent(array $parameters = [])
{
- if (self::login() === false) {
+ if (self::login(self::SCOPE_READ) === false) {
throw new HTTPException\ForbiddenException();
}
{
public static function rawContent(array $parameters = [])
{
- if (self::login() === false) {
+ if (self::login(self::SCOPE_READ) === false) {
throw new HTTPException\ForbiddenException();
}
{
public static function post(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_FOLLOW);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
{
public static function post(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_FOLLOW);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
$cid = Contact::follow($parameters['id'], self::getCurrentUserID());
- System::jsonExit(DI::mstdnRelationship()->createFromContactId($cid)->toArray());
+ System::jsonExit(DI::mstdnRelationship()->createFromContactId($cid, $uid)->toArray());
}
}
*/
public static function rawContent(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
*/
public static function rawContent(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
*/
public static function rawContent(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_READ);
System::jsonExit([]);
}
*/
public static function rawContent(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
{
public static function post(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_FOLLOW);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
{
public static function post(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
*/
public static function rawContent(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
if (empty($_REQUEST['id']) || !is_array($_REQUEST['id'])) {
*/
public static function rawContent(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
// What to search for
{
public static function post(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_FOLLOW);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
{
public static function post(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_FOLLOW);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
{
public static function post(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_FOLLOW);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
{
public static function patch(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
$data = Network::postdata();
*/
public static function rawContent(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
$self = User::getOwnerDataById($uid);
*/
public static function rawContent(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_READ);
// @todo Possibly use the message from the pageheader addon for this
System::jsonExit([]);
$fields['scopes'] = $scopes;
}
- $fields['read'] = (stripos($scopes, 'read') !== false);
- $fields['write'] = (stripos($scopes, 'write') !== false);
- $fields['follow'] = (stripos($scopes, 'follow') !== false);
+ $fields['read'] = (stripos($scopes, self::SCOPE_READ) !== false);
+ $fields['write'] = (stripos($scopes, self::SCOPE_WRITE) !== false);
+ $fields['follow'] = (stripos($scopes, self::SCOPE_FOLLOW) !== false);
+ $fields['push'] = (stripos($scopes, self::SCOPE_PUSH) !== false);
if (!empty($website)) {
$fields['website'] = $website;
*/
public static function rawContent(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
*/
public static function rawContent(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
// Maximum number of results to return. Defaults to 20.
*/
public static function rawContent(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
// Maximum number of results to return. Defaults to 20.
*/
public static function post(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_FOLLOW);
$uid = self::getCurrentUserID();
$introduction = DI::intro()->selectFirst(['id' => $parameters['id'], 'uid' => $uid]);
*/
public static function rawContent(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
$min_id = $_GET['min_id'] ?? null;
{
public static function delete(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
public static function post(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
$title = $_REQUEST['title'] ?? '';
*/
public static function rawContent(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
*/
public static function rawContent(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
{
public static function post(array $parameters = [])
{
+ self::login(self::SCOPE_WRITE);
+
self::unsupported('post');
}
*/
public static function rawContent(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_READ);
System::jsonExit([]);
}
{
public static function put(array $parameters = [])
{
+ self::login(self::SCOPE_WRITE);
+ $uid = self::getCurrentUserID();
+
$data = self::getPutData();
self::unsupported('put');
}
*/
public static function rawContent(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
*/
public static function rawContent(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
*/
public static function rawContent(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
if (!empty($parameters['id'])) {
{
public static function post(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
DBA::update('notify', ['seen' => true], ['uid' => $uid]);
{
public static function post(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
*/
public static function rawContent(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
$user = User::getById($uid, ['language', 'allow_cid', 'allow_gid', 'deny_cid', 'deny_gid']);
{
public static function post(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
$data = self::getJsonPostData();
public static function delete(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
{
public static function post(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
{
public static function post(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
{
public static function post(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
{
public static function post(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
{
public static function post(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
{
public static function post(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
{
public static function post(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
{
public static function post(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
{
public static function post(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
{
public static function post(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
*/
public static function rawContent(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
// Maximum number of results to return. Defaults to 40.
*/
public static function rawContent(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
// Return results older than id
*/
public static function rawContent(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
*/
public static function rawContent(array $parameters = [])
{
- self::login();
+ self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
if (empty($parameters['hashtag'])) {
{
parent::init($parameters);
- if (!self::login()) {
+ if (!self::login(self::SCOPE_READ)) {
throw new HTTPException\UnauthorizedException();
}
}
class BaseApi extends BaseModule
{
+ const SCOPE_READ = 'read';
+ const SCOPE_WRITE = 'write';
+ const SCOPE_FOLLOW = 'follow';
+ const SCOPE_PUSH = 'push';
+
/**
* @var string json|xml|rss|atom
*/
*
* Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part
*
+ * @param string $scope the requested scope (read, write, follow)
+ *
* @return bool Was a user authenticated?
* @throws HTTPException\ForbiddenException
* @throws HTTPException\UnauthorizedException
* 'authenticated' => return status,
* 'user_record' => return authenticated user record
*/
- protected static function login()
+ protected static function login(string $scope)
{
if (empty(self::$current_user_id)) {
self::$current_token = self::getTokenByBearer();
}
}
+ if (!empty($scope) && !empty(self::$current_token)) {
+ if (empty(self::$current_token[$scope])) {
+ Logger::warning('The requested scope is not allowed', ['scope' => $scope, 'application' => self::$current_token]);
+ DI::mstdnError()->Forbidden();
+ }
+ }
+
if (empty(self::$current_user_id)) {
// The execution stops here if no one is logged in
api_login(DI::app());
$bearer = trim(substr($authorization, 7));
$condition = ['access_token' => $bearer];
- $token = DBA::selectFirst('application-view', ['uid', 'id', 'name', 'website', 'created_at', 'read', 'write', 'follow'], $condition);
+ $token = DBA::selectFirst('application-view', ['uid', 'id', 'name', 'website', 'created_at', 'read', 'write', 'follow', 'push'], $condition);
if (!DBA::isResult($token)) {
Logger::warning('Token not found', $condition);
return [];
$access_token = bin2hex(random_bytes(32));
$fields = ['application-id' => $application['id'], 'uid' => $uid, 'code' => $code, 'access_token' => $access_token, 'scopes' => $scope,
- 'read' => (stripos($scope, 'read') !== false), 'write' => (stripos($scope, 'write') !== false),
- 'follow' => (stripos($scope, 'follow') !== false), 'created_at' => DateTimeFormat::utcNow(DateTimeFormat::MYSQL)];
+ 'read' => (stripos($scope, self::SCOPE_READ) !== false),
+ 'write' => (stripos($scope, self::SCOPE_WRITE) !== false),
+ 'follow' => (stripos($scope, self::SCOPE_FOLLOW) !== false),
+ 'push' => (stripos($scope, self::SCOPE_PUSH) !== false),
+ 'created_at' => DateTimeFormat::utcNow(DateTimeFormat::MYSQL)];
+
+ foreach ([self::SCOPE_READ, self::SCOPE_WRITE, self::SCOPE_WRITE, self::SCOPE_PUSH] as $scope) {
+ if ($fields[$scope] && !$application[$scope]) {
+ Logger::warning('Requested token scope is not allowed for the application', ['token' => $fields, 'application' => $application]);
+ }
+ }
+
if (!DBA::insert('application-token', $fields, Database::INSERT_UPDATE)) {
return [];
}
use Friendica\Database\DBA;
if (!defined('DB_UPDATE_VERSION')) {
- define('DB_UPDATE_VERSION', 1417);
+ define('DB_UPDATE_VERSION', 1418);
}
return [
"read" => ["type" => "boolean", "comment" => "Read scope"],
"write" => ["type" => "boolean", "comment" => "Write scope"],
"follow" => ["type" => "boolean", "comment" => "Follow scope"],
+ "push" => ["type" => "boolean", "comment" => "Push scope"],
],
"indexes" => [
"PRIMARY" => ["id"],
"read" => ["type" => "boolean", "comment" => "Read scope"],
"write" => ["type" => "boolean", "comment" => "Write scope"],
"follow" => ["type" => "boolean", "comment" => "Follow scope"],
+ "push" => ["type" => "boolean", "comment" => "Push scope"],
],
"indexes" => [
"PRIMARY" => ["application-id", "uid"],
"read" => ["application-token", "read"],
"write" => ["application-token", "write"],
"follow" => ["application-token", "follow"],
+ "push" => ["application-token", "push"],
],
"query" => "FROM `application-token`
INNER JOIN `application` ON `application-token`.`application-id` = `application`.`id`"