Skip to content
Go to file

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

EVE Online Provider for OAuth 2.0 Client

Source Code Latest Version Software License Build Status Coverage Status Quality Score Total Downloads

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


To install, use composer:

composer require killmails/oauth2-eve


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

Authorization Code Flow

$provider = new Killmails\OAuth2\Client\Provider\EveOnline([
    'clientId'          => '{eve-client-id}',
    'clientSecret'      => '{eve-client-key}',
    'redirectUri'       => '',

// If we don't have an authorization code then get one
if (!isset($_GET['code'])) {

    // Fetch the authorization URL from the provider; this returns the
    // urlAuthorize option and generates and applies any necessary parameters
    // (e.g. state).
    $authorizationUrl = $provider->getAuthorizationUrl();

    // Get the state generated for you and store it to the session.
    $_SESSION['oauth2state'] = $provider->getState();

    // Redirect the user to the authorization URL.
    header('Location: ' . $authorizationUrl);

// Check given state against previously stored one to mitigate CSRF attack
} elseif (empty($_GET['state']) || (isset($_SESSION['oauth2state']) && $_GET['state'] !== $_SESSION['oauth2state'])) {

    if (isset($_SESSION['oauth2state'])) {

    exit('Invalid state');

} else {

    try {

        // Try to get an access token using the authorization code grant.
        $accessToken = $provider->getAccessToken('authorization_code', [
            'code' => $_GET['code']

        // We have an access token, which we may use in authenticated
        // requests against the service provider's API.
        echo 'Access Token: ' . $accessToken->getToken() . "<br>";
        echo 'Refresh Token: ' . $accessToken->getRefreshToken() . "<br>";
        echo 'Expired in: ' . $accessToken->getExpires() . "<br>";
        echo 'Already expired? ' . ($accessToken->hasExpired() ? 'expired' : 'not expired') . "<br>";

        // Using the access token, we may look up details about the
        // resource owner.
        $resourceOwner = $provider->getResourceOwner($accessToken);


    } catch (\League\OAuth2\Client\Provider\Exception\IdentityProviderException $e) {

        // Failed to get the access token or user details.



Refreshing a Token

Once your application is authorized, 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 this refresh token from your data store to request a refresh.

$provider = new Killmails\OAuth2\Client\Provider\EveOnline([
    'clientId'          => '{eve-client-id}',
    'clientSecret'      => '{eve-client-key}',
    'redirectUri'       => '',

$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.

Managing Scopes

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

$options = [
    'scope' => ['esi-killmails.read_killmails.v1', 'esi-killmails.read_corporation_killmails.v1']

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

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

Use the ESI documentation to find the full list of scopes available.


$ ./vendor/bin/phpunit


Please see CONTRIBUTING for details.



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

You can’t perform that action at this time.