芝麻web文件管理V1.00
编辑当前文件:/home2/sdektunc/tepakanyucatan.gob.mx/plugins/system/webauthn/src/CredentialRepository.php
* @license GNU General Public License version 2 or later; see LICENSE.txt */ namespace Joomla\Plugin\System\Webauthn; // Protect from unauthorized access \defined('_JEXEC') or die(); use Exception; use InvalidArgumentException; use Joomla\CMS\Encrypt\Aes; use Joomla\CMS\Factory; use Joomla\CMS\Language\Text; use Joomla\Database\DatabaseDriver; use Joomla\Plugin\System\Webauthn\Helper\Joomla; use Joomla\Registry\Registry; use JsonException; use RuntimeException; use Throwable; use Webauthn\PublicKeyCredentialSource; use Webauthn\PublicKeyCredentialSourceRepository; use Webauthn\PublicKeyCredentialUserEntity; /** * Handles the storage of WebAuthn credentials in the database * * @since 4.0.0 */ class CredentialRepository implements PublicKeyCredentialSourceRepository { /** * Returns a PublicKeyCredentialSource object given the public key credential ID * * @param string $publicKeyCredentialId The identified of the public key credential we're searching for * * @return PublicKeyCredentialSource|null * * @since 4.0.0 */ public function findOneByCredentialId(string $publicKeyCredentialId): ?PublicKeyCredentialSource { /** @var DatabaseDriver $db */ $db = Factory::getContainer()->get('DatabaseDriver'); $credentialId = base64_encode($publicKeyCredentialId); $query = $db->getQuery(true) ->select($db->qn('credential')) ->from($db->qn('#__webauthn_credentials')) ->where($db->qn('id') . ' = :credentialId') ->bind(':credentialId', $credentialId); $encrypted = $db->setQuery($query)->loadResult(); if (empty($encrypted)) { return null; } $json = $this->decryptCredential($encrypted); try { return PublicKeyCredentialSource::createFromArray(json_decode($json, true)); } catch (Throwable $e) { return null; } } /** * Returns all PublicKeyCredentialSource objects given a user entity. We only use the `id` property of the user * entity, cast to integer, as the Joomla user ID by which records are keyed in the database table. * * @param PublicKeyCredentialUserEntity $publicKeyCredentialUserEntity Public key credential user entity record * * @return PublicKeyCredentialSource[] * * @since 4.0.0 */ public function findAllForUserEntity(PublicKeyCredentialUserEntity $publicKeyCredentialUserEntity): array { /** @var DatabaseDriver $db */ $db = Factory::getContainer()->get('DatabaseDriver'); $userHandle = $publicKeyCredentialUserEntity->getId(); $query = $db->getQuery(true) ->select('*') ->from($db->qn('#__webauthn_credentials')) ->where($db->qn('user_id') . ' = :user_id') ->bind(':user_id', $userHandle); try { $records = $db->setQuery($query)->loadAssocList(); } catch (Exception $e) { return []; } /** * Converts invalid credential records to PublicKeyCredentialSource objects, or null if they * are invalid. * * This closure is defined as a variable to prevent PHP-CS from getting a stoke trying to * figure out the correct indentation :) * * @param array $record The record to convert * * @return PublicKeyCredentialSource|null */ $recordsMapperClosure = function ($record) { try { $json = $this->decryptCredential($record['credential']); $data = json_decode($json, true); } catch (JsonException $e) { return; } if (empty($data)) { return; } try { return PublicKeyCredentialSource::createFromArray($data); } catch (InvalidArgumentException $e) { return; } }; $records = array_map($recordsMapperClosure, $records); /** * Filters the list of records to only keep valid entries. * * Only array members that are PublicKeyCredentialSource objects survive the filter. * * This closure is defined as a variable to prevent PHP-CS from getting a stoke trying to * figure out the correct indentation :) * * @param PublicKeyCredentialSource|mixed $record The record to filter * * @return boolean */ $filterClosure = function ($record) { return !\is_null($record) && \is_object($record) && ($record instanceof PublicKeyCredentialSource); }; return array_filter($records, $filterClosure); } /** * Add or update an attested credential for a given user. * * @param PublicKeyCredentialSource $publicKeyCredentialSource The public key credential * source to store * * @return void * * @throws Exception * @since 4.0.0 */ public function saveCredentialSource(PublicKeyCredentialSource $publicKeyCredentialSource): void { // Default values for saving a new credential source $credentialId = base64_encode($publicKeyCredentialSource->getPublicKeyCredentialId()); $user = Factory::getApplication()->getIdentity(); $o = (object) [ 'id' => $credentialId, 'user_id' => $this->getHandleFromUserId($user->id), 'label' => Text::sprintf('PLG_SYSTEM_WEBAUTHN_LBL_DEFAULT_AUTHENTICATOR_LABEL', Joomla::formatDate('now')), 'credential' => json_encode($publicKeyCredentialSource), ]; $update = false; /** @var DatabaseDriver $db */ $db = Factory::getContainer()->get('DatabaseDriver'); // Try to find an existing record try { $query = $db->getQuery(true) ->select('*') ->from($db->qn('#__webauthn_credentials')) ->where($db->qn('id') . ' = :credentialId') ->bind(':credentialId', $credentialId); $oldRecord = $db->setQuery($query)->loadObject(); if (\is_null($oldRecord)) { throw new Exception('This is a new record'); } /** * Sanity check. The existing credential source must have the same user handle as the one I am trying to * save. Otherwise something fishy is going on. */ // phpcs:ignore if ($oldRecord->user_id != $publicKeyCredentialSource->getUserHandle()) { throw new RuntimeException(Text::_('PLG_SYSTEM_WEBAUTHN_ERR_CREDENTIAL_ID_ALREADY_IN_USE')); } // phpcs:ignore $o->user_id = $oldRecord->user_id; $o->label = $oldRecord->label; $update = true; } catch (Exception $e) { } $o->credential = $this->encryptCredential($o->credential); if ($update) { $db->updateObject('#__webauthn_credentials', $o, ['id']); return; } /** * This check is deliberately skipped for updates. When logging in the underlying library will try to save the * credential source. This is necessary to update the last known authenticator signature counter which prevents * replay attacks. When we are saving a new record, though, we have to make sure we are not a guest user. Hence * the check below. */ if ((\is_null($user) || $user->guest)) { throw new RuntimeException(Text::_('PLG_SYSTEM_WEBAUTHN_ERR_CANT_STORE_FOR_GUEST')); } $db->insertObject('#__webauthn_credentials', $o); } /** * Get all credential information for a given user ID. This is meant to only be used for displaying records. * * @param int $userId The user ID * * @return array * * @since 4.0.0 */ public function getAll(int $userId): array { /** @var DatabaseDriver $db */ $db = Factory::getContainer()->get('DatabaseDriver'); $userHandle = $this->getHandleFromUserId($userId); $query = $db->getQuery(true) ->select('*') ->from($db->qn('#__webauthn_credentials')) ->where($db->qn('user_id') . ' = :user_id') ->bind(':user_id', $userHandle); try { $results = $db->setQuery($query)->loadAssocList(); } catch (Exception $e) { return []; } if (empty($results)) { return []; } return $results; } /** * Do we have stored credentials under the specified Credential ID? * * @param string $credentialId The ID of the credential to check for existence * * @return boolean * * @since 4.0.0 */ public function has(string $credentialId): bool { /** @var DatabaseDriver $db */ $db = Factory::getContainer()->get('DatabaseDriver'); $credentialId = base64_encode($credentialId); $query = $db->getQuery(true) ->select('COUNT(*)') ->from($db->qn('#__webauthn_credentials')) ->where($db->qn('id') . ' = :credentialId') ->bind(':credentialId', $credentialId); try { $count = $db->setQuery($query)->loadResult(); return $count > 0; } catch (Exception $e) { return false; } } /** * Update the human readable label of a credential * * @param string $credentialId The credential ID * @param string $label The human readable label to set * * @return void * * @since 4.0.0 */ public function setLabel(string $credentialId, string $label): void { /** @var DatabaseDriver $db */ $db = Factory::getContainer()->get('DatabaseDriver'); $credentialId = base64_encode($credentialId); $o = (object) [ 'id' => $credentialId, 'label' => $label, ]; $db->updateObject('#__webauthn_credentials', $o, ['id'], false); } /** * Remove stored credentials * * @param string $credentialId The credentials ID to remove * * @return void * * @since 4.0.0 */ public function remove(string $credentialId): void { if (!$this->has($credentialId)) { return; } /** @var DatabaseDriver $db */ $db = Factory::getContainer()->get('DatabaseDriver'); $credentialId = base64_encode($credentialId); $query = $db->getQuery(true) ->delete($db->qn('#__webauthn_credentials')) ->where($db->qn('id') . ' = :credentialId') ->bind(':credentialId', $credentialId); $db->setQuery($query)->execute(); } /** * Return the user handle for the stored credential given its ID. * * The user handle must not be personally identifiable. Per https://w3c.github.io/webauthn/#user-handle it is * acceptable to have a salted hash with a salt private to our server, e.g. Joomla's secret. The only immutable * information in Joomla is the user ID so that's what we will be using. * * @param string $credentialId The credential ID to get the user handle for * * @return string * * @since 4.0.0 */ public function getUserHandleFor(string $credentialId): string { $publicKeyCredentialSource = $this->findOneByCredentialId($credentialId); if (empty($publicKeyCredentialSource)) { return ''; } return $publicKeyCredentialSource->getUserHandle(); } /** * Return a user handle given an integer Joomla user ID. We use the HMAC-SHA-256 of the user ID with the site's * secret as the key. Using it instead of SHA-512 is on purpose! WebAuthn only allows user handles up to 64 bytes * long. * * @param int $id The user ID to convert * * @return string The user handle (HMAC-SHA-256 of the user ID) * * @since 4.0.0 */ public function getHandleFromUserId(int $id): string { $key = $this->getEncryptionKey(); $data = sprintf('%010u', $id); return hash_hmac('sha256', $data, $key, false); } /** * Encrypt the credential source before saving it to the database * * @param string $credential The unencrypted, JSON-encoded credential source * * @return string The encrypted credential source, base64 encoded * * @since 4.0.0 */ private function encryptCredential(string $credential): string { $key = $this->getEncryptionKey(); if (empty($key)) { return $credential; } $aes = new Aes($key, 256); return $aes->encryptString($credential); } /** * Decrypt the credential source if it was already encrypted in the database * * @param string $credential The encrypted credential source, base64 encoded * * @return string The decrypted, JSON-encoded credential source * * @since 4.0.0 */ private function decryptCredential(string $credential): string { $key = $this->getEncryptionKey(); if (empty($key)) { return $credential; } // Was the credential stored unencrypted (e.g. the site's secret was empty)? if ((strpos($credential, '{') !== false) && (strpos($credential, '"publicKeyCredentialId"') !== false)) { return $credential; } $aes = new Aes($key, 256); return $aes->decryptString($credential); } /** * Get the site's secret, used as an encryption key * * @return string * * @since 4.0.0 */ private function getEncryptionKey(): string { try { $app = Factory::getApplication(); /** @var Registry $config */ $config = $app->getConfig(); $secret = $config->get('secret', ''); } catch (Exception $e) { $secret = ''; } return $secret; } }