first commit

admin/tool/mfa/classes/event/user_deleted_factor.php

@@ -0,0 +1,97 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+namespace tool_mfa\event;
+
+use stdClass;
+
+/**
+ * Event for when user factor is deleted.
+ *
+ * @property-read array $other {
+ *      Extra information about event.
+ * }
+ *
+ * @package     tool_mfa
+ * @author      Peter Burnett <peterburnett@catalyst-au.net>
+ * @copyright   Catalyst IT
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class user_deleted_factor extends \core\event\base {
+
+    /**
+     * Create instance of event.
+     *
+     * @param stdClass $user the User object of the User who had the factor deleted.
+     * @param stdClass $deleteuser the user who performed the factor delete.
+     * @param string $factorname deleted factor
+     *
+     * @return \core\event\base the user_factor_deleted event
+     *
+     * @throws \coding_exception
+     */
+    public static function user_deleted_factor_event(stdClass $user, $deleteuser, $factorname): \core\event\base {
+
+        $data = [
+            'relateduserid' => $user->id,
+            'context' => \context_user::instance($user->id),
+            'other' => [
+                'userid' => $user->id,
+                'factorname' => $factorname,
+                'delete' => $deleteuser->id,
+            ],
+        ];
+
+        return self::create($data);
+    }
+
+    /**
+     * Init method.
+     *
+     * @return void
+     */
+    protected function init(): void {
+        $this->data['crud'] = 'd';
+        $this->data['edulevel'] = self::LEVEL_OTHER;
+    }
+
+    /**
+     * Returns description of what happened.
+     *
+     * @return string
+     */
+    public function get_description(): string {
+        // The log message changed from logging the deleter user object to the ID. This must be kept for backwards compat
+        // With old log events.
+        if (is_object($this->other['delete'])) {
+            return "The user with id '{$this->other['delete']->id}' successfully deleted
+                {$this->other['factorname']} factor for user with id '{$this->other['userid']}'";
+        } else {
+            return "The user with id '{$this->other['delete']}' successfully deleted
+                {$this->other['factorname']} factor for user with id '{$this->other['userid']}'";
+        }
+    }
+
+    /**
+     * Return localised event name.
+     *
+     * @return string
+     * @throws \coding_exception
+     */
+    public static function get_name(): string {
+        return get_string('event:userdeletedfactor', 'tool_mfa');
+    }
+}

admin/tool/mfa/classes/event/user_failed_mfa.php

@@ -0,0 +1,100 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+namespace tool_mfa\event;
+
+use stdClass;
+
+/**
+ * Event for when user successfully passed all MFA factor checks.
+ *
+ * @property-read array $other {
+ *      Extra information about event.
+ * }
+ *
+ * @package     tool_mfa
+ * @author      Peter Burnett <peterburnett@catalyst-au.net>
+ * @copyright   Catalyst IT
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class user_failed_mfa extends \core\event\base {
+
+    /**
+     * Create instance of event.
+     *
+     * @param stdClass $user the User object of the User who failed MFA authentication.
+     *
+     * @return user_failed_mfa the user_passed_mfa event
+     *
+     * @throws \coding_exception
+     */
+    public static function user_failed_mfa_event(stdClass $user): user_failed_mfa {
+        // Build debug info string.
+        $factors = \tool_mfa\plugininfo\factor::get_active_user_factor_types();
+        $debug = '';
+        $failurereason = get_string('event:failnotenoughfactors', 'tool_mfa');
+        foreach ($factors as $factor) {
+            $debug .= "<br> Factor {$factor->name} status: {$factor->get_state()}";
+            if ($factor->get_state() === \tool_mfa\plugininfo\factor::STATE_FAIL) {
+                $failurereason = get_string('event:failfactor', 'tool_mfa');
+            } else if ($factor->get_state() === \tool_mfa\plugininfo\factor::STATE_LOCKED) {
+                $failurereason = get_string('event:faillockout', 'tool_mfa');
+            }
+        }
+
+        $data = [
+            'relateduserid' => null,
+            'context' => \context_user::instance($user->id),
+            'other' => [
+                'userid' => $user->id,
+                'debug' => $debug,
+                'failurereason' => $failurereason,
+            ],
+        ];
+
+        return self::create($data);
+    }
+
+    /**
+     * Init method.
+     *
+     * @return void
+     */
+    protected function init(): void {
+        $this->data['crud'] = 'r';
+        $this->data['edulevel'] = self::LEVEL_OTHER;
+    }
+
+    /**
+     * Returns description of what happened.
+     *
+     * @return string
+     */
+    public function get_description(): string {
+        return "The user with id '{$this->other['userid']}' failed authenticating with MFA.
+            <br> Information: {$this->other['failurereason']}{$this->other['debug']}";
+    }
+
+    /**
+     * Return localised event name.
+     *
+     * @return string
+     * @throws \coding_exception
+     */
+    public static function get_name(): string {
+        return get_string('event:userfailedmfa', 'tool_mfa');
+    }
+}

admin/tool/mfa/classes/event/user_passed_mfa.php

