phpmyadmin/libraries/plugins/AuthenticationPlugin.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Abstract class for the authentication plugins
   5  *
   6  * @package PhpMyAdmin
   7  */
   8 if (! defined('PHPMYADMIN')) {
   9     exit;
  10 }
  11
  12 /**
  13  * Provides a common interface that will have to be implemented by all of the
  14  * authentication plugins.
  15  *
  16  * @package PhpMyAdmin
  17  */
  18 abstract class AuthenticationPlugin
  19 {
  20     /**
  21      * Displays authentication form
  22      *
  23      * @return boolean
  24      */
  25     abstract public function auth();
  26
  27     /**
  28      * Gets advanced authentication settings
  29      *
  30      * @return boolean
  31      */
  32     abstract public function authCheck();
  33
  34     /**
  35      * Set the user and password after last checkings if required
  36      *
  37      * @return boolean
  38      */
  39     abstract public function authSetUser();
  40
  41     /**
  42      * Stores user credentials after successful login.
  43      *
  44      * @return void
  45      */
  46     public function storeUserCredentials()
  47     {
  48     }
  49
  50     /**
  51      * User is not allowed to login to MySQL -> authentication failed
  52      *
  53      * @return boolean
  54      */
  55     abstract public function authFails();
  56
  57     /**
  58      * Returns error message for failed authentication.
  59      *
  60      * @return string
  61      */
  62     public function getErrorMessage()
  63     {
  64         if (! empty($GLOBALS['login_without_password_is_forbidden'])) {
  65             return __(
  66                 'Login without a password is forbidden by configuration'
  67                 . ' (see AllowNoPassword)'
  68             );
  69         } elseif (! empty($GLOBALS['allowDeny_forbidden'])) {
  70             return __('Access denied!');
  71         } elseif (! empty($GLOBALS['no_activity'])) {
  72             return sprintf(
  73                 __('No activity within %s seconds; please log in again.'),
  74                 $GLOBALS['cfg']['LoginCookieValidity']
  75             );
  76         } else {
  77             $dbi_error = $GLOBALS['dbi']->getError();
  78             if (! empty($dbi_error)) {
  79                 return PMA_sanitize($dbi_error);
  80             } elseif (isset($GLOBALS['errno'])) {
  81                 return '#' . $GLOBALS['errno'] . ' '
  82                     . __('Cannot log in to the MySQL server');
  83             } else {
  84                 return __('Cannot log in to the MySQL server');
  85             }
  86         }
  87     }
  88
  89     /**
  90      * Callback when user changes password.
  91      *
  92      * @param string $password New password to set
  93      *
  94      * @return void
  95      */
  96     public function handlePasswordChange($password)
  97     {
  98     }
  99 }