diff options
Diffstat (limited to 'webmail/plugins/http_authentication/http_authentication.php')
| -rw-r--r-- | webmail/plugins/http_authentication/http_authentication.php | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/webmail/plugins/http_authentication/http_authentication.php b/webmail/plugins/http_authentication/http_authentication.php new file mode 100644 index 0000000..a94b612 --- /dev/null +++ b/webmail/plugins/http_authentication/http_authentication.php @@ -0,0 +1,92 @@ +<?php + +/** + * HTTP Basic Authentication + * + * Make use of an existing HTTP authentication and perform login with the existing user credentials + * + * Configuration: + * // redirect the client to this URL after logout. This page is then responsible to clear HTTP auth + * $rcmail_config['logout_url'] = 'http://server.tld/logout.html'; + * + * See logout.html (in this directory) for an example how HTTP auth can be cleared. + * + * For other configuration options, see config.inc.php.dist! + * + * @version @package_version@ + * @license GNU GPLv3+ + * @author Thomas Bruederli + */ +class http_authentication extends rcube_plugin +{ + + function init() + { + $this->add_hook('startup', array($this, 'startup')); + $this->add_hook('authenticate', array($this, 'authenticate')); + $this->add_hook('logout_after', array($this, 'logout')); + } + + function startup($args) + { + if (!empty($_SERVER['PHP_AUTH_USER']) && !empty($_SERVER['PHP_AUTH_PW'])) { + $rcmail = rcmail::get_instance(); + $rcmail->add_shutdown_function(array('http_authentication', 'shutdown')); + + // handle login action + if (empty($args['action']) && empty($_SESSION['user_id'])) { + $args['action'] = 'login'; + } + // Set user password in session (see shutdown() method for more info) + else if (!empty($_SESSION['user_id']) && empty($_SESSION['password'])) { + $_SESSION['password'] = $rcmail->encrypt($_SERVER['PHP_AUTH_PW']); + } + } + + return $args; + } + + function authenticate($args) + { + // Load plugin's config file + $this->load_config(); + + $host = rcmail::get_instance()->config->get('http_authentication_host'); + if (is_string($host) && trim($host) !== '') + $args['host'] = rcube_idn_to_ascii(rcube_parse_host($host)); + + // Allow entering other user data in login form, + // e.g. after log out (#1487953) + if (!empty($args['user'])) { + return $args; + } + + if (!empty($_SERVER['PHP_AUTH_USER']) && !empty($_SERVER['PHP_AUTH_PW'])) { + $args['user'] = $_SERVER['PHP_AUTH_USER']; + $args['pass'] = $_SERVER['PHP_AUTH_PW']; + } + + $args['cookiecheck'] = false; + $args['valid'] = true; + + return $args; + } + + function logout($args) + { + // redirect to configured URL in order to clear HTTP auth credentials + if (!empty($_SERVER['PHP_AUTH_USER']) && $args['user'] == $_SERVER['PHP_AUTH_USER']) { + if ($url = rcmail::get_instance()->config->get('logout_url')) { + header("Location: $url", true, 307); + } + } + } + + function shutdown() + { + // There's no need to store password (even if encrypted) in session + // We'll set it back on startup (#1486553) + rcmail::get_instance()->session->remove('password'); + } +} + |