@@ -0,0 +1,93 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+namespace tool_mfa\event;
+
+use stdClass;
+
+/**
+ * Event for when user successfully passed all MFA factor checks.
+ *
+ * @property-read array $other {
+ *      Extra information about event.
+ * }
+ *
+ * @package     tool_mfa
+ * @author      Mikhail Golenkov <golenkovm@gmail.com>
+ * @copyright   Catalyst IT
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class user_passed_mfa extends \core\event\base {
+
+    /**
+     * Create instance of event.
+     *
+     * @param stdClass $user the User object of the User who passed all MFA factor checks.
+     *
+     * @return user_passed_mfa the user_passed_mfa event
+     *
+     * @throws \coding_exception
+     */
+    public static function user_passed_mfa_event(stdClass $user): user_passed_mfa {
+
+        // Build debug info string.
+        $factors = \tool_mfa\plugininfo\factor::get_active_user_factor_types();
+        $debug = '';
+        foreach ($factors as $factor) {
+            $debug .= "<br> Factor {$factor->name} status: {$factor->get_state()}";
+        }
+
+        $data = [
+            'relateduserid' => null,
+            'context' => \context_user::instance($user->id),
+            'other' => [
+                'userid' => $user->id,
+                'debug' => $debug,
+            ],
+        ];
+
+        return self::create($data);
+    }
+
+    /**
+     * Init method.
+     *
+     * @return void
+     */
+    protected function init(): void {
+        $this->data['crud'] = 'r';
+        $this->data['edulevel'] = self::LEVEL_OTHER;
+    }
+
+    /**
+     * Returns description of what happened.
+     *
+     * @return string
+     */
+    public function get_description(): string {
+        return "The user with id '{$this->other['userid']}' successfully passed MFA. <br> Information: {$this->other['debug']}";
+    }
+
+    /**
+     * Return localised event name.
+     *
+     * @return string
+     * @throws \coding_exception
+     */
+    public static function get_name(): string {
+        return get_string('event:userpassedmfa', 'tool_mfa');
+    }
+}

admin/tool/mfa/classes/event/user_revoked_factor.php

@@ -0,0 +1,87 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+namespace tool_mfa\event;
+
+use stdClass;
+
+/**
+ * Event for when user successfully revoked MFA Factor.
+ *
+ * @property-read array $other {
+ *      Extra information about event.
+ * }
+ *
+ * @package     tool_mfa
+ * @author      Mikhail Golenkov <golenkovm@gmail.com>
+ * @copyright   Catalyst IT
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class user_revoked_factor extends \core\event\base {
+
+    /**
+     * Create instance of event.
+     *
+     * @param stdClass $user the User object of the User who has revoked new factor
+     * @param string $factorname revoked factor
+     *
+     * @return self the related event
+     *
+     * @throws \coding_exception
+     */
+    public static function user_revoked_factor_event(stdClass $user, $factorname): self {
+
+        $data = [
+            'relateduserid' => null,
+            'context' => \context_user::instance($user->id),
+            'other' => [
+                'userid' => $user->id,
+                'factorname' => $factorname,
+            ],
+        ];
+
+        return self::create($data);
+    }
+
+    /**
+     * Init method.
+     *
+     * @return void
+     */
+    protected function init(): void {
+        $this->data['crud'] = 'd';
+        $this->data['edulevel'] = self::LEVEL_OTHER;
+    }
+
+    /**
+     * Returns description of what happened.
+     *
+     * @return string
+     */
+    public function get_description(): string {
+        return "The user with id '{$this->other['userid']}' successfully revoked {$this->other['factorname']}";
+    }
+
+    /**
+     * Return localised event name.
+     *
+     * @return string
+     * @throws \coding_exception
+     */
+    public static function get_name(): string {
+        return get_string('event:userrevokedfactor', 'tool_mfa');
+    }
+}

admin/tool/mfa/classes/event/user_setup_factor.php

@@ -0,0 +1,87 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+namespace tool_mfa\event;
+
+use stdClass;
+
+/**
+ * Event for when user successfully setup new MFA Factor.
+ *
+ * @property-read array $other {
+ *      Extra information about event.
+ * }
+ *
+ * @package     tool_mfa
+ * @author      Mikhail Golenkov <golenkovm@gmail.com>
+ * @copyright   Catalyst IT
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class user_setup_factor extends \core\event\base {
+
+    /**
+     * Create instance of event.
+     *
+     * @param stdClass $user the User object of the User who has setup new factor
+     * @param string $factorname setup factor
+     *
+     * @return self the related event
+     *
+     * @throws \coding_exception
+     */
+    public static function user_setup_factor_event(stdClass $user, $factorname): self {
+
+        $data = [
+            'relateduserid' => null,
+            'context' => \context_user::instance($user->id),
+            'other' => [
+                'userid' => $user->id,
+                'factorname' => $factorname,
+            ],
+        ];
+
+        return self::create($data);
+    }
+
+    /**
+     * Init method.
+     *
+     * @return void
+     */
+    protected function init(): void {
+        $this->data['crud'] = 'c';
+        $this->data['edulevel'] = self::LEVEL_OTHER;
+    }
+
+    /**
+     * Returns description of what happened.
+     *
+     * @return string
+     */
+    public function get_description(): string {
+        return "The user with id '{$this->other['userid']}' successfully setup {$this->other['factorname']}";
+    }
+
+    /**
+     * Return localised event name.
+     *
+     * @return string
+     * @throws \coding_exception
+     */
+    public static function get_name(): string {
+        return get_string('event:usersetupfactor', 'tool_mfa');
+    }
+}