https://github.com/chrishemmings/oauth2-drupal

Drupal 7 OAuth 2.0 support for the PHP League's OAuth 2.0 Client
https://github.com/chrishemmings/oauth2-drupal

Last synced: about 2 months ago
JSON representation

Drupal 7 OAuth 2.0 support for the PHP League's OAuth 2.0 Client

• Host: GitHub
• URL: https://github.com/chrishemmings/oauth2-drupal
• Owner: chrishemmings
• License: mit
• Created: 2016-03-05T19:00:24.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2021-08-11T08:22:29.000Z (over 3 years ago)
• Last Synced: 2024-08-09T16:37:51.747Z (5 months ago)
• Language: PHP
• Homepage:
• Size: 9.77 KB
• Stars: 8
• Watchers: 3
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Drupal OAuth2-Server support for the PHP League's OAuth 2.0 Client

[![Latest Version](https://img.shields.io/github/release/chrishemmings/oauth2-drupal.svg?style=flat-square)](https://github.com/chrishemmings/oauth2-drupal/releases)

[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)

[![Build Status](https://img.shields.io/travis/chrishemmings/oauth2-drupal/master.svg?style=flat-square)](https://travis-ci.org/chrishemmings/oauth2-drupal)

[![Quality Score](https://img.shields.io/scrutinizer/g/chrishemmings/oauth2-drupal.svg?style=flat-square)](https://scrutinizer-ci.com/g/chrishemmings/oauth2-drupal)

[![Total Downloads](https://img.shields.io/packagist/dt/chrishemmings/oauth2-drupal.svg?style=flat-square)](https://packagist.org/packages/chrishemmings/oauth2-drupal)

This package provides Drupal 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-drupal

```

## Usage

Usage is the same as The League's OAuth client, using `\ChrisHemmings\OAuth2\Client\Provider\Drupal` as the provider.

### Authorization Code Flow

```php

require_once('./vendor/autoload.php');

session_start();

$provider = new \ChrisHemmings\OAuth2\Client\Provider\Drupal([

    'clientId'          => '{drupal-client-id}',

    'clientSecret'      => '{drupal-client-secret}',

    'redirectUri'       => 'https://example.com/callback-url',

    'baseUrl'           => 'https://example.com',

]);

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-drupal/blob/master/CONTRIBUTING.md) for details.

## Credits

- [Chris Hemmings](https://github.com/chrishemmings)

- [All Contributors](https://github.com/chrishemmings/oauth2-drupal/contributors)

## License

The MIT License (MIT). Please see [License File](https://github.com/chrishemmings/oauth2-drupal/blob/master/LICENSE) for more information.