-
Notifications
You must be signed in to change notification settings - Fork 5
Technical_Documentation
Central file to accept and propagate all requests from clients. Those include:
-
upload firmware: User either drag and drops file or selects it by hand. For further information see (### file uploading)
It is passed as FirmwareFile attached to the request which is stored as model in the database and saved packed on the server machine. -
analyse firmware: User fills django form which is send togehter with the request.
It includes Reference to FirmwareFile, normal emba Options and expert mode Options, which is saved into the DB.
Both the File and the Metainformation are passed to the BoundedExecuter (see ###) - service dashboard: Displays currently running Analyzers with status information. Communication is done via asgi and channels. To retrieve the status information the emba log is read asynchronously
- central dashboard: TODO
The Archiver is basically an extended wrapper around shutils to support all common archive formats.
It supports packing, unpacking and validating of different archive types.
Unittest labeled as test_archiver.
The BoundedExecutor is basically an extended wrapper around pythons ThreadPoolExecutor to support a selectable finite upper bound for running processes.
Internally it uses additional BoundedSemaphore to track the current load, on submit() the semaphore ius decremented on finished process incremented.
On submit_firmware, the Archiver is utilized to unpack the selected firmware to an new directory and also starting the emba.sh process with the blocking subprocess.call.
Unittest labeled as test_boundedExecutor.
There are currently 2 different models:
- FirmwareFile:
Used to track zipped firmwares. Featuring FileField as well as DateTimeField. - Firmware:
Used to track Analyzed firmwares. Custom fields provide additional attribute for defining expert field: CharFieldExpertMode, BooleanFieldExpertMode.
Fields include reference to FirmwareFile, basic fields (e.g. version, vendor, architecture) and expert fields (e.g. web-report, multi-threading, dependencies)