-
-
Notifications
You must be signed in to change notification settings - Fork 4.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(session): Make session encryption more robust #47396
Draft
ChristophWurst
wants to merge
9
commits into
master
Choose a base branch
from
fix/session/session-passphraze-handling
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
80d724b
fix(session): Make session encryption more robust
ChristophWurst 7a3f5cd
fixup! fix(session): Make session encryption more robust
ChristophWurst fec9972
fixup! fix(session): Make session encryption more robust
ChristophWurst aee7a7d
fixup! fix(session): Make session encryption more robust
ChristophWurst 525de82
Merge remote-tracking branch 'origin/master' into fix/session/session…
ChristophWurst 7190925
fixup! fix(session): Make session encryption more robust
ChristophWurst 6d10bf6
fixup! fix(session): Make session encryption more robust
ChristophWurst 5c5e26e
Merge remote-tracking branch 'origin/master' into fix/session/session…
ChristophWurst f99c089
fixup! fix(session): Make session encryption more robust
ChristophWurst File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,124 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors | ||
| * SPDX-License-Identifier: AGPL-3.0-only | ||
| */ | ||
|
|
||
| namespace OC\Session; | ||
|
|
||
| use Exception; | ||
| 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); | ||
| } | ||
| } | ||
|
|
||
| $possiblyEncryptedData = parent::read($sessionId); | ||
| if ($possiblyEncryptedData === '') { | ||
| return ''; | ||
| } | ||
| if (str_contains($possiblyEncryptedData, 'encrypted_session_data')) { | ||
| // This data is not encrypted | ||
| return $possiblyEncryptedData; | ||
| } | ||
| try { | ||
| return $this->crypto->decrypt($possiblyEncryptedData, $passphrase); | ||
| } catch (Exception $e) { | ||
| $this->logger->error('Failed to decrypt session data', [ | ||
| 'exception' => $e, | ||
| 'sessionId' => $sessionId, | ||
| ]); | ||
| return ''; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * 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 🫠