Authentication is the same as described in [Using the APIs](help/api#Authentication).
+## Clients
+
+Supported mobile apps:
+
+- Tusky
+- Husky
+- twitlatte
+
+Unsupported mobile apps:
+
+- [Subway Tooter](https://github.com/tateisu/SubwayTooter) Uses the wrong grant_type when requesting a token, possibly a problem in the server type detection of the app. See issue https://github.com/tateisu/SubwayTooter/issues/156
+- [Mammut](https://github.com/jamiesanson/Mammut) States that the instance doesn't exist. Most likely an issue in the vitality check of the app, see issue https://github.com/jamiesanson/Mammut/issues/19
+- [AndStatus](https://github.com/andstatus/andstatus) Doesn't provide all data at token request, see issue https://github.com/andstatus/andstatus/issues/537
+- [Fedilab](https://framagit.org/tom79/fedilab) Automatically uses the legacy API, see issue: https://framagit.org/tom79/fedilab/-/issues/520
+
## Entities
These endpoints use the [Mastodon API entities](https://docs.joinmastodon.org/entities/).
*/
public function createFromUriId(int $uriId)
{
- $item = Post::selectFirst(['nody'], ['uri-id' => $uriId]);
+ $item = Post::selectFirst(['body'], ['uri-id' => $uriId]);
if (!empty($item['body'])) {
$data = BBCode::getAttachmentData($item['body']);
} else {
$data['description'] = '';
}
- if (!empty($data['author_name']) && !empty($data['provider_name'])) {
+ if (($data['author_name'] ?? '') == ($data['provider_name'] ?? '')) {
$data['author_name'] = '';
}
- if (!empty($data['author_url']) && !empty($data['provider_url'])) {
+ if (($data['author_url'] ?? '') && ($data['provider_url'] ?? '')) {
$data['author_url'] = '';
}
} elseif (preg_match("/.*(\[attachment.*?\].*?\[\/attachment\]).*/ism", $body, $match)) {
use Friendica\Database\DBA;
use Friendica\DI;
use Friendica\Module\BaseApi;
+use Friendica\Util\Network;
/**
* Apps class to register new OAuth clients
*/
public static function post(array $parameters = [])
{
+ // Workaround for AndStatus, see issue https://github.com/andstatus/andstatus/issues/538
+ if (empty($_REQUEST['client_name']) || empty($_REQUEST['redirect_uris'])) {
+ $postdata = Network::postdata();
+ if (!empty($postdata)) {
+ $_REQUEST = json_decode($postdata, true);
+ if (empty($_REQUEST)) {
+ DI::mstdnError()->UnprocessableEntity(DI::l10n()->t('Missing parameters'));
+ }
+ }
+ }
+
$name = $_REQUEST['client_name'] ?? '';
$redirect = $_REQUEST['redirect_uris'] ?? '';
$scopes = $_REQUEST['scopes'] ?? '';
namespace Friendica\Module;
+use Exception;
use Friendica\BaseModule;
use Friendica\Core\Logger;
use Friendica\Core\System;
/**
* Get the application record via the proved request header fields
*
+ * @param string $client_id
+ * @param string $client_secret
+ * @param string $redirect_uri
* @return array application record
*/
- public static function getApplication()
+ public static function getApplication(string $client_id, string $client_secret, string $redirect_uri)
{
- $redirect_uri = $_REQUEST['redirect_uri'] ?? '';
- $client_id = $_REQUEST['client_id'] ?? '';
- $client_secret = $_REQUEST['client_secret'] ?? '';
-
- if ((empty($redirect_uri) && empty($client_secret)) || empty($client_id)) {
- Logger::warning('Incomplete request', ['request' => $_REQUEST]);
- return [];
- }
-
$condition = ['client_id' => $client_id];
if (!empty($client_secret)) {
$condition['client_secret'] = $client_secret;
/**
* Create and fetch an token for the application and user
*
- * @param array $application
+ * @param array $application
* @param integer $uid
+ * @param string $scope
* @return array application record
*/
- public static function createTokenForUser(array $application, int $uid)
+ public static function createTokenForUser(array $application, int $uid, string $scope)
{
$code = bin2hex(random_bytes(32));
$access_token = bin2hex(random_bytes(32));
+ // @todo store the scope
+
$fields = ['application-id' => $application['id'], 'uid' => $uid, 'code' => $code, 'access_token' => $access_token, 'created_at' => DateTimeFormat::utcNow(DateTimeFormat::MYSQL)];
if (!DBA::insert('application-token', $fields, Database::INSERT_UPDATE)) {
return [];
/**
* @see https://docs.joinmastodon.org/spec/oauth/
+ * @see https://aaronparecki.com/oauth-2-simplified/
*/
class Authorize extends BaseApi
{
public static function rawContent(array $parameters = [])
{
$response_type = $_REQUEST['response_type'] ?? '';
+ $client_id = $_REQUEST['client_id'] ?? '';
+ $client_secret = $_REQUEST['client_secret'] ?? ''; // Isn't normally provided. We will use it if present.
+ $redirect_uri = $_REQUEST['redirect_uri'] ?? '';
+ $scope = $_REQUEST['scope'] ?? '';
+ $state = $_REQUEST['state'] ?? '';
+
if ($response_type != 'code') {
- Logger::warning('Wrong or missing response type', ['response_type' => $response_type]);
- DI::mstdnError()->UnprocessableEntity();
+ Logger::warning('Unsupported or missing response type', ['request' => $_REQUEST]);
+ DI::mstdnError()->UnprocessableEntity(DI::l10n()->t('Unsupported or missing response type'));
}
- $application = self::getApplication();
+ if (empty($client_id) || empty($redirect_uri)) {
+ Logger::warning('Incomplete request data', ['request' => $_REQUEST]);
+ DI::mstdnError()->UnprocessableEntity(DI::l10n()->t('Incomplete request data'));
+ }
+
+ $application = self::getApplication($client_id, $client_secret, $redirect_uri);
if (empty($application)) {
DI::mstdnError()->UnprocessableEntity();
}
+ // @todo Compare the application scope and requested scope
+
$request = $_REQUEST;
unset($request['pagename']);
$redirect = 'oauth/authorize?' . http_build_query($request);
DI::session()->remove('oauth_acknowledge');
- $token = self::createTokenForUser($application, $uid);
+ $token = self::createTokenForUser($application, $uid, $scope);
if (!$token) {
DI::mstdnError()->UnprocessableEntity();
}
- DI::app()->redirect($application['redirect_uri'] . '?code=' . $token['code']);
+ DI::app()->redirect($application['redirect_uri'] . '?' . http_build_query(['code' => $token['code'], 'state' => $state]));
}
}
/**
* @see https://docs.joinmastodon.org/spec/oauth/
+ * @see https://aaronparecki.com/oauth-2-simplified/
*/
class Token extends BaseApi
{
public static function post(array $parameters = [])
{
- $client_secret = $_REQUEST['client_secret'] ?? '';
- $code = $_REQUEST['code'] ?? '';
$grant_type = $_REQUEST['grant_type'] ?? '';
+ $code = $_REQUEST['code'] ?? '';
+ $redirect_uri = $_REQUEST['redirect_uri'] ?? '';
+ $client_id = $_REQUEST['client_id'] ?? '';
+ $client_secret = $_REQUEST['client_secret'] ?? '';
if ($grant_type != 'authorization_code') {
Logger::warning('Unsupported or missing grant type', ['request' => $_REQUEST]);
DI::mstdnError()->UnprocessableEntity(DI::l10n()->t('Unsupported or missing grant type'));
}
- $application = self::getApplication();
- if (empty($application)) {
- DI::mstdnError()->UnprocessableEntity();
+ if (empty($client_id) || empty($client_secret) || empty($redirect_uri)) {
+ Logger::warning('Incomplete request data', ['request' => $_REQUEST]);
+ DI::mstdnError()->UnprocessableEntity(DI::l10n()->t('Incomplete request data'));
}
- if ($application['client_secret'] != $client_secret) {
- Logger::warning('Wrong client secret', $client_secret);
- DI::mstdnError()->Unauthorized();
+ $application = self::getApplication($client_id, $client_secret, $redirect_uri);
+ if (empty($application)) {
+ DI::mstdnError()->UnprocessableEntity();
}
- $condition = ['application-id' => $application['id'], 'code' => $code];
+ // For security reasons only allow freshly created tokens
+ $condition = ["`application-id` = ? AND `code` = ? AND `created_at` > UTC_TIMESTAMP() - INTERVAL ? MINUTE", $application['id'], $code, 5];
$token = DBA::selectFirst('application-token', ['access_token', 'created_at'], $condition);
if (!DBA::isResult($token)) {
- Logger::warning('Token not found', $condition);
+ Logger::warning('Token not found or outdated', $condition);
DI::mstdnError()->Unauthorized();
}
- // @todo Use entity class
- System::jsonExit(['access_token' => $token['access_token'], 'token_type' => 'Bearer', 'scope' => $application['scopes'], 'created_at' => $token['created_at']]);
+ $object = new \Friendica\Object\Api\Mastodon\Token($token['access_token'], 'Bearer', $application['scopes'], $token['created_at']);
+
+ System::jsonExit($object->toArray());
}
}
--- /dev/null
+<?php
+/**
+ * @copyright Copyright (C) 2010-2021, the Friendica project
+ *
+ * @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/>.
+ *
+ */
+
+namespace Friendica\Object\Api\Mastodon;
+
+use Friendica\BaseDataTransferObject;
+use Friendica\Util\DateTimeFormat;
+
+/**
+ * Class Error
+ *
+ * @see https://docs.joinmastodon.org/entities/error
+ */
+class Token extends BaseDataTransferObject
+{
+ /** @var string */
+ protected $access_token;
+ /** @var string */
+ protected $token_type;
+ /** @var string */
+ protected $scope;
+ /** @var string (Datetime) */
+ protected $created_at;
+
+ /**
+ * Creates a token record
+ *
+ * @param string $access_token
+ * @param string $token_type
+ * @param string $scope
+ * @param string $created_at
+ */
+ public function __construct(string $access_token, string $token_type, string $scope, string $created_at)
+ {
+ $this->access_token = $access_token;
+ $this->token_type = $token_type;
+ $this->scope = $scope;
+ $this->created_at = DateTimeFormat::utc($created_at, DateTimeFormat::ATOM);
+ }
+}
projects / friendica.git / commitdiff