Skip to content
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.

Sign up for GitHub

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

[stable28] fix: Use sha256 to hash arguments of background jobs #47776

Merged
merged 3 commits into from
Sep 5, 2024
Merged

[stable28] fix: Use sha256 to hash arguments of background jobs #47776

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f4fc57c
fix: Use sha256 to hash arguments of background jobs
artonge Aug 28, 2024
7f742cb
fix: Migrate existing bg jobs to use sha256
artonge Sep 5, 2024
095389d
fix: missing use statements
blizzz Sep 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 77 additions & 0 deletions core/Migrations/Version28000Date20240828142927.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
<?php

declare(strict_types=1);

/**
* SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/

namespace OC\Core\Migrations;

use Closure;
use OCP\DB\ISchemaWrapper;
use OCP\DB\QueryBuilder\IQueryBuilder;
use OCP\IDBConnection;

/**
* Migrate the argument_hash column of oc_jobs to use sha256 instead of md5.
*/
class Version28000Date20240828142927 extends SimpleMigrationStep {

Check failure on line 20 in core/Migrations/Version28000Date20240828142927.php

View workflow job for this annotation

GitHub Actions / static-code-analysis

UndefinedClass 

core/Migrations/Version28000Date20240828142927.php:20:46: UndefinedClass: Class, interface or enum named OC\Core\Migrations\SimpleMigrationStep does not exist (see https://psalm.dev/019)
blizzz marked this conversation as resolved.
Show resolved Hide resolved
Fixed Show fixed Hide fixed
public function __construct(
protected IDBConnection $connection,
) {
}

public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
/** @var ISchemaWrapper $schema */
$schema = $schemaClosure();

// Increase the column size from 32 to 64
$table = $schema->getTable('jobs');
$table->modifyColumn('argument_hash', [
'notnull' => false,
'length' => 64,
]);

return $schema;
}

public function postSchemaChange(IOutput $output, Closure $schemaClosure, array $options): void {
$chunkSize = 1000;
$offset = 0;
$nullHash = hash('sha256', 'null');

$selectQuery = $this->connection->getQueryBuilder()
->select('*')
->from('jobs')
->setMaxResults($chunkSize);

$insertQuery = $this->connection->getQueryBuilder();
$insertQuery->update('jobs')
->set('argument_hash', $insertQuery->createParameter('argument_hash'))
->where($insertQuery->expr()->eq('id', $insertQuery->createParameter('id')));

do {
$result = $selectQuery
->setFirstResult($offset)
->executeQuery();

$jobs = $result->fetchAll();
$count = count($jobs);

foreach ($jobs as $jobRow) {
if ($jobRow['argument'] === 'null') {
$hash = $nullHash;
} else {
$hash = hash('sha256', $jobRow['argument']);
}
$insertQuery->setParameter('id', (string)$jobRow['id'], IQueryBuilder::PARAM_INT);
$insertQuery->setParameter('argument_hash', $hash);
$insertQuery->executeStatement();
}

$offset += $chunkSize;
} while ($count === $chunkSize);
}
}
1 change: 1 addition & 0 deletions lib/composer/composer/autoload_classmap.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1232,6 +1232,7 @@
'OC\\Core\\Migrations\\Version28000Date20231004103301' => $baseDir . '/core/Migrations/Version28000Date20231004103301.php',
'OC\\Core\\Migrations\\Version28000Date20231103104802' => $baseDir . '/core/Migrations/Version28000Date20231103104802.php',
'OC\\Core\\Migrations\\Version28000Date20231126110901' => $baseDir . '/core/Migrations/Version28000Date20231126110901.php',
'OC\\Core\\Migrations\\Version28000Date20240828142927' => $baseDir . '/core/Migrations/Version28000Date20240828142927.php',
'OC\\Core\\Migrations\\Version30000Date20240814180800' => $baseDir . '/core/Migrations/Version30000Date20240814180800.php',
'OC\\Core\\Notification\\CoreNotifier' => $baseDir . '/core/Notification/CoreNotifier.php',
'OC\\Core\\Service\\LoginFlowV2Service' => $baseDir . '/core/Service/LoginFlowV2Service.php',
Expand Down
1 change: 1 addition & 0 deletions lib/composer/composer/autoload_static.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1265,6 +1265,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
'OC\\Core\\Migrations\\Version28000Date20231004103301' => __DIR__ . '/../../..' . '/core/Migrations/Version28000Date20231004103301.php',
'OC\\Core\\Migrations\\Version28000Date20231103104802' => __DIR__ . '/../../..' . '/core/Migrations/Version28000Date20231103104802.php',
'OC\\Core\\Migrations\\Version28000Date20231126110901' => __DIR__ . '/../../..' . '/core/Migrations/Version28000Date20231126110901.php',
'OC\\Core\\Migrations\\Version28000Date20240828142927' => __DIR__ . '/../../..' . '/core/Migrations/Version28000Date20240828142927.php',
'OC\\Core\\Migrations\\Version30000Date20240814180800' => __DIR__ . '/../../..' . '/core/Migrations/Version30000Date20240814180800.php',
'OC\\Core\\Notification\\CoreNotifier' => __DIR__ . '/../../..' . '/core/Notification/CoreNotifier.php',
'OC\\Core\\Service\\LoginFlowV2Service' => __DIR__ . '/../../..' . '/core/Service/LoginFlowV2Service.php',
Expand Down
9 changes: 4 additions & 5 deletions lib/private/BackgroundJob/JobList.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@
use Psr\Log\LoggerInterface;
use function get_class;
use function json_encode;
use function md5;
use function strlen;

