Skip to content

Service tasking and result publishing API for Assemblyline 4

License

Notifications You must be signed in to change notification settings

CybercentreCanada/assemblyline-service-server

Repository files navigation

Discord Static Badge Static Badge GitHub Issues or Pull Requests by label License

Assemblyline 4 - Service Server

The service server is a API that the service clients can call to interface with the system. This is the only access the services have to the system as they are completely segregated from the other components.

Image variants and tags

Tag Type Description Example Tag
latest The most recent build (can be unstable). latest
build_type The type of build used. dev is the latest unstable build. stable is the latest stable build. stable or dev
series Complete build details, including version and build type: version.buildType. 4.5.stable, 4.5.1.dev3

API functionality

Service server provides the following functions via API to the client:

  • File download and upload
  • Register service to the system
  • Get a new task
  • Publish results for a task
  • Checking if certain tags or files have a reputation relative to the system (ie. safe vs malicious)

Running this component

docker run --name service-server cccs/assemblyline-service-server

Documentation

For more information about this Assemblyline component, follow this overview of the system's architecture.


Assemblyline 4 - Serveur de service

Le serveur de service est une API que les clients des services peuvent contacter pour interagir avec le système. C'est le seul accès que les services ont avec le système. Autrement, ils sont complètement isolés des autres composants du système.

Variantes et étiquettes d'image

Type d'étiquette Description Exemple d'étiquette
dernière La version la plus récente (peut être instable). latest
build_type Le type de compilation utilisé. dev est la dernière version instable. stable est la dernière version stable. stable ou dev
séries Le détail de compilation utilisé, incluant la version et le type de compilation : version.buildType. 4.5.stable, 4.5.1.dev3

Fonctionnalité de l'API

Le serveur de service fournit les fonctionnalités suivantes au client via l'API :

  • Téléchargement et chargement de fichiers
  • Enregistrement d'un service dans le système
  • Obtenir une nouvelle tâche
  • Publier les résultats d'une tâche
  • Vérifier si certaines étiquettes ou fichiers ont une réputation liée au système (c'est-à-dire sûrs ou malveillants).

Exécuter ce composant

docker run --name service-server cccs/assemblyline-service-server

Documentation

Pour plus d'informations sur ce composant Assemblyline, suivez ce overview de l'architecture du système.