README

LTI 1.3 Advantage Library

This code consists of a library for creating LTI tool providers in PHP.

Library Documentation

Importing the library

Using Composer

Add the following to your composer.json file

"repositories": [
    {
        "type": "vcs",
        "url": "https://github.com/IMSGlobal/lti-1-3-php-library"
    }
],
"require": {
    "imsglobal/lti-1p3-tool": "dev-master"
}

Run composer install or composer update In your code, you will now be able to use classes in the \IMSGlobal\LTI namespace to access the library.

Manually

To import the library, copy the lti folder inside src into your project and use the following code at the beginning of execution:

require_once('lti/lti.php');
use \IMSGlobal\LTI;

Accessing Registration Data

To allow for launches to be validated and to allow the tool to know where it has to make calls to, registration data must be stored. Rather than dictating how this is store, the library instead provides an interface that must be implemented to allow it to access registration data. The LTI\Database interface must be fully implemented for this to work.

class Example_Database implements LTI\Database {
    public function find_registration_by_issuer($iss) {
        ...
    }
    public function find_deployment($iss, $deployment_id) {
        ...
    }
}

The find_registration_by_issuer method must return an LTI\LTI_Registration.

return LTI\LTI_Registration::new()
    ->set_auth_login_url($auth_login_url)
    ->set_auth_token_url($auth_token_url)
    ->set_client_id($client_id)
    ->set_key_set_url($key_set_url)
    ->set_kid($kid)
    ->set_issuer($issuer)
    ->set_tool_private_key($private_key);

The find_deployment method must return an LTI\LTI_Deployment if it exists within the database.

return LTI\LTI_Deployment::new()
    ->set_deployment_id($deployment_id);

Calls into the Library will require an instance of LTI\Database to be passed into them.

Creating a JWKS endpoint

A JWKS (JSON Web Key Set) endpoint can be generated for either an individual registration or from an array of KIDs and private keys.

// From issuer
LTI\JWKS_Endpoint::from_issuer(new Example_Database(), 'http://example.com')->output_jwks();
// From registration
LTI\JWKS_Endpoint::from_registration($registration)->output_jwks();
// From array
LTI\JWKS_Endpoint::new(['a_unique_KID' => file_get_contents('/path/to/private/key.pem')])->output_jwks();

Handling Requests

Open Id Connect Login Request

LTI 1.3 uses a modified version of the OpenId Connect third party initiate login flow. This means that to do an LTI 1.3 launch, you must first receive a login initialization request and return to the platform.

To handle this request, you must first create a new LTI\LTI_OIDC_Login object.

$login = LTI_OIDC_Login::new(new Example_Database());

Now you must configure your login request with a return url (this must be preconfigured and white-listed on the tool). If a redirect url is not given or the registration does not exist an LTI\OIDC_Exception will be thrown.

try {
    $redirect = $login->do_oidc_login_redirect("https://my.tool/launch");
} catch (LTI\OIDC_Exception $e) {
    echo 'Error doing OIDC login';
}

With the redirect, we can now redirect the user back to the tool. There are three ways to do this:

This will add a 302 location header and then exit.

$redirect->do_redirect();

This will echo out some javascript to do the redirect instead of using a 302.

$redirect->do_js_redirect();

You can also get the url you need to redirect to, with all the necessary query parameters, if you would prefer to redirect in a custom way.

$redirect_url = $redirect->get_redirect_url();

Redirect is now done, we can move onto the launch.

LTI Message Launches

Now that we have done the OIDC log the platform will launch back to the tool. To handle this request, first we need to create a new LTI\LTI_Message_Launch object.

$launch = LTI\LTI_Message_Launch::new(new Example_Database());

Once we have the message launch, we can validate it. This will check signatures and the presence of a deployment and any required parameters. If the validation fails an exception will be thrown.

try {
    $launch->validate();
} catch (Exception $e) {
    echo 'Launch validation failed';
}

Now we know the launch is valid we can find out more information about the launch.

Check if we have a resource launch or a deep linking launch.

