fix(session): Make session encryption more robust #47396
+216
−89
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors | ||
| * SPDX-License-Identifier: AGPL-3.0-only | ||
| */ | ||
|
|
||
| namespace OC\Session; | ||
|
|
||
| use OCP\IRequest; | ||
| use OCP\Security\ICrypto; | ||
| use OCP\Security\ISecureRandom; | ||
| use Psr\Log\LoggerInterface; | ||
| use SessionHandler; | ||
| use function explode; | ||
| use function implode; | ||
| use function strlen; | ||
|
|
||
| class CryptoSessionHandler extends SessionHandler { | ||
|
|
||
| public function __construct(private ISecureRandom $secureRandom, | ||
| private ICrypto $crypto, | ||
| private LoggerInterface $logger, | ||
| private IRequest $request) { | ||
| } | ||
|
|
||
| public function create_sid(): string { | ||
| $id = parent::create_sid(); | ||
| $passphrase = $this->secureRandom->generate(128); | ||
| return implode('|', [$id, $passphrase]); | ||
| } | ||
|
|
||
| /** | ||
| * Read and decrypt session data | ||
| * | ||
| * @param string $id | ||
| * | ||
| * @return false|string | ||
| * | ||
| * @codeCoverageIgnore | ||
| */ | ||
| public function read(string $id): false|string { | ||
| [$sessionId, $passphrase] = self::parseId($id); | ||
| if ($passphrase === null) { | ||
| $passphrase = $this->request->getCookie(CryptoWrapper::COOKIE_NAME); | ||
| if ($passphrase === null) { | ||
| $this->logger->debug('Reading unencrypted session data', [ | ||
| 'sessionId' => $id, | ||
| ]); | ||
| return parent::read($sessionId); | ||
| } | ||
| } | ||
|
|
||
| $encryptedData = parent::read($sessionId); | ||
| if ($encryptedData === '') { | ||
| return ''; | ||
| } | ||
| return $this->crypto->decrypt($encryptedData, $passphrase); | ||
|
There was a problem hiding this comment. TODO: catch decryption error, log and continue with empty session data |
||
| } | ||
|
|
||
| /** | ||
| * Encrypt and write session data | ||
| * | ||
| * @param string $id | ||
| * @param string $data | ||
| * | ||
| * @return bool | ||
| * | ||
| * @codeCoverageIgnore | ||
| */ | ||
| public function write(string $id, string $data): bool { | ||
| [$sessionId, $passphrase] = self::parseId($id); | ||
|
|
||
| if ($passphrase === null) { | ||
| $passphrase = $this->request->getCookie(CryptoWrapper::COOKIE_NAME); | ||
| if ($passphrase === null) { | ||
| $this->logger->warning('Can not write session because there is no passphrase', [ | ||
| 'sessionId' => $id, | ||
| 'dataLength' => strlen($data), | ||
| ]); | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| $encryptedData = $this->crypto->encrypt($data, $passphrase); | ||
|
|
||
| return parent::write($sessionId, $encryptedData); | ||
| } | ||
|
|
||
| /** | ||
| * @return bool | ||
| * | ||
| * @codeCoverageIgnore | ||
| */ | ||
| public function close(): bool { | ||
|
||
| return parent::close(); | ||
| } | ||
|
|
||
| /** | ||
| * @param string $id | ||
| * | ||
| * @return array{0: string, 1: ?string} | ||
| */ | ||
| public static function parseId(string $id): array { | ||
| $parts = explode('|', $id, 2); | ||
| return [$parts[0], $parts[1] ?? null]; | ||
| } | ||
|
|
||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unfortunately writing unit tests is not an option for a session handler because PHP sessions have so many side effects. E.g. an actual session has to be opened to test read/write, but you can't close and re-open the session because opening a session sets a header, and setting headers is not possible once any kind of output was written 🫠