config->twoFactorAuthenticationSerialAttributeName; $handle = getLDAPServerHandle(); $userData = ldapGetDN($userDn, [$attrName], $handle); if (empty($userData[$attrName])) { logNewMessage(LOG_DEBUG, getDefaultLDAPErrorString($handle)); return null; } if (is_array($userData[$attrName])) { return $userData[$attrName][0]; } return $userData[$attrName]; } /** * {@inheritDoc} * @see TwoFactorProvider::isShowSubmitButton */ public function isShowSubmitButton() { return true; } } /** * Provider for privacyIDEA. */ class PrivacyIDEAProvider extends BaseProvider { /** * Constructor. * * @param TwoFactorConfiguration $config configuration */ public function __construct(&$config) { $this->config = $config; } /** * {@inheritDoc} * @see TwoFactorProvider::getSerials */ public function getSerials($user, $password) { logNewMessage(LOG_DEBUG, 'PrivacyIDEAProvider: Getting serials for ' . $user); $loginAttribute = $this->getLoginAttributeValue($user); $token = $this->authenticate($loginAttribute, $password); return $this->getSerialsForUser($loginAttribute, $token); } /** * {@inheritDoc} * @see TwoFactorProvider::verify2ndFactor */ public function verify2ndFactor($user, $password, $serial, $twoFactorInput) { logNewMessage(LOG_DEBUG, 'PrivacyIDEAProvider: Checking 2nd factor for ' . $user); $loginAttribute = $this->getLoginAttributeValue($user); $token = $this->authenticate($loginAttribute, $password); return $this->verify($token, $serial, $twoFactorInput); } /** * Authenticates against the server * * @param string $user user name * @param string $password password * @return string token * @throws Exception error during authentication */ private function authenticate($user, $password) { $curl = $this->getCurl(); $url = $this->config->twoFactorAuthenticationURL . "/auth"; curl_setopt($curl, CURLOPT_URL, $url); $header = ['Accept: application/json']; curl_setopt($curl, CURLOPT_HTTPHEADER, $header); $options = [ 'username' => $user, 'password' => $password, ]; curl_setopt($curl, CURLOPT_POSTFIELDS, $options); $json = curl_exec($curl); curl_close($curl); if (empty($json)) { throw new Exception("Unable to get server response from $url."); } $output = json_decode($json); if (empty($output) || !isset($output->result) || !isset($output->result->status)) { throw new Exception("Unable to get json from $url."); } $status = $output->result->status; if ($status != 1) { $errCode = $output->result->error->code ?? ''; $errMessage = $output->result->error->message ?? ''; throw new Exception("Unable to login: " . $errCode . ' ' . $errMessage); } if (!isset($output->result->value) || !isset($output->result->value->token)) { throw new Exception("Unable to get token."); } return $output->result->value->token; } /** * Returns the curl object. * * @return object curl handle * @throws Exception error during curl creation */ private function getCurl() { $curl = curl_init(); if ($this->config->twoFactorAuthenticationInsecure) { curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false); curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 0); } curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); return $curl; } /** * Returns the serial numbers of the user. * * @param string $user user name * @param string $token login token * @return string[] serials * @throws Exception error during serial reading */ private function getSerialsForUser($user, $token) { $curl = $this->getCurl(); $url = $this->config->twoFactorAuthenticationURL . "/token/?user=" . $user; curl_setopt($curl, CURLOPT_URL, $url); $header = ['Authorization: ' . $token, 'Accept: application/json']; curl_setopt($curl, CURLOPT_HTTPHEADER, $header); $json = curl_exec($curl); curl_close($curl); if (empty($json)) { throw new Exception("Unable to get server response from $url."); } $output = json_decode($json); if (empty($output) || !isset($output->result) || !isset($output->result->status)) { throw new Exception("Unable to get json from $url."); } $status = $output->result->status; if (($status != 1) || !isset($output->result->value) || !isset($output->result->value->tokens)) { $errCode = $output->result->error->code ?? ''; $errMessage = $output->result->error->message ?? ''; throw new Exception("Unable to get serials: " . $errCode . ' ' . $errMessage); } $serials = []; foreach ($output->result->value->tokens as $tokenEntry) { if (!isset($tokenEntry->active) || ($tokenEntry->active != 1) || !isset($tokenEntry->serial)) { continue; } $serials[] = $tokenEntry->serial; } return $serials; } /** * Verifies if the given 2nd factor input is valid. * * @param string $token login token * @param string $serial serial number * @param string $twoFactorInput 2factor pin + password */ private function verify($token, $serial, $twoFactorInput) { $curl = $this->getCurl(); $url = $this->config->twoFactorAuthenticationURL . "/validate/check"; curl_setopt($curl, CURLOPT_URL, $url); $options = [ 'pass' => $twoFactorInput, 'serial' => $serial, ]; curl_setopt($curl, CURLOPT_POSTFIELDS, $options); $header = ['Authorization: ' . $token, 'Accept: application/json']; curl_setopt($curl, CURLOPT_HTTPHEADER, $header); $json = curl_exec($curl); curl_close($curl); $output = json_decode($json); if (empty($output) || !isset($output->result) || !isset($output->result->status) || !isset($output->result->value)) { throw new Exception("Unable to get json from $url."); } $status = $output->result->status; $value = $output->result->value; if (($status == 'true') && ($value == 'true')) { return true; } logNewMessage(LOG_DEBUG, "Unable to verify token: " . print_r($output, true)); return false; } /** * @inheritDoc */ public function supportsToRememberDevice(): bool { return $this->config->twoFactorAllowToRememberDevice; } } /** * Authentication via YubiKeys. * * @author Roland Gruber */ class YubicoProvider extends BaseProvider { /** * Constructor. * * @param TwoFactorConfiguration $config configuration */ public function __construct(&$config) { $this->config = $config; } /** * {@inheritDoc} * @see TwoFactorProvider::getSerials */ public function getSerials($user, $password) { $keyAttributeName = strtolower($this->config->twoFactorAuthenticationSerialAttributeName); if (isset($_SESSION['selfService_clientDN'])) { $loginDn = lamDecrypt($_SESSION['selfService_clientDN'], 'SelfService'); } else { $loginDn = $_SESSION['ldap']->getUserName(); } $handle = getLDAPServerHandle(); $ldapData = ldapGetDN($loginDn, [$keyAttributeName], $handle); if (empty($ldapData[$keyAttributeName])) { return []; } return [implode(', ', $ldapData[$keyAttributeName])]; } /** * {@inheritDoc} * @see TwoFactorProvider::verify2ndFactor */ public function verify2ndFactor($user, $password, $serial, $twoFactorInput) { include_once(__DIR__ . "/3rdParty/yubico/Yubico.php"); $serialData = $this->getSerials($user, $password); if (empty($serialData)) { return false; } $serials = explode(', ', $serialData[0]); $serialMatched = false; foreach ($serials as $serial) { if (str_starts_with($twoFactorInput, $serial)) { $serialMatched = true; break; } } if (!$serialMatched) { throw new Exception(_('YubiKey id does not match allowed list of key ids.')); } $urls = $this->config->twoFactorAuthenticationURL; shuffle($urls); $httpsverify = !$this->config->twoFactorAuthenticationInsecure; $clientId = $this->config->twoFactorAuthenticationClientId; $secretKey = $this->config->twoFactorAuthenticationSecretKey; foreach ($urls as $url) { try { $auth = new \Auth_Yubico($clientId, $secretKey, $url, $httpsverify); $auth->verify($twoFactorInput); return true; } catch (LAMException $e) { logNewMessage(LOG_DEBUG, 'Unable to verify 2FA: ' . $e->getMessage()); } } return false; } /** * @inheritDoc */ public function supportsToRememberDevice(): bool { return $this->config->twoFactorAllowToRememberDevice; } } /** * Provider for DUO. */ class DuoProvider extends BaseProvider { /** * Constructor. * * @param TwoFactorConfiguration $config configuration */ public function __construct(&$config) { $this->config = $config; } /** * {@inheritDoc} * @see TwoFactorProvider::getSerials */ public function getSerials($user, $password) { return ['DUO']; } /** * {@inheritDoc} * @see TwoFactorProvider::isShowSubmitButton */ public function isShowSubmitButton() { return false; } /** * {@inheritDoc} * @see TwoFactorProvider::hasCustomInputForm */ public function hasCustomInputForm() { return true; } /** * {@inheritDoc} * @see BaseProvider::addCustomInput */ public function addCustomInput(&$row, $userDn) { $pathPrefix = ($this->config->interface === LAM_INTERFACE::SELF_SERVICE) ? '../' : ''; $row->add(new htmlImage($pathPrefix . '../graphics/duo.png')); if (!empty($_GET['duo_code'])) { // authentication is verified return; } // authentication not started, provide redirect URL if (empty($_GET['duoRedirect'])) { $jsBlock = ' document.addEventListener("DOMContentLoaded", function(event) { var currentLocation = window.location.href; if (currentLocation.includes("?")) { currentLocation = currentLocation.substring(0, currentLocation.indexOf("?")); } if (currentLocation.includes("#")) { currentLocation = currentLocation.substring(0, currentLocation.indexOf("#")); } var targetUrl = currentLocation + "?duoRedirect=" + currentLocation; window.location.href = targetUrl; }); '; $row->add(new htmlJavaScript($jsBlock)); } // start authentication else { include_once __DIR__ . '/3rdParty/composer/autoload.php'; try { $duoClient = new Client( $this->config->twoFactorAuthenticationClientId, $this->config->twoFactorAuthenticationSecretKey, $this->config->twoFactorAuthenticationURL, $_GET['duoRedirect'] ); $duoClient->healthCheck(); $state = $duoClient->generateState(); $_SESSION['duo_state'] = $state; $_SESSION['duo_redirect'] = $_GET['duoRedirect']; $loginAttribute = $this->getLoginAttributeValue($userDn); $redirectUrl = $duoClient->createAuthUrl($loginAttribute, $state); $jsBlock = ' document.addEventListener("DOMContentLoaded", function(event) { window.location.href = "' . $redirectUrl . '"; }); '; $row->add(new htmlJavaScript($jsBlock)); } catch (DuoException $e) { $row->add(new htmlStatusMessage('ERROR', _('Duo connection failed'), $e->getMessage())); } } } /** * {@inheritDoc} * @see TwoFactorProvider::verify2ndFactor */ public function verify2ndFactor($user, $password, $serial, $twoFactorInput) { logNewMessage(LOG_DEBUG, 'DuoProvider: Checking 2nd factor for ' . $user); $loginAttribute = $this->getLoginAttributeValue($user); $state = $_GET['state']; $code = $_GET['duo_code']; if ($state !== $_SESSION['duo_state']) { logNewMessage(LOG_ERR, 'DUO state does not match'); return false; } include_once __DIR__ . '/3rdParty/composer/autoload.php'; try { $duoClient = new Client( $this->config->twoFactorAuthenticationClientId, $this->config->twoFactorAuthenticationSecretKey, $this->config->twoFactorAuthenticationURL, $_SESSION['duo_redirect'] ); $duoResult = $duoClient->exchangeAuthorizationCodeFor2FAResult($code, $loginAttribute); logNewMessage(LOG_DEBUG, print_r($duoResult, true)); return true; } catch (DuoException $e) { logNewMessage(LOG_ERR, 'DUO error: ' . $e->getMessage()); return false; } } /** * @inheritDoc */ public function supportsToRememberDevice(): bool { return false; } } /** * Provider for Okta. */ class OktaProvider extends BaseProvider { private $verificationFailed = false; /** * Constructor. * * @param TwoFactorConfiguration $config configuration */ public function __construct(&$config) { $this->config = $config; if (empty($this->config->twoFactorAuthenticationSerialAttributeName)) { $this->config->twoFactorAuthenticationSerialAttributeName = 'mail'; } } /** * {@inheritDoc} * @see TwoFactorProvider::getSerials */ public function getSerials($user, $password) { return ['OKTA']; } /** * {@inheritDoc} * @see TwoFactorProvider::isShowSubmitButton */ public function isShowSubmitButton() { return false; } /** * {@inheritDoc} * @see TwoFactorProvider::hasCustomInputForm */ public function hasCustomInputForm() { return true; } /** * {@inheritDoc} * @throws LAMException error building custom input * @see BaseProvider::addCustomInput */ public function addCustomInput(&$row, $userDn) { if (($this->config->loginHandler === null) || !$this->config->loginHandler->managesAuthentication()) { $loginAttribute = $this->getLoginAttributeValue($userDn); if (empty($loginAttribute)) { throw new LAMException('Unable to read login attribute from ' . $userDn); } } if ($this->verificationFailed) { return; } $pathPrefix = ($this->config->interface === LAM_INTERFACE::SELF_SERVICE) ? '../' : ''; $row->add(new htmlImage($pathPrefix . '../graphics/okta.png')); $_SESSION['okta_state'] = bin2hex(random_bytes(10)); $_SESSION['okta_code_verifier'] = bin2hex(random_bytes(50)); $hash = hash('sha256', $_SESSION['okta_code_verifier'], true); $codeChallenge = rtrim(strtr(base64_encode($hash), '+/', '-_'), '='); $jsBlock = ' document.addEventListener("DOMContentLoaded", function(event) { if (window.location.href.indexOf("code=") < 0) { var currentLocation = window.location.href; if (currentLocation.includes("#")) { currentLocation = currentLocation.substring(0, currentLocation.indexOf("#")); } window.location.href = "' . $this->config->twoFactorAuthenticationURL . '/oauth2/default/v1/authorize?code_challenge_method=S256&response_type=code&scope=openid email profile&client_id=' . $this->config->twoFactorAuthenticationClientId . '&code_challenge=' . $codeChallenge . '&state=' . $_SESSION['okta_state'] . '&redirect_uri=" + currentLocation } }); '; $row->add(new htmlJavaScript($jsBlock)); } /** * {@inheritDoc} * @see TwoFactorProvider::verify2ndFactor */ public function verify2ndFactor($user, $password, $serial, $twoFactorInput) { $this->verificationFailed = true; logNewMessage(LOG_DEBUG, 'OktaProvider: Checking 2nd factor for ' . $user); if (empty($_GET['state']) || ($_GET['state'] !== $_SESSION['okta_state'])) { logNewMessage(LOG_ERR, 'Okta state does not match.'); return false; } if (!empty($_GET['error'])) { logNewMessage(LOG_ERR, 'Okta reported an error: ' . $_GET['error']); return false; } $code = $_GET['code']; if (empty($code)) { logNewMessage(LOG_DEBUG, 'No code provided for 2FA verification.'); return false; } $accessCode = $this->getAccessCode($code); if (empty($accessCode)) { logNewMessage(LOG_DEBUG, 'No access code readable for Okta 2FA verification.'); return false; } try { $claims = json_decode(base64_decode(explode('.', $accessCode)[1]), true); logNewMessage(LOG_DEBUG, 'Okta claims: ' . print_r($claims, true)); $oktaUser = $claims['sub']; if (($this->config->loginHandler !== null) && $this->config->loginHandler->managesAuthentication()) { $this->config->loginHandler->authorize2FaUser($oktaUser); } else { $loginAttribute = $this->getLoginAttributeValue($user); if ($loginAttribute !== $oktaUser) { logNewMessage(LOG_ERR, 'User name ' . $loginAttribute . ' does not match claim sub: ' . $oktaUser); return false; } } $this->verificationFailed = false; return true; } catch (Exception $e) { logNewMessage(LOG_ERR, 'Unable to validate access code - ' . $e->getMessage()); } return false; } /** * Reads the access code using code. * * @param string $code code parameter from request * @return string|null access token */ private function getAccessCode($code) { $curl = curl_init(); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); $url = $this->config->twoFactorAuthenticationURL . '/oauth2/default/v1/token'; curl_setopt($curl, CURLOPT_URL, $url); curl_setopt($curl, CURLOPT_POST, true); $callingUrl = getCallingURL(); $callingUrl = substr($callingUrl, 0, strpos($callingUrl, '?')); logNewMessage(LOG_DEBUG, 'Get Okta access code.'); curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query([ 'grant_type' => 'authorization_code', 'code' => $code, 'code_verifier' => $_SESSION['okta_code_verifier'], 'redirect_uri' => $callingUrl, 'client_id' => $this->config->twoFactorAuthenticationClientId, 'client_secret' => $this->config->twoFactorAuthenticationSecretKey ])); curl_setopt($curl, CURLOPT_HTTPHEADER, [ 'accept: application/json', 'content-type: application/x-www-form-urlencoded', ]); $results = curl_exec($curl); $returnCode = curl_errno($curl); logNewMessage(LOG_DEBUG, 'Okta responded with ' . $returnCode . ': ' . $results); curl_close($curl); if ($returnCode !== 0) { logNewMessage(LOG_ERR, 'Error calling Okta ' . $url . '. ' . $returnCode); return null; } $jsonData = json_decode($results, true); if (empty($jsonData['access_token'])) { return null; } return $jsonData['access_token']; } /** * @inheritDoc */ public function supportsToRememberDevice(): bool { return false; } } /** * Provider for OpenId. */ class OpenIdProvider extends BaseProvider { private $verificationFailed = false; /** * Constructor. * * @param TwoFactorConfiguration $config configuration */ public function __construct(&$config) { $this->config = $config; if (empty($this->config->twoFactorAuthenticationSerialAttributeName)) { $this->config->twoFactorAuthenticationSerialAttributeName = 'uid'; } } /** * {@inheritDoc} * @see TwoFactorProvider::getSerials */ public function getSerials($user, $password) { return ['OpenID']; } /** * {@inheritDoc} * @see TwoFactorProvider::isShowSubmitButton */ public function isShowSubmitButton() { return false; } /** * {@inheritDoc} * @see TwoFactorProvider::hasCustomInputForm */ public function hasCustomInputForm() { return true; } /** * {@inheritDoc} * @throws LAMException error building custom input * @see BaseProvider::addCustomInput */ public function addCustomInput(&$row, $userDn) { $loginAttribute = ''; if (($this->config->loginHandler === null) || !$this->config->loginHandler->managesAuthentication()) { $loginAttribute = $this->getLoginAttributeValue($userDn); if (empty($loginAttribute)) { throw new LAMException('Unable to read login attribute from ' . $userDn); } } if ($this->verificationFailed) { return; } $content = new htmlResponsiveRow(); $pathPrefix = ($this->config->interface === LAM_INTERFACE::SELF_SERVICE) ? '../' : ''; $row->add(new htmlImage($pathPrefix . '../graphics/openid.png')); include_once __DIR__ . '/3rdParty/composer/autoload.php'; try { $client = $this->getOpenIdClient(); $authorizationService = $this->getAuthorizationService(); $redirectAuthorizationUri = $authorizationService->getAuthorizationUri( $client, ['login_hint' => $loginAttribute] ); $jsBlock = ' document.addEventListener("DOMContentLoaded", function(event) { var currentLocation = window.location.href; if (currentLocation.includes("?")) { currentLocation = currentLocation.substring(0, currentLocation.indexOf("?")); } if (currentLocation.includes("#")) { currentLocation = currentLocation.substring(0, currentLocation.indexOf("#")); } if (window.location.href.indexOf("code=") > 0) { var targetUrl = window.location.href + "&redirect_uri=" + currentLocation; window.location.href = targetUrl; } else { window.location.href = "' . $redirectAuthorizationUri . '&redirect_uri=" + currentLocation } }); '; $content->add(new htmlJavaScript($jsBlock)); } catch (Exception $e) { $content->add(new htmlStatusMessage('ERROR', _('OpenID connection failed'), $e->getMessage())); } $row->add($content); } /** * Returns the client object. * * @return ClientInterface client */ private function getOpenIdClient(): ClientInterface { $issuer = (new IssuerBuilder())->build($this->config->twoFactorAuthenticationURL . '/.well-known/openid-configuration'); $meta = [ 'client_id' => $this->config->twoFactorAuthenticationClientId, 'client_secret' => $this->config->twoFactorAuthenticationSecretKey, 'token_endpoint_auth_method' => 'client_secret_basic', ]; if (!empty($_GET['redirect_uri'])) { $meta['redirect_uri'] = $_GET['redirect_uri']; } $clientMetadata = ClientMetadata::fromArray($meta); return (new ClientBuilder()) ->setIssuer($issuer) ->setClientMetadata($clientMetadata) ->build(); } /** * Returns the authorization service. * * @return \Facile\OpenIDClient\Service\AuthorizationService service */ private function getAuthorizationService(): \Facile\OpenIDClient\Service\AuthorizationService { return (new \Facile\OpenIDClient\Service\Builder\AuthorizationServiceBuilder())->build(); } /** * {@inheritDoc} * @see TwoFactorProvider::verify2ndFactor */ public function verify2ndFactor($user, $password, $serial, $twoFactorInput) { $this->verificationFailed = true; logNewMessage(LOG_DEBUG, 'OpenIdProvider: Checking 2nd factor for ' . $user); $code = $_GET['code']; if (empty($code)) { logNewMessage(LOG_DEBUG, 'No code provided for 2FA verification.'); return false; } include_once __DIR__ . '/3rdParty/composer/autoload.php'; $client = $this->getOpenIdClient(); $authorizationService = $this->getAuthorizationService(); $serverRequest = ServerRequest::fromGlobals(); try { $callbackParams = $authorizationService->getCallbackParams($serverRequest, $client); $tokenSet = $authorizationService->callback($client, $callbackParams, $_GET['redirect_uri']); $claims = $tokenSet->claims(); logNewMessage(LOG_DEBUG, print_r($claims, true)); $openIdUser = $claims['preferred_username']; if (($this->config->loginHandler !== null) && $this->config->loginHandler->managesAuthentication()) { $this->config->loginHandler->authorize2FaUser($openIdUser); } else { $loginAttribute = $this->getLoginAttributeValue($user); if ($loginAttribute !== $openIdUser) { logNewMessage(LOG_ERR, 'User name ' . $loginAttribute . ' does not match claim preferred_username: ' . $openIdUser); return false; } } $this->verificationFailed = false; return true; } catch (Exception $e) { logNewMessage(LOG_ERR, 'Unable to validate JWT - ' . $e->getMessage()); } return false; } /** * @inheritDoc */ public function supportsToRememberDevice(): bool { return false; } } /** * Provider for Webauthn. */ class WebauthnProvider extends BaseProvider { /** * Constructor. * * @param TwoFactorConfiguration $config configuration */ public function __construct($config) { $this->config = $config; } /** * {@inheritDoc} * @see TwoFactorProvider::getSerials */ public function getSerials($user, $password) { return ['WEBAUTHN']; } /** * {@inheritDoc} * @see TwoFactorProvider::isShowSubmitButton */ public function isShowSubmitButton() { return false; } /** * {@inheritDoc} * @see TwoFactorProvider::hasCustomInputForm */ public function hasCustomInputForm() { return true; } /** * {@inheritDoc} * @see BaseProvider::addCustomInput */ public function addCustomInput(&$row, $userDn) { if (!extension_loaded('PDO')) { $row->add(new htmlStatusMessage('ERROR', 'WebAuthn requires the PDO extension for PHP.')); return; } $pdoDrivers = \PDO::getAvailableDrivers(); if (!in_array('sqlite', $pdoDrivers)) { $row->add(new htmlStatusMessage('ERROR', 'WebAuthn requires the sqlite PDO driver for PHP.')); return; } include_once __DIR__ . '/webauthn.inc'; $webauthnManager = $this->getWebauthnManager(); $hasTokens = $webauthnManager->isRegistered($userDn); if ($hasTokens) { $row->add(new htmlStatusMessage('INFO', _('Please authenticate with your security device.'))); } else { $row->add(new htmlStatusMessage('INFO', _('Please register a security device.'))); } $row->addVerticalSpacer('2rem'); $pathPrefix = ($this->config->interface === LAM_INTERFACE::SELF_SERVICE) ? '../' : ''; $selfServiceParam = ($this->config->interface === LAM_INTERFACE::SELF_SERVICE) ? 'selfservice=true' : ''; $row->add(new htmlImage($pathPrefix . '../graphics/webauthn.svg', '50%')); $row->addVerticalSpacer('1rem'); $errorMessage = new htmlStatusMessage('ERROR', '', _('This service requires a browser with "WebAuthn" support.')); $row->add(new htmlDiv(null, $errorMessage, ['hidden webauthn-error'])); if (($this->config->twoFactorAuthenticationOptional === true) && !$hasTokens) { $registerButton = new htmlButton('register_webauthn', _('Register new key')); $registerButton->setType('button'); $registerButton->setCSSClasses(['fullwidth']); $row->add($registerButton); $skipButton = new htmlButton('skip_webauthn', _('Skip')); $skipButton->setCSSClasses(['fullwidth']); $row->add($skipButton); } $errorMessageDiv = new htmlDiv('generic-webauthn-error', new htmlOutputText('')); $errorMessageDiv->addDataAttribute('button', _('Ok')); $errorMessageDiv->addDataAttribute('title', _('WebAuthn failed')); $row->add($errorMessageDiv); $row->add(new htmlJavaScript('window.lam.webauthn.start(\'' . $pathPrefix . '\', \'' . $selfServiceParam . '\',' . ' \'' . _('Do you want to set a name for this device?') . '\', \'' . _('Name') . '\',' . ' \'' . _('Ok') . '\', \'' . _('Cancel') . '\');'), 0); } /** * Returns the webauthn manager. * * @return WebauthnManager manager */ public function getWebauthnManager() { return new WebauthnManager(); } /** * {@inheritDoc} * @see TwoFactorProvider::verify2ndFactor */ public function verify2ndFactor($user, $password, $serial, $twoFactorInput) { logNewMessage(LOG_DEBUG, 'WebauthnProvider: Checking 2nd factor for ' . $user); include_once __DIR__ . '/webauthn.inc'; $webauthnManager = $this->getWebauthnManager(); if (!empty($_SESSION['ldap'])) { $userDn = $_SESSION['ldap']->getUserName(); } else { $userDn = lamDecrypt($_SESSION['selfService_clientDN'], 'SelfService'); } $hasTokens = $webauthnManager->isRegistered($userDn); if (!$hasTokens) { if ($this->config->twoFactorAuthenticationOptional && !$webauthnManager->isRegistered($user) && ($_POST['sig_response'] === 'skip')) { logNewMessage(LOG_DEBUG, 'Skipped 2FA for ' . $user . ' as no devices are registered and 2FA is optional.'); return true; } $response = base64_decode($_POST['sig_response']); $registrationObject = PublicKeyCredentialCreationOptions::createFromString($_SESSION['webauthn_registration']); if (!$webauthnManager->storeNewRegistration($registrationObject, $response)) { return false; } if (!empty($_POST['newName'])) { $deviceList = $webauthnManager->getDatabase()->findAllForUserDn($userDn); $webauthnManager->getDatabase()->updateDeviceName($userDn, base64_encode($deviceList[0]->getPublicKeyCredentialId()), $_POST['newName']); } return true; } else { logNewMessage(LOG_DEBUG, 'Checking WebAuthn response of ' . $userDn); $response = base64_decode($_POST['sig_response']); return $webauthnManager->isValidAuthentication($response, $userDn); } } /** * @inheritDoc */ public function supportsToRememberDevice(): bool { return $this->config->twoFactorAllowToRememberDevice; } } /** * Returns the correct 2 factor provider. */ class TwoFactorProviderService { /** 2factor authentication disabled */ public const TWO_FACTOR_NONE = 'none'; /** 2factor authentication via privacyIDEA */ public const TWO_FACTOR_PRIVACYIDEA = 'privacyidea'; /** 2factor authentication via YubiKey */ public const TWO_FACTOR_YUBICO = 'yubico'; /** 2factor authentication via DUO */ public const TWO_FACTOR_DUO = 'duo'; /** 2factor authentication via webauthn */ public const TWO_FACTOR_WEBAUTHN = 'webauthn'; /** 2factor authentication via Okta */ public const TWO_FACTOR_OKTA = 'okta'; /** 2factor authentication via OpenId */ public const TWO_FACTOR_OPENID = 'openid'; /** date format when remembering devices */ private const DEVICE_REMEMBER_DATE_FORMAT = 'Y-m-d H:i:s'; private TwoFactorConfiguration $config; /** * Constructor. * * @param selfServiceProfile|LAMConfig $configObj profile */ public function __construct(selfServiceProfile|LAMConfig $configObj) { if ($configObj instanceof selfServiceProfile) { $this->config = $this->getConfigSelfService($configObj); } else { $this->config = $this->getConfigAdmin($configObj); } } /** * Returns the provider for the given type. * * @return TwoFactorProvider provider * @throws Exception unable to get provider */ public function getProvider() { if ($this->config->twoFactorAuthentication == TwoFactorProviderService::TWO_FACTOR_PRIVACYIDEA) { return new PrivacyIDEAProvider($this->config); } elseif ($this->config->twoFactorAuthentication == TwoFactorProviderService::TWO_FACTOR_YUBICO) { return new YubicoProvider($this->config); } elseif ($this->config->twoFactorAuthentication == TwoFactorProviderService::TWO_FACTOR_DUO) { return new DuoProvider($this->config); } elseif ($this->config->twoFactorAuthentication == TwoFactorProviderService::TWO_FACTOR_WEBAUTHN) { return new WebauthnProvider($this->config); } elseif ($this->config->twoFactorAuthentication == TwoFactorProviderService::TWO_FACTOR_OKTA) { return new OktaProvider($this->config); } elseif ($this->config->twoFactorAuthentication == TwoFactorProviderService::TWO_FACTOR_OPENID) { return new OpenIdProvider($this->config); } throw new Exception('Invalid provider: ' . $this->config->twoFactorAuthentication); } /** * Remembers the users device. * * @param string $user user name * @throws Exception error getting provider */ public function rememberDevice(string $user): void { if (!$this->getProvider()->supportsToRememberDevice()) { logNewMessage(LOG_ERR, 'The selected 2FA provider does not support to remember devices.'); return; } if (empty($this->config->twoFactorRememberDevicePassword)) { logNewMessage(LOG_ERR, 'The selected 2FA password to remember devices is empty.'); return; } $dataToEncrypt = [ 'user' => $user, 'timestamp' => getFormattedTime(self::DEVICE_REMEMBER_DATE_FORMAT), ]; if (!empty($_SERVER['HTTP_USER_AGENT'])) { $dataToEncrypt['userAgent'] = $_SERVER['HTTP_USER_AGENT']; } if (!empty($_SERVER['REMOTE_ADDR'])) { $dataToEncrypt['clientIp'] = $_SERVER['REMOTE_ADDR']; } $iv = openssl_random_pseudo_bytes(16); $encryptedData = openssl_encrypt(json_encode($dataToEncrypt), lamEncryptionAlgo(), $this->config->twoFactorRememberDevicePassword, 0, $iv); $data = [ 'iv' => base64_encode($iv), 'data' => base64_encode($encryptedData) ]; $cookieOptions = lamDefaultCookieOptions(); $cookieOptions['expires'] = time() + intval($this->config->twoFactorRememberDeviceDuration); $this->setCookie('lam_remember_2fa', json_encode($data), $cookieOptions); } /** * Sets a cookie. * * @param string $name cookie name * @param string $value cookie value * @param array $options cookie options */ protected function setCookie(string $name, string $value, array $options): void { setcookie($name, $value, $options); } /** * Returns if the user has selected to save the device before. * * @param string $user user name * @return bool valid remembered device * @throws Exception error getting provider */ public function isValidRememberedDevice(string $user): bool { if (!$this->getProvider()->supportsToRememberDevice()) { logNewMessage(LOG_ERR, 'The selected 2FA provider does not support to remember devices.'); return false; } if (empty($this->config->twoFactorRememberDevicePassword)) { logNewMessage(LOG_ERR, 'The selected 2FA password to remember devices is empty.'); return false; } if (empty($this->config->twoFactorRememberDeviceDuration)) { logNewMessage(LOG_ERR, 'The selected 2FA remember device period is empty.'); return false; } if (!isset($_COOKIE['lam_remember_2fa'])) { return false; } $data = json_decode($_COOKIE['lam_remember_2fa'], true); if (($data === null) || empty($data['iv']) || empty($data['data'])) { return false; } $iv = base64_decode($data['iv']); $decryptedData = openssl_decrypt(base64_decode($data['data']), lamEncryptionAlgo(), $this->config->twoFactorRememberDevicePassword, 0, $iv); if ($decryptedData === false) { return false; } $decryptedData = json_decode($decryptedData, true); if (!isset($decryptedData['user'])) { return false; } if ($decryptedData['user'] !== $user) { logNewMessage(LOG_DEBUG, 'User name for remembered device does not match. ' . $user . ' - ' . $decryptedData['user']); return false; } if (!empty($decryptedData['userAgent']) && (empty($_SERVER['HTTP_USER_AGENT']) || ($decryptedData['userAgent'] !== $_SERVER['HTTP_USER_AGENT']))) { logNewMessage(LOG_DEBUG, 'User agent for remembered device does not match. ' . $decryptedData['user']); return false; } if (!empty($decryptedData['clientIp']) && (empty($_SERVER['REMOTE_ADDR']) || ($decryptedData['clientIp'] !== $_SERVER['REMOTE_ADDR']))) { logNewMessage(LOG_DEBUG, 'Client IP for remembered device does not match. ' . $decryptedData['clientIp']); return false; } try { $acceptedTime = new DateTime('now', getTimeZone()); $acceptedTime = $acceptedTime->sub(new DateInterval('PT' . $this->config->twoFactorRememberDeviceDuration . 'S')); $deviceDate = DateTime::createFromFormat(self::DEVICE_REMEMBER_DATE_FORMAT, $decryptedData['timestamp'], getTimeZone()); if ($deviceDate > $acceptedTime) { return true; } } catch (Exception $e) { logNewMessage(LOG_ERR, 'Unable to check remembered device of ' . $user . ': ' . $e->getMessage()); } return false; } /** * Returns the configuration from self service. * * @param selfServiceProfile $profile profile * @return TwoFactorConfiguration configuration */ private function getConfigSelfService(&$profile): TwoFactorConfiguration { $tfConfig = new TwoFactorConfiguration(); $tfConfig->interface = LAM_INTERFACE::SELF_SERVICE; $tfConfig->twoFactorAuthentication = $profile->twoFactorAuthentication; $tfConfig->twoFactorAuthenticationInsecure = $profile->twoFactorAuthenticationInsecure; $tfConfig->twoFactorAuthenticationOptional = $profile->twoFactorAuthenticationOptional; if ($tfConfig->twoFactorAuthentication == TwoFactorProviderService::TWO_FACTOR_YUBICO) { $tfConfig->twoFactorAuthenticationURL = explode("\r\n", $profile->twoFactorAuthenticationURL); } else { $tfConfig->twoFactorAuthenticationURL = $profile->twoFactorAuthenticationURL; } $tfConfig->twoFactorAuthenticationClientId = $profile->twoFactorAuthenticationClientId; $tfConfig->twoFactorAuthenticationSecretKey = $profile->twoFactorAuthenticationSecretKey; if ($tfConfig->twoFactorAuthentication == TwoFactorProviderService::TWO_FACTOR_YUBICO) { $moduleSettings = $profile->moduleSettings; if (!empty($moduleSettings['yubiKeyUser_attributeName'][0])) { $tfConfig->twoFactorAuthenticationSerialAttributeName = $moduleSettings['yubiKeyUser_attributeName'][0]; } else { $tfConfig->twoFactorAuthenticationSerialAttributeName = 'yubiKeyId'; } } if (($tfConfig->twoFactorAuthentication == TwoFactorProviderService::TWO_FACTOR_PRIVACYIDEA) || ($tfConfig->twoFactorAuthentication == TwoFactorProviderService::TWO_FACTOR_DUO) || ($tfConfig->twoFactorAuthentication == TwoFactorProviderService::TWO_FACTOR_OKTA) || ($tfConfig->twoFactorAuthentication == TwoFactorProviderService::TWO_FACTOR_OPENID)) { $attrName = $profile->twoFactorAuthenticationAttribute; if (empty($attrName)) { $attrName = 'uid'; } $tfConfig->twoFactorAuthenticationSerialAttributeName = strtolower($attrName); } if (($tfConfig->twoFactorAuthentication == TwoFactorProviderService::TWO_FACTOR_PRIVACYIDEA) || ($tfConfig->twoFactorAuthentication == TwoFactorProviderService::TWO_FACTOR_WEBAUTHN) || ($tfConfig->twoFactorAuthentication == TwoFactorProviderService::TWO_FACTOR_YUBICO)) { $tfConfig->twoFactorAllowToRememberDevice = ($profile->twoFactorAllowToRememberDevice === 'true'); $tfConfig->twoFactorRememberDeviceDuration = $profile->twoFactorRememberDeviceDuration; $tfConfig->twoFactorRememberDevicePassword = $profile->twoFactorRememberDevicePassword; } $tfConfig->loginHandler = $profile->getLoginHandler(); return $tfConfig; } /** * Returns the configuration for admin interface. * * @param LAMConfig $conf configuration * @return TwoFactorConfiguration configuration */ private function getConfigAdmin($conf): TwoFactorConfiguration { $tfConfig = new TwoFactorConfiguration(); $tfConfig->interface = LAM_INTERFACE::ADMIN; $tfConfig->twoFactorAuthentication = $conf->getTwoFactorAuthentication(); $tfConfig->twoFactorAuthenticationInsecure = $conf->getTwoFactorAuthenticationInsecure(); $tfConfig->twoFactorAuthenticationOptional = $conf->getTwoFactorAuthenticationOptional(); if ($tfConfig->twoFactorAuthentication == TwoFactorProviderService::TWO_FACTOR_YUBICO) { $tfConfig->twoFactorAuthenticationURL = explode("\r\n", $conf->getTwoFactorAuthenticationURL()); } else { $tfConfig->twoFactorAuthenticationURL = $conf->getTwoFactorAuthenticationURL(); } $tfConfig->twoFactorAuthenticationClientId = $conf->getTwoFactorAuthenticationClientId(); $tfConfig->twoFactorAuthenticationSecretKey = $conf->getTwoFactorAuthenticationSecretKey(); if ($tfConfig->twoFactorAuthentication == TwoFactorProviderService::TWO_FACTOR_YUBICO) { $moduleSettings = $conf->get_moduleSettings(); if (!empty($moduleSettings['yubiKeyUser_attributeName'][0])) { $tfConfig->twoFactorAuthenticationSerialAttributeName = $moduleSettings['yubiKeyUser_attributeName'][0]; } else { $tfConfig->twoFactorAuthenticationSerialAttributeName = 'yubiKeyId'; } } if (($tfConfig->twoFactorAuthentication == TwoFactorProviderService::TWO_FACTOR_PRIVACYIDEA) || ($tfConfig->twoFactorAuthentication == TwoFactorProviderService::TWO_FACTOR_DUO) || ($tfConfig->twoFactorAuthentication == TwoFactorProviderService::TWO_FACTOR_OKTA) || ($tfConfig->twoFactorAuthentication == TwoFactorProviderService::TWO_FACTOR_OPENID)) { $tfConfig->twoFactorAuthenticationSerialAttributeName = strtolower($conf->getTwoFactorAuthenticationAttribute()); } if (($tfConfig->twoFactorAuthentication == TwoFactorProviderService::TWO_FACTOR_PRIVACYIDEA) || ($tfConfig->twoFactorAuthentication == TwoFactorProviderService::TWO_FACTOR_WEBAUTHN) || ($tfConfig->twoFactorAuthentication == TwoFactorProviderService::TWO_FACTOR_YUBICO)) { $tfConfig->twoFactorAllowToRememberDevice = ($conf->getTwoFactorAllowToRememberDevice() === 'true'); $tfConfig->twoFactorRememberDeviceDuration = $conf->getTwoFactorRememberDeviceDuration(); $tfConfig->twoFactorRememberDevicePassword = $conf->getTwoFactorRememberDevicePassword(); } return $tfConfig; } } /** * Configuration settings for 2-factor authentication. * * @author Roland Gruber */ class TwoFactorConfiguration { /** LAM UI */ public LAM_INTERFACE $interface = LAM_INTERFACE::ADMIN; /** * @var ?string provider id */ public ?string $twoFactorAuthentication = null; /** * @var string|array service URL(s) */ public $twoFactorAuthenticationURL; /** * @var bool disable certificate check */ public bool $twoFactorAuthenticationInsecure = false; /** * @var ?string client ID for API access */ public ?string $twoFactorAuthenticationClientId = null; /** * @var ?string secret key for API access */ public ?string $twoFactorAuthenticationSecretKey = null; /** * @var ?string LDAP attribute name that stores the token serials */ public ?string $twoFactorAuthenticationSerialAttributeName = null; /** * @var bool 2FA is optional */ public bool $twoFactorAuthenticationOptional = false; /** * @var bool allow to remember 2nd factor */ public bool $twoFactorAllowToRememberDevice = false; /** * @var string duration for remembering */ public string $twoFactorRememberDeviceDuration = ''; /** * @var string password for remembering */ public string $twoFactorRememberDevicePassword = ''; /** * @var SelfServiceLoginHandler|null login handler */ public ?SelfServiceLoginHandler $loginHandler = null; }