auth/pam/auth.php

   1 <?php
   2
   3 /**
   4  * @author Martin Dougiamas
   5  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
   6  * @package moodle multiauth
   7  *
   8  * Authentication Plugin: PAM Authentication
   9  *
  10  * PAM (Pluggable Authentication Modules) for Moodle
  11  *
  12  * Description:
  13  * Authentication by using the PHP4 PAM module:
  14  * http://www.math.ohio-state.edu/~ccunning/pam_auth/
  15  *
  16  * Version 0.3  2006/09/07 by Jonathan Harker (plugin class)
  17  * Version 0.2: 2004/09/01 by Martin V�geli (stable version)
  18  * Version 0.1: 2004/08/30 by Martin V�geli (first draft)
  19  *
  20  * Contact: martinvoegeli@gmx.ch
  21  * Website 1: http://elearning.zhwin.ch/
  22  * Website 2: http://birdy1976.com/
  23  *
  24  * License:  GPL License v2
  25  *
  26  * 2006-08-31  File created.
  27  */
  28
  29 if (!defined('MOODLE_INTERNAL')) {
  30     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
  31 }
  32
  33 require_once($CFG->libdir.'/authlib.php');
  34
  35 /**
  36  * PAM authentication plugin.
  37  */
  38 class auth_plugin_pam extends auth_plugin_base {
  39
  40     /**
  41      * Store error messages from pam authentication attempts.
  42      */
  43     var $lasterror;
  44
  45     /**
  46      * Constructor.
  47      */
  48     function auth_plugin_pam() {
  49         $this->authtype = 'pam';
  50         $this->config = get_config('auth/pam');
  51         $this->errormessage = '';
  52     }
  53
  54     /**
  55      * Returns true if the username and password work and false if they are
  56      * wrong or don't exist.
  57      *
  58      * @param string $username The username
  59      * @param string $password The password
  60      * @return bool Authentication success or failure.
  61      */
  62     function user_login ($username, $password) {
  63         // variable to store possible errors during authentication
  64         $errormessage = str_repeat(' ', 2048);
  65
  66         // just for testing and debugging
  67         // error_reporting(E_ALL);
  68
  69         // call_time_pass_reference of errormessage is deprecated - throws warnings in multiauth
  70         //if (pam_auth($username, $password, &$errormessage)) {
  71         if (pam_auth($username, $password)) {
  72             return true;
  73         }
  74         else {
  75             $this->lasterror = $errormessage;
  76             return false;
  77         }
  78     }
  79
  80     function prevent_local_passwords() {
  81         return true;
  82     }
  83
  84     /**
  85      * Returns true if this authentication plugin is 'internal'.
  86      *
  87      * @return bool
  88      */
  89     function is_internal() {
  90         return false;
  91     }
  92
  93     /**
  94      * Returns true if this authentication plugin can change the user's
  95      * password.
  96      *
  97      * @return bool
  98      */
  99     function can_change_password() {
 100         return false;
 101     }
 102
 103     /**
 104      * Prints a form for configuring this authentication plugin.
 105      *
 106      * This function is called from admin/auth.php, and outputs a full page with
 107      * a form for configuring this plugin.
 108      *
 109      * @param array $page An object containing all the data for this page.
 110      */
 111     function config_form($config, $err, $user_fields) {
 112         include "config.html";
 113     }
 114
 115     /**
 116      * Processes and stores configuration data for this authentication plugin.
 117      */
 118     function process_config($config) {
 119         return true;
 120     }
 121
 122 }
 123
 124