DO NOT USE!
PHP
Latest commit 8f25622 May 31, 2016 @fkooman add deprecation warning

README.md

PLEASE NO LONGER USE THIS LIBRARY

DO NOT USE

Please consider using https://github.com/fkooman/php-oauth2-client if you require a library with PHP 5.4 support.

NOTE: if you are not bound to PHP 5.4, use the OAuth 2.0 client of the League of Extraordinary Packages! It can be found here.

Build Status

Introduction

This project provides an OAuth 2.0 "Authorization Code Grant" client as described in RFC 6749, section 4.1.

The client can be controlled through a PHP API that is used from the application trying to access an OAuth 2.0 protected resource server.

Features

The following features are supported:

  • "Authorization Code Grant" Profile
  • Refresh Tokens

License

Licensed under the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

https://www.gnu.org/licenses/lgpl.html

This roughly means that if you write some PHP application that uses this client you do not need to release your application under (L)GPL as well. Refer to the license for the exact details.

Application Integration

If you want to integrate this OAuth client in your application you need to answer some questions:

  • Where am I going to store the access tokens?
  • How do I make an endpoint URL available in my application that can be used as a redirect URL for the callback from the authorization server?

Next to this you need OAuth client credentials from the authorization server and REST API documentation from the service you want to connect to. You for instance need to know the authorize_endpoint, the token_endpoint, the client_id and client_secret.

As for storing access tokens, this library includes two backends. One for storing the tokens in a database (using the PHP PDO abstraction layer) and one for storing them in the user session. The first one requires some setup, the second one is very easy to use (no configuration) but will not allow the client to access data at the resource server without the session data being available. A more robust implementation would use the PDO backed storage. For testing purposes or very simple setups the session implementation makes the most sense.

The sections below will walk through all the steps you need in order to get the client working.

Example

In addition to this, a full example is available in the example directory. This includes index.php that does the token request and requests the data. Also a callback.php is included to show how to use the Callback API. Next to this a composer.json is included for use with Composer.

Composer

In order to easily integrate with your application it is recommended to use Composer to install the dependencies.

  • fkooman/oauth-client

Below is a simple example composer.json file you could use:

{
    "name": "fkooman/my-demo-oauth-app",
    "require": {
        "fkooman/oauth-client": "dev-master"
    }
}

Client Configuration

You can create an client configuration object as shown below. You can fetch this from a configuration file in your application if desired. Below is an example of the generic ClientConfig class:

$clientConfig = new ClientConfig(
    array(
        "authorize_endpoint" => "http://localhost/oauth/php-oauth/authorize.php",
        "client_id" => "foo",
        "client_secret" => "foobar",
        "token_endpoint" => "http://localhost/oauth/php-oauth/token.php",
    )
);

There is also a GoogleClientConfig class that you can use with Google's client_secrets.json file format:

// Google
$googleClientConfig = new GoogleClientConfig(
    json_decode(file_get_contents("client_secrets.json"), true)
);

The Google class also sets some Google specific options to deal with some specification violations. Configuration options to deal with specification violating services are:

  • allow_null_expires_in in case the OAuth 2.0 AS returns "expires_in": null this setting removes the expires_in field when it is null so it falls back to assuming the token is valid indefinitely. Set it to true to enable this configuration option, defaults to false. AS with this behavior: SurveyMonkey.
  • default_token_type in case the OAuth 2.0 AS omits the token_type field altogether. This allows you to set the token_type. For example you can set it to bearer if you know that is the type the AS returns. AS with this behavior: Salesforce.
  • credentials_in_request_body in case the OAuth 2.0 AS does not accept Basic authentication on the token endpoint. This will force the client to use client_id and client_secret POST body fields to specify the credentials. This option will also make it possible to allow for the client_id to have a colon (:) in it. AS with this behavior: Google, SurveyMonkey, GitHub.
  • default_server_scope in case the server returns a specification violating empty string as scope. This will override the scope value allowing you to set one. It will ONLY be set when the server scope is an empty string, not as a default in all situations! AS with this behavior: Nationbuilder.
  • use_redirect_uri_on_refresh_token_request in case the server requires you to also provide the redirect_uri parameter on a refresh_token request. AS with this behavior: Nationbuilder.
  • use_comma_separated_scope when the AS sends the scope response as a comma separated value instead of space separated. AS with this behavior: GitHub.
  • use_array_scope when the AS sends the scope as an array instead of a space separated string.
  • allow_string_expires_in some AS returns the expires_in value as a string instead of a numerical value. Setting this will cast the string to number.

Initializing the API

Now you can initialize the Api object:

$api = new Api("foo", $clientConfig, new SessionStorage(), new Guzzle3Client());

In this example we use the SessionStorage token storage backend. This is used to keep the obtained tokens in the user session. For testing purposes this is sufficient, for production deployments you will want to use the PdoStorage backend instead, see below.

You also need to provide an instance of Guzzle, or in this case the Guzzle3Client which is a HTTP client used to exchange authorization codes for access tokens, or use a refresh token to obtain a new access token. There is also a Guzzle6Client available if your application already uses Guzzle 6.

Requesting Tokens

In order to request tokens you need to use two methods: Api::getAccessToken() and Api::getAuthorizeUri(). The first one is used to see if there is already a token available, the second to obtain an URL to which you have to redirect the browser from your application. The example below will show you how to use these methods.

Before you can call these methods you need to create a Context object to specify for which user you are requesting this access token and what the scope is you want to request at the authorization server.

$context = new Context("john.doe@example.org", array("read"));

