Moodle authentication plugin for Macaroons

auth.php 5.1KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201
  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. * Authentication plugin: Macaroons
  18. *
  19. * Macaroons: Cookies with Contextual Caveats for Decentralized Authorization
  20. *
  21. * @package auth_macaroons
  22. * @author Brendan Abolivier
  23. * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
  24. */
  25. defined('MOODLE_INTERNAL') || die();
  26. require_once($CFG->libdir.'/authlib.php');
  27. require_once($CFG->dirroot.'/auth/macaroons/Macaroons/Macaroon.php');
  28. require_once($CFG->dirroot.'/auth/macaroons/Macaroons/Caveat.php');
  29. require_once($CFG->dirroot.'/auth/macaroons/Macaroons/Packet.php');
  30. require_once($CFG->dirroot.'/auth/macaroons/Macaroons/Utils.php');
  31. require_once($CFG->dirroot.'/auth/macaroons/Macaroons/Verifier.php');
  32. require_once($CFG->dirroot.'/auth/macaroons/Macaroons/Exceptions/CaveatUnsatisfiedException.php');
  33. require_once($CFG->dirroot.'/auth/macaroons/Macaroons/Exceptions/InvalidMacaroonKeyException.php');
  34. require_once($CFG->dirroot.'/auth/macaroons/Macaroons/Exceptions/SignatureMismatchException.php');
  35. use Macaroons\Macaroon;
  36. use Macaroons\Verifier;
  37. /**
  38. * Plugin for no authentication.
  39. */
  40. class auth_plugin_macaroons extends auth_plugin_base {
  41. /**
  42. * Constructor.
  43. */
  44. public function __construct() {
  45. $this->authtype = 'macaroons';
  46. }
  47. /**
  48. * Old syntax of class constructor. Deprecated in PHP7.
  49. *
  50. * @deprecated since Moodle 3.1
  51. */
  52. public function auth_plugin_macaroons() {
  53. debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
  54. self::__construct();
  55. }
  56. function loginpage_hook() {
  57. global $DB;
  58. $message = "";
  59. if(!empty($_COOKIE['das-macaroon'])) {
  60. try {
  61. $m = Macaroon::deserialize($_COOKIE['das-macaroon']);
  62. $v = new Verifier();
  63. $v->setCallbacks([
  64. function($a) {
  65. return !strcmp($a, "status = student");
  66. }
  67. ]);
  68. if($v->verify($m, "pocsecret")) {
  69. $name = explode(";", $m->getIdentifier());
  70. $username = join("", $name);
  71. $user = authenticate_user_login($username, null);
  72. if($user) {
  73. $user->firstname = $name[0];
  74. $user->lastname = $name[1];
  75. $user->email = $username."@brendanabolivier.com";
  76. // var_dump($user);
  77. $DB->update_record('user', $user);
  78. complete_user_login($user);
  79. }
  80. }
  81. } catch(Exception $e) {
  82. $message = $e->getMessage();
  83. }
  84. }
  85. }
  86. /**
  87. * Returns true if the username and password work or don't exist and false
  88. * if the user exists and the password is wrong.
  89. *
  90. * @param string $username The username
  91. * @param string $password The password
  92. * @return bool Authentication success or failure.
  93. */
  94. function user_login ($username, $password) {
  95. return true;
  96. }
  97. /**
  98. * Updates the user's password.
  99. *
  100. * called when the user password is updated.
  101. *
  102. * @param object $user User table object
  103. * @param string $newpassword Plaintext password
  104. * @return boolean result
  105. *
  106. */
  107. function user_update_password($user, $newpassword) {
  108. $user = get_complete_user_data('id', $user->id);
  109. // This will also update the stored hash to the latest algorithm
  110. // if the existing hash is using an out-of-date algorithm (or the
  111. // legacy md5 algorithm).
  112. return update_internal_user_password($user, $newpassword);
  113. }
  114. function prevent_local_passwords() {
  115. return false;
  116. }
  117. /**
  118. * Returns true if this authentication plugin is 'internal'.
  119. *
  120. * @return bool
  121. */
  122. function is_internal() {
  123. return false;
  124. }
  125. /**
  126. * Returns true if this authentication plugin can change the user's
  127. * password.
  128. *
  129. * @return bool
  130. */
  131. function can_change_password() {
  132. return true;
  133. }
  134. /**
  135. * Returns the URL for changing the user's pw, or empty if the default can
  136. * be used.
  137. *
  138. * @return moodle_url
  139. */
  140. function change_password_url() {
  141. return null;
  142. }
  143. /**
  144. * Returns true if plugin allows resetting of internal password.
  145. *
  146. * @return bool
  147. */
  148. function can_reset_password() {
  149. return true;
  150. }
  151. /**
  152. * Returns true if plugin can be manually set.
  153. *
  154. * @return bool
  155. */
  156. function can_be_manually_set() {
  157. return true;
  158. }
  159. /**
  160. * Prints a form for configuring this authentication plugin.
  161. *
  162. * This function is called from admin/auth.php, and outputs a full page with
  163. * a form for configuring this plugin.
  164. *
  165. * @param array $page An object containing all the data for this page.
  166. function config_form($config, $err, $user_fields) {
  167. include "config.html";
  168. }
  169. */
  170. /**
  171. * Processes and stores configuration data for this authentication plugin.
  172. */
  173. function process_config($config) {
  174. return true;
  175. }
  176. }