4chan/team/developer/pma/libraries/plugins/AuthenticationPlugin.class.php
2025-04-17 18:12:08 -05:00

100 lines
2.4 KiB
PHP

<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
* Abstract class for the authentication plugins
*
* @package PhpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;
}
/**
* Provides a common interface that will have to be implemented by all of the
* authentication plugins.
*
* @package PhpMyAdmin
*/
abstract class AuthenticationPlugin
{
/**
* Displays authentication form
*
* @return boolean
*/
abstract public function auth();
/**
* Gets advanced authentication settings
*
* @return boolean
*/
abstract public function authCheck();
/**
* Set the user and password after last checkings if required
*
* @return boolean
*/
abstract public function authSetUser();
/**
* Stores user credentials after successful login.
*
* @return void
*/
public function storeUserCredentials()
{
}
/**
* User is not allowed to login to MySQL -> authentication failed
*
* @return boolean
*/
abstract public function authFails();
/**
* Returns error message for failed authentication.
*
* @return string
*/
public function getErrorMessage()
{
if (! empty($GLOBALS['login_without_password_is_forbidden'])) {
return __(
'Login without a password is forbidden by configuration'
. ' (see AllowNoPassword)'
);
} elseif (! empty($GLOBALS['allowDeny_forbidden'])) {
return __('Access denied!');
} elseif (! empty($GLOBALS['no_activity'])) {
return sprintf(
__('No activity within %s seconds; please log in again.'),
$GLOBALS['cfg']['LoginCookieValidity']
);
} else {
$dbi_error = $GLOBALS['dbi']->getError();
if ( ! empty($dbi_error)) {
return PMA_sanitize($dbi_error);
} elseif (isset($GLOBALS['errno'])) {
return '#' . $GLOBALS['errno'] . ' '
. __('Cannot log in to the MySQL server');
} else {
return __('Cannot log in to the MySQL server');
}
}
}
/**
* Callback when user changes password.
*
* @param string $password New password to set
*
* @return void
*/
public function handlePasswordChange($password)
{
}
}
?>