Skip to main content

Assemblyline 4 - User Interface

Project description

Assemblyline 4 - User Interface

This component provides the User Interface as well as the different APIs and socketio endpoints for the Assemblyline 4 framework.

UI Components

APIs

Assemblyline 4 provides a large set of API that can provide you with all the same information you will find in it's UI and even more. The list of APIs and their functionality is described in the help section of the UI.

All APIs in Assemblyline output their result in the same manner for consistency:

{
   "api_response": {},            //Actual response from the API
   "api_error_message": "",       //Error message if it is an error response
   "api_server_version": "4.0.0"  //Assemblyline version and version of the different component
   "api_status_code": 200         //Status code of the response
}

NOTE: All response codes return this output layout

Views

The views are built in layers:

  1. It all starts with the python code which takes care of the authentication and loads information about the page and about the user
  2. It then passes that information to the Jinja template for the page to be rendered
  3. When it reaches the browser, the page in loaded into the angular controller which then in turn calls more APIs to load the data
  4. The angular layer loads the data received from the API into angular specific templates to render the page's final components

SocketIO endpoints

Assemblyline 4 also provide a list of SocketIO endpoints to get information about the system live. The endpoints will provide authenticated access to many Redis broadcast queues. It is a way for the system to notify user of changes and health of the system without having them to query for that information.

The following queues can be listen on:

  • Alerts created
  • Submissions ingested
  • Health of the system
  • State of a given running submission

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

assemblyline_ui-4.0.0.dev226-py3-none-any.whl (4.1 MB view details)

Uploaded Python 3

File details

Details for the file assemblyline_ui-4.0.0.dev226-py3-none-any.whl.

File metadata

  • Download URL: assemblyline_ui-4.0.0.dev226-py3-none-any.whl
  • Upload date:
  • Size: 4.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.3

File hashes

Hashes for assemblyline_ui-4.0.0.dev226-py3-none-any.whl
Algorithm Hash digest
SHA256 419da6d76ecbeb84f82ee3c2f5f8a60ee28e0b7fe6c7702fcb791b753f558003
MD5 6207188f9bcd758d19b4237fb096f4c3
BLAKE2b-256 cda486e54b0b7eaab8e6c05afa9702a92f763480d8e78c939097dc6dbbdb4ecc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page