tobias/friendica
1
0
Fork 0
Code Pull requests Activity

API: Added OAuth revoke, adding documentation to parameters

Browse source
This commit is contained in:
Michael 2021-06-16 19:24:44 +00:00
parent ead0cf370a
commit 5e22704f7e
3 changed files with 30 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
src/Module/OAuth/Authorize.php
View file

@ -41,11 +41,12 @@ class Authorize extends BaseApi
public static function rawContent(array $parameters = []) public static function rawContent(array $parameters = [])
{ {
$request = self::getRequest([ $request = self::getRequest([
'response_type' => '', 'force_login' => '', // Forces the user to re-login, which is necessary for authorizing with multiple accounts from the same instance.
'client_id' => '', 'response_type' => '', // Should be set equal to "code".
'client_id' => '', // Client ID, obtained during app registration.
'client_secret' => '', // Isn't normally provided. We will use it if present. 'client_secret' => '', // Isn't normally provided. We will use it if present.
'redirect_uri' => '', 'redirect_uri' => '', // Set a URI to redirect the user to. If this parameter is set to "urn:ietf:wg:oauth:2.0:oob" then the authorization code will be shown instead. Must match one of the redirect URIs declared during app registration.
'scope' => 'read', 'scope' => 'read', // List of requested OAuth scopes, separated by spaces (or by pluses, if using query parameters). Must be a subset of scopes declared during app registration. If not provided, defaults to "read".
'state' => '', 'state' => '',
]); ]);

20
src/Module/OAuth/Revoke.php
View file

@ -21,6 +21,10 @@
namespace Friendica\Module\OAuth; namespace Friendica\Module\OAuth;
use Friendica\Core\Logger;
use Friendica\Core\System;
use Friendica\Database\DBA;
use Friendica\DI;
use Friendica\Module\BaseApi; use Friendica\Module\BaseApi;
/** /**
@ -30,6 +34,20 @@ class Revoke extends BaseApi
{ {
public static function post(array $parameters = []) public static function post(array $parameters = [])
{ {
self::unsupported('post'); $request = self::getRequest([
'client_id' => '', // Client ID, obtained during app registration
'client_secret' => '', // Client secret, obtained during app registration
'token' => '', // The previously obtained token, to be invalidated
]);
$condition = ['client_id' => $request['client_id'], 'client_secret' => $request['client_secret'], 'access_token' => $request['token']];
$token = DBA::selectFirst('application-view', ['id'], $condition);
if (empty($token['id'])) {
Logger::warning('Token not found', $condition);
DI::mstdnError()->Unauthorized();
}
DBA::delete('application-token', ['application-id' => $token['id']]);
System::jsonExit([]);
} }
} }

11
src/Module/OAuth/Token.php
View file

@ -37,11 +37,12 @@ class Token extends BaseApi
public static function post(array $parameters = []) public static function post(array $parameters = [])
{ {
$request = self::getRequest([ $request = self::getRequest([
'grant_type' => '', 'client_id' => '', // Client ID, obtained during app registration
'code' => '', 'client_secret' => '', // Client secret, obtained during app registration
'redirect_uri' => '', 'redirect_uri' => '', // Set a URI to redirect the user to. If this parameter is set to "urn:ietf:wg:oauth:2.0:oob" then the token will be shown instead. Must match one of the redirect URIs declared during app registration.
'client_id' => '', 'scope' => 'read', // List of requested OAuth scopes, separated by spaces. Must be a subset of scopes declared during app registration. If not provided, defaults to "read".
'client_secret' => '', 'code' => '', // A user authorization code, obtained via /oauth/authorize
'grant_type' => '', // Set equal to "authorization_code" if code is provided in order to gain user-level access. Otherwise, set equal to "client_credentials" to obtain app-level access only.
]); ]);
// AndStatus transmits the client data in the AUTHORIZATION header field, see https://github.com/andstatus/andstatus/issues/530 // AndStatus transmits the client data in the AUTHORIZATION header field, see https://github.com/andstatus/andstatus/issues/530