Stars: 111
Forks: 21
Pull Requests: 16
Issues: 32
Watchers: 10
Last Updated: 2023-01-29 18:45:06
New Discord Provider for the OAuth 2.0 Client
License: MIT License
Languages: PHP
This package provides Discord OAuth 2.0 support for the PHP League's OAuth 2.0 Client, v2.0 and up.
The following versions of PHP are supported.
To install, use composer:
$ composer require wohali/oauth2-discord-new
Usage is the same as The League's OAuth client, using \Wohali\OAuth2\Client\Provider\Discord
as the provider.
This self-contained example:
You can try this script by registering a Discord App with a redirect URI to your server's copy of this sample script. Then, place the Discord app's client id and secret, along with that same URI, into the settings at the top of the script.
<?php
require __DIR__ . '/vendor/autoload.php';
session_start();
echo ('Main screen turn on!<br/><br/>');
$provider = new \Wohali\OAuth2\Client\Provider\Discord([
'clientId' => '{discord-client-id}',
'clientSecret' => '{discord-client-secret}',
'redirectUri' => '{your-server-uri-to-this-script-here}'
]);
if (!isset($_GET['code'])) {
// Step 1. Get authorization code
$authUrl = $provider->getAuthorizationUrl();
$_SESSION['oauth2state'] = $provider->getState();
header('Location: ' . $authUrl);
// Check given state against previously stored one to mitigate CSRF attack
} elseif (empty($_GET['state']) || ($_GET['state'] !== $_SESSION['oauth2state'])) {
unset($_SESSION['oauth2state']);
exit('Invalid state');
} else {
// Step 2. Get an access token using the provided authorization code
$token = $provider->getAccessToken('authorization_code', [
'code' => $_GET['code']
]);
// Show some token details
echo '<h2>Token details:</h2>';
echo 'Token: ' . $token->getToken() . "<br/>";
echo 'Refresh token: ' . $token->getRefreshToken() . "<br/>";
echo 'Expires: ' . $token->getExpires() . " - ";
echo ($token->hasExpired() ? 'expired' : 'not expired') . "<br/>";
// Step 3. (Optional) Look up the user's profile with the provided token
try {
$user = $provider->getResourceOwner($token);
echo '<h2>Resource owner details:</h2>';
printf('Hello %s#%s!<br/><br/>', $user->getUsername(), $user->getDiscriminator());
var_export($user->toArray());
} catch (Exception $e) {
// Failed to get user details
exit('Oh dear...');
}
}
When creating your Discord authorization URL in Step 1, you can specify the state and scopes your application may authorize.
$options = [
'state' => 'OPTIONAL_CUSTOM_CONFIGURED_STATE',
'scope' => ['identify', 'email', '...'] // array or string
];
$authorizationUrl = $provider->getAuthorizationUrl($options);
If neither are defined, the provider will utilize internal defaults.
At the time of authoring this documentation, the following scopes are available:
You can refresh an expired token using a refresh token rather than going through the entire process of obtaining a brand new token. To do so, simply reuse the fresh token from your data store to request a refresh:
// create $provider as in the initial example
$existingAccessToken = getAccessTokenFromYourDataStore();
if ($existingAccessToken->hasExpired()) {
$newAccessToken = $provider->getAccessToken('refresh_token', [
'refresh_token' => $existingAccessToken->getRefreshToken()
]);
// Purge old access token and store new access token to your data store.
}
Discord provides a client credentials flow for bot developers to get their own bearer tokens for testing purposes. This returns an access token for the bot owner:
// create $provider as in the initial example
try {
// Try to get an access token using the client credentials grant.
$accessToken = $provider->getAccessToken('client_credentials');
} catch (\League\OAuth2\Client\Provider\Exception\IdentityProviderException $e) {
// Failed to get the access token
exit($e->getMessage());
}
To authorize a bot, specify a scope of bot
and set permissions appropriately:
// create $provider as in the initial example
$options = [
'scope' => ['bot'],
'permissions' => 1
];
$authorizationUrl = $provider->getAuthorizationUrl($options);
// Redirect user to authorization page
header('Location: ' . $authUrl);
$ ./vendor/bin/parallel-lint src test
$ ./vendor/bin/phpcs src --standard=psr2 -sp
$ ./vendor/bin/phpunit --coverage-text
Please see CONTRIBUTING for details.
The MIT License (MIT). Please see License File for more information.