1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952
|
<?php
/*
This code is part of LDAP Account Manager (http://www.ldap-account-manager.org/)
Copyright (C) 2006 - 2024 Roland Gruber
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/**
* This file includes functions to perform several security checks on each page load.
*
* @package lib
* @author Roland Gruber
*/
/** configuration options */
include_once('config.inc');
/** ldap connection */
include_once('ldap.inc');
/** common functions */
include_once('account.inc');
// check client IP address
checkClientIP();
setLAMHeaders();
/**
* Starts a session and sets the cookie options.
*/
function lam_start_session() {
$cookieOptions = lamDefaultCookieOptions();
$cookieOptions['lifetime'] = 0;
session_set_cookie_params($cookieOptions);
session_start();
}
function lamDefaultCookieOptions(): array {
$secureFlag = false;
if (isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) === 'on') {
$secureFlag = true;
}
return [
'path' => '/',
'domain' => '',
'secure' => $secureFlag,
'httponly' => true,
'samesite' => 'Lax'
];
}
/**
* Starts a session and checks the environment.
* The script is stopped if one of the checks fail (timeout redirection may be overridden).
*
* @param boolean $redirectToLogin redirect user to login page (default: true)
* @param boolean $initSecureData init verification data like session ID and client IP (default: false)
* @return boolean true if all ok, false if session expired
*/
function startSecureSession($redirectToLogin = true, $initSecureData = false) {
// start session
if (isset($_SESSION)) {
unset($_SESSION);
}
if (isFileBasedSession()) {
$sessionDir = __DIR__ . "/../sess";
session_save_path($sessionDir);
// enable garbage collection (fix for Debian based systems)
if (@ini_get("session.gc_probability") == 0) {
@ini_set("session.gc_probability", 1);
}
}
lam_start_session();
// init secure data if needed
if ($initSecureData && !isset($_SESSION["sec_session_id"])) {
$_SESSION["sec_session_id"] = session_id();
$_SESSION["sec_client_ip"] = $_SERVER['REMOTE_ADDR'];
$_SESSION['sec_sessionTime'] = time();
$_SESSION['cfgMain'] = new LAMCfgMain();
}
// set error reporting
if (empty($_SESSION['cfgMain']) || ($_SESSION['cfgMain']->errorReporting == LAMCfgMain::ERROR_REPORTING_DEFAULT)) {
ini_set('error_reporting', (E_ALL & ~E_NOTICE));
}
elseif ($_SESSION['cfgMain']->errorReporting == LAMCfgMain::ERROR_REPORTING_ALL) {
ini_set('error_reporting', E_ALL);
ini_set('display_errors', 'On');
}
// check session id
if (!isset($_SESSION["sec_session_id"]) || ($_SESSION["sec_session_id"] != session_id())) {
// session id is invalid
logNewMessage(LOG_WARNING, "Invalid session ID, access denied (" . getClientIPForLogging() . ")");
if ($redirectToLogin) {
logoffAndBackToLoginPage();
}
else {
die();
}
}
// check if client IP has not changed
if (!isset($_SESSION["sec_client_ip"]) || ($_SESSION["sec_client_ip"] != $_SERVER['REMOTE_ADDR'])) {
// IP is invalid
logNewMessage(LOG_WARNING, "Client IP changed, access denied (" . getClientIPForLogging() . ")");
if ($redirectToLogin) {
logoffAndBackToLoginPage();
}
else {
die();
}
}
// check if session time has not expired
if (($_SESSION['sec_sessionTime'] + (60 * $_SESSION['cfgMain']->sessionTimeout)) > time()) {
// ok, update time
$_SESSION['sec_sessionTime'] = time();
}
elseif ($redirectToLogin) {
// session expired, logoff user
logoffAndBackToLoginPage();
}
else {
return false;
}
setSSLCaCert();
return true;
}
/**
* Returns if the session uses files storage.
*
* @return bool file based session
*/
function isFileBasedSession(): bool {
return ((session_module_name() !== false) && (strtolower(session_module_name()) === 'files'));
}
/**
* Checks if the client's IP address is on the list of allowed IPs.
* The script is stopped if the host is not valid.
*/
function checkClientIP() {
$cfg = $_SESSION['cfgMain'] ?? new LAMCfgMain();
$allowedHosts = $cfg->allowedHosts;
$url = getCallingURL();
if (($url !== null) &&
((str_contains($url, '/selfService/selfService'))
|| ((str_contains($url, '/misc/ajax.php?')) && str_contains($url, 'selfservice=1')))) {
// self service pages have separate IP list
$allowedHosts = $cfg->allowedHostsSelfService;
}
// skip test if no hosts are defined
if (empty($allowedHosts) || empty($_SERVER['REMOTE_ADDR'])) {
return;
}
$allowedHosts = explode(",", $allowedHosts);
$grantAccess = false;
for ($i = 0; $i < sizeof($allowedHosts); $i++) {
$host = $allowedHosts[$i];
$ipRegex = '/^[0-9a-z\\.:\\*]+$/i';
if (!preg_match($ipRegex, $host)) {
continue;
}
$hostRegex = str_replace(".", "\\.", $host);
$hostRegex = '/^' . str_replace("*", ".*", $hostRegex) . '$/';
$clientIP = $_SERVER['REMOTE_ADDR'];
if (preg_match($hostRegex, $clientIP)) {
// client is allowed to access LAM
$grantAccess = true;
}
}
// stop script is client may not access LAM
if (!$grantAccess) {
logNewMessage(LOG_WARNING, "Invalid client IP, access denied (" . getClientIPForLogging() . ")");
die();
}
}
/**
* Logs off the user and displays the login page.
*
*/
function logoffAndBackToLoginPage(): void {
// log message
if (isset($_SESSION['ldap'])) {
$ldapUser = $_SESSION['ldap']->getUserName();
logNewMessage(LOG_WARNING, 'Session of user ' . $ldapUser . ' expired.');
// close LDAP connection
@$_SESSION["ldap"]->destroy();
}
elseif (isset($_SESSION['selfService_clientDN']) || (str_contains($_SERVER['REQUEST_URI'], '/selfService/'))) {
logNewMessage(LOG_WARNING, 'Self service session of DN ' . lamDecrypt($_SESSION['selfService_clientDN'], 'SelfService') . ' expired.');
}
// delete key and iv in cookie
$cookieOptions = lamDefaultCookieOptions();
$cookieOptions['expires'] = 0;
setcookie("Key", "", $cookieOptions);
setcookie("IV", "", $cookieOptions);
// link back to login page
$paths = ['./', '../', '../../', '../../../', '../../../../'];
$page = 'login.php';
$pageSuffix = '?expired=yes';
if (isset($_SESSION['selfService_clientDN']) || (str_contains($_SERVER['REQUEST_URI'], '/selfService/'))) {
$scope = $_GET['scope'];
$name = $_GET['name'];
if (!preg_match('/^[0-9a-zA-Z _-]+$/', $scope) || !preg_match('/^[0-9a-zA-Z _-]+$/', $name)) {
logNewMessage(LOG_ERR, 'GET parameters invalid: ' . $name . ' ' . $scope);
die();
}
$page = 'selfServiceLogin.php';
$pageSuffix = '?expired=yes&scope=' . $scope . '&name=' . $name;
}
for ($i = 0; $i < sizeof($paths); $i++) {
if (file_exists($paths[$i] . $page)) {
$page = $paths[$i] . $page;
break;
}
}
$page .= $pageSuffix;
echo $_SESSION['header'];
echo "<title></title>\n";
echo "</head>\n";
echo "<body>\n";
// print JavaScript refresh
echo "<script type=\"text/javascript\">\n";
echo "top.location.href = \"" . $page . "\";\n";
echo "</script>\n";
// print link if refresh does not work
echo "<p>\n";
echo "<a target=\"_top\" href=\"" . $page . "\">" . _("Your session expired, click here to go back to the login page.") . "</a>\n";
echo "</p>\n";
echo "</body>\n";
echo "</html>\n";
// destroy session
session_destroy();
unset($_SESSION);
die();
}
/**
* Returns if debug messages are to be logged.
*
* @return boolean debug enabled
*/
function isDebugLoggingEnabled() {
$cfg = $_SESSION['cfgMain'] ?? new LAMCfgMain();
return $cfg->logLevel >= LOG_DEBUG;
}
/**
* Puts a new message in the log file.
*
* @param string $level log level (LOG_DEBUG, LOG_NOTICE, LOG_WARNING, LOG_ERR)
* @param string $message log message
*/
function logNewMessage($level, $message): void {
$possibleLevels = [
LOG_DEBUG => 'DEBUG',
LOG_NOTICE => 'NOTICE',
LOG_WARNING => 'WARNING',
LOG_ERR => 'ERROR'];
if (!in_array($level, array_keys($possibleLevels))) {
StatusMessage('ERROR', 'Invalid log level!', $level);
return;
}
if (isset($_SESSION['cfgMain'])) {
$cfg = $_SESSION['cfgMain'];
}
else {
$cfg = new LAMCfgMain();
$_SESSION['cfgMain'] = $cfg;
}
// check if logging is disabled
if (($cfg->logDestination == 'NONE')
// check if log level is high enough
|| ($cfg->logLevel < $level)) {
return;
}
// ok to log, build log message
$prefix = "LDAP Account Manager (" . session_id() . ' - ' . getClientIPForLogging() . ' - ' . getLamLdapUser() . ") - " . $possibleLevels[$level] . ": ";
$message = $prefix . $message;
// Syslog logging
if ($cfg->logDestination == 'SYSLOG') {
syslog($level, $message);
}
// remote logging
elseif (str_starts_with($cfg->logDestination, 'REMOTE')) {
lamLogRemoteMessage($level, $message, $cfg);
}
// log to file
elseif (LAMCfgMain::isValidLogFilename($cfg->logDestination)) {
@touch($cfg->logDestination);
if (is_writable($cfg->logDestination)) {
$file = fopen($cfg->logDestination, 'a');
if ($file) {
$timeZone = 'UTC';
$sysTimeZone = @date_default_timezone_get();
if (!empty($sysTimeZone)) {
$timeZone = $sysTimeZone;
}
$time = new DateTime('now', new DateTimeZone($timeZone));
fwrite($file, $time->format('Y-m-d H:i:s') . ': ' . $message . "\n");
fclose($file);
}
}
}
}
/**
* Checks if write access to LDAP is allowed.
*
* @param String $scope account type (e.g. user)
* @return boolean true, if allowed
*/
function checkIfWriteAccessIsAllowed($scope = null) {
if (!isset($_SESSION['config'])) {
return false;
}
if ($_SESSION['config']->getAccessLevel() >= LAMConfig::ACCESS_ALL) {
$typeSettings = $_SESSION['config']->get_typeSettings();
if (($scope == null)
// check if write for this type is allowed
|| !isset($typeSettings['readOnly_' . $scope])
|| !$typeSettings['readOnly_' . $scope]) {
return true;
}
}
return false;
}
/**
* Checks if passwords may be changed.
*
* @return boolean true, if allowed
*/
function checkIfPasswordChangeIsAllowed() {
if (!isset($_SESSION['config'])) {
return false;
}
if ($_SESSION['config']->getAccessLevel() >= LAMConfig::ACCESS_PASSWORD_CHANGE) {
return true;
}
return false;
}
/**
* Checks if it is allowed to create new LDAP entries of the given type.
* This also checks if general write access is enabled.
*
* @param String $scope account type (e.g. 'user')
* @return boolean true, if new entries are allowed
*/
function checkIfNewEntriesAreAllowed($scope) {
if (!isLAMProVersion()) {
return true;
}
if (!isset($_SESSION['config']) || empty($scope)) {
return false;
}
$typeSettings = $_SESSION['config']->get_typeSettings();
if (isset($typeSettings['hideNewButton_' . $scope]) && $typeSettings['hideNewButton_' . $scope]) {
return false;
}
return checkIfWriteAccessIsAllowed();
}
/**
* Checks if it is allowed to delete LDAP entries of the given type.
*
* @param String $scope account type (e.g. 'user')
* @return boolean true, if entries may be deleted
*/
function checkIfDeleteEntriesIsAllowed($scope) {
if (!isLAMProVersion()) {
return true;
}
if (!isset($_SESSION['config']) || empty($scope)) {
return false;
}
$typeSettings = $_SESSION['config']->get_typeSettings();
if (isset($typeSettings['hideDeleteButton_' . $scope]) && $typeSettings['hideDeleteButton_' . $scope]) {
return false;
}
return checkIfWriteAccessIsAllowed();
}
/**
* Checks if the password fulfills the password policies.
*
* @param String $password password
* @param String|array $userNames user name(s)
* @param array $otherUserAttrs user's first/last name
* @return mixed true if ok, string with error message if not valid
*/
function checkPasswordStrength($password, $userNames, $otherUserAttrs) {
if (($userNames !== null) && !is_array($userNames)) {
$userNames = [$userNames];
}
if ($password == null) {
$password = "";
}
$cfg = $_SESSION['cfgMain'] ?? new LAMCfgMain();
// check length
$minLength = $cfg->passwordMinLength;
if (isset($_SESSION['config']) && is_numeric($_SESSION['config']->getPwdPolicyMinLength())) {
$minLength = $_SESSION['config']->getPwdPolicyMinLength();
}
if (strlen($password) < $minLength) {
return sprintf(_('The password is too short. You have to enter at least %s characters.'), $minLength);
}
// get number of characters per character class
$lower = 0;
$upper = 0;
$numeric = 0;
$symbols = 0;
for ($i = 0; $i < strlen($password); $i++) {
if (preg_match("/[a-z]/", $password[$i])) {
$lower++;
}
if (preg_match("/[A-Z]/", $password[$i])) {
$upper++;
}
if (preg_match("/[0-9]/", $password[$i])) {
$numeric++;
}
if (preg_match("/[^a-z0-9]/i", $password[$i])) {
$symbols++;
}
}
$rulesMatched = 0;
// check lower case
$minLower = $cfg->passwordMinLower;
if (isset($_SESSION['config']) && is_numeric($_SESSION['config']->getpwdPolicyMinLowercase())) {
$minLower = $_SESSION['config']->getpwdPolicyMinLowercase();
}
if (($cfg->checkedRulesCount == -1) && ($lower < $minLower)) {
return sprintf(_('The password is too weak. You have to enter at least %s lower case characters.'), $minLower);
}
if ($lower >= $minLower) {
$rulesMatched++;
}
// check upper case
$minUpper = $cfg->passwordMinUpper;
if (isset($_SESSION['config']) && is_numeric($_SESSION['config']->getPwdPolicyMinUppercase())) {
$minUpper = $_SESSION['config']->getPwdPolicyMinUppercase();
}
if (($cfg->checkedRulesCount == -1) && ($upper < $minUpper)) {
return sprintf(_('The password is too weak. You have to enter at least %s upper case characters.'), $minUpper);
}
if ($upper >= $minUpper) {
$rulesMatched++;
}
// check numeric
$minNumeric = $cfg->passwordMinNumeric;
if (isset($_SESSION['config']) && is_numeric($_SESSION['config']->getPwdPolicyMinNumeric())) {
$minNumeric = $_SESSION['config']->getPwdPolicyMinNumeric();
}
if (($cfg->checkedRulesCount == -1) && ($numeric < $minNumeric)) {
return sprintf(_('The password is too weak. You have to enter at least %s numeric characters.'), $minNumeric);
}
if ($numeric >= $minNumeric) {
$rulesMatched++;
}
// check symbols
$minSymbols = $cfg->passwordMinSymbol;
if (isset($_SESSION['config']) && is_numeric($_SESSION['config']->getPwdPolicyMinSymbolic())) {
$minSymbols = $_SESSION['config']->getPwdPolicyMinSymbolic();
}
if (($cfg->checkedRulesCount == -1) && ($symbols < $minSymbols)) {
return sprintf(_('The password is too weak. You have to enter at least %s symbolic characters.'), $minSymbols);
}
if ($symbols >= $minSymbols) {
$rulesMatched++;
}
// check classes
$classes = getNumberOfCharacterClasses($password);
if (($cfg->checkedRulesCount == -1) && ($classes < $cfg->passwordMinClasses)) {
return sprintf(_('The password is too weak. You have to enter at least %s different character classes (upper/lower case, numbers and symbols).'), $cfg->passwordMinClasses);
}
if ($classes >= $cfg->passwordMinClasses) {
$rulesMatched++;
}
// check rules count
if (($cfg->checkedRulesCount != -1) && ($rulesMatched < $cfg->checkedRulesCount)) {
return sprintf(_('The password is too weak. It needs to match at least %s password complexity rules.'), $cfg->checkedRulesCount);
}
$pwdLow = strtolower($password);
// check user name
if (($cfg->passwordMustNotContainUser == 'true') && !empty($userNames)) {
foreach ($userNames as $userName) {
$userLow = strtolower($userName);
if (str_contains($pwdLow, $userLow)) {
return _('The password is too weak. You may not use the user name as part of the password.');
}
}
}
// check part of user name and additional attributes
if (($cfg->passwordMustNotContain3Chars == 'true') && !empty($userNames)) {
// check if contains part of user name
foreach ($userNames as $userName) {
if (strlen($userName) > 2) {
$userLow = strtolower($userName);
for ($i = 0; $i < strlen($userLow) - 3; $i++) {
$part = substr($userLow, 0, 3);
if (str_contains($pwdLow, $part)) {
return _('The password is too weak. You may not use parts of the user name for the password.');
}
}
}
}
}
if (($cfg->passwordMustNotContain3Chars == 'true') && !empty($otherUserAttrs)) {
// check other attributes
foreach ($otherUserAttrs as $other) {
$low = strtolower($other);
for ($i = 0; $i < strlen($low) - 3; $i++) {
$part = substr($low, 0, 3);
if (str_contains($pwdLow, $part)) {
return _('The password is too weak. You may not use parts of user attributes for the password.');
}
}
}
}
// check external password service
if (!checkPwdWithExternalPasswordService($cfg, $password)) {
return _('Your selected password is known to be insecure.');
}
return true;
}
/**
* Checks the password against the external password service.
*
* @param LAMCfgMain $cfg main configuration
* @param string $password password
* @return boolean password accepted as secure
*/
function checkPwdWithExternalPasswordService($cfg, $password) {
if (!function_exists('curl_init') || empty($cfg->externalPwdCheckUrl)) {
return true;
}
$sha1 = sha1($password);
$sha1Prefix = substr($sha1, 0, 5);
$sha1Suffix = substr($sha1, 5);
$curl = curl_init();
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$url = $cfg->externalPwdCheckUrl;
$url = str_replace('{SHA1PREFIX}', $sha1Prefix, $url);
curl_setopt($curl, CURLOPT_URL, $url);
$results = curl_exec($curl);
$code = curl_errno($curl);
if ($code) {
logNewMessage(LOG_ERR, 'Error calling the external password service at ' . $url
. '. ' . curl_error($curl));
return true;
}
curl_close($curl);
if (empty($results)) {
return true;
}
$results = explode("\n", $results);
foreach ($results as $result) {
if (stripos($result, $sha1Suffix . ':') !== false) {
return false;
}
}
return true;
}
/**
* Checks if the given tool is active.
* Otherwise, an error message is logged and the execution is stopped (die()).
*
* @param String $tool tool class name (e.g. toolFileUpload)
*/
function checkIfToolIsActive($tool) {
// check if hidden by config
if (!$_SESSION['config']->isToolActive($tool)) {
logNewMessage(LOG_ERR, 'Unauthorized access to tool ' . $tool . ' denied.');
die();
}
}
/**
* Returns if the user is logged in.
*
* @return boolean is logged in
*/
function isLoggedIn() {
return (isset($_SESSION['loggedIn']) && ($_SESSION['loggedIn'] === true));
}
/**
* Returns the client IP and comma separated proxy IPs if any (HTTP_X_FORWARDED_FOR, HTTP_X_REAL_IP).
*
* @return String client IP (e.g. 10.10.10.10,11.11.11.11)
*/
function getClientIPForLogging() {
$ip = empty($_SERVER['REMOTE_ADDR']) ? '' : $_SERVER['REMOTE_ADDR'];
if (!empty($_SERVER['HTTP_X_FORWARDED_FOR']) && (strlen($_SERVER['HTTP_X_FORWARDED_FOR']) < 100)) {
$ip .= ',' . $_SERVER['HTTP_X_FORWARDED_FOR'];
}
if (!empty($_SERVER['HTTP_X_REAL_IP']) && (strlen($_SERVER['HTTP_X_REAL_IP']) < 100)) {
$ip .= ',' . $_SERVER['HTTP_X_REAL_IP'];
}
return $ip;
}
/**
* Returns the login dn of the current user.
*
* @return string user DN
*/
function getLamLdapUser() {
if (isset($_SESSION['ldap'])) {
return $_SESSION['ldap']->getUserName();
}
elseif (isset($_SESSION['selfService_clientDN'])) {
return lamDecrypt($_SESSION['selfService_clientDN'], 'SelfService');
}
return '';
}
/**
* Adds a security token to the session to prevent CSRF attacks.
*
* @param boolean $overwrite overwrite existing token
*/
function addSecurityTokenToSession($overwrite = true): void {
if (!empty($_SESSION[getSecurityTokenName()]) && !$overwrite) {
return;
}
$_SESSION[getSecurityTokenName()] = generateRandomPassword(40);
}
/**
* Checks if the security token from SESSION matches POST data.
*/
function validateSecurityToken() {
if (empty($_POST)) {
return;
}
if (empty($_POST[getSecurityTokenName()]) || ($_POST[getSecurityTokenName()] != $_SESSION[getSecurityTokenName()])) {
logNewMessage(LOG_ERR, 'Security token does not match POST data.');
die();
}
}
/**
* Adds a hidden input field to the given meta HTML table.
* Should be used to add token at the end of table.
*
* @param htmlTable|htmlGroup|htmlResponsiveRow $container table
*/
function addSecurityTokenToMetaHTML(&$container) {
$token = new htmlHiddenInput(getSecurityTokenName(), $_SESSION[getSecurityTokenName()]);
if ($container instanceof htmlResponsiveRow) {
$container->add($token);
return;
}
$container->addElement($token, true);
}
/**
* Returns the name of the security token parameter.
*
* @return String name
*/
function getSecurityTokenName() {
return 'sec_token';
}
/**
* Returns the value of the security token parameter.
*
* @return String value
*/
function getSecurityTokenValue() {
return $_SESSION[getSecurityTokenName()];
}
/**
* Sets the X-Frame-Options and Content-Security-Policy header to prevent clickjacking.
*/
function setLAMHeaders() {
if (!headers_sent()) {
header('X-Frame-Options: sameorigin');
header('Content-Security-Policy: frame-ancestors \'self\'; form-action \'self\'; base-uri \'none\'; object-src \'none\'; frame-src \'self\' https://www.google.com/recaptcha/ https://hcaptcha.com https://*.hcaptcha.com https://api.friendlycaptcha.com; worker-src \'self\' blob:');
header('X-Content-Type-Options: nosniff');
header('X-XSS-Protection: 1; mode=block');
header("Feature-Policy: ambient-light-sensor 'none'; autoplay 'none'; accelerometer 'none'; camera 'none'; encrypted-media 'none'; fullscreen 'self'; geolocation 'none'; gyroscope 'none'; magnetometer 'none'; microphone 'none'; midi 'none'; payment 'none'; picture-in-picture 'none'; speaker 'none'; sync-xhr 'self'; usb 'none'; vr 'none'");
}
}
/**
* Encrypts a string
*
* @param string $data string to encrypt
* @param string $prefix prefix for cookie names
* @return object encrypted string
*/
function lamEncrypt($data, $prefix = '') {
if (empty($_COOKIE[$prefix . "IV"])) {
return $data;
}
// read key and iv from cookie
$iv = base64_decode($_COOKIE[$prefix . "IV"]);
$key = base64_decode($_COOKIE[$prefix . "Key"]);
// encrypt string
return openssl_encrypt(base64_encode($data), lamEncryptionAlgo(), $key, 0, $iv);
}
/**
* Decrypts a string
*
* @param object $data string to decrypt
* @param string $prefix prefix for cookie names
* @return string decrypted string
*/
function lamDecrypt($data, $prefix = '') {
if (empty($_COOKIE[$prefix . "IV"])) {
return $data;
}
// read key and iv from cookie
$iv = base64_decode($_COOKIE[$prefix . "IV"]);
$key = base64_decode($_COOKIE[$prefix . "Key"]);
// decrypt string
$ret = openssl_decrypt($data, lamEncryptionAlgo(), $key, 0, $iv);
return base64_decode(str_replace(chr(00), "", $ret));
}
/**
* Returns the encryption algorithm to use.
*
* @return string algorithm name
*/
function lamEncryptionAlgo() {
$possibleAlgos = openssl_get_cipher_methods();
if (in_array('AES-256-CTR', $possibleAlgos)) {
return 'AES-256-CTR';
}
elseif (in_array('AES-256-CBC', $possibleAlgos)) {
return 'AES-256-CBC';
}
return 'AES256';
}
/**
* Logs a message to a remote logging service.
*
* @param int $level log level
* @param string $message log message
* @param LAMCfgMain $cfgMain main configuration
*/
function lamLogRemoteMessage($level, $message, $cfgMain) {
include_once __DIR__ . '/3rdParty/composer/autoload.php';
$remoteParts = explode(':', $cfgMain->logDestination);
$server = $remoteParts[1];
$port = intval($remoteParts[2]);
$output = "%channel%.%level_name%: %message%";
$formatter = new Monolog\Formatter\LineFormatter($output);
$logger = new Monolog\Logger('lam');
$syslogHandler = new Monolog\Handler\SyslogUdpHandler($server, $port);
$syslogHandler->setFormatter($formatter);
$logger->pushHandler($syslogHandler);
switch ($level) {
case LOG_DEBUG:
$logger->debug($message);
break;
case LOG_NOTICE:
$logger->notice($message);
break;
case LOG_WARNING:
$logger->warning($message);
break;
case LOG_ERR:
$logger->error($message);
break;
}
}
/**
* Manages temporary files.
*/
class LamTemporaryFilesManager {
private const SESSION_KEY = 'sec_registered_tmp_files';
/**
* Creates a temporary file and registers it for the current session.
*
* @param string $extension file extension (including ".", e.g. ".svg")
* @param string $prefix file prefix (default: empty)
* @return string file name
* @throws LAMException unable to create temporary file
*/
public function registerTemporaryFile(string $extension, string $prefix = ''): string {
$fileName = $prefix . time() . generateRandomText() . $extension;
if (!$this->isValidFileName($fileName)) {
throw new LAMException(_('Unable to create temporary file.'));
}
$path = __DIR__ . '/../tmp/' . $fileName;
$handle = @fopen($path, "wb");
if ($handle) {
@chmod($path, 0600);
fclose($handle);
$_SESSION[self::SESSION_KEY][] = $fileName;
return $fileName;
}
throw new LAMException(_('Unable to create temporary file.'));
}
/**
* Opens a temporary file for reading.
*
* @param string $fileName file name
* @return resource file handle
* @throws LAMException unable to open file
*/
public function openTemporaryFileForRead(string $fileName) {
if (!$this->isRegisteredFile($fileName)) {
throw new LAMException(_('Unable to read file.'));
}
$path = $this->getFileSystemPath($fileName);
$handle = @fopen($path, "r");
if ($handle) {
return $handle;
}
throw new LAMException(_('Unable to read file.'));
}
/**
* Opens a temporary file for writing.
*
* @param string $fileName file name
* @return resource file handle
* @throws LAMException unable to open file
*/
public function openTemporaryFileForWrite(string $fileName) {
if (!$this->isRegisteredFile($fileName)) {
throw new LAMException(_('Unable to read file.'));
}
$path = $this->getFileSystemPath($fileName);
$handle = @fopen($path, "wb");
if ($handle) {
return $handle;
}
throw new LAMException(_('Unable to read file.'));
}
/**
* Checks if the given file name is valid and registered.
*
* @param string $fileName file name
* @return bool is valid
*/
public function isRegisteredFile(string $fileName): bool {
return $this->isValidFileName($fileName)
&& !empty($_SESSION[self::SESSION_KEY])
&& in_array($fileName, $_SESSION[self::SESSION_KEY]);
}
/**
* Checks if the given file name contains no special characters.
*
* @param string $fileName file name
* @return bool is valid
*/
private function isValidFileName(string $fileName): bool {
return preg_match('/^[a-zA-Z0-9\\._-]+$/', $fileName);
}
/**
* Returns the download link to a file.
*
* @param string $fileName file name
* @param string $prefix prefix to folder "templates" (e.g. "../../" if called from templates/config/sub, default: "../")
* @return string download link
* @throws LAMException error reading file
*/
public function getDownloadLink(string $fileName, string $prefix = '../'): string {
if (!$this->isRegisteredFile($fileName)) {
throw new LAMException(_('Unable to read file.'));
}
$selfServicePart = isSelfService() ? '&selfservice=true' : '';
return $prefix . 'misc/download.php?file=' . $fileName . '&download=true' . $selfServicePart;
}
/**
* Returns the plain link to a file.
*
* @param string $fileName file name
* @param string $prefix prefix to folder "templates" (e.g. "../../" if called from templates/config/sub, default: "../")
* @return string download link
* @throws LAMException error reading file
*/
public function getResourceLink(string $fileName, string $prefix = '../'): string {
if (!$this->isRegisteredFile($fileName)) {
throw new LAMException(_('Unable to read file.'));
}
$selfServicePart = isSelfService() ? '&selfservice=true' : '';
return $prefix . 'misc/download.php?file=' . $fileName . $selfServicePart;
}
/**
* Deletes all registered files of the user.
*/
public function deleteAllRegisteredFiles(): void {
if (empty($_SESSION[self::SESSION_KEY])) {
return;
}
foreach ($_SESSION[self::SESSION_KEY] as $fileName) {
if (!$this->isValidFileName($fileName)) {
continue;
}
$path = $this->getFileSystemPath($fileName);
if (file_exists($path)) {
unlink($path);
}
}
unset($_SESSION[self::SESSION_KEY]);
}
/**
* Returns the raw path on file system.
* Only to be used if download/resource link cannot be used.
*
* @param string $fileName file name
* @return string path on file system
* @throws LAMException
*/
public function getFileSystemPath(string $fileName): string {
if (!$this->isValidFileName($fileName) || !$this->isRegisteredFile($fileName)) {
throw new LAMException(_('Unable to read file.'));
}
return __DIR__ . '/../tmp/' . $fileName;
}
}
|