-
-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
make OAuth2 authorization code expire
Signed-off-by: Julien Veyssier <[email protected]>
- Loading branch information
Showing
10 changed files
with
359 additions
and
35 deletions.
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
61 changes: 61 additions & 0 deletions
61
apps/oauth2/lib/BackgroundJob/CleanupExpiredAuthorizationCode.php
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,61 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * @copyright Copyright (c) 2024 Julien Veyssier <[email protected]> | ||
| * | ||
| * @author Julien Veyssier <[email protected]> | ||
| * | ||
| * @license GNU AGPL version 3 or any later version | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as | ||
| * published by the Free Software Foundation, either version 3 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 Affero General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| */ | ||
|
|
||
|
|
||
| namespace OCA\OAuth2\BackgroundJob; | ||
|
|
||
| use OCA\OAuth2\Db\AccessTokenMapper; | ||
| use OCP\AppFramework\Utility\ITimeFactory; | ||
| use OCP\BackgroundJob\IJob; | ||
| use OCP\BackgroundJob\TimedJob; | ||
| use OCP\DB\Exception; | ||
| use Psr\Log\LoggerInterface; | ||
|
|
||
| class CleanupExpiredAuthorizationCode extends TimedJob { | ||
|
|
||
| public function __construct( | ||
| ITimeFactory $timeFactory, | ||
| private AccessTokenMapper $accessTokenMapper, | ||
| private LoggerInterface $logger, | ||
|
|
||
| ) { | ||
| parent::__construct($timeFactory); | ||
| // 30 days | ||
| $this->setInterval(60 * 60 * 24 * 30); | ||
| $this->setTimeSensitivity(IJob::TIME_INSENSITIVE); | ||
| } | ||
|
|
||
| /** | ||
| * @param mixed $argument | ||
| * @inheritDoc | ||
| */ | ||
| protected function run($argument): void { | ||
| try { | ||
| $this->accessTokenMapper->cleanupExpiredAuthorizationCode(); | ||
| } catch (Exception $e) { | ||
| $this->logger->warning('Failed to cleanup tokens with expired authorization code', ['exception' => $e]); | ||
| } | ||
| } | ||
| } |
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
86 changes: 86 additions & 0 deletions
86
apps/oauth2/lib/Migration/Version011603Date20230620111039.php
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,86 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * @copyright Copyright 2023, Julien Veyssier <[email protected]> | ||
| * | ||
| * @author Julien Veyssier <[email protected]> | ||
| * | ||
| * @license GNU AGPL version 3 or any later version | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as | ||
| * published by the Free Software Foundation, either version 3 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 Affero General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| * | ||
| */ | ||
| namespace OCA\OAuth2\Migration; | ||
|
|
||
| use Closure; | ||
| use OCP\DB\ISchemaWrapper; | ||
| use OCP\DB\QueryBuilder\IQueryBuilder; | ||
| use OCP\DB\Types; | ||
| use OCP\IDBConnection; | ||
| use OCP\Migration\IOutput; | ||
| use OCP\Migration\SimpleMigrationStep; | ||
|
|
||
| class Version011603Date20230620111039 extends SimpleMigrationStep { | ||
|
|
||
| public function __construct( | ||
| private IDBConnection $connection, | ||
| ) { | ||
| } | ||
|
|
||
| public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper { | ||
| /** @var ISchemaWrapper $schema */ | ||
| $schema = $schemaClosure(); | ||
|
|
||
| if ($schema->hasTable('oauth2_access_tokens')) { | ||
| $table = $schema->getTable('oauth2_access_tokens'); | ||
| $dbChanged = false; | ||
| if (!$table->hasColumn('code_created_at')) { | ||
| $table->addColumn('code_created_at', Types::BIGINT, [ | ||
| 'notnull' => true, | ||
| 'default' => 0, | ||
| 'unsigned' => true, | ||
| ]); | ||
| $dbChanged = true; | ||
| } | ||
| if (!$table->hasColumn('token_count')) { | ||
| $table->addColumn('token_count', Types::BIGINT, [ | ||
| 'notnull' => true, | ||
| 'default' => 0, | ||
| 'unsigned' => true, | ||
| ]); | ||
| $dbChanged = true; | ||
| } | ||
| if (!$table->hasIndex('oauth2_tk_c_created_idx')) { | ||
| $table->addIndex(['token_count', 'code_created_at'], 'oauth2_tk_c_created_idx'); | ||
| $dbChanged = true; | ||
| } | ||
| if ($dbChanged) { | ||
| return $schema; | ||
| } | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
|
|
||
| public function postSchemaChange(IOutput $output, Closure $schemaClosure, array $options): void { | ||
| // we consider that existing access_tokens have already produced at least one oauth token | ||
| // which prevents cleaning them up | ||
| $qbUpdate = $this->connection->getQueryBuilder(); | ||
| $qbUpdate->update('oauth2_access_tokens') | ||
| ->set('token_count', $qbUpdate->createNamedParameter(1, IQueryBuilder::PARAM_INT)); | ||
| $qbUpdate->executeStatement(); | ||
| } | ||
| } |
Oops, something went wrong.