Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chrishemmings/oauth2-digitalocean
DigitalOcean OAuth 2.0 support for the PHP League's OAuth 2.0 Client
https://github.com/chrishemmings/oauth2-digitalocean
digitalocean oauth2 php-league
Last synced: about 1 month ago
JSON representation
DigitalOcean OAuth 2.0 support for the PHP League's OAuth 2.0 Client
- Host: GitHub
- URL: https://github.com/chrishemmings/oauth2-digitalocean
- Owner: chrishemmings
- License: mit
- Created: 2016-02-12T21:56:07.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-04-18T14:50:29.000Z (over 4 years ago)
- Last Synced: 2024-10-31T04:21:10.336Z (2 months ago)
- Topics: digitalocean, oauth2, php-league
- Language: PHP
- Homepage:
- Size: 24.4 KB
- Stars: 7
- Watchers: 2
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# DigitalOcean Provider for OAuth 2.0 Client
[](https://github.com/chrishemmings/oauth2-digitalocean/releases)
[](LICENSE)
[](https://travis-ci.org/chrishemmings/oauth2-digitalocean)
[](https://scrutinizer-ci.com/g/chrishemmings/oauth2-digitalocean)
[](https://packagist.org/packages/chrishemmings/oauth2-digitalocean)
This package provides DigitalOcean OAuth 2.0 support for the PHP League's [OAuth 2.0 Client](https://github.com/thephpleague/oauth2-client).
## Installation
To install, use composer:
```
composer require chrishemmings/oauth2-digitalocean
```
## Usage
Usage is the same as The League's OAuth client, using `\ChrisHemmings\OAuth2\Client\Provider\DigitalOcean` as the provider.
### Authorization Code Flow
```php
require_once('./vendor/autoload.php');
session_start();
$provider = new \ChrisHemmings\OAuth2\Client\Provider\DigitalOcean([
'clientId' => '{digitalocean-client-id}',
'clientSecret' => '{digitalocean-client-secret}',
'redirectUri' => 'https://example.com/callback-url',
]);
if (!isset($_GET['code'])) {
// If we don't have an authorization code then get one
$authUrl = $provider->getAuthorizationUrl();
$_SESSION['oauth2state'] = $provider->getState();
header('Location: '.$authUrl);
exit;
// 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 {
// Try to get an access token (using the authorization code grant)
$token = $provider->getAccessToken('authorization_code', [
'code' => $_GET['code']
]);
// Optional: Now you have a token you can look up a users profile data
try {
// We got an access token, let's now get the user's details
$user = $provider->getResourceOwner($token);
// Use these details to create a new profile
printf('Hello %s!', $user->getName());
} catch (Exception $e) {
// Failed to get user details
exit('Oh dear...');
}
// Use this to interact with an API on the users behalf
echo $token->getToken();
}
```
## Testing
``` bash
$ ./vendor/bin/phpunit
```
## Contributing
Please see [CONTRIBUTING](https://github.com/chrishemmings/oauth2-digitalocean/blob/master/CONTRIBUTING.md) for details.
## Credits
- [Chris Hemmings](https://github.com/chrishemmings)
- [Daniel Hensby](https://github.com/dhensby)
- [All Contributors](https://github.com/chrishemmings/oauth2-digitalocean/contributors)
## License
The MIT License (MIT). Please see [License File](https://github.com/chrishemmings/oauth2-digitalocean/blob/master/LICENSE) for more information.