class JobList implements IJobList {
Expand Down Expand Up @@ -80,7 +79,7 @@ public function add($job, $argument = null, int $firstCheck = null): void {
->values([
'class' => $query->createNamedParameter($class),
'argument' => $query->createNamedParameter($argumentJson),
'argument_hash' => $query->createNamedParameter(md5($argumentJson)),
'argument_hash' => $query->createNamedParameter(hash('sha256', $argumentJson)),
'last_run' => $query->createNamedParameter(0, IQueryBuilder::PARAM_INT),
'last_checked' => $query->createNamedParameter($firstCheck, IQueryBuilder::PARAM_INT),
]);
Expand All @@ -90,7 +89,7 @@ public function add($job, $argument = null, int $firstCheck = null): void {
->set('last_checked', $query->createNamedParameter($firstCheck, IQueryBuilder::PARAM_INT))
->set('last_run', $query->createNamedParameter(0, IQueryBuilder::PARAM_INT))
->where($query->expr()->eq('class', $query->createNamedParameter($class)))
->andWhere($query->expr()->eq('argument_hash', $query->createNamedParameter(md5($argumentJson))));
->andWhere($query->expr()->eq('argument_hash', $query->createNamedParameter(hash('sha256', $argumentJson))));
}
$query->executeStatement();
}
Expand All @@ -115,7 +114,7 @@ public function remove($job, $argument = null): void {
->where($query->expr()->eq('class', $query->createNamedParameter($class)));
if (!is_null($argument)) {
$argumentJson = json_encode($argument);
$query->andWhere($query->expr()->eq('argument_hash', $query->createNamedParameter(md5($argumentJson))));
$query->andWhere($query->expr()->eq('argument_hash', $query->createNamedParameter(hash('sha256', $argumentJson))));
}

// Add galera safe delete chunking if using mysql
Expand Down Expand Up @@ -160,7 +159,7 @@ public function has($job, $argument): bool {
$query->select('id')
->from('jobs')
->where($query->expr()->eq('class', $query->createNamedParameter($class)))
->andWhere($query->expr()->eq('argument_hash', $query->createNamedParameter(md5($argument))))
->andWhere($query->expr()->eq('argument_hash', $query->createNamedParameter(hash('sha256', $argument))))
->setMaxResults(1);

$result = $query->executeQuery();
Expand Down
Loading