README

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

Installation

To install, use composer:

composer require ahoicloud/oauth2-client

Usage

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

Authorization Code Flow

$provider = new FVJM\OAuth2\Client\Provider\Ahoi([
    'clientId'          => '{ahoi-client-id}',
    'clientSecret'      => '{ahoi-client-secret}',
    'ahoiInstanceUrl'      => '{ahoi-instance-url}',
    '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->getFirstname());

    } 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 Ahoi authorization URL, you can specify the state and scopes your application may authorize.

$options = [
    'state' => 'OPTIONAL_CUSTOM_CONFIGURED_STATE',
    'scope' => ['profile','offline_acccess'] // 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.

profile
offline_acccess

Refreshing a Token

$provider = new FVJM\OAuth2\Client\Provider\Ahoi([
    'clientId'          => '{ahoi-client-id}',
    'clientSecret'      => '{ahoi-client-secret}',
    'ahoiInstanceUrl'      => '{ahoi-instance-url}',
    'redirectUri'       => 'https://example.com/callback-url'
]);

$grant = new \League\OAuth2\Client\Grant\RefreshToken();
$token = $provider->getAccessToken($grant, ['refresh_token' => $refreshToken]);

Client Credentials Grant

When your application is acting on its own behalf to access resources it controls/owns in a service provider, it may use the client credentials grant type. This is best used when the credentials for your application are stored privately and never exposed (e.g. through the web browser, etc.) to end-users. This grant type functions similarly to the resource owner password credentials grant type, but it does not request a user's username or password. It uses only the client ID and secret issued to your client by the service provider.

$provider = new FVJM\OAuth2\Client\Provider\Ahoi([
    'clientId'          => '{ahoi-client-id}',
    'clientSecret'      => '{ahoi-client-secret}',
    'ahoiInstanceUrl'      => '{ahoi-instance-url}',
    'redirectUri'       => 'https://example.com/callback-url'
]);

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

}

Testing

$ ./vendor/bin/phpunit

Credits

License

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

ahoicloud / oauth2-client

Maintainers

Details