This means that you will request a token bound to john.doe@example.org with the scope read. The user you specify here is typically the user identifier you use in your application that wants to integrate with the OAuth 2.0 protected resource. At your service the user can for example be john.doe@example.org. This identifier is in no way related to the identity of the user at the remote service, it is just used for book keeping the access tokens. If you do not want to request any particular scope you can use array().

Now you can see if an access token is already available:

$accessToken = $api->getAccessToken($context);

This call returns false if no access token is available for this user and scope and none could be obtained through the backchannel using a refresh token. This means that there never was a token or it expired. The token can still be revoked, but we cannot see that right now, we'll find that out when we try to use it later.

Assuming the getAccessToken($context) call returns false, i.e.: there was no token, we have to obtain authorization:

if (false === $accessToken) {
    /* no valid access token available, go to authorization server */
    header("HTTP/1.1 302 Found");
    header("Location: " . $api->getAuthorizeUri($context));
    exit;
}

This is the simplest way if your application is not using any framework. If your application uses a framework you can probably use that to do "proper" redirect without setting the HTTP headers yourself. You should use this!

After this, the flow of this script ends and the user is redirected to the authorization server. Once there, the user accepts the client request and is redirected back to the redirection URL you registered at the OAuth 2.0 service provider. You also need to put some code at this callback location, see the next section below.

Assuming you already had an access token, i.e.: the response from Api::getAccessToken() was not false you can now try to get the resource. You can usually request the resource by setting the Authorization header, like this: Authorization: Bearer access_token where access_token is the value of Api::getAccessToken().

If the request fails with a 401 it means something was wrong with the token. It possibly expired or was revoked. You can remove the currently stored access token and try again:

$api->deleteAccessToken($context);
$api->deleteRefreshToken($context);

Handling the Callback

The above situation assumed you already had a valid access token. If you didn't you got redirected to the authorization server where you had to accept the request for access to your data. Assuming that all went well you will be redirected back to the redirection URI you registered at the OAuth 2.0 service.

The Callback class is very similar to the Api class. We assume you also create the ClientConfig object here, like in the Api case. The contents of this file are assumed to be in callback.php.

try {
    $cb = new Callback("foo", $clientConfig, new SessionStorage(), new Guzzle3Client());
    $cb->handleCallback($_GET);

    header("HTTP/1.1 302 Found");
    header("Location: http://www.example.org/index.php");
} catch (AuthorizeException $e) {
    // this exception is thrown by Callback when the OAuth server returns a 
    // specific error message for the client, e.g.: the user did not authorize 
    // the request
    echo sprintf("ERROR: %s, DESCRIPTION: %s", $e->getMessage(), $e->getDescription());
} catch (Exception $e) {
    // other error, these should never occur in the normal flow
    echo sprintf("ERROR: %s", $e->getMessage());
}

This is all that is needed here. The authorization code will be extracted from the callback URL and used to obtain an access token. The access token will be stored in the token storage, here SessionStorage and the browser will be redirected back to the page where the Api calls are made, here index.php.

Token Storage

You can store the tokens either in SessionStorage or PdoStorage. The first one is already demonstrated above and requires no further configuration, it just works out of the box.

$tokenStorage = new SessionStorage();

The PDO backend requires you specifying the database you want to use:

$db = new PDO("sqlite:/path/to/db/client.sqlite");
$tokenStorage = new PdoStorage($db);

In both cases you can use $tokenStorage in the constructor where before we put new SessionStorage() there directly. See the PHP PDO documentation on how to specify other databases.

Please note that if you use SQLite, please note that the directory you write the file to needs to be writable to the web server as well!

If you want to use a table prefix, please use the second parameter of the constructor to set the prefix, for instance:

$tokenStorage = new PdoStorage($db, "foo_");

To see the database schema you need to import in your database you can use the script in the bin directory, the first parameter is the prefix you want to use for your tables:

$ php bin/php-oauth-client-create-tables foo_

If you specify no parameter no prefix is assumed and the tables to be created are shown without prefix.

Logging

In order to log all the requests the OAuth library makes to the token endpoint it is possible to use e.g. the Monolog adapter for this. Below is an example on how to do this. For production systems you may want to integrate with your own logging framework, set the appropriate log level, e.g. only log on errors.

So instead of just using

new Guzzle3Client()

You can use the following snippet:

use Monolog\Logger;
use Monolog\Handler\StreamHandler;

use Guzzle\Plugin\Log\LogPlugin;
use Guzzle\Log\MessageFormatter;
use Guzzle\Log\MonologLogAdapter;

/* create the log channel */
$log = new Logger('my-app');
$log->pushHandler(new StreamHandler(sprintf("%s/data/client.log", __DIR__), Logger::DEBUG));
$logPlugin = new LogPlugin(new MonologLogAdapter($log), MessageFormatter::DEBUG_FORMAT);

$httpClient = new Client();
$httpClient->addSubscriber($logPlugin);

$guzzle3Client = new Guzzle3Client($httpClient);

Now you can feed the $guzzle3Client to the Api and Callback classes and the requests and responses including their bodies will be logged.

Tests

In order to run the tests you can use PHPUnit. You can run the tests like this:

$ php /path/to/phpunit.phar tests

from the directory. Make sure you first run php /path/to/composer.phar install before running the tests. By default the SQLite PDO driver is used for running database tests. If you want to use another database to test against, copy the phpunit.xml.dist file to phpunit.xml and modify the configuration. For example to use MySQL, configure it like this:

<php>
    <var name="DB_DSN" value="mysql:dbname=oauth;host=localhost" />
    <var name="DB_USER" value="foo" />
    <var name="DB_PASSWD" value="bar" />
</php>