[](https://discord.gg/GUAy9wErNu)
[](https://discord.gg/GUAy9wErNu)
[](https://github.com/CybercentreCanada/assemblyline)
[](https://github.com/CybercentreCanada/assemblyline-core)
[](https://github.com/CybercentreCanada/assemblyline/issues?q=is:issue+is:open+label:core)
[](./LICENSE.md)
# Assemblyline 4 - Core
This repository provides cores services for Assemblyline 4.
## 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` |
## Components
### Alerter
Create alerts for the different submissions in the system.
```bash
docker run --name alerter cccs/assemblyline-core python -m assemblyline_core.alerter.run_alerter
```
### Archiver
Archives submissions and their results & files into the archive.
```bash
docker run --name archiver cccs/assemblyline-core python -m assemblyline_core.archiver.run_archiver
```
### Dispatcher
Route the files in the system while a submission is tacking place. Make sure all files during a submission are completed by all required services.
```bash
docker run --name dispatcher cccs/assemblyline-core python -m assemblyline_core.dispatching
```
### Expiry
Delete submissions and their results when their time-to-live expires.
```bash
docker run --name expiry cccs/assemblyline-core python -m assemblyline_core.expiry.run_expiry
```
### Ingester
Move ingested files from the priority queues to the processing queues.
```bash
docker run --name ingester cccs/assemblyline-core python -m assemblyline_core.ingester
```
### Metrics
Generates metrics of the different components in the system.
#### Heartbeat Manager
```bash
docker run --name heartbeat cccs/assemblyline-core python -m assemblyline_core.metrics.run_heartbeat_manager
```
#### Metrics Aggregator
```bash
docker run --name metrics cccs/assemblyline-core python -m assemblyline_core.metrics.run_metrics_aggregator
```
#### Statistics Aggregator
```bash
docker run --name statistics cccs/assemblyline-core python -m assemblyline_core.metrics.run_statistics_aggregator
```
### Scaler
Spin up and down services in the system depending on the load.
```bash
docker run --name scaler cccs/assemblyline-core python -m assemblyline_core.scaler.run_scaler
```
### Updater
Make sure the different services get their latest update files.
```bash
docker run --name updater cccs/assemblyline-core python -m assemblyline_core.updater.run_updater
```
### Workflow
Run the different workflows in the system and apply their labels, priority and status.
```bash
docker run --name workflow cccs/assemblyline-core python -m assemblyline_core.workflow.run_workflow
```
## Documentation
For more information about these Assemblyline components, follow this [overview](https://cybercentrecanada.github.io/assemblyline4_docs/overview/architecture/) of the system's architecture.
---
# Assemblyline 4 - Core
Ce dépôt fournit des services de base pour Assemblyline 4.
## 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` |
## Composants
### Alerter
Crée des alertes pour les différentes soumissions dans le système.
```bash
docker run --name alerter cccs/assemblyline-core python -m assemblyline_core.alerter.run_alerter
```
### Archiver
Archivage des soumissions, de leurs résultats et des fichiers dans l'archive.
```bash
docker run --name archiver cccs/assemblyline-core python -m assemblyline_core.archiver.run_archiver
```
### Dispatcher
Achemine les fichiers dans le système durant une soumission. S'assure que tous les fichiers de la soumission courante soient complétés par tous les services requis.
```bash
docker run --name dispatcher cccs/assemblyline-core python -m assemblyline_core.dispatching
```
### Expiration
Supprimer les soumissions et leurs résultats à l'expiration de leur durée de vie.
```bash
docker run --name expiry cccs/assemblyline-core python -m assemblyline_core.expiry.run_expiry
```
### Ingester
Déplace les fichiers ingérés des files d'attente prioritaires vers les files d'attente de traitement.
```bash
docker run --name ingester cccs/assemblyline-core python -m assemblyline_core.ingester
```
### Métriques
Génère des métriques des différents composants du système.
#### Heartbeat Manager
```bash
docker run --name heartbeat cccs/assemblyline-core python -m assemblyline_core.metrics.run_heartbeat_manager
```
#### Agrégateur de métriques
```bash
docker run --name metrics cccs/assemblyline-core python -m assemblyline_core.metrics.run_metrics_aggregator
```
##### Agrégateur de statistiques
```bash
docker run --name statistics cccs/assemblyline-core python -m assemblyline_core.metrics.run_statistics_aggregator
```
### Scaler
Augmente et diminue les services dans le système en fonction de la charge.
```bash
docker run --name scaler cccs/assemblyline-core python -m assemblyline_core.scaler.run_scaler
```
### Mise à jour
Assure que les différents services reçoivent leurs derniers fichiers de mise à jour.
```bash
docker run --name updater cccs/assemblyline-core python -m assemblyline_core.updater.run_updater
```
### Workflow
Exécute les différents flux de travail dans le système et appliquer leurs étiquettes, leur priorité et leur statut.
```bash
docker run --name workflow cccs/assemblyline-core python -m assemblyline_core.workflow.run_workflow
```
## Documentation
Pour plus d'informations sur ces composants Assemblyline, suivez ce [overview](https://cybercentrecanada.github.io/assemblyline4_docs/overview/architecture/) de l'architecture du système.
Raw data
{
"_id": null,
"home_page": "https://github.com/CybercentreCanada/assemblyline-core/",
"name": "assemblyline-core",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "assemblyline automated malware analysis gc canada cse-cst cse cst cyber cccs",
"author": "CCCS Assemblyline development team",
"author_email": "assemblyline@cyber.gc.ca",
"download_url": "https://files.pythonhosted.org/packages/d0/64/5ddb2573f6fe54e75e081521101d4bf5e8132d39e35209f8fca4476b583c/assemblyline_core-4.5.0.68.tar.gz",
"platform": null,
"description": "[](https://discord.gg/GUAy9wErNu)\n[](https://discord.gg/GUAy9wErNu)\n[](https://github.com/CybercentreCanada/assemblyline)\n[](https://github.com/CybercentreCanada/assemblyline-core)\n[](https://github.com/CybercentreCanada/assemblyline/issues?q=is:issue+is:open+label:core)\n[](./LICENSE.md)\n\n# Assemblyline 4 - Core\n\nThis repository provides cores services for Assemblyline 4.\n\n## Image variants and tags\n\n| **Tag Type** | **Description** | **Example Tag** |\n| :----------: | :----------------------------------------------------------------------------------------------- | :------------------------: |\n| latest | The most recent build (can be unstable). | `latest` |\n| build_type | The type of build used. `dev` is the latest unstable build. `stable` is the latest stable build. | `stable` or `dev` |\n| series | Complete build details, including version and build type: `version.buildType`. | `4.5.stable`, `4.5.1.dev3` |\n\n## Components\n\n### Alerter\n\nCreate alerts for the different submissions in the system.\n\n```bash\ndocker run --name alerter cccs/assemblyline-core python -m assemblyline_core.alerter.run_alerter\n```\n\n### Archiver\n\nArchives submissions and their results & files into the archive.\n\n```bash\ndocker run --name archiver cccs/assemblyline-core python -m assemblyline_core.archiver.run_archiver\n```\n\n### Dispatcher\n\nRoute the files in the system while a submission is tacking place. Make sure all files during a submission are completed by all required services.\n\n```bash\ndocker run --name dispatcher cccs/assemblyline-core python -m assemblyline_core.dispatching\n```\n\n### Expiry\n\nDelete submissions and their results when their time-to-live expires.\n\n```bash\ndocker run --name expiry cccs/assemblyline-core python -m assemblyline_core.expiry.run_expiry\n```\n\n### Ingester\n\nMove ingested files from the priority queues to the processing queues.\n\n```bash\ndocker run --name ingester cccs/assemblyline-core python -m assemblyline_core.ingester\n```\n\n### Metrics\n\nGenerates metrics of the different components in the system.\n\n#### Heartbeat Manager\n\n```bash\ndocker run --name heartbeat cccs/assemblyline-core python -m assemblyline_core.metrics.run_heartbeat_manager\n```\n\n#### Metrics Aggregator\n\n```bash\ndocker run --name metrics cccs/assemblyline-core python -m assemblyline_core.metrics.run_metrics_aggregator\n```\n\n#### Statistics Aggregator\n\n```bash\ndocker run --name statistics cccs/assemblyline-core python -m assemblyline_core.metrics.run_statistics_aggregator\n```\n\n### Scaler\n\nSpin up and down services in the system depending on the load.\n\n```bash\ndocker run --name scaler cccs/assemblyline-core python -m assemblyline_core.scaler.run_scaler\n```\n\n### Updater\n\nMake sure the different services get their latest update files.\n\n```bash\ndocker run --name updater cccs/assemblyline-core python -m assemblyline_core.updater.run_updater\n```\n\n### Workflow\n\nRun the different workflows in the system and apply their labels, priority and status.\n\n```bash\ndocker run --name workflow cccs/assemblyline-core python -m assemblyline_core.workflow.run_workflow\n```\n\n## Documentation\n\nFor more information about these Assemblyline components, follow this [overview](https://cybercentrecanada.github.io/assemblyline4_docs/overview/architecture/) of the system's architecture.\n\n---\n\n# Assemblyline 4 - Core\n\nCe d\u00e9p\u00f4t fournit des services de base pour Assemblyline 4.\n\n## Variantes et \u00e9tiquettes d'image\n\n| **Type d'\u00e9tiquette** | **Description** | **Exemple d'\u00e9tiquette** |\n| :------------------: | :--------------------------------------------------------------------------------------------------------------- | :------------------------: |\n| derni\u00e8re | La version la plus r\u00e9cente (peut \u00eatre instable). | `latest` |\n| build_type | Le type de compilation utilis\u00e9. `dev` est la derni\u00e8re version instable. `stable` est la derni\u00e8re version stable. | `stable` ou `dev` |\n| s\u00e9ries | Le d\u00e9tail de compilation utilis\u00e9, incluant la version et le type de compilation : `version.buildType`. | `4.5.stable`, `4.5.1.dev3` |\n\n## Composants\n\n### Alerter\n\nCr\u00e9e des alertes pour les diff\u00e9rentes soumissions dans le syst\u00e8me.\n\n```bash\ndocker run --name alerter cccs/assemblyline-core python -m assemblyline_core.alerter.run_alerter\n```\n\n### Archiver\n\nArchivage des soumissions, de leurs r\u00e9sultats et des fichiers dans l'archive.\n\n```bash\ndocker run --name archiver cccs/assemblyline-core python -m assemblyline_core.archiver.run_archiver\n```\n\n### Dispatcher\n\nAchemine les fichiers dans le syst\u00e8me durant une soumission. S'assure que tous les fichiers de la soumission courante soient compl\u00e9t\u00e9s par tous les services requis.\n\n```bash\ndocker run --name dispatcher cccs/assemblyline-core python -m assemblyline_core.dispatching\n```\n\n### Expiration\n\nSupprimer les soumissions et leurs r\u00e9sultats \u00e0 l'expiration de leur dur\u00e9e de vie.\n\n```bash\ndocker run --name expiry cccs/assemblyline-core python -m assemblyline_core.expiry.run_expiry\n```\n\n### Ingester\n\nD\u00e9place les fichiers ing\u00e9r\u00e9s des files d'attente prioritaires vers les files d'attente de traitement.\n\n```bash\ndocker run --name ingester cccs/assemblyline-core python -m assemblyline_core.ingester\n```\n\n### M\u00e9triques\n\nG\u00e9n\u00e8re des m\u00e9triques des diff\u00e9rents composants du syst\u00e8me.\n\n#### Heartbeat Manager\n\n```bash\ndocker run --name heartbeat cccs/assemblyline-core python -m assemblyline_core.metrics.run_heartbeat_manager\n```\n\n#### Agr\u00e9gateur de m\u00e9triques\n\n```bash\ndocker run --name metrics cccs/assemblyline-core python -m assemblyline_core.metrics.run_metrics_aggregator\n```\n\n##### Agr\u00e9gateur de statistiques\n\n```bash\ndocker run --name statistics cccs/assemblyline-core python -m assemblyline_core.metrics.run_statistics_aggregator\n```\n\n### Scaler\n\nAugmente et diminue les services dans le syst\u00e8me en fonction de la charge.\n\n```bash\ndocker run --name scaler cccs/assemblyline-core python -m assemblyline_core.scaler.run_scaler\n```\n\n### Mise \u00e0 jour\n\nAssure que les diff\u00e9rents services re\u00e7oivent leurs derniers fichiers de mise \u00e0 jour.\n\n```bash\ndocker run --name updater cccs/assemblyline-core python -m assemblyline_core.updater.run_updater\n```\n\n### Workflow\n\nEx\u00e9cute les diff\u00e9rents flux de travail dans le syst\u00e8me et appliquer leurs \u00e9tiquettes, leur priorit\u00e9 et leur statut.\n\n```bash\ndocker run --name workflow cccs/assemblyline-core python -m assemblyline_core.workflow.run_workflow\n```\n\n## Documentation\n\nPour plus d'informations sur ces composants Assemblyline, suivez ce [overview](https://cybercentrecanada.github.io/assemblyline4_docs/overview/architecture/) de l'architecture du syst\u00e8me.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Assemblyline 4 - Core components",
"version": "4.5.0.68",
"project_urls": {
"Homepage": "https://github.com/CybercentreCanada/assemblyline-core/"
},
"split_keywords": [
"assemblyline",
"automated",
"malware",
"analysis",
"gc",
"canada",
"cse-cst",
"cse",
"cst",
"cyber",
"cccs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d0645ddb2573f6fe54e75e081521101d4bf5e8132d39e35209f8fca4476b583c",
"md5": "1bcb8c3a03b030ae6c4b4f433c78a4c7",
"sha256": "ace5ca0dbdd7fb87b4a172920b4a4d51327c73f7aed57ad26f5edf429d7d5d87"
},
"downloads": -1,
"filename": "assemblyline_core-4.5.0.68.tar.gz",
"has_sig": false,
"md5_digest": "1bcb8c3a03b030ae6c4b4f433c78a4c7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 183323,
"upload_time": "2025-01-13T18:52:11",
"upload_time_iso_8601": "2025-01-13T18:52:11.895558Z",
"url": "https://files.pythonhosted.org/packages/d0/64/5ddb2573f6fe54e75e081521101d4bf5e8132d39e35209f8fca4476b583c/assemblyline_core-4.5.0.68.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-13 18:52:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CybercentreCanada",
"github_project": "assemblyline-core",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "assemblyline-core"
}
JSON
