Skip to content

Add API helper endpoint to trigger a re-scan of a cracker binary - #2643

Open
novasam23 wants to merge 2 commits into
masterfrom
2625-enhancement-allow-triggering-a-re-scan-of-a-cracker-binary
Open

novasam23 wants to merge 2 commits into
masterfrom
2625-enhancement-allow-triggering-a-re-scan-of-a-cracker-binary

Conversation

@novasam23

Copy link
Copy Markdown
Contributor

Closes #2641

Part of #2625

@novasam23 novasam23 self-assigned this Nov 20, 2026
@novasam23
novasam23 requested review from sulpayki and a balanced review from Copilot November 20, 2026 11:21

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

Concurrent rescans can corrupt shared downloads or cause failures, and a null JSON body bypasses required-field validation and triggers a TypeError instead of a 400 response.

2 open issues
What changed in this PR

Adds API v2 support for retrying hashcat binary scans without changing the download URL or uploading another archive, using the existing background-job runner.

Changes:

  • Adds a POST helper with update-permission, access-group, and binary-type checks.
  • Refreshes URL-backed archives before requesting an asynchronous scan.
  • Registers and documents the endpoint, with tests for retries, pending scans, validation, and access control.
File Description
src/​inc/​apiv2/​helper/​RescanCrackerBinaryHelperAPI.php Implements the rescan endpoint and access checks.
src/​inc/​apiv2/​common/​ApiRegistry.php Registers the new helper.
openapi.json Documents the endpoint and request/response schemas.
ci/​apiv2/​test_permissions.py Adds the helper to permission checks.
ci/​apiv2/​test_cracker.py Tests rescan behavior, failure recovery, and access restrictions.

Review effort: Balanced

}

try {
CrackerUtils::checkCrackerBinary($binary->getId(), $this->getCurrentUser());
Add validation for required 'crackerBinaryId' parameter.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[ENHANCEMENT]: Add API helper endpoint to trigger a re-scan of a cracker binary

2 participants