OAuth2lib v10 Installation Guide

• DefaultFormattingResource.class.php
• IFormattingResource.class.php
• OAuth.class.php
• OAuthClient.class.php

Step1: Instantiate the OAuth class with the ID of the Client Application and its client secret.

$client = new OAuth($client_id,$secret);

Step2: Configure the parameters of the OAuth Client class

In the access point of the Client Application we must configure the parameters of the oauth Client class. These are defined in the client's documentation and are the following:

• Authorization Server
  • PUBLIC setAs($url_as): void
• Resource Server
  • PUBLIC setRs($url_rs): void
• Scope
  • PUBLIC setScope($scope): void
• Assertion Type: Type of the assertion (Defined by the constants PAPI or SAML2). By default PAPI.
  • PUBLIC setPAPIAssertionType(): void
  • PUBLIC setSAML2AssertionType(): void
• Error Type: Error type. Defined by the constants HTML or JSON. By default HTML.
  • PUBLIC setHTMLErrorResponse(): void
  • PUBLIC setJSONErrorResponse(): void
• Request type: Type of request that the Client makes to the Resource Server (Defined by the constants HEADER, GET or BODY). By default HEADER.
  • PUBLIC setBODYResourceRequest(): void
  • PUBLIC setGETResourceRequest(): void
  • PUBLIC setHEADERResourceRequest(): void
• Client Secret and Client ID: Defined in the constructor of the OAuth Class
  • OAuth __construct ([ $clientid = "app_client_1"], [ $clientsecret = "example_key"])

The configuration will be made with these methods. For example:

$as="https://oauth-server.rediris.es/oauth2_10/oauth_as/tokenEndpoint.php";
$rs="https://oauth-server.rediris.es/oauth2_10/oauth_server/serverEndpoint.php";
$client->setAs($as);
$client->setRs($rs);
$client->setGETResourceRequest();
$client->setJSONErrorResponse();
$client->setSAML2AssertionType();

Step3: Start the authorization flow

$dev = $client->doOAuthFlow($assertion)

Where $assertion will be the specific assertion for an user. It could be an PAPI assertion or a SAML2 assertion.

In the case of a PAPI assertion, we send in $assertion the information stored in $_SESSION['userdata'], obtained with the phpPoA. For more information about phpPoA, see its web page

In the SAML2 case, we send in $assertion the result of call the method $as->getAttributes(); of SimpleSAMLphp. For more information about SimpleSAMLphp, see its web page

Step4: Getting the resource (or the error)

if(!$dev){
	echo $client->getError();
}else{
    echo $client->getResource();
}

We get the resource with the method getResource().

To know if exists an error, we must check if the result of the doOAuthFlow method returns FALSE or not.

To know which error has happened, we can use the getError() method, that returns a string with the information.

Step5: Formatting the resource

To show the resources to the user, you must implement a method to visualize them properly.

For example, in the use case example, we've implemented a method that gets the resource, an xml string, and format it properly, to show the information in a readable way.

We can format the resources in different ways depending on the scope of the resource, thanks to the method returnResource() of the OAuth class. This function, given an OAuthClient object, formats the corresponding response depending on the scope of the request.

In order to format a Response we must do the following steps:

Step 5.1: Formatting the resource

To format a resource you must to develop a Class that implements the interface IFormattingResource. An example of this type of class is the DefaultFormattingResource.

Step 5.2: Register the format to an specific Scope

To register the format, you must configure the FormatResponses.xml file as you can see in its documentation.

tokenEndpoint.php

'config' directory

keys.xml
errors.xml
policies.xml

'src' directory

oauthAS class
ClientList class
ErrorList class
'assertions' directory
AssertionPolicy class:
IAssertionChecking interface
saml2AssertionChecking
sirAssertionChecking

serverEndpoint.php

'config' directory

keys.xml
errors.xml

'src' directory

oauthRS class
ClientList class
ErrorList class
'assertions' directory
Resource class
IServerResource interface