if ($launch->is_resource_launch()) {
    echo 'Resource Launch!';
} else if ($launch->is_deep_link_launch()) {
    echo 'Deep Linking Launch!';
} else {
    echo 'Unknown launch type';
}

Check which services we have access to.

if ($launch->has_ags()) {
    echo 'Has Assignments and Grades Service';
}
if ($launch->has_nrps()) {
    echo 'Has Names and Roles Service';
}

Accessing Cached Launch Requests

It is likely that you will want to refer back to a launch later during subsequent requests. This is done using the launch id to identify a cached request. The launch id can be found using:

$launch_id = $launch->get_launch_id().

Once you have the launch id, you can link it to your session and pass it along as a query parameter.

Make sure you check the launch id against the user session to prevent someone from making actions on another person's launch.

Retrieving a launch using the launch id can be done using:

$launch = LTI_Message_Launch::from_cache($launch_id, new Example_Database());

Once retrieved, you can call any of the methods on the launch object as normal, e.g.

if ($launch->has_ags()) {
    echo 'Has Assignments and Grades Service';
}

Deep Linking Responses

If you receive a deep linking launch, it is very likely that you are going to want to respond to the deep linking request with resources for the platform.

To create a deep link response you will need to get the deep link for the current launch.

$dl = $launch->get_deep_link();

Now we are going to need to create LTI\LTI_Deep_Link_Resource to return.

$resource = LTI\LTI_Deep_Link_Resource::new()
    ->set_url("https://my.tool/launch")
    ->set_custom_params(['my_param' => $my_param])
    ->set_title('My Resource');

Everything is set to return the resource to the platform. There are two methods of doing this.

The following method will output the html for an aut-posting form for you.

$dl->output_response_form([$resource]);

Alternatively you can just request the signed JWT that will need posting back to the platform by calling.

$dl->get_response_jwt([$resource]);

Calling Services

Names and Roles Service

Before using names and roles you should check that you have access to it.

if (!$launch->has_nrps()) {
    throw new Exception("Don't have names and roles!");
}

Once we know we can access it, we can get an instance of the service from the launch.

$nrps = $launch->get_nrps();

From the service we can get an array of all the members by calling:

$members = $nrps->get_members();

Assignments and Grades Service

Before using assignments and grades you should check that you have access to it.

if (!$launch->has_ags()) {
    throw new Exception("Don't have assignments and grades!");
}

Once we know we can access it, we can get an instance of the service from the launch.

$ags = $launch->get_ags();

To pass a grade back to the platform, you will need to create an LTI\LTI_Grade object and populate it with the necessary information.

$grade = LTI\LTI_Grade::new()
    ->set_score_given($grade)
    ->set_score_maximum(100)
    ->set_timestamp(date(DateTime::ISO8601))
    ->set_activity_progress('Completed')
    ->set_grading_progress('FullyGraded')
    ->set_user_id($external_user_id);

To send the grade to the platform we can call:

$ags->put_grade($grade);

This will put the grade into the default provided lineitem. If no default lineitem exists it will create one.

If you want to send multiple types of grade back, that can be done by specifying an LTI\LTI_Lineitem.

$lineitem = LTI\LTI_Lineitem::new()
    ->set_tag('grade')
    ->set_score_maximum(100)
    ->set_label('Grade');

$ags->put_grade($grade, $lineitem);

If a lineitem with the same tag exists, that lineitem will be used, otherwise a new lineitem will be created.

Contributing

If you have improvements, suggestions or bug fixes, feel free to make a pull request or issue and someone will take a look at it.

You do not need to be an IMS Member to use or contribute to this library, however it is recommended for better access to support resources and certification.

This library was initially created by @MartinLenord from Turnitin to help prove out the LTI 1.3 specification and accelerate tool development.

Note: This library is for IMS LTI 1.3 based specifications only. Requests to include custom, off-spec or vendor-specific changes will be declined.

Don't like PHP?

If you don't like PHP and have a favorite language that you would like to make a library for, we'd love to hear about it!

ct-imsglobal / lti-1p3-tool

Maintainers

Details