Skip to content

CybercentreCanada/assemblyline-service-emlparser

Repository files navigation

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

EmlParser Service

This service parses emails using GOVCERT-LU eml_parser library while extracting header information, attachments, and URIs.

Service Details

This service preforms the following actions:

  • Extracts email header information
  • Extracts email body urls
  • Extracts Attachments
  • Tags the various email addresses, URIs, domains, IPs, ...
  • Optionally extracts email raw body
  • Optionally return raw output from eml_parser lib

Supporting Tools

Image variants and tags

Assemblyline services are built from the Assemblyline service base image, which is based on Debian 11 with Python 3.11.

Assemblyline services use the following tag definitions:

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

Running this service

This is an Assemblyline service. It is designed to run as part of the Assemblyline framework.

If you would like to test this service locally, you can run the Docker image directly from the a shell:

docker run \
    --name EmlParser \
    --env SERVICE_API_HOST=http://`ip addr show docker0 | grep "inet " | awk '{print $2}' | cut -f1 -d"/"`:5003 \
    --network=host \
    cccs/assemblyline-service-emlparser

To add this service to your Assemblyline deployment, follow this guide.

Documentation

General Assemblyline documentation can be found at: https://cybercentrecanada.github.io/assemblyline4_docs/

Service EmlParser

Ce service analyse les courriels à l'aide de la bibliothèque eml_parser de GOVCERT-LU tout en extrayant les informations d'en-tête, les pièces jointes et les URI.

Détails du service

Ce service effectue les actions suivantes :

  • Extraction des informations de l'en-tête du courrier électronique
  • Extraction des URL du corps de l'e-mail
  • Extraction des pièces jointes
  • Étiquette les différentes adresses électroniques, URI, domaines, IP, ...
  • Optionnellement, extrait le corps brut de l'email
  • Optionnellement, renvoie la sortie brute de eml_parser lib

Outils de support

Variantes et étiquettes d'image

Les services d'Assemblyline sont construits à partir de l'image de base Assemblyline service, qui est basée sur Debian 11 avec Python 3.11.

Les services d'Assemblyline utilisent les définitions d'étiquettes suivantes:

Type d'étiquette Description Exemple d'étiquette
dernière version La version la plus récente (peut être instable). latest
build_type Type de construction utilisé. dev est la dernière version instable. stable est la dernière version stable. stable ou dev
série Détails de construction complets, comprenant la version et le type de build: version.buildType. 4.5.stable, 4.5.1.dev3

Exécution de ce service

Ce service est spécialement optimisé pour fonctionner dans le cadre d'un déploiement d'Assemblyline.

Si vous souhaitez tester ce service localement, vous pouvez exécuter l'image Docker directement à partir d'un terminal:

docker run \
    --name EmlParser \
    --env SERVICE_API_HOST=http://`ip addr show docker0 | grep "inet " | awk '{print $2}' | cut -f1 -d"/"`:5003 \
    --network=host \
    cccs/assemblyline-service-emlparser

Pour ajouter ce service à votre déploiement d'Assemblyline, suivez ceci guide.

Documentation

La documentation générale sur Assemblyline peut être consultée à l'adresse suivante: https://cybercentrecanada.github.io/assemblyline4_docs/