/**
* Check the authenticity of the LTI launch request.
*
* The consumer, resource link and user objects will be initialised if the request is valid.
*
* @return boolean True if the request has been successfully validated.
*/
private function authenticate()
{
// Get the consumer
$doSaveConsumer = false;
// Check all required launch parameters
$this->ok = isset($_POST['lti_message_type']) && array_key_exists($_POST['lti_message_type'], self::$MESSAGE_TYPES);
if (!$this->ok) {
$this->reason = 'Invalid or missing lti_message_type parameter.';
}
if ($this->ok) {
$this->ok = isset($_POST['lti_version']) && in_array($_POST['lti_version'], self::$LTI_VERSIONS);
if (!$this->ok) {
$this->reason = 'Invalid or missing lti_version parameter.';
}
}
if ($this->ok) {
if ($_POST['lti_message_type'] === 'basic-lti-launch-request') {
$this->ok = isset($_POST['resource_link_id']) && strlen(trim($_POST['resource_link_id'])) > 0;
if (!$this->ok) {
$this->reason = 'Missing resource link ID.';
}
} else {
if ($_POST['lti_message_type'] === 'ContentItemSelectionRequest') {
if (isset($_POST['accept_media_types']) && strlen(trim($_POST['accept_media_types'])) > 0) {
$mediaTypes = array_filter(explode(',', str_replace(' ', '', $_POST['accept_media_types'])), 'strlen');
$mediaTypes = array_unique($mediaTypes);
$this->ok = count($mediaTypes) > 0;
if (!$this->ok) {
$this->reason = 'No accept_media_types found.';
} else {
$this->mediaTypes = $mediaTypes;
}
} else {
$this->ok = false;
}
if ($this->ok && isset($_POST['accept_presentation_document_targets']) && strlen(trim($_POST['accept_presentation_document_targets'])) > 0) {
$documentTargets = array_filter(explode(',', str_replace(' ', '', $_POST['accept_presentation_document_targets'])), 'strlen');
$documentTargets = array_unique($documentTargets);
$this->ok = count($documentTargets) > 0;
if (!$this->ok) {
$this->reason = 'Missing or empty accept_presentation_document_targets parameter.';
} else {
foreach ($documentTargets as $documentTarget) {
$this->ok = $this->checkValue($documentTarget, array('embed', 'frame', 'iframe', 'window', 'popup', 'overlay', 'none'), 'Invalid value in accept_presentation_document_targets parameter: %s.');
if (!$this->ok) {
break;
}
}
if ($this->ok) {
$this->documentTargets = $documentTargets;
}
}
} else {
$this->ok = false;
}
if ($this->ok) {
$this->ok = isset($_POST['content_item_return_url']) && strlen(trim($_POST['content_item_return_url'])) > 0;
if (!$this->ok) {
$this->reason = 'Missing content_item_return_url parameter.';
}
}
} else {
if ($_POST['lti_message_type'] == 'ToolProxyRegistrationRequest') {
$this->ok = isset($_POST['reg_key']) && strlen(trim($_POST['reg_key'])) > 0 && (isset($_POST['reg_password']) && strlen(trim($_POST['reg_password'])) > 0) && (isset($_POST['tc_profile_url']) && strlen(trim($_POST['tc_profile_url'])) > 0) && (isset($_POST['launch_presentation_return_url']) && strlen(trim($_POST['launch_presentation_return_url'])) > 0);
if ($this->debugMode && !$this->ok) {
$this->reason = 'Missing message parameters.';
}
}
}
}
}
$now = time();
// Check consumer key
if ($this->ok && $_POST['lti_message_type'] != 'ToolProxyRegistrationRequest') {
$this->ok = isset($_POST['oauth_consumer_key']);
if (!$this->ok) {
$this->reason = 'Missing consumer key.';
}
if ($this->ok) {
$this->consumer = new ToolConsumer($_POST['oauth_consumer_key'], $this->dataConnector);
$this->ok = !is_null($this->consumer->created);
if (!$this->ok) {
$this->reason = 'Invalid consumer key.';
}
}
if ($this->ok) {
$today = date('Y-m-d', $now);
if (is_null($this->consumer->lastAccess)) {
$doSaveConsumer = true;
} else {
$last = date('Y-m-d', $this->consumer->lastAccess);
$doSaveConsumer = $doSaveConsumer || $last !== $today;
}
$this->consumer->last_access = $now;
try {
$store = new OAuthDataStore($this);
$server = new OAuth\OAuthServer($store);
$method = new OAuth\OAuthSignatureMethod_HMAC_SHA1();
$server->add_signature_method($method);
$request = OAuth\OAuthRequest::from_request();
$res = $server->verify_request($request);
} catch (\Exception $e) {
$this->ok = false;
if (empty($this->reason)) {
if ($this->debugMode) {
$consumer = new OAuth\OAuthConsumer($this->consumer->getKey(), $this->consumer->secret);
$signature = $request->build_signature($method, $consumer, false);
$this->reason = $e->getMessage();
if (empty($this->reason)) {
$this->reason = 'OAuth exception';
}
$this->details[] = 'Timestamp: ' . time();
$this->details[] = "Signature: {$signature}";
$this->details[] = "Base string: {$request->base_string}]";
} else {
$this->reason = 'OAuth signature check failed - perhaps an incorrect secret or timestamp.';
}
}
}
}
if ($this->ok) {
$today = date('Y-m-d', $now);
if (is_null($this->consumer->lastAccess)) {
$doSaveConsumer = true;
} else {
$last = date('Y-m-d', $this->consumer->lastAccess);
$doSaveConsumer = $doSaveConsumer || $last !== $today;
}
$this->consumer->last_access = $now;
if ($this->consumer->protected) {
if (!is_null($this->consumer->consumerGuid)) {
$this->ok = empty($_POST['tool_consumer_instance_guid']) || $this->consumer->consumerGuid === $_POST['tool_consumer_instance_guid'];
if (!$this->ok) {
$this->reason = 'Request is from an invalid tool consumer.';
}
} else {
$this->ok = isset($_POST['tool_consumer_instance_guid']);
if (!$this->ok) {
$this->reason = 'A tool consumer GUID must be included in the launch request.';
}
}
}
if ($this->ok) {
$this->ok = $this->consumer->enabled;
if (!$this->ok) {
$this->reason = 'Tool consumer has not been enabled by the tool provider.';
}
}
if ($this->ok) {
$this->ok = is_null($this->consumer->enableFrom) || $this->consumer->enableFrom <= $now;
if ($this->ok) {
$this->ok = is_null($this->consumer->enableUntil) || $this->consumer->enableUntil > $now;
if (!$this->ok) {
$this->reason = 'Tool consumer access has expired.';
}
} else {
$this->reason = 'Tool consumer access is not yet available.';
}
}
}
// Validate other message parameter values
if ($this->ok) {
if ($_POST['lti_message_type'] === 'ContentItemSelectionRequest') {
if (isset($_POST['accept_unsigned'])) {
$this->ok = $this->checkValue($_POST['accept_unsigned'], array('true', 'false'), 'Invalid value for accept_unsigned parameter: %s.');
}
if ($this->ok && isset($_POST['accept_multiple'])) {
$this->ok = $this->checkValue($_POST['accept_multiple'], array('true', 'false'), 'Invalid value for accept_multiple parameter: %s.');
}
if ($this->ok && isset($_POST['accept_copy_advice'])) {
$this->ok = $this->checkValue($_POST['accept_copy_advice'], array('true', 'false'), 'Invalid value for accept_copy_advice parameter: %s.');
}
if ($this->ok && isset($_POST['auto_create'])) {
$this->ok = $this->checkValue($_POST['auto_create'], array('true', 'false'), 'Invalid value for auto_create parameter: %s.');
}
if ($this->ok && isset($_POST['can_confirm'])) {
$this->ok = $this->checkValue($_POST['can_confirm'], array('true', 'false'), 'Invalid value for can_confirm parameter: %s.');
}
} else {
if (isset($_POST['launch_presentation_document_target'])) {
$this->ok = $this->checkValue($_POST['launch_presentation_document_target'], array('embed', 'frame', 'iframe', 'window', 'popup', 'overlay'), 'Invalid value for launch_presentation_document_target parameter: %s.');
}
}
}
}
if ($this->ok && $_POST['lti_message_type'] === 'ToolProxyRegistrationRequest') {
$this->ok = $_POST['lti_version'] == self::LTI_VERSION2;
if (!$this->ok) {
$this->reason = 'Invalid lti_version parameter';
}
if ($this->ok) {
$http = new HTTPMessage($_POST['tc_profile_url'], 'GET', null, 'Accept: application/vnd.ims.lti.v2.toolconsumerprofile+json');
$this->ok = $http->send();
if (!$this->ok) {
$this->reason = 'Tool consumer profile not accessible.';
} else {
$tcProfile = json_decode($http->response);
$this->ok = !is_null($tcProfile);
if (!$this->ok) {
$this->reason = 'Invalid JSON in tool consumer profile.';
}
}
}
// Check for required capabilities
if ($this->ok) {
$this->consumer = new ToolConsumer($_POST['reg_key'], $this->dataConnector);
$this->consumer->profile = $tcProfile;
$capabilities = $this->consumer->profile->capability_offered;
$missing = array();
foreach ($this->resourceHandlers as $resourceHandler) {
foreach ($resourceHandler->requiredMessages as $message) {
if (!in_array($message->type, $capabilities)) {
$missing[$message->type] = true;
}
}
}
foreach ($this->constraints as $name => $constraint) {
if ($constraint['required']) {
if (!in_array($name, $capabilities) && !in_array($name, array_flip($capabilities))) {
$missing[$name] = true;
}
}
}
if (!empty($missing)) {
ksort($missing);
$this->reason = 'Required capability not offered - \'' . implode('\', \'', array_keys($missing)) . '\'';
$this->ok = false;
}
}
// Check for required services
if ($this->ok) {
foreach ($this->requiredServices as $service) {
foreach ($service->formats as $format) {
if (!$this->findService($format, $service->actions)) {
if ($this->ok) {
$this->reason = 'Required service(s) not offered - ';
$this->ok = false;
} else {
$this->reason .= ', ';
}
$this->reason .= "'{$format}' [" . implode(', ', $service->actions) . ']';
}
}
}
}
if ($this->ok) {
if ($_POST['lti_message_type'] === 'ToolProxyRegistrationRequest') {
$this->consumer->profile = $tcProfile;
$this->consumer->secret = $_POST['reg_password'];
$this->consumer->ltiVersion = $_POST['lti_version'];
$this->consumer->name = $tcProfile->product_instance->service_owner->service_owner_name->default_value;
$this->consumer->consumerName = $this->consumer->name;
$this->consumer->consumerVersion = "{$tcProfile->product_instance->product_info->product_family->code}-{$tcProfile->product_instance->product_info->product_version}";
$this->consumer->consumerGuid = $tcProfile->product_instance->guid;
$this->consumer->enabled = true;
$this->consumer->protected = true;
$doSaveConsumer = true;
}
}
} else {
if ($this->ok && !empty($_POST['custom_tc_profile_url']) && empty($this->consumer->profile)) {
$http = new HTTPMessage($_POST['custom_tc_profile_url'], 'GET', null, 'Accept: application/vnd.ims.lti.v2.toolconsumerprofile+json');
if ($http->send()) {
$tcProfile = json_decode($http->response);
if (!is_null($tcProfile)) {
$this->consumer->profile = $tcProfile;
$doSaveConsumer = true;
}
}
}
}
// Validate message parameter constraints
if ($this->ok) {
$invalidParameters = array();
foreach ($this->constraints as $name => $constraint) {
if (empty($constraint['messages']) || in_array($_POST['lti_message_type'], $constraint['messages'])) {
$ok = true;
if ($constraint['required']) {
if (!isset($_POST[$name]) || strlen(trim($_POST[$name])) <= 0) {
$invalidParameters[] = "{$name} (missing)";
$ok = false;
}
}
if ($ok && !is_null($constraint['max_length']) && isset($_POST[$name])) {
if (strlen(trim($_POST[$name])) > $constraint['max_length']) {
$invalidParameters[] = "{$name} (too long)";
}
}
}
}
if (count($invalidParameters) > 0) {
$this->ok = false;
if (empty($this->reason)) {
$this->reason = 'Invalid parameter(s): ' . implode(', ', $invalidParameters) . '.';
}
}
}
if ($this->ok) {
// Set the request context
if (isset($_POST['context_id'])) {
$this->context = Context::fromConsumer($this->consumer, trim($_POST['context_id']));
$title = '';
if (isset($_POST['context_title'])) {
$title = trim($_POST['context_title']);
}
if (empty($title)) {
$title = "Course {$this->context->getId()}";
}
if (isset($_POST['context_type'])) {
$this->context->type = trim($_POST['context_type']);
}
$this->context->title = $title;
}
// Set the request resource link
if (isset($_POST['resource_link_id'])) {
$contentItemId = '';
if (isset($_POST['custom_content_item_id'])) {
$contentItemId = $_POST['custom_content_item_id'];
}
$this->resourceLink = ResourceLink::fromConsumer($this->consumer, trim($_POST['resource_link_id']), $contentItemId);
if (!empty($this->context)) {
$this->resourceLink->setContextId($this->context->getRecordId());
}
$title = '';
if (isset($_POST['resource_link_title'])) {
$title = trim($_POST['resource_link_title']);
}
if (empty($title)) {
$title = "Resource {$this->resourceLink->getId()}";
}
$this->resourceLink->title = $title;
// Delete any existing custom parameters
foreach ($this->consumer->getSettings() as $name => $value) {
if (strpos($name, 'custom_') === 0) {
$this->consumer->setSetting($name);
$doSaveConsumer = true;
}
}
if (!empty($this->context)) {
foreach ($this->context->getSettings() as $name => $value) {
if (strpos($name, 'custom_') === 0) {
$this->context->setSetting($name);
}
}
}
foreach ($this->resourceLink->getSettings() as $name => $value) {
if (strpos($name, 'custom_') === 0) {
$this->resourceLink->setSetting($name);
}
}
// Save LTI parameters
foreach (self::$LTI_CONSUMER_SETTING_NAMES as $name) {
if (isset($_POST[$name])) {
$this->consumer->setSetting($name, $_POST[$name]);
} else {
$this->consumer->setSetting($name);
}
}
if (!empty($this->context)) {
foreach (self::$LTI_CONTEXT_SETTING_NAMES as $name) {
if (isset($_POST[$name])) {
$this->context->setSetting($name, $_POST[$name]);
} else {
$this->context->setSetting($name);
}
}
}
foreach (self::$LTI_RESOURCE_LINK_SETTING_NAMES as $name) {
if (isset($_POST[$name])) {
$this->resourceLink->setSetting($name, $_POST[$name]);
} else {
$this->resourceLink->setSetting($name);
}
}
// Save other custom parameters
foreach ($_POST as $name => $value) {
if (strpos($name, 'custom_') === 0 && !in_array($name, array_merge(self::$LTI_CONSUMER_SETTING_NAMES, self::$LTI_CONTEXT_SETTING_NAMES, self::$LTI_RESOURCE_LINK_SETTING_NAMES))) {
$this->resourceLink->setSetting($name, $value);
}
}
}
// Set the user instance
$userId = '';
if (isset($_POST['user_id'])) {
$userId = trim($_POST['user_id']);
}
$this->user = User::fromResourceLink($this->resourceLink, $userId);
// Set the user name
$firstname = isset($_POST['lis_person_name_given']) ? $_POST['lis_person_name_given'] : '';
$lastname = isset($_POST['lis_person_name_family']) ? $_POST['lis_person_name_family'] : '';
$fullname = isset($_POST['lis_person_name_full']) ? $_POST['lis_person_name_full'] : '';
$this->user->setNames($firstname, $lastname, $fullname);
// Set the user email
$email = isset($_POST['lis_person_contact_email_primary']) ? $_POST['lis_person_contact_email_primary'] : '';
$this->user->setEmail($email, $this->defaultEmail);
// Set the user image URI
if (isset($_POST['user_image'])) {
$this->user->image = $_POST['user_image'];
}
// Set the user roles
if (isset($_POST['roles'])) {
$this->user->roles = self::parseRoles($_POST['roles']);
}
// Initialise the consumer and check for changes
$this->consumer->defaultEmail = $this->defaultEmail;
if ($this->consumer->ltiVersion !== $_POST['lti_version']) {
$this->consumer->ltiVersion = $_POST['lti_version'];
$doSaveConsumer = true;
}
if (isset($_POST['tool_consumer_instance_name'])) {
if ($this->consumer->consumerName !== $_POST['tool_consumer_instance_name']) {
$this->consumer->consumerName = $_POST['tool_consumer_instance_name'];
$doSaveConsumer = true;
}
}
if (isset($_POST['tool_consumer_info_product_family_code'])) {
$version = $_POST['tool_consumer_info_product_family_code'];
if (isset($_POST['tool_consumer_info_version'])) {
$version .= "-{$_POST['tool_consumer_info_version']}";
}
// do not delete any existing consumer version if none is passed
if ($this->consumer->consumerVersion !== $version) {
$this->consumer->consumerVersion = $version;
$doSaveConsumer = true;
}
} else {
if (isset($_POST['ext_lms']) && $this->consumer->consumerName !== $_POST['ext_lms']) {
$this->consumer->consumerVersion = $_POST['ext_lms'];
$doSaveConsumer = true;
}
}
if (isset($_POST['tool_consumer_instance_guid'])) {
if (is_null($this->consumer->consumerGuid)) {
$this->consumer->consumerGuid = $_POST['tool_consumer_instance_guid'];
$doSaveConsumer = true;
} else {
if (!$this->consumer->protected) {
$doSaveConsumer = $this->consumer->consumerGuid !== $_POST['tool_consumer_instance_guid'];
if ($doSaveConsumer) {
$this->consumer->consumerGuid = $_POST['tool_consumer_instance_guid'];
}
}
}
}
if (isset($_POST['launch_presentation_css_url'])) {
if ($this->consumer->cssPath !== $_POST['launch_presentation_css_url']) {
$this->consumer->cssPath = $_POST['launch_presentation_css_url'];
$doSaveConsumer = true;
}
} else {
if (isset($_POST['ext_launch_presentation_css_url']) && $this->consumer->cssPath !== $_POST['ext_launch_presentation_css_url']) {
$this->consumer->cssPath = $_POST['ext_launch_presentation_css_url'];
$doSaveConsumer = true;
} else {
if (!empty($this->consumer->cssPath)) {
$this->consumer->cssPath = null;
$doSaveConsumer = true;
}
}
}
}
// Persist changes to consumer
if ($doSaveConsumer) {
$this->consumer->save();
}
if ($this->ok && isset($this->context)) {
$this->context->save();
}
if ($this->ok && isset($this->resourceLink)) {
// Check if a share arrangement is in place for this resource link
$this->ok = $this->checkForShare();
// Persist changes to resource link
$this->resourceLink->save();
// Save the user instance
if (isset($_POST['lis_result_sourcedid'])) {
if ($this->user->ltiResultSourcedId !== $_POST['lis_result_sourcedid']) {
$this->user->ltiResultSourcedId = $_POST['lis_result_sourcedid'];
$this->user->save();
}
} else {
if (!empty($this->user->ltiResultSourcedId)) {
$this->user->ltiResultSourcedId = '';
$this->user->save();
}
}
}
return $this->ok;
}
public function setUp()
{
$this->resetAfterTest();
// Set this user as the admin.
$this->setAdminUser();
$this->task = new dummy_sync_members_task();
$generator = $this->getDataGenerator();
$course = $generator->create_course();
$tooldata = ['courseid' => $course->id, 'membersyncmode' => helper::MEMBER_SYNC_ENROL_AND_UNENROL, 'membersync' => 1];
$tool = $generator->create_lti_tool((object) $tooldata);
$this->tool = helper::get_lti_tool($tool->id);
$dataconnector = $this->task->get_dataconnector();
$this->consumer = new ToolConsumer('Consumer1Key', $dataconnector);
$this->consumer->name = 'Consumer1';
$this->consumer->secret = 'Consumer1Secret';
$this->consumer->save();
$toolprovider = new tool_provider($this->tool->id);
$toolprovider->consumer = $this->consumer;
$toolprovider->map_tool_to_consumer();
$imageurl = $this->getExternalTestFileUrl('test.jpg');
$count = 10;
$this->members = [];
for ($i = 1; $i <= $count; $i++) {
$user = new User();
$user->firstname = 'Firstname' . $i;
$user->lastname = 'Lastname' . $i;
$user->ltiUserId = 'user' . $i;
// Set user image values for some users.
if ($i % 3 == 0) {
$user->image = $imageurl;
}
$this->members[] = $user;
}
$this->context = Context::fromConsumer($this->consumer, 'testlticontextid');
$this->context->save();
$this->resourcelink = ResourceLink::fromContext($this->context, 'testresourcelinkid');
$this->resourcelink->save();
}
/**
* Test for data_connector::getSharesResourceLink().
*/
public function test_get_shares_resource_link()
{
$dc = new data_connector();
$consumer = new ToolConsumer(null, $dc);
$consumer->name = 'testconsumername';
$consumer->setKey('TestKey');
$consumer->secret = 'testsecret';
$consumer->idScope = ToolProvider::ID_SCOPE_GLOBAL;
$consumer->save();
$title = 'testcontexttitle';
$settings = ['a', 'b', 'c'];
$lticontextid = 'testlticontextid';
$context = Context::fromConsumer($consumer, $lticontextid);
$context->title = $title;
$context->settings = $settings;
$context->save();
$resourcelink = ResourceLink::fromConsumer($consumer, 'testresourcelinkid');
$resourcelink->setContextId($context->getRecordId());
$resourcelink->save();
$shares = $dc->getSharesResourceLink($resourcelink);
$this->assertEmpty($shares);
$resourcelinkchild = ResourceLink::fromConsumer($consumer, 'testresourcelinkchildid');
$resourcelinkchild->primaryResourceLinkId = $resourcelink->getRecordId();
$resourcelinkchild->shareApproved = true;
$resourcelinkchild->save();
$resourcelinkchild2 = ResourceLink::fromConsumer($consumer, 'testresourcelinkchildid2');
$resourcelinkchild2->primaryResourceLinkId = $resourcelink->getRecordId();
$resourcelinkchild2->shareApproved = false;
$resourcelinkchild2->save();
$shares = $dc->getSharesResourceLink($resourcelink);
$this->assertCount(2, $shares);
$shareids = [$resourcelinkchild->getRecordId(), $resourcelinkchild2->getRecordId()];
foreach ($shares as $share) {
$this->assertTrue($share instanceof ResourceLinkShare);
$this->assertTrue(in_array($share->resourceLinkId, $shareids));
if ($share->resourceLinkId == $shareids[0]) {
$this->assertTrue($share->approved);
} else {
$this->assertFalse($share->approved);
}
}
}
/**
* Test for data_connector::get_resourcelink_from_context()
*/
public function test_get_resourcelink_from_context()
{
$dc = new data_connector();
$consumer = new ToolConsumer(null, $dc);
$consumer->name = 'TestName';
$consumer->setKey('TestKey');
$consumer->secret = 'TestSecret';
$consumer->save();
$settings = ['a', 'b', 'c'];
$lticontextid = 'testlticontextid';
$context = Context::fromConsumer($consumer, $lticontextid);
$context->settings = $settings;
$context->save();
// No ResourceLink associated with the Context yet.
$this->assertNull($dc->get_resourcelink_from_context($context));
// Create and save ResourceLink from the Context.
$resourcelink = ResourceLink::fromContext($context, 'testresourcelinkid');
$resourcelink->save();
$dc->loadResourceLink($resourcelink);
// Assert that the resource link and the one fetched by get_resourcelink_from_context() are the same.
$this->assertEquals($resourcelink, $dc->get_resourcelink_from_context($context));
}
/**
* Fetches the list of Context objects that are linked to a ToolConsumer.
*
* @param ToolConsumer $consumer
* @return Context[]
*/
public function get_contexts_from_consumer(ToolConsumer $consumer)
{
global $DB;
$contexts = [];
$contextrecords = $DB->get_records($this->contexttable, ['consumerid' => $consumer->getRecordId()], '', 'lticontextkey');
foreach ($contextrecords as $record) {
$context = Context::fromConsumer($consumer, $record->lticontextkey);
$contexts[] = $context;
}
return $contexts;
}