AMOS 2025 - API Endpoints

[ClProsser]

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
feature

What is the current behavior?
Currently, there is no EMBArk API

What is the new behavior (if this is a feature change)?

We added:

• API key generation (See My account -> User Menu)
  • Each API key is visible once.
  • If a new API key is generated, all previous API keys of this user get invalid.
• API key test endpoint
  • Supports authentication using either the Authorization header or the api_key URL parameter
• API uploader endpoint
  • Upload firmware and initiate scan
  • Returns scan uuid
• API report status endpoint
  • Given a scan uuid, returns scan status
  • If the scan is finished, a report download link is returned
• Github workflow to run django tests (Workflow django-tests)

Each endpoint is documented using the OpenAPI specification (Check openapi.yaml) and tested using integration tests.

Does this PR introduce a breaking change?
No

Other information:
This is the first release of the AMOS 2025 embark project.

[github-actions]

Thank you for contributing a pull request!

Welcome to the EMBA firmware analysis community!

We are glad you are here and appreciate your contribution. Please keep in mind our contributing guidelines here and here.
Also, please check existing open issues and consider to open a discussion in the dedicated discussion area.
Additionally, we have collected a lot of details around EMBArk, the installation and the usage of EMBArk in our Wiki.

If you like EMBA you have the chance to support us by becoming a Sponsor or buying some beer here.

This is an automatic message. Allow for time for the EMBA community to be able to read the pull request and comment on it.

[Copilot]

Pull Request Overview

This feature PR adds new API endpoints for the AMOS 2025 EMBArk project including API key generation, firmware upload, status reporting, and associated integration tests and documentation updates. Key changes include:

• Implementation of new API endpoints with proper authentication and status reporting.
• Updates to UI templates and static assets for API key generation.
• Enhancements to configuration, workflows, and tests to support the new functionality.

Reviewed Changes

Copilot reviewed 34 out of 34 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
embark/uploader/management/commands/test_runapscheduler.py	Updated test case base class for transactional tests.
embark/tracker/tests.py	Removed placeholder tracker tests.
embark/templates/user/index.html	Integrated API key generation UI block.
embark/templates/user/apiKeyGen.html	New template for API key generation with clipboard support.
embark/static/content/css/apiKeyGen.css	Added CSS styling for the API key generation component.
embark/reporter/views.py	Added API endpoint (status_report) with new authentication and zip generation logic.
embark/reporter/urls.py	Registered the new status_report endpoint.
embark/reporter/tests.py	Added integration tests covering the new endpoints.
embark/porter/tests.py	Entire file content commented out, potentially reducing test coverage.
embark/entrypoint.sh	Updated migration command to include the porter app.
embark/embark/tests/test_linecache.py	All tests commented out, affecting test coverage.
embark/embark/test_logreader.py	Minor adjustments with new skipIf decorator added.
embark/embark/settings/dev.py & deploy.py	Updated authors and added rest_framework to installed apps.
dev-tools/check_project.sh, .spectral.yaml, .github/workflows/*	Added and updated linting and CI test configuration files.
emba	Updated subproject commit reference.

Comments suppressed due to low confidence (2)

embark/porter/tests.py:1

• Consider re-enabling or cleaning up the commented test code to ensure the porter functionality is adequately covered by tests.

All test content commented out in this file

embark/embark/tests/test_linecache.py:1

• Re-enable the test cases or remove the commented code to maintain proper test coverage for the line cache functionality.

All test content commented out in this file

[BenediktMKuehne]

Love it
Just the copyright headers have to be corrected

[BenediktMKuehne]

Great work everyone 👏