Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.

Differences Between: [Versions 310 and 311] [Versions 310 and 400] [Versions 310 and 401] [Versions 310 and 402] [Versions 310 and 403]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * PHPUnit Tests for config_key class.
  19   *
  20   * @package    quizaccess_seb
  21   * @author     Andrew Madden <andrewmadden@catalyst-au.net>
  22   * @copyright  2019 Catalyst IT
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  use quizaccess_seb\config_key;
  27  
  28  defined('MOODLE_INTERNAL') || die();
  29  
  30  /**
  31   * PHPUnit Tests for config_key class.
  32   *
  33   * @copyright  2020 Catalyst IT
  34   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class quizaccess_seb_config_key_testcase extends advanced_testcase {
  37  
  38      /**
  39       * Test that trying to generate the hash key with bad xml will result in an error.
  40       */
  41      public function test_config_key_not_generated_with_bad_xml() {
  42          $this->expectException(invalid_parameter_exception::class);
  43          $this->expectExceptionMessage("Invalid a PList XML string, representing SEB config");
  44          config_key::generate("<?xml This is some bad xml for sure.");
  45      }
  46  
  47      /**
  48       * Test that a config key is generated with empty configuration. SEB would be using defaults for all settings.
  49       */
  50      public function test_config_key_hash_generated_with_empty_string() {
  51          $hash = config_key::generate('')->get_hash();
  52          $this->assertEquals('4f53cda18c2baa0c0354bb5f9a3ecbe5ed12ab4d8e11ba873c2f11161202b945', $hash);
  53      }
  54  
  55      /**
  56       * Check that the Config Key hash is not altered if the originatorVersion is present in the XML or not.
  57       */
  58      public function test_presence_of_originator_version_does_not_effect_hash() {
  59          $xmlwithoriginatorversion = file_get_contents(__DIR__ . '/fixtures/simpleunencrypted.seb');
  60          $xmlwithoutoriginatorversion = file_get_contents(__DIR__ . '/fixtures/simpleunencryptedwithoutoriginator.seb');
  61          $hashwithorigver = config_key::generate($xmlwithoriginatorversion)->get_hash();
  62          $hashwithoutorigver = config_key::generate($xmlwithoutoriginatorversion)->get_hash();
  63          $this->assertEquals($hashwithorigver, $hashwithoutorigver);
  64      }
  65  
  66      /**
  67       * Provide a seb file, the expected Config Key and a password if encrypted.
  68       *
  69       * @return array
  70       */
  71      public function real_ck_hash_provider() : array {
  72          return [
  73              'unencrypted_mac2.1.4' => ['unencrypted_mac_001.seb',
  74                      '4fa9af8ec8759eb7c680752ef4ee5eaf1a860628608fccae2715d519849f9292', ''],
  75              'unencrypted_win2.2.3' => ['unencrypted_win_223.seb',
  76                      'fc6f4ea5922717760f4d6d536c23b8d19bf20b52aa97940f5427a76e20f49026', ''],
  77          ];
  78      }
  79  }