eaf3f6c9ffa5e3011a2bbc77d250d8e8ce03b077
[moodle.git] / auth / cas / auth.php
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/>.
17 /**
18  * Authentication Plugin: CAS Authentication
19  *
20  * Authentication using CAS (Central Authentication Server).
21  *
22  * @author Martin Dougiamas
23  * @author Jerome GUTIERREZ
24  * @author IƱaki Arenaza
25  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
26  * @package auth_cas
27  */
29 defined('MOODLE_INTERNAL') || die();
31 require_once($CFG->dirroot.'/auth/ldap/auth.php');
32 require_once($CFG->dirroot.'/auth/cas/CAS/CAS.php');
34 /**
35  * CAS authentication plugin.
36  */
37 class auth_plugin_cas extends auth_plugin_ldap {
39     /**
40      * Constructor.
41      */
42     function auth_plugin_cas() {
43         $this->authtype = 'cas';
44         $this->roleauth = 'auth_cas';
45         $this->errorlogtag = '[AUTH CAS] ';
46         $this->init_plugin($this->authtype);
47     }
49     function prevent_local_passwords() {
50         return true;
51     }
53     /**
54      * Authenticates user against CAS
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 (with system magic quotes)
59      * @param string $password The password (with system magic quotes)
60      * @return bool Authentication success or failure.
61      */
62     function user_login ($username, $password) {
63         $this->connectCAS();
64         return phpCAS::isAuthenticated() && (trim(core_text::strtolower(phpCAS::getUser())) == $username);
65     }
67     /**
68      * Returns true if this authentication plugin is 'internal'.
69      *
70      * @return bool
71      */
72     function is_internal() {
73         return false;
74     }
76     /**
77      * Returns true if this authentication plugin can change the user's
78      * password.
79      *
80      * @return bool
81      */
82     function can_change_password() {
83         return false;
84     }
86     /**
87      * Authentication choice (CAS or other)
88      * Redirection to the CAS form or to login/index.php
89      * for other authentication
90      */
91     function loginpage_hook() {
92         global $frm;
93         global $CFG;
94         global $SESSION, $OUTPUT, $PAGE;
96         $site = get_site();
97         $CASform = get_string('CASform', 'auth_cas');
98         $username = optional_param('username', '', PARAM_RAW);
99         $courseid = optional_param('courseid', 0, PARAM_INT);
101         if (!empty($username)) {
102             if (isset($SESSION->wantsurl) && (strstr($SESSION->wantsurl, 'ticket') ||
103                                               strstr($SESSION->wantsurl, 'NOCAS'))) {
104                 unset($SESSION->wantsurl);
105             }
106             return;
107         }
109         // Return if CAS enabled and settings not specified yet
110         if (empty($this->config->hostname)) {
111             return;
112         }
114         // If the multi-authentication setting is used, check for the param before connecting to CAS.
115         if ($this->config->multiauth) {
117             // If there is an authentication error, stay on the default authentication page.
118             if (!empty($SESSION->loginerrormsg)) {
119                 return;
120             }
122             $authCAS = optional_param('authCAS', '', PARAM_RAW);
123             if ($authCAS == 'NOCAS') {
124                 return;
125             }
126             // Show authentication form for multi-authentication.
127             // Test pgtIou parameter for proxy mode (https connection in background from CAS server to the php server).
128             if ($authCAS != 'CAS' && !isset($_GET['pgtIou'])) {
129                 $PAGE->set_url('/login/index.php');
130                 $PAGE->navbar->add($CASform);
131                 $PAGE->set_title("$site->fullname: $CASform");
132                 $PAGE->set_heading($site->fullname);
133                 echo $OUTPUT->header();
134                 include($CFG->dirroot.'/auth/cas/cas_form.html');
135                 echo $OUTPUT->footer();
136                 exit();
137             }
138         }
140         // Connection to CAS server
141         $this->connectCAS();
143         if (phpCAS::checkAuthentication()) {
144             $frm = new stdClass();
145             $frm->username = phpCAS::getUser();
146             $frm->password = 'passwdCas';
148             // Redirect to a course if multi-auth is activated, authCAS is set to CAS and the courseid is specified.
149             if ($this->config->multiauth && !empty($courseid)) {
150                 redirect(new moodle_url('/course/view.php', array('id'=>$courseid)));
151             }
153             return;
154         }
156         if (isset($_GET['loginguest']) && ($_GET['loginguest'] == true)) {
157             $frm = new stdClass();
158             $frm->username = 'guest';
159             $frm->password = 'guest';
160             return;
161         }
163         // Force CAS authentication (if needed).
164         if (!phpCAS::isAuthenticated()) {
165             phpCAS::setLang($this->config->language);
166             phpCAS::forceAuthentication();
167         }
168     }
171     /**
172      * Connect to the CAS (clientcas connection or proxycas connection)
173      *
174      */
175     function connectCAS() {
176         global $CFG;
177         static $connected = false;
179         if (!$connected) {
180             // Make sure phpCAS doesn't try to start a new PHP session when connecting to the CAS server.
181             if ($this->config->proxycas) {
182                 phpCAS::proxy($this->config->casversion, $this->config->hostname, (int) $this->config->port, $this->config->baseuri, false);
183             } else {
184                 phpCAS::client($this->config->casversion, $this->config->hostname, (int) $this->config->port, $this->config->baseuri, false);
185             }
186             $connected = true;
187         }
189         // If Moodle is configured to use a proxy, phpCAS needs some curl options set.
190         if (!empty($CFG->proxyhost) && !is_proxybypass($this->config->hostname)) {
191             phpCAS::setExtraCurlOption(CURLOPT_PROXY, $CFG->proxyhost);
192             if (!empty($CFG->proxyport)) {
193                 phpCAS::setExtraCurlOption(CURLOPT_PROXYPORT, $CFG->proxyport);
194             }
195             if (!empty($CFG->proxytype)) {
196                 // Only set CURLOPT_PROXYTYPE if it's something other than the curl-default http
197                 if ($CFG->proxytype == 'SOCKS5') {
198                     phpCAS::setExtraCurlOption(CURLOPT_PROXYTYPE, CURLPROXY_SOCKS5);
199                 }
200             }
201             if (!empty($CFG->proxyuser) and !empty($CFG->proxypassword)) {
202                 phpCAS::setExtraCurlOption(CURLOPT_PROXYUSERPWD, $CFG->proxyuser.':'.$CFG->proxypassword);
203                 if (defined('CURLOPT_PROXYAUTH')) {
204                     // any proxy authentication if PHP 5.1
205                     phpCAS::setExtraCurlOption(CURLOPT_PROXYAUTH, CURLAUTH_BASIC | CURLAUTH_NTLM);
206                 }
207             }
208         }
210         if ($this->config->certificate_check && $this->config->certificate_path){
211             phpCAS::setCasServerCACert($this->config->certificate_path);
212         } else {
213             // Don't try to validate the server SSL credentials
214             phpCAS::setNoCasServerValidation();
215         }
216     }
218     /**
219      * Prints a form for configuring this authentication plugin.
220      *
221      * This function is called from admin/auth.php, and outputs a full page with
222      * a form for configuring this plugin.
223      *
224      * @param array $page An object containing all the data for this page.
225      */
226     function config_form($config, $err, $user_fields) {
227         global $CFG, $OUTPUT;
229         if (!function_exists('ldap_connect')) { // Is php-ldap really there?
230             echo $OUTPUT->notification(get_string('auth_ldap_noextension', 'auth_ldap'));
232             // Don't return here, like we do in auth/ldap. We cas use CAS without LDAP.
233             // So just warn the user (done above) and define the LDAP constants we use
234             // in config.html, to silence the warnings.
235             if (!defined('LDAP_DEREF_NEVER')) {
236                 define ('LDAP_DEREF_NEVER', 0);
237             }
238             if (!defined('LDAP_DEREF_ALWAYS')) {
239                 define ('LDAP_DEREF_ALWAYS', 3);
240             }
241         }
243         include($CFG->dirroot.'/auth/cas/config.html');
244     }
246     /**
247      * A chance to validate form data, and last chance to
248      * do stuff before it is inserted in config_plugin
249      * @param object object with submitted configuration settings (without system magic quotes)
250      * @param array $err array of error messages
251      */
252     function validate_form($form, &$err) {
253         $certificate_path = trim($form->certificate_path);
254         if ($form->certificate_check && empty($certificate_path)) {
255             $err['certificate_path'] = get_string('auth_cas_certificate_path_empty', 'auth_cas');
256         }
257     }
259     /**
260      * Returns the URL for changing the user's pw, or empty if the default can
261      * be used.
262      *
263      * @return moodle_url
264      */
265     function change_password_url() {
266         return null;
267     }
269     /**
270      * Processes and stores configuration data for this authentication plugin.
271      */
272     function process_config($config) {
274         // CAS settings
275         if (!isset($config->hostname)) {
276             $config->hostname = '';
277         }
278         if (!isset($config->port)) {
279             $config->port = '';
280         }
281         if (!isset($config->casversion)) {
282             $config->casversion = '';
283         }
284         if (!isset($config->baseuri)) {
285             $config->baseuri = '';
286         }
287         if (!isset($config->language)) {
288             $config->language = '';
289         }
290         if (!isset($config->proxycas)) {
291             $config->proxycas = '';
292         }
293         if (!isset($config->logoutcas)) {
294             $config->logoutcas = '';
295         }
296         if (!isset($config->multiauth)) {
297             $config->multiauth = '';
298         }
299         if (!isset($config->certificate_check)) {
300             $config->certificate_check = '';
301         }
302         if (!isset($config->certificate_path)) {
303             $config->certificate_path = '';
304         }
305         if (!isset($config->logout_return_url)) {
306             $config->logout_return_url = '';
307         }
309         // LDAP settings
310         if (!isset($config->host_url)) {
311             $config->host_url = '';
312         }
313         if (!isset($config->start_tls)) {
314              $config->start_tls = false;
315         }
316         if (empty($config->ldapencoding)) {
317             $config->ldapencoding = 'utf-8';
318         }
319         if (!isset($config->pagesize)) {
320             $config->pagesize = LDAP_DEFAULT_PAGESIZE;
321         }
322         if (!isset($config->contexts)) {
323             $config->contexts = '';
324         }
325         if (!isset($config->user_type)) {
326             $config->user_type = 'default';
327         }
328         if (!isset($config->user_attribute)) {
329             $config->user_attribute = '';
330         }
331         if (!isset($config->search_sub)) {
332             $config->search_sub = '';
333         }
334         if (!isset($config->opt_deref)) {
335             $config->opt_deref = LDAP_DEREF_NEVER;
336         }
337         if (!isset($config->bind_dn)) {
338             $config->bind_dn = '';
339         }
340         if (!isset($config->bind_pw)) {
341             $config->bind_pw = '';
342         }
343         if (!isset($config->ldap_version)) {
344             $config->ldap_version = '3';
345         }
346         if (!isset($config->objectclass)) {
347             $config->objectclass = '';
348         }
349         if (!isset($config->memberattribute)) {
350             $config->memberattribute = '';
351         }
353         if (!isset($config->memberattribute_isdn)) {
354             $config->memberattribute_isdn = '';
355         }
356         if (!isset($config->attrcreators)) {
357             $config->attrcreators = '';
358         }
359         if (!isset($config->groupecreators)) {
360             $config->groupecreators = '';
361         }
362         if (!isset($config->removeuser)) {
363             $config->removeuser = AUTH_REMOVEUSER_KEEP;
364         }
366         // save CAS settings
367         set_config('hostname', trim($config->hostname), $this->pluginconfig);
368         set_config('port', trim($config->port), $this->pluginconfig);
369         set_config('casversion', $config->casversion, $this->pluginconfig);
370         set_config('baseuri', trim($config->baseuri), $this->pluginconfig);
371         set_config('language', $config->language, $this->pluginconfig);
372         set_config('proxycas', $config->proxycas, $this->pluginconfig);
373         set_config('logoutcas', $config->logoutcas, $this->pluginconfig);
374         set_config('multiauth', $config->multiauth, $this->pluginconfig);
375         set_config('certificate_check', $config->certificate_check, $this->pluginconfig);
376         set_config('certificate_path', $config->certificate_path, $this->pluginconfig);
377         set_config('logout_return_url', $config->logout_return_url, $this->pluginconfig);
379         // save LDAP settings
380         set_config('host_url', trim($config->host_url), $this->pluginconfig);
381         set_config('start_tls', $config->start_tls, $this->pluginconfig);
382         set_config('ldapencoding', trim($config->ldapencoding), $this->pluginconfig);
383         set_config('pagesize', (int)trim($config->pagesize), $this->pluginconfig);
384         set_config('contexts', trim($config->contexts), $this->pluginconfig);
385         set_config('user_type', core_text::strtolower(trim($config->user_type)), $this->pluginconfig);
386         set_config('user_attribute', core_text::strtolower(trim($config->user_attribute)), $this->pluginconfig);
387         set_config('search_sub', $config->search_sub, $this->pluginconfig);
388         set_config('opt_deref', $config->opt_deref, $this->pluginconfig);
389         set_config('bind_dn', trim($config->bind_dn), $this->pluginconfig);
390         set_config('bind_pw', $config->bind_pw, $this->pluginconfig);
391         set_config('ldap_version', $config->ldap_version, $this->pluginconfig);
392         set_config('objectclass', trim($config->objectclass), $this->pluginconfig);
393         set_config('memberattribute', core_text::strtolower(trim($config->memberattribute)), $this->pluginconfig);
394         set_config('memberattribute_isdn', $config->memberattribute_isdn, $this->pluginconfig);
395         set_config('attrcreators', trim($config->attrcreators), $this->pluginconfig);
396         set_config('groupecreators', trim($config->groupecreators), $this->pluginconfig);
397         set_config('removeuser', $config->removeuser, $this->pluginconfig);
399         return true;
400     }
402     /**
403      * Returns true if user should be coursecreator.
404      *
405      * @param mixed $username    username (without system magic quotes)
406      * @return boolean result
407      */
408     function iscreator($username) {
409         if (empty($this->config->host_url) or (empty($this->config->attrcreators) && empty($this->config->groupecreators)) or empty($this->config->memberattribute)) {
410             return false;
411         }
413         $extusername = core_text::convert($username, 'utf-8', $this->config->ldapencoding);
415         // Test for group creator
416         if (!empty($this->config->groupecreators)) {
417             $ldapconnection = $this->ldap_connect();
418             if ($this->config->memberattribute_isdn) {
419                 if(!($userid = $this->ldap_find_userdn($ldapconnection, $extusername))) {
420                     return false;
421                 }
422             } else {
423                 $userid = $extusername;
424             }
426             $group_dns = explode(';', $this->config->groupecreators);
427             if (ldap_isgroupmember($ldapconnection, $userid, $group_dns, $this->config->memberattribute)) {
428                 return true;
429             }
430         }
432         // Build filter for attrcreator
433         if (!empty($this->config->attrcreators)) {
434             $attrs = explode(';', $this->config->attrcreators);
435             $filter = '(& ('.$this->config->user_attribute."=$username)(|";
436             foreach ($attrs as $attr){
437                 if(strpos($attr, '=')) {
438                     $filter .= "($attr)";
439                 } else {
440                     $filter .= '('.$this->config->memberattribute."=$attr)";
441                 }
442             }
443             $filter .= '))';
445             // Search
446             $result = $this->ldap_get_userlist($filter);
447             if (count($result) != 0) {
448                 return true;
449             }
450         }
452         return false;
453     }
455     /**
456      * Reads user information from LDAP and returns it as array()
457      *
458      * If no LDAP servers are configured, user information has to be
459      * provided via other methods (CSV file, manually, etc.). Return
460      * an empty array so existing user info is not lost. Otherwise,
461      * calls parent class method to get user info.
462      *
463      * @param string $username username
464      * @return mixed array with no magic quotes or false on error
465      */
466     function get_userinfo($username) {
467         if (empty($this->config->host_url)) {
468             return array();
469         }
470         return parent::get_userinfo($username);
471     }
473     /**
474      * Syncronizes users from LDAP server to moodle user table.
475      *
476      * If no LDAP servers are configured, simply return. Otherwise,
477      * call parent class method to do the work.
478      *
479      * @param bool $do_updates will do pull in data updates from LDAP if relevant
480      * @return nothing
481      */
482     function sync_users($do_updates=true) {
483         if (empty($this->config->host_url)) {
484             error_log('[AUTH CAS] '.get_string('noldapserver', 'auth_cas'));
485             return;
486         }
487         parent::sync_users($do_updates);
488     }
490     /**
491     * Hook for logout page
492     */
493     function logoutpage_hook() {
494         global $USER, $redirect;
496         // Only do this if the user is actually logged in via CAS
497         if ($USER->auth === $this->authtype) {
498             // Check if there is an alternative logout return url defined
499             if (isset($this->config->logout_return_url) && !empty($this->config->logout_return_url)) {
500                 // Set redirect to alternative return url
501                 $redirect = $this->config->logout_return_url;
502             }
503         }
504     }
506     /**
507      * Post logout hook.
508      *
509      * Note: this method replace the prelogout_hook method to avoid redirect to CAS logout
510      * before the event userlogout being triggered.
511      *
512      * @param stdClass $user clone of USER object object before the user session was terminated
513      */
514     public function postlogout_hook($user) {
515         global $CFG;
516         // Only redirect to CAS logout if the user is logged as a CAS user.
517         if (!empty($this->config->logoutcas) && $user->auth == $this->authtype) {
518             $backurl = !empty($this->config->logout_return_url) ? $this->config->logout_return_url : $CFG->wwwroot;
519             $this->connectCAS();
520             phpCAS::logoutWithRedirectService($backurl);
521         }
522     }