Moodle authentication plugin for Macaroons

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206
  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. function loginpage_hook() {
  48. global $message, $DB;
  49. $message = "";
  50. if(!empty($_COOKIE['das-macaroon'])) {
  51. try {
  52. $m = Macaroon::deserialize($_COOKIE['das-macaroon']);
  53. $v = new Verifier();
  54. $v->setCallbacks([
  55. function($a) {
  56. return !strcmp($a, "status = student");
  57. }
  58. ]);
  59. if($v->verify($m, "pocsecret")) {
  60. $name = explode(";", $m->getIdentifier());
  61. $username = join("", $name);
  62. $user = authenticate_user_login($username, sesskey());
  63. if($user) {
  64. $user->firstname = $name[0];
  65. $user->lastname = $name[1];
  66. $user->email = $username."@brendanabolivier.com";
  67. // var_dump($user);
  68. $DB->update_record('user', $user);
  69. complete_user_login($user);
  70. }
  71. }
  72. } catch(Exception $e) {
  73. $message = $e->getMessage();
  74. }
  75. }
  76. }
  77. /**
  78. * Old syntax of class constructor. Deprecated in PHP7.
  79. *
  80. * @deprecated since Moodle 3.1
  81. */
  82. public function auth_plugin_macaroons() {
  83. debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
  84. self::__construct();
  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. global $message;
  96. if(!empty($message)) {
  97. return false;
  98. } elseif(!empty($_COOKIE['das-macaroon'])) {
  99. return true;
  100. }
  101. }
  102. /**
  103. * Updates the user's password.
  104. *
  105. * called when the user password is updated.
  106. *
  107. * @param object $user User table object
  108. * @param string $newpassword Plaintext password
  109. * @return boolean result
  110. *
  111. */
  112. function user_update_password($user, $newpassword) {
  113. $user = get_complete_user_data('id', $user->id);
  114. // This will also update the stored hash to the latest algorithm
  115. // if the existing hash is using an out-of-date algorithm (or the
  116. // legacy md5 algorithm).
  117. return update_internal_user_password($user, $newpassword);
  118. }
  119. function prevent_local_passwords() {
  120. return false;
  121. }
  122. /**
  123. * Returns true if this authentication plugin is 'internal'.
  124. *
  125. * @return bool
  126. */
  127. function is_internal() {
  128. return false;
  129. }
  130. /**
  131. * Returns true if this authentication plugin can change the user's
  132. * password.
  133. *
  134. * @return bool
  135. */
  136. function can_change_password() {
  137. return true;
  138. }
  139. /**
  140. * Returns the URL for changing the user's pw, or empty if the default can
  141. * be used.
  142. *
  143. * @return moodle_url
  144. */
  145. function change_password_url() {
  146. return null;
  147. }
  148. /**
  149. * Returns true if plugin allows resetting of internal password.
  150. *
  151. * @return bool
  152. */
  153. function can_reset_password() {
  154. return true;
  155. }
  156. /**
  157. * Returns true if plugin can be manually set.
  158. *
  159. * @return bool
  160. */
  161. function can_be_manually_set() {
  162. return true;
  163. }
  164. /**
  165. * Prints a form for configuring this authentication plugin.
  166. *
  167. * This function is called from admin/auth.php, and outputs a full page with
  168. * a form for configuring this plugin.
  169. *
  170. * @param array $page An object containing all the data for this page.
  171. function config_form($config, $err, $user_fields) {
  172. include "config.html";
  173. }
  174. */
  175. /**
  176. * Processes and stores configuration data for this authentication plugin.
  177. */
  178. function process_config($config) {
  179. return true;
  180. }
  181. }