class SecuresiteManager in Secure Site 8
Hierarchy
- class \Drupal\securesite\SecuresiteManager implements SecuresiteManagerInterface
Expanded class hierarchy of SecuresiteManager
1 string reference to 'SecuresiteManager'
1 service uses SecuresiteManager
File
- src/
SecuresiteManager.php, line 22 - Contains \Drupal\securesite\SecuresiteManager.
Namespace
Drupal\securesiteView source
class SecuresiteManager implements SecuresiteManagerInterface {
/**
* The page request to act on.
*
* @var \Symfony\Component\HttpFoundation\Request
*/
protected $request;
/**
* The entity manager.
*
* @var \Drupal\Core\Entity\EntityManagerInterface
*/
protected $entityManager;
/**
* The config factory.
*
* @var \Drupal\Core\Config\ConfigFactoryInterface
*/
protected $configFactory;
/**
* The user auth service.
*
* @var \Drupal\user\UserAuthInterface
*/
protected $userAuth;
public function __construct(EntityManagerInterface $entity_manager, ConfigFactoryInterface $config_factory, UserAuthInterface $user_auth) {
$this->entityManager = $entity_manager;
$this->configFactory = $config_factory;
$this->userAuth = $user_auth;
}
/**
* {@inheritdoc}
*/
public function setRequest(Request $request) {
$this->request = $request;
}
/**
* {@inheritdoc}
*/
public function getMechanism() {
static $mechanism;
$request = $this->request;
if (!isset($mechanism)) {
// PHP in CGI mode work-arounds. Sometimes "REDIRECT_" prefixes $_SERVER
// variables. See http://www.php.net/reserved.variables.
if (empty($request->headers
->get('HTTP_AUTHORIZATION')) && !empty($request->headers
->get('REDIRECT_HTTP_AUTHORIZATION'))) {
$request->headers
->set('HTTP_AUTHORIZATION', $request->headers
->get('REDIRECT_HTTP_AUTHORIZATION'));
}
if (!empty($request->headers
->get('HTTP_AUTHORIZATION'))) {
list($type, $authorization) = explode(' ', $request->headers
->get('HTTP_AUTHORIZATION'), 2);
switch (drupal_strtolower($type)) {
case 'digest':
$request->headers
->set('PHP_AUTH_DIGEST', $authorization);
break;
case 'basic':
$credentials = explode(':', base64_decode($authorization), 2);
$request->headers
->set('PHP_AUTH_USER', $credentials[0]);
$request->headers
->set('PHP_AUTH_PW', $credentials[1]);
break;
}
}
$mechanism = FALSE;
$types = $this->configFactory
->get('securesite.settings')
->get('securesite_type');
rsort($types, SORT_NUMERIC);
foreach ($types as $type) {
switch ($type) {
case SECURESITE_DIGEST:
if ($_SERVER['PHP_AUTH_DIGEST'] != null) {
$mechanism = SECURESITE_DIGEST;
break 2;
}
break;
case SECURESITE_BASIC:
if ($request->headers
->get('PHP_AUTH_USER') != null || $request->headers
->get('PHP_AUTH_PW') != null) {
$mechanism = SECURESITE_BASIC;
break 2;
}
break;
case SECURESITE_FORM:
if ($request->request
->get('form_id') != null && $request->request
->get('form_id') == 'securesite_login_form') {
$mechanism = SECURESITE_FORM;
break 2;
}
break;
}
}
}
return $mechanism;
}
/**
* {@inheritdoc}
*/
public function boot($type) {
$currentUser = \Drupal::currentUser();
$request = $this->request;
switch ($type) {
case SECURESITE_DIGEST:
$edit = $this
->parseDirectives($_SERVER['PHP_AUTH_DIGEST']);
$edit['name'] = $edit['username'];
$edit['pass'] = NULL;
$function = 'digestAuth';
break;
case SECURESITE_BASIC:
$edit['name'] = $request->headers
->get('PHP_AUTH_USER', '');
$edit['pass'] = $request->headers
->get('PHP_AUTH_PW', '');
$function = 'plainAuth';
break;
case SECURESITE_FORM:
//todo check if openid works
if (!empty($_POST['openid_identifier'])) {
openid_begin($_POST['openid_identifier'], $_POST['openid.return_to']);
}
$edit = array(
'name' => $request->request
->get('name'),
'pass' => $request->request
->get('pass'),
);
$function = 'plainAuth';
break;
}
// Are credentials different from current user?
$differentUser = $currentUser
->getUsername() == \Drupal::config('user.settings')
->get('anonymous') || $edit['name'] !== $currentUser
->getUsername();
$notGuestLogin = !isset($_SESSION['securesite_guest']) || $edit['name'] !== $_SESSION['securesite_guest'];
if ($differentUser && $notGuestLogin) {
$this
->{$function}($edit);
}
}
public function plainAuth($edit) {
// We cant set username to be a required field so we check here if it is empty
if (empty($edit['name'])) {
drupal_set_message(t('Unrecognized user name and/or password.'), 'error');
$this
->showDialog($this
->getType());
}
$accounts = $this->entityManager
->getStorage('user')
->loadByProperties(array(
'name' => $edit['name'],
'status' => 1,
));
$account = reset($accounts);
if (!$account) {
// Not a registered user.
// If we have correct LDAP credentials, register this new user.
if (\Drupal::moduleHandler()
->moduleExists('ldapauth') && _ldapauth_auth($edit['name'], $edit['pass'], TRUE) !== FALSE) {
$accounts = $this->entityManager
->getStorage('user')
->loadByProperties(array(
'name' => $edit['name'],
'status' => 1,
));
$account = reset($accounts);
// System should be setup correctly now, perform log-in.
if ($account != FALSE) {
$this
->userLogin($edit, $account);
}
}
else {
// See if we have guest user credentials.
$this
->guestLogin($edit);
}
}
else {
if ($this->userAuth
->authenticate($edit['name'], $edit['pass']) || \Drupal::moduleHandler()
->moduleExists('ldapauth') && _ldapauth_auth($edit['name'], $edit['pass']) !== FALSE) {
// Password is correct. Perform log-in.
$this
->userLogin($edit, $account);
}
else {
// Request credentials using most secure authentication method.
\Drupal::logger('user')
->notice('Log-in attempt failed for %user.', array(
'%user' => $edit['name'],
));
drupal_set_message(t('Unrecognized user name and/or password.'), 'error');
$this
->showDialog($this
->getType());
}
}
}
public function userLogin($edit, AccountInterface $account) {
global $user;
if ($account
->hasPermission('access secured pages')) {
\Drupal::currentUser()
->setAccount($account);
$newUser = User::load($account
->id());
user_login_finalize($newUser);
// Mark the session so Secure Site will be triggered on log-out.
$_SESSION['securesite_login'] = TRUE;
// Unset the session variable set by securesite_denied().
unset($_SESSION['securesite_denied']);
// Unset messages from previous log-in attempts.
unset($_SESSION['messages']);
// Clear the guest session.
unset($_SESSION['securesite_guest']);
// Prevent a log-in/log-out loop by redirecting off the log-out page.
if (current_path() == 'user/logout') {
$response = new RedirectResponse('/');
$response
->send();
}
return $account;
}
else {
$this
->denied(t('You have not been authorized to log in to secured pages.'));
}
}
public function guestLogin($edit) {
$config = \Drupal::config('securesite.settings');
$guest_name = $config
->get('securesite_guest_name');
$guest_pass = $config
->get('securesite_guest_pass');
$anonymous_user = new AnonymousUserSession();
// Check anonymous user permission and credentials.
if ($anonymous_user
->hasPermission('access secured pages') && (empty($guest_name) || $edit['name'] == $guest_name) && (empty($guest_pass) || $edit['pass'] == $guest_pass)) {
// Unset the session variable set by securesite_denied().
if (isset($_SESSION['securesite_denied'])) {
unset($_SESSION['securesite_denied']);
}
// Mark this session to prevent re-login (note: guests can't log out).
$_SESSION['securesite_guest'] = $edit['name'];
$_SESSION['securesite_login'] = TRUE;
// Prevent a 403 error by redirecting off the logout page.
if (current_path() == 'user/logout') {
$response = new RedirectResponse('/');
$response
->send();
}
}
else {
if ((empty($guest_name) || $edit['name'] == $guest_name) && (empty($guest_pass) || $edit['pass'] == $guest_pass)) {
\Drupal::logger('user')
->notice('Log-in attempt failed for <em>anonymous</em> user.');
$this
->denied(t('Anonymous users are not allowed to log in to secured pages.'));
}
else {
\Drupal::logger('user')
->notice('Log-in attempt failed for %user.', array(
'%user' => $edit['name'],
));
drupal_set_message(t('Unrecognized user name and/or password.'), 'error');
$this
->showDialog($this
->getType());
}
}
}
/**
* Perform digest authentication.
*/
public function digestAuth($edit) {
$request = $this->request;
$realm = \Drupal::config('securesite.settings')
->get('securesite_realm');
$header = $this
->_securesite_digest_validate($status, array(
'data' => $_SERVER['PHP_AUTH_DIGEST'],
'method' => $_SERVER['REQUEST_METHOD'],
'uri' => request_uri(),
'realm' => $realm,
));
$account = $this->entityManager
->getStorage('user')
->loadByProperties(array(
'name' => $edit['name'],
'status' => 1,
));
$account = reset($account);
if (!$account) {
// Not a registered user. See if we have guest user credentials.
switch ($status) {
case 1:
$this->request->securesiteHeaders += array(
'Status',
'400 Bad Request',
);
$this
->showDialog($this
->getType());
break;
case 0:
// Password is correct. Log user in.
$this->request->securesiteHeaders += array(
$header['name'] => $header['value'],
);
$edit['pass'] = \Drupal::config('securesite.settings')
->get('securesite_guest_pass');
default:
$this
->guestLogin($edit);
break;
}
}
else {
switch ($status) {
case 0:
// Password is correct. Log user in.
$this->request->securesiteHeaders += array(
$header['name'] => $header['value'],
);
$this
->userLogin($edit, $account);
break;
case 2:
// Password not stored. Request credentials using next most secure authentication method.
$mechanism = $this
->getMechanism();
$types = \Drupal::config('securesite.settings')
->get('securesite_type');
rsort($types);
foreach ($types as $type) {
if ($type < $mechanism) {
break;
}
}
\Drupal::logger('user')
->notice('Secure log-in failed for %user.', array(
'%user' => $edit['name'],
));
drupal_set_message(t('Secure log-in failed. Please try again.'), 'error');
$this
->showDialog($type);
break;
case 1:
$this->request->securesiteHeaders += array(
'Status',
'400 Bad Request',
);
$this
->showDialog($this
->getType());
default:
// Authentication failed. Request credentials using most secure authentication method.
\Drupal::logger('user')
->notice('Log-in attempt failed for %user.', array(
'%user' => $edit['name'],
));
drupal_set_message(t('Unrecognized user name and/or password.'), 'error');
$this
->showDialog($this
->getType());
break;
}
}
}
/**
* Get the result of digest validation.
*
* @param $status
* Will be set to the return status of the validation script
* @param $edit
* An array of parameters to pass to the validation script
* @return
* An HTTP header string.
*/
public function _securesite_digest_validate(&$status, $edit = array()) {
static $header;
$edit['site_path'] = DrupalKernel::findSitePath(\Drupal::request());
if (!empty($edit)) {
$args = array();
foreach ($edit as $key => $value) {
$args[] = "{$key}=" . escapeshellarg($value);
}
$script = \Drupal::config('securesite.settings')
->get('securesite_digest_script');
$response = exec($script . ' ' . implode(' ', $args), $output, $status);
// drupal_set_header() is now drupal_add_http_header() and requires headers passed as name, value in an array.
// The script returns a string, so we shall break it up as best we can. The existing code doesn't seem
// to worry about correct data to append to 'WWW-Authenticate: ' etc so I won't add any for the D7 conversion.
/* $response_explode = explode('=', $response);
$name = array_shift($response_explode);
$value = implode('=', $response_explode);*/
if (isset($edit['data']) && empty($status)) {
$header = array(
'name' => "Authentication-Info",
'value' => $response,
);
}
else {
$header = array(
'name' => "WWW-Authenticate",
'value' => 'Digest ' . $response,
);
}
}
return $header;
}
public function showDialog($type) {
global $base_path, $language;
$request = $this->request;
$response = new Response();
// Has the password reset form been submitted?
//todo what is the use of the following if statement? why get the form and not display it?
if (isset($_POST['form_id']) && $_POST['form_id'] == 'user_pass') {
// Get form messages, but do not display form.
\Drupal::formBuilder()
->getForm('securesite_user_pass');
$content = '';
}
elseif (strpos(current_path(), 'user/reset/') === 0 || \Drupal::moduleHandler()
->moduleExists('locale') && $language->enabled && strpos(current_path(), $language->prefix . '/user/reset/') === 0) {
$args = explode('/', current_path());
if (\Drupal::moduleHandler()
->moduleExists('locale') && $language->enabled && $language->prefix != '') {
// Remove the language argument.
array_shift($args);
}
// The password reset function doesn't work well if it doesn't have all the
// required parameters or if the UID parameter isn't valid
if (count($args) < 5 || $this->entityManager
->getStorage('user')
->loadByProperties(array(
'uid' => $args[2],
'status' => 1,
)) == FALSE) {
$error = t('You have tried to use an invalid one-time log-in link.');
$reset = \Drupal::config('securesite.settings')
->get('securesite_reset_form');
if (empty($reset)) {
drupal_set_message($error, 'error');
$content = '';
}
else {
$error .= ' ' . t('Please request a new one using the form below.');
drupal_set_message($error, 'error');
$content = \Drupal::formBuilder()
->getForm('securesite_user_pass');
}
}
}
elseif (!\Drupal::moduleHandler()
->moduleExists('openid') || $_GET['q'] != 'openid/authenticate') {
// Display log-in dialog.
switch ($type) {
case SECURESITE_DIGEST:
$realm = \Drupal::config('securesite.settings')
->get('securesite_realm');
$header = $this
->_securesite_digest_validate($status, array(
'realm' => $realm,
'fakerealm' => $this
->getFakeRealm(),
));
if (strpos($header, 'WWW-Authenticate') === 0) {
$this->request->securesiteHeaders += array(
'Status' => '401',
);
}
else {
$this->request->securesiteHeaders += array(
'Status' => '401',
);
$this->request->securesiteHeaders += array(
$header['name'] => $header['value'],
);
}
break;
case SECURESITE_BASIC:
$this->request->securesiteHeaders += array(
'Status' => '401',
);
$this->request->securesiteHeaders += array(
'WWW-Authenticate' => 'Basic realm="' . $this
->getFakeRealm() . '"',
);
case SECURESITE_FORM:
$this->request->securesiteHeaders += array(
'Status' => '200',
);
break;
}
// Form authentication doesn't work for cron, so allow cron.php to run
// without authenticating when no other authentication type is enabled.
if ((request_uri() != $base_path . 'cron.php' || \Drupal::config('securesite.settings')
->get('securesite_type') != array(
SECURESITE_FORM,
)) && in_array(SECURESITE_FORM, \Drupal::config('securesite.settings')
->get('securesite_type'))) {
//todo fix next line
//drupal_set_title(t('Authentication required'));
$content = $this
->dialogPage();
}
}
if (isset($content)) {
// Theme and display output
$html = _theme('securesite_page', array(
'content' => $content,
));
$response
->setContent($html);
$response->headers
->set('Content-Type', 'text/html');
$response
->send();
exit;
}
}
/**
* Deny access to users who are not authorized to access secured pages.
*/
public function denied($message) {
$request = $this->request;
if (empty($_SESSION['securesite_denied'])) {
// Unset messages from previous log-in attempts.
if (isset($_SESSION['messages'])) {
unset($_SESSION['messages']);
}
// Set a session variable so that the log-in dialog will be displayed when the page is reloaded.
$_SESSION['securesite_denied'] = TRUE;
$types = \Drupal::config('securesite.settings')
->get('securesite_type');
if (array_pop($types) != SECURESITE_FORM) {
$this->request->securesiteHeaders += array(
'Status' => '403',
);
}
else {
drupal_set_message(Xss::Filter($message), 'error');
// Theme and display output
$content = $this
->dialogPage();
print _theme('securesite_page', array(
'content' => $content,
));
// Exit
exit;
}
}
else {
unset($_SESSION['securesite_denied']);
// Safari will attempt to use old credentials before requesting new credentials
// from the user. Logging out requires that the WWW-Authenticate header be sent
// twice.
$user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? drupal_strtolower($_SERVER['HTTP_USER_AGENT']) : '';
if ($user_agent != str_replace('safari', '', $user_agent)) {
$_SESSION['securesite_repeat'] = TRUE;
}
$types = \Drupal::config('securesite.settings')
->get('securesite_type');
//todo fix next few lines
if (in_array(SECURESITE_DIGEST, $types)) {
// Reset the digest header.
$realm = \Drupal::config('securesite.settings')
->get('securesite_realm');
$this
->_securesite_digest_validate($status, array(
'realm' => $realm,
'fakerealm' => $this
->getFakeRealm(),
));
}
if ($this
->getType() == SECURESITE_FORM) {
drupal_set_message(Xss::Filter($message), 'error');
// Theme and display output
$content = $this
->dialogPage();
print _theme('securesite_page', array(
'content' => $content,
));
// Exit
exit;
}
else {
$this
->showDialog($this
->getType());
}
}
}
/**
* Display fall-back HTML for HTTP authentication dialogs. Safari will not load
* this. Opera will not load this after log-out unless the page has been
* reloaded and the authentication dialog has been displayed twice.
*/
public function dialogPage() {
$formBuilder = \Drupal::formBuilder();
$reset = \Drupal::config('securesite.settings')
->get('securesite_reset_form');
if (in_array(SECURESITE_FORM, \Drupal::config('securesite.settings')
->get('securesite_type'))) {
$user_login = $formBuilder
->getForm('Drupal\\securesite\\Form\\SecuresiteLoginForm');
$output = render($user_login);
if (!empty($reset)) {
$user_pass = $formBuilder
->getForm('Drupal\\user\\Form\\UserPasswordForm');
$output .= "<hr />\n" . render($user_pass);
}
}
else {
if (!empty($reset)) {
$user_pass = $formBuilder
->getForm('securesite_user_pass');
$output = render($user_pass);
}
else {
$output = '<p>' . t('Reload the page to try logging in again.') . '</p>';
}
}
$output = SafeMarkup::set($output);
return $output;
}
/**
* Determine if Secure Site authentication should be forced.
*/
public function forcedAuth() {
// Do we require credentials to display this page?
if (php_sapi_name() == 'cli' || current_path() == 'admin/reports/request-test') {
return FALSE;
}
else {
switch (\Drupal::config('securesite.settings')
->get('securesite_enabled')) {
case SECURESITE_ALWAYS:
return TRUE;
case SECURESITE_OFFLINE:
return \Drupal::state()
->get('system.maintenance_mode') ?: 0;
default:
return FALSE;
}
}
}
/**
* Opera and Internet Explorer save credentials indefinitely and will keep
* attempting to use them even when they have failed multiple times. We add a
* random string to the realm to allow users to log out.
*/
public function getFakeRealm() {
$realm = \Drupal::config('securesite.settings')
->get('securesite_realm');
$user_agent = drupal_strtolower($this->request->server
->get('HTTP_USER_AGENT', ''));
if ($user_agent != str_replace(array(
'msie',
'opera',
), '', $user_agent)) {
$realm .= ' - ' . mt_rand(10, 999);
}
return $realm;
}
public function getType() {
$securesite_type = \Drupal::config('securesite.settings')
->get('securesite_type');
return array_pop($securesite_type);
}
public function parseDirectives($field_value) {
$directives = array();
foreach (explode(',', trim($field_value)) as $directive) {
list($directive, $value) = explode('=', trim($directive), 2);
$directives[$directive] = trim($value, '"');
}
return $directives;
}
/**
* Menu callback; handle restricted pages.
*/
public static function handle403() {
global $user;
if (empty($user->uid) && !isset($_SESSION['securesite_guest']) && $_GET['q'] != 'user/logout') {
_securesite_dialog(securesite_type_get());
}
else {
$path = \Drupal::service('path.alias_manager.cached')
->getSystemPath(\Drupal::config('securesite.settings')
->get('securesite_403'));
menu_set_active_item($path);
return menu_execute_active_handler($path);
}
}
}Members
Name |
Modifiers | Type | Description | Overrides |
|---|---|---|---|---|
|
SecuresiteManager:: |
protected | property | The config factory. | |
|
SecuresiteManager:: |
protected | property | The entity manager. | |
|
SecuresiteManager:: |
protected | property | The page request to act on. | |
|
SecuresiteManager:: |
protected | property | The user auth service. | |
|
SecuresiteManager:: |
public | function |
Overrides SecuresiteManagerInterface:: |
|
|
SecuresiteManager:: |
public | function | Deny access to users who are not authorized to access secured pages. | |
|
SecuresiteManager:: |
public | function | Display fall-back HTML for HTTP authentication dialogs. Safari will not load this. Opera will not load this after log-out unless the page has been reloaded and the authentication dialog has been displayed twice. | |
|
SecuresiteManager:: |
public | function | Perform digest authentication. | |
|
SecuresiteManager:: |
public | function |
Determine if Secure Site authentication should be forced. Overrides SecuresiteManagerInterface:: |
|
|
SecuresiteManager:: |
public | function | Opera and Internet Explorer save credentials indefinitely and will keep attempting to use them even when they have failed multiple times. We add a random string to the realm to allow users to log out. | |
|
SecuresiteManager:: |
public | function |
Return the appropriate method of authentication for the request Overrides SecuresiteManagerInterface:: |
|
|
SecuresiteManager:: |
public | function | ||
|
SecuresiteManager:: |
public | function | ||
|
SecuresiteManager:: |
public static | function | Menu callback; handle restricted pages. | |
|
SecuresiteManager:: |
public | function | ||
|
SecuresiteManager:: |
public | function | ||
|
SecuresiteManager:: |
public | function |
Overrides SecuresiteManagerInterface:: |
|
|
SecuresiteManager:: |
public | function |
Overrides SecuresiteManagerInterface:: |
|
|
SecuresiteManager:: |
public | function | ||
|
SecuresiteManager:: |
public | function | Get the result of digest validation. | |
|
SecuresiteManager:: |
public | function |