README

This package provides Phabricator OAuth 2.0 support for the PHP League's OAuth 2.0 Client.

Updates

The project is considered in a usable state and feature complete.

This project is used in corporate applications. As such, the authors are unlikely to update it on a regular basis, but instead when the corporate applications that use it run into problems. You should expect updates in the 5-10yr range.

Issues and PRs will be monitored, and we will continue to work with the community to provide updates as they are contributed.

Installation

To install, use composer:

composer require ofbeaton/oauth2-phabricator

Usage

Usage is the same as The League's OAuth client, using \Ofbeaton\OAuth2\Client\Provider\Phabricator as the provider.

With oauth2-client bundles

Symfony Bundles like knpuniversity's oauth2-client-bundle or HWIOAuthBundle use the PHP League's OAuth 2.0 Client under the hood.

It is vital that you pass the domain for your phabricator install. For knpuniversity's oauth2-client-bundle this means in your Symfony config.yml you want this instead:

knpu_oauth2_client:
   clients:
      phabricator_oauth:
         type: generic
         provider_class: Ofbeaton\OAuth2\Client\Provider\Phabricator
         
         provider_options:
            domain: %phab_host%
            
         client_id: %phab_client_id%
         client_secret: %phab_client_secret%
         redirect_route: connect_phabricator_check
         redirect_params: {}                        

Authorization Code Flow

$provider = new Ofbeaton\OAuth2\Client\Provider\Phabricator([
    'domain'            => 'https://your-phabricator-install.com',
    'clientId'          => '{phabricator-client-id}',
    'clientSecret'      => '{phabricator-client-secret}',
    'redirectUri'       => 'https://your-application.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->getRealName());

    } 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();
}

Managing Scopes

When creating your Phabricator authorization URL, you can specify the state and scopes your application may authorize.

$options = [
    'state' => 'OPTIONAL_CUSTOM_CONFIGURED_STATE',
    'scope' => ['user','user:email','repo'] // array or string
];

$authorizationUrl = $provider->getAuthorizationUrl($options);

If neither are defined, the provider will utilize internal defaults.

At the time of authoring this documentation, no scopes are available.

Testing

$ ./vendor/bin/phpunit

Contributing

Please see CONTRIBUTING for details.

Credits

• Finlay Beaton
• Sammy Kaye Powers (through code from oauth2-facebook)
• Steven Maguire (through code from oauth2-github)
• All Contributors

License

The MIT License (MIT). Please see License File for more information.