Merge pull request #9 from Izumi-kun/lti1p3

LTI 1.3 Support

Author: Izumi-kun

LICENSE.md

@@ -1,4 +1,4 @@
-Copyright 2019 Viktor Khokhryakov
+Copyright 2024 Viktor Khokhryakov
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions

README.md

@@ -1,7 +1,7 @@
-Yii2 LTI Tool Provider
+Yii2 LTI Tool
 ======================
 
-LTI Tool Provider module for Yii2.
+LTI Tool module for Yii2.
 
 [![Latest Stable Version](https://poser.pugx.org/izumi-kun/yii2-lti-tool-provider/v/stable)](https://packagist.org/packages/izumi-kun/yii2-lti-tool-provider)
 [![Total Downloads](https://poser.pugx.org/izumi-kun/yii2-lti-tool-provider/downloads)](https://packagist.org/packages/izumi-kun/yii2-lti-tool-provider)
@@ -23,27 +23,34 @@ Add namespaced migrations: `izumi\yii2lti\migrations`. Apply new migrations.
 
 ### Application config
 
-Add module to web config and configure. The module has three main events for handling messages from Tool Consumers:
+Add the module to the web config and configure it. The module supports the following events for handling messages from Platforms:
 
-- `launch` for `basic-lti-launch-request` message type
-- `contentItem` for `ContentItemSelectionRequest` message type
-- `register` for `ToolProxyRegistrationRequest` message type
+- `launch`
+- `configure`
+- `dashboard`
+- `contentItem`
+- `contentItemUpdate`
+- `submissionReview`
 
-Make sure to configure access to `lti/consumer` controller actions.
-All messages from Tool Consumers handles by `lti/connect` controller and there is no access restrictions.
+Make sure to configure access to the `lti/platform` controller actions.
+All messages from Platforms are handled by the `lti/tool` controller, and there are no access restrictions.
 
 ```php
 $config = [
     'modules' => [
         'lti' => [
-            'class' => '\izumi\yii2lti\Module',
-            'on launch' => ['\app\controllers\SiteController', 'ltiLaunch'],
-            'on error' => ['\app\controllers\SiteController', 'ltiError'],
+            'class' => \izumi\yii2lti\Module::class,
+            'tool' => [
+                'debugMode' => YII_DEBUG,
+                'rsaKey' => 'A PEM formatted private key (for LTI 1.3 support)',
+            ],
+            'on launch' => [SiteController::class, 'ltiLaunch'],
+            'on error' => [SiteController::class, 'ltiError'],
             'as access' => [
-                'class' => '\yii\filters\AccessControl',
+                'class' => \yii\filters\AccessControl::class,
                 'rules' => [
-                    ['allow' => true, 'controllers' => ['lti/connect']],
-                    ['allow' => true, 'controllers' => ['lti/consumer'], 'roles' => ['admin']],
+                    ['allow' => true, 'controllers' => ['lti/tool']],
+                    ['allow' => true, 'controllers' => ['lti/platform'], 'roles' => ['admin']],
                 ],
             ],
         ],
@@ -53,12 +60,12 @@ $config = [
 
 ### Event handlers
 
-Create event handlers to respect module config.
+Create event handlers according to the module configuration.
 
 ```php
 namespace app\controllers;
 
-use izumi\yii2lti\ToolProviderEvent;
+use izumi\yii2lti\ToolEvent;
 use Yii;
 use yii\web\BadRequestHttpException;
 use yii\web\Controller;
@@ -67,9 +74,9 @@ class SiteController extends Controller
 {
     /**
      * basic-lti-launch-request handler
-     * @param ToolProviderEvent $event
+     * @param ToolEvent $event
      */
-    public static function ltiLaunch(ToolProviderEvent $event)
+    public static function ltiLaunch(ToolEvent $event)
     {
         $tool = $event->sender;
 
@@ -78,25 +85,25 @@ class SiteController extends Controller
         $isAdmin = $tool->user->isStaff() || $tool->user->isAdmin();
 
         Yii::$app->session->set('isAdmin', $isAdmin);
-        Yii::$app->session->set('isLtiSession', true);
         Yii::$app->session->set('userPk', $userPk);
         Yii::$app->controller->redirect(['/site/index']);
 
         $tool->ok = true;
+        $event->handled = true;
     }
 
     /**
      * LTI error handler
-     * @param ToolProviderEvent $event
+     * @param ToolEvent $event
      * @throws BadRequestHttpException
      */
-    public static function ltiError(ToolProviderEvent $event)
+    public static function ltiError(ToolEvent $event)
     {
         $tool = $event->sender;
         $msg = $tool->message;
         if (!empty($tool->reason)) {
             Yii::error($tool->reason);
-            if ($tool->isDebugMode()) {
+            if ($tool->debugMode) {
                 $msg = $tool->reason;
             }
         }
@@ -108,17 +115,17 @@ class SiteController extends Controller
 ### Outcome
 
 ```php
-use IMSGlobal\LTI\ToolProvider;
+use ceLTIc\LTI;
 
 /* @var \izumi\yii2lti\Module $module */
 $module = Yii::$app->getModule('lti');
 
-$user = ToolProvider\User::fromRecordId(Yii::$app->session->get('userPk'), $module->toolProvider->dataConnector);
+$user = $module->findUserById(Yii::$app->session->get('userPk'));
 
 $result = '0.8';
-$outcome = new ToolProvider\Outcome($result);
+$outcome = new LTI\Outcome($result);
 
-if ($user->getResourceLink()->doOutcomesService(ToolProvider\ResourceLink::EXT_WRITE, $outcome, $user)) {
+if ($module->doOutcomesService(LTI\Enum\ServiceAction::Write, $outcome, $user)) {
     Yii::$app->session->addFlash('success', 'Result sent successfully');
 }
 ```
@@ -129,5 +136,5 @@ if ($user->getResourceLink()->doOutcomesService(ToolProvider\ResourceLink::EXT_W
 
 ### Useful
 
-- [LTI Tool Consumer emulator](https://lti.tools/saltire/tc)
-- [IMSGlobal/LTI-Tool-Provider-Library-PHP/wiki](https://github.com/IMSGlobal/LTI-Tool-Provider-Library-PHP/wiki)
+- [LTI Platform emulator](https://saltire.lti.app/platform)
+- [celtic-project/LTI-PHP/wiki](https://github.com/celtic-project/LTI-PHP/wiki)

composer.json

@@ -1,12 +1,12 @@
 {
   "name": "izumi-kun/yii2-lti-tool-provider",
-  "description": "LTI Tool Provider module for Yii2",
+  "description": "LTI Tool module for Yii2",
   "type": "yii2-extension",
   "require": {
-    "php": ">=5.4.0",
-    "yiisoft/yii2": "~2.0.14",
+    "php": ">=8.1",
+    "yiisoft/yii2": "~2.0.51",
     "yiisoft/yii2-httpclient": "~2.0.0",
-    "izumi-kun/lti": "~1.2.0"
+    "celtic/lti": "^v5.1.0"
   },
   "scripts": {
     "messages": "yii message/extract src/messages/config.php"
@@ -18,9 +18,20 @@
       "email": "viktor.khokhryakov@gmail.com"
     }
   ],
+  "repositories": [
+    {
+      "type": "composer",
+      "url": "https://asset-packagist.org"
+    }
+  ],
   "autoload": {
     "psr-4": {
       "izumi\\yii2lti\\": "src"
     }
+  },
+  "config": {
+    "allow-plugins": {
+      "yiisoft/yii2-composer": true
+    }
   }
 }

src/HttpClient.php

@@ -1,14 +1,14 @@
 <?php
 /**
  * @link https://github.com/Izumi-kun/yii2-lti-tool-provider
- * @copyright Copyright (c) 2019 Viktor Khokhryakov
+ * @copyright Copyright (c) 2024 Viktor Khokhryakov
  * @license http://opensource.org/licenses/BSD-3-Clause
  */
 
 namespace izumi\yii2lti;
 
-use IMSGlobal\LTI\Http\ClientInterface;
-use IMSGlobal\LTI\HTTPMessage;
+use ceLTIc\LTI\Http\ClientInterface;
+use ceLTIc\LTI\Http\HttpMessage;
 
 /**
  * Class HttpClient
@@ -21,26 +21,22 @@ class HttpClient implements ClientInterface
     /**
      * @inheritdoc
      */
-    public function send(HTTPMessage $message)
+    public function send(HttpMessage $message): bool
     {
         $request = Module::getInstance()->httpClient->createRequest()
-            ->setMethod($message->method)
-            ->setUrl($message->url)
+            ->setMethod($message->getMethod())
+            ->setUrl($message->getUrl())
             ->setContent($message->request);
 
         if (!empty($message->requestHeaders)) {
-            if (is_string($message->requestHeaders)) {
-                $request->setHeaders(explode("\n", $message->requestHeaders));
-            } elseif (is_array($message->requestHeaders)) {
-                $request->setHeaders(array_values($message->requestHeaders));
-            }
-            $message->requestHeaders = implode("\n", $request->composeHeaderLines());
+            $request->setHeaders(array_values($message->requestHeaders));
+            $message->requestHeaders = $request->composeHeaderLines();
         }
 
         $resp = $request->send();
         $message->status = $resp->statusCode;
         $message->response = $resp->getContent();
-        $message->responseHeaders = implode("\n", $resp->composeHeaderLines());
+        $message->responseHeaders = $resp->composeHeaderLines();
 
         return $resp->isOk;
     }

src/Module.php

@@ -1,18 +1,25 @@
 <?php
 /**
  * @link https://github.com/Izumi-kun/yii2-lti-tool-provider
- * @copyright Copyright (c) 2019 Viktor Khokhryakov
+ * @copyright Copyright (c) 2024 Viktor Khokhryakov
  * @license http://opensource.org/licenses/BSD-3-Clause
  */
 
 namespace izumi\yii2lti;
 
-use IMSGlobal\LTI\HTTPMessage;
-use IMSGlobal\LTI\ToolProvider\DataConnector\DataConnector_pdo;
+use ceLTIc\LTI\DataConnector\DataConnector;
+use ceLTIc\LTI\Enum\LtiVersion;
+use ceLTIc\LTI\Enum\ServiceAction;
+use ceLTIc\LTI\Http\HttpMessage;
+use ceLTIc\LTI\Outcome;
+use ceLTIc\LTI\Tool as BaseTool;
+use ceLTIc\LTI\UserResult;
 use Yii;
 use yii\db\Connection;
 use yii\di\Instance;
+use yii\helpers\Url;
 use yii\httpclient\Client;
+use yii\i18n\PhpMessageSource;
 
 /**
  * Module.
@@ -22,22 +29,29 @@
 class Module extends \yii\base\Module
 {
     const EVENT_LAUNCH = 'launch';
-    const EVENT_REGISTER = 'register';
+    const EVENT_CONFIGURE = 'configure';
+    const EVENT_DASHBOARD = 'dashboard';
     const EVENT_CONTENT_ITEM = 'contentItem';
+    const EVENT_CONTENT_ITEM_UPDATE = 'contentItemUpdate';
+    const EVENT_SUBMISSION_REVIEW = 'submissionReview';
     const EVENT_ERROR = 'error';
 
     /**
-     * @var ToolProvider|array
+     * @var Tool|array
      */
-    public $toolProvider = [];
+    public array|Tool $tool = [];
     /**
      * @var Client|array|string
      */
-    public $httpClient = [];
+    public string|Client|array $httpClient = [];
     /**
      * @var Connection|array|string the DB connection object or the application component ID of the DB connection.
      */
-    public $db = 'db';
+    public Connection|string|array $db = 'db';
+    /**
+     * @var string
+     */
+    public string $lti1p3SignatureMethod = 'RS256';
 
     /**
      * @inheritdoc
@@ -49,22 +63,62 @@ public function init()
         $i18n = Yii::$app->i18n;
         if (!isset($i18n->translations['lti']) && !isset($i18n->translations['lti*'])) {
             $i18n->translations['lti'] = [
-                'class' => '\yii\i18n\PhpMessageSource',
+                'class' => PhpMessageSource::class,
                 'basePath' => __DIR__ . '/messages',
                 'sourceLanguage' => 'en',
             ];
         }
 
-        $this->db = Instance::ensure($this->db, Connection::className());
+        $this->db = Instance::ensure($this->db, Connection::class);
+
+        $toolConfig = is_array($this->tool) ? $this->tool : [];
+        $toolConfig['dataConnector'] = DataConnector::getDataConnector($this->db->getMasterPdo(), $this->db->tablePrefix);
+        if (!isset($toolConfig['baseUrl'])) {
+            $toolConfig['baseUrl'] = Yii::$app->getRequest()->getHostInfo();
+        }
+        if (!array_key_exists('jku', $toolConfig)) {
+            $toolConfig['jku'] = Url::to($this->getUniqueId() . '/tool/jwks', true);
+        }
+        $this->tool = Instance::ensure($toolConfig, Tool::class);
 
-        $tpConfig = is_array($this->toolProvider) ? $this->toolProvider : [];
-        $tpConfig['dataConnector'] = new DataConnector_pdo($this->db->getMasterPdo(), $this->db->tablePrefix);
-        if (!isset($tpConfig['baseUrl'])) {
-            $tpConfig['baseUrl'] = Yii::$app->getRequest()->getHostInfo();
+        if ($this->tool->rsaKey && openssl_pkey_get_private($this->tool->rsaKey) === false) {
+            $this->tool->rsaKey = null;
+            Yii::warning('rsaKey is not valid private key', __METHOD__);
         }
-        $this->toolProvider = Instance::ensure($tpConfig, '\izumi\yii2lti\ToolProvider');
 
-        $this->httpClient = Instance::ensure($this->httpClient, Client::className());
-        HTTPMessage::setHttpClient(new HttpClient());
+        $this->httpClient = Instance::ensure($this->httpClient, Client::class);
+        HttpMessage::setHttpClient(new HttpClient());
+        BaseTool::$defaultTool = $this->tool;
+    }
+
+    /**
+     * Load the user from the database.
+     * @param int $id
+     * @return UserResult|null
+     */
+    public function findUserById(int $id): ?UserResult
+    {
+        $user = UserResult::fromRecordId($id, $this->tool->dataConnector);
+        if (!$user->getResourceLink()) {
+            return null;
+        }
+        return $user;
+    }
+
+    /**
+     * Perform an Outcomes service request.
+     * @param ServiceAction $action
+     * @param Outcome $ltiOutcome
+     * @param UserResult $user
+     * @return bool
+     */
+    public function doOutcomesService(ServiceAction $action, Outcome $ltiOutcome, UserResult $user): bool
+    {
+        $resourceLink = $user->getResourceLink();
+        if (!$resourceLink) {
+            return false;
+        }
+        $this->tool->signatureMethod = $resourceLink->getPlatform()->ltiVersion === LtiVersion::V1P3 ? $this->lti1p3SignatureMethod : 'HMAC-SHA1';
+        return $resourceLink->doOutcomesService($action, $ltiOutcome, $user);
     }
 }