https://github.com/cybercentrecanada/assemblyline-service-sigma
Assemblyline 4 Sigma service for Windows Event Log scanning
https://github.com/cybercentrecanada/assemblyline-service-sigma
assemblyline malware-analysis sigma
Last synced: 6 months ago
JSON representation
Assemblyline 4 Sigma service for Windows Event Log scanning
- Host: GitHub
- URL: https://github.com/cybercentrecanada/assemblyline-service-sigma
- Owner: CybercentreCanada
- License: other
- Created: 2020-12-07T16:26:57.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-13T18:26:05.000Z (8 months ago)
- Last Synced: 2025-04-04T18:38:22.715Z (7 months ago)
- Topics: assemblyline, malware-analysis, sigma
- Language: Python
- Homepage: https://cybercentrecanada.github.io/assemblyline4_docs/
- Size: 195 KB
- Stars: 1
- Watchers: 0
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://discord.gg/GUAy9wErNu)
[](https://discord.gg/GUAy9wErNu)
[](https://github.com/CybercentreCanada/assemblyline)
[](https://github.com/CybercentreCanada/assemblyline-service-sigma)
[](https://github.com/CybercentreCanada/assemblyline/issues?q=is:issue+is:open+label:service-sigma)
[](./LICENSE)
# Sigma Service
This assemblyline service automates detection of Windows Sysmon Event logs that indicate malicious behavior.
## Service Details
This service utilizes [our pysigma library](https://github.com/CybercentreCanada/pysigma) to check Windows Sysmon Event logs against a Sigma ruleset.
The sigma rules are found from a list of sources defined in the service_manifest.yml. Currently all the rules used in the service are found from https://github.com/SigmaHQ/sigma/tree/master/rules/windows
## Image variants and tags
Assemblyline services are built from the [Assemblyline service base image](https://hub.docker.com/r/cccs/assemblyline-v4-service-base),
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 Sigma \
--env SERVICE_API_HOST=http://`ip addr show docker0 | grep "inet " | awk '{print $2}' | cut -f1 -d"/"`:5003 \
--network=host \
cccs/assemblyline-service-sigma
To add this service to your Assemblyline deployment, follow this
[guide](https://cybercentrecanada.github.io/assemblyline4_docs/developer_manual/services/run_your_service/#add-the-container-to-your-deployment).
## Documentation
General Assemblyline documentation can be found at: https://cybercentrecanada.github.io/assemblyline4_docs/
# Service Sigma
Ce service en ligne automatise la détection des journaux d'événements Windows Sysmon qui indiquent un comportement malveillant.
## Détails du service
Ce service utilise [notre bibliothèque pysigma](https://github.com/CybercentreCanada/pysigma) pour vérifier les journaux d'événements Windows Sysmon par rapport à un ensemble de règles Sigma.
Les règles Sigma sont trouvées à partir d'une liste de sources définie dans le fichier service_manifest.yml. Actuellement, toutes les règles utilisées par le service proviennent de https://github.com/SigmaHQ/sigma/tree/master/rules/windows.
## Variantes et étiquettes d'image
Les services d'Assemblyline sont construits à partir de l'image de base [Assemblyline service](https://hub.docker.com/r/cccs/assemblyline-v4-service-base),
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 Sigma \
--env SERVICE_API_HOST=http://`ip addr show docker0 | grep "inet " | awk '{print $2}' | cut -f1 -d"/"`:5003 \
--network=host \
cccs/assemblyline-service-sigma
Pour ajouter ce service à votre déploiement d'Assemblyline, suivez ceci
[guide](https://cybercentrecanada.github.io/assemblyline4_docs/fr/developer_manual/services/run_your_service/#add-the-container-to-your-deployment).
## Documentation
La documentation générale sur Assemblyline peut être consultée à l'adresse suivante: https://cybercentrecanada.github.io/assemblyline4_docs/