Skip to content

Latest commit

 

History

History
314 lines (274 loc) · 13.1 KB

README.md

File metadata and controls

314 lines (274 loc) · 13.1 KB
Raw

Sigma Importer

Sigma Importer (a.k.a. sigmai) is a project designed to do the opposite of Sigma. The objective of sigmai is to convert specific data sources into the Sigma generic and open signature format.

Installation

If you have Go installed, you can get the newest version of sigmai through:

go get github.com/0xThiebaut/sigmai

Alternatively, you can download the release binaries which are updated less frequently.

Usage

For the generic usage's help section, sigmai is equipped with the --help flag (shorthand -h).

sigmai --help
Usage of ./sigmai:
      --directory-path string       Directory: Path to save rules
  -h, --help                        Display this help section
  -i, --interval string             Continuous importing interval
      --json                        Output JSON instead of pretty print
      --level-set string            Set level on all rules [low, medium, high, critical]
      --misp-buffer int             MISP: Size of the event buffer (default 500)
      --misp-events ints            MISP: Only events with matching IDs
      --misp-ids-exclude            MISP: Only IDS-disabled attributes
      --misp-ids-ignore             MISP: All attributes regardless of their IDS flag
      --misp-insecure               MISP: Allow insecure connections when using SSL
      --misp-key string             MISP: User API key
      --misp-keywords stringArray   MISP: All events containing any of the keywords
      --misp-levels stringArray     MISP: Only events with matching threat levels [1-4]
      --misp-period strings         MISP: Only events within time-frame (4d, 3w, ...)
      --misp-published              MISP: Only published events
      --misp-published-exclude      MISP: Only unpublished events
      --misp-tags stringArray       MISP: Only events with matching tags
      --misp-url string             MISP: Instance API base URL
      --misp-warning-include        MISP: Include attributes listed on warning-list
      --misp-workers int            MISP: Number of concurrent workers (default 20)
  -q, --quiet                       Only output error information
  -s, --source string               Source backend [misp]
      --status-set string           Set status on all rules [experimental, testing, stable]
      --tags-add stringArray        Add tags on all rules
      --tags-clear                  Clear tags from all rules
      --tags-rm stringArray         Remove tags from all rules
      --tags-set stringArray        Set tags on all rules
  -t, --target string               Target backend [stdout, directory] (default "stdout")
  -v, --verbose                     Show debug information

Sources

A source is the origin from which data will be fetched in order to generate Sigma rules. Currently, MISP is the only implemented source.

A source can be defined through the --source flag (shorthand -s). Currently, the only acceptable value for this flag is misp.

MISP

Importing events from MISP can be done by specifying misp as source. When using MISP, The following flags are required:

Flag Description
--misp-url The URL at which the MISP instance API can be queried (i.e. https://localhost).
--misp-key A User API key authorized to query the MISP instance.
Use Cases

A sample sigmai command would be as follows:

sigmai -t stdout -s misp --misp-url https://localhost --misp-key CAFEBABE== --misp-levels 1,2

The above command sends the Sigma rules to the stdout target (-t; more on that later). The Sigma rules are to be generated from the misp source (-s). In MISP, we'll solely generate Sigma rules for event's with a level (--misp-levels) of high (1) or medium (2). For the eligible events, only attributes flagged for IDS (decent enough for detection) will be used. Furthermore, any attribute on a warning list (a.k.a. subject to false positives) won't be included.

As an example, this is how a generated multi-document Sigma rule would look like if imported from MISP:

action: global
title: 'Related IoCs to https://cert.gov.ua/article/39708 - Cyberattack on state organizations
  of Ukraine using the topic "Azovstal" and the malicious program Cobalt Strike Beacon
  (CERT-UA # 4490)'
id: 1b2b6e15-3655-4648-afcb-c93214187736
status: experimental
description: See MISP event 6803
author: CIRCL
level: high
tags:
  - type:OSINT
  - osint:lifetime="perpetual"
  - osint:certainty="50"
  - tlp:white
  - misp-galaxy:target-information="Ukraine"
  - misp-galaxy:tool="Cobalt Strike"
  - misp-galaxy:tool="Trick Bot"
---
action: global
logsource:
  product: windows
---
detection:
  condition: all of event6803attr2265257mapping*
  event6803attr2265257mappingHostname:
    - - DestinationHostname: kitchenbath.mckillican.com
      - SourceHostname: kitchenbath.mckillican.com
      - Computer: kitchenbath.mckillican.com
      - ComputerName: kitchenbath.mckillican.com
      - Workstation: kitchenbath.mckillican.com
      - WorkstationName: kitchenbath.mckillican.com
---
detection:
  condition: all of event6803attr2265258mapping*
  event6803attr2265258mappingHostname:
    - - DestinationHostname: www.15ns84-fedex.us
      - SourceHostname: www.15ns84-fedex.us
      - Computer: www.15ns84-fedex.us
      - ComputerName: www.15ns84-fedex.us
      - Workstation: www.15ns84-fedex.us
      - WorkstationName: www.15ns84-fedex.us
---
// Some more domain-related detections
---
detection:
  condition: event6803object276948 and all of event6803object276948attr2265319mapping*
  event6803object276948:
    - Hashes|contains:
        - 877f834e8788d05b625ba639b9318512
        - 96bde83f4d3f29fb2801cd357c1abea827487e37
        - ea9dae45f81fe3527c62ad7b84b03d19629014b1a0e346b6aa933e52b0929d8a
        - cf72096dee679bce8cde6eacf922b5559dbac9b77367a7f2a3fba5022fd2b1303aa1c5805167c3cb8fb774e7390fab86eb3d16585fc72c31497a08bdf2b26518
        - 768:pdzHDjCxD6czZ8K1PjOoDl8SZbKsLRGKpb8rGYrMPelwhKmFV5xtezEs/48/dgAX:pVHDjCxD6czZ8K1PjOoDl8SZbKsLRGKM
  event6803object276948attr2265319mappingFilename:
    - - Image|endswith: ea9dae45f81fe3527c62ad7b84b03d19629014b1a0e346b6aa933e52b0929d8a
      - ProcessName|contains: ea9dae45f81fe3527c62ad7b84b03d19629014b1a0e346b6aa933e52b0929d8a
---
// Some more file-related detections
---
detection:
  condition: event6803
  event6803:
    - DestinationIp:
        - 84.32.188.29
        - 139.60.161.225
        - 139.60.161.74
        - 139.60.161.62
        - 139.60.161.99
        - 139.60.161.57
        - 139.60.161.75
        - 139.60.161.24
        - 139.60.161.89
        - 139.60.161.209
        - 139.60.161.85
        - 139.60.160.51
        - 139.60.161.226
        - 139.60.161.216
        - 139.60.161.163
        - 139.60.160.8
        - 139.60.161.32
        - 139.60.161.45
        - 139.60.161.60
        - 139.60.160.17
    - Hashes|contains:
        - 6f0ddfe6b68ea68b5e450e30b131137b6f01c60cc8383f3c48bea0c8acb6ef1c
        - 9990fe0d8aac0b4a6040d5979afd822c2212d9aec2b90e5d10c0b15dee8d61b1
        - df58100f881e2bfa694e00dd06bdb326b272a51ff9b75114819498a26bf6504c
        - ea9dae45f81fe3527c62ad7b84b03d19629014b1a0e346b6aa933e52b0929d8a
---
action: global
logsource:
  category: proxy
---
detection:
  condition: all of event6803attr2265246mapping*
  event6803attr2265246mappingURI:
    - - c-uri: https://e5qo83-fedex.us/wzlco?VLakox?80934612
      - cs-referrer: https://e5qo83-fedex.us/wzlco?VLakox?80934612
      - r-dns: https://e5qo83-fedex.us/wzlco?VLakox?80934612
---
detection:
  condition: all of event6803attr2265247mapping*
  event6803attr2265247mappingURI:
    - - c-uri: http://138.68.229.0/pe.dll
      - cs-referrer: http://138.68.229.0/pe.dll
      - r-dns: http://138.68.229.0/pe.dll
---
// Some more proxy-related detections
---
detection:
  condition: event6803
  event6803:
    - dst_ip:
        - 84.32.188.29
        - 139.60.161.225
        - 139.60.161.74
        - 139.60.161.62
        - 139.60.161.99
        - 139.60.161.57
        - 139.60.161.75
        - 139.60.161.24
        - 139.60.161.89
        - 139.60.161.209
        - 139.60.161.85
        - 139.60.160.51
        - 139.60.161.226
        - 139.60.161.216
        - 139.60.161.163
        - 139.60.160.8
        - 139.60.161.32
        - 139.60.161.45
        - 139.60.161.60
        - 139.60.160.17
---
action: global
logsource:
  category: webserver
---
detection:
  condition: all of event6803attr2265246mapping*
  event6803attr2265246mappingURI:
    - - c-uri: https://e5qo83-fedex.us/wzlco?VLakox?80934612
      - cs-referrer: https://e5qo83-fedex.us/wzlco?VLakox?80934612
      - r-dns: https://e5qo83-fedex.us/wzlco?VLakox?80934612
---
// Many more log-sources (firewall, proxy, webserver, ...) are trimmed for readability...
Specific Events

Alternatively, you might wish to import a specific set of events. To do so, you might use the --misp-events flag as follows:

sigmai -t stdout -s misp --misp-url https://localhost --misp-key CAFEBABE== --misp-events 123,456,789

The above command will import the events with IDs 123, 456 and 789.

Searching Events

You can also import events whose description contains one of the specified case-sensitive sub-string. To do so, you would need to use the --misp-keywords flag as follows:

sigmai -t stdout -s misp --misp-url https://localhost --misp-key CAFEBABE== --misp-keywords emotet,zloader

The above command will import all events whose description contains either the emotet or zloader substring.

Targets

A target is a way to select where to send the generated Sigma rules.

Defining the target can be done using the --target flag (shorthand -t). Currently, both stdout and directory are implemented.

Stdout

This target outputs the generated Sigma rules to the standard output. It can be selected by using stdout as the --target flag's value.

Do note that all other logging is send to the standard error, which enables you to split logging and generated Sigma rules.

Directory

This target output's the generated Sigma rules into a directory, which defaults to the current one. It can be selected by using directory as the --target flag's value.

Additionally, one may change the path using the --directory-path flag.

Modifiers

The sigmai tool comes with some additional modifiers to ensure the generated rules meet your existing standard.

Tags

More specifically, one can modify the imported rule's tags by using the beneath flags.

Flag Description
--tags-add A flag with a comma-separated list of tags to be added to the current ones.
--tags-rm A flag with a comma-separated list of tags to be removed if present in the current ones.
--tags-set A flag with a comma-separated list of tags to overwrite the current ones.
--tags-clear A flag clearing all tags, resulting in tag-less rules.

Level

You can also override the rules by defining a common level using the --level-set flag.

Status

As for levels, sigmai enables you to override the status of all rules by using the --status-set flag.

Continuous Importing

It is possible to run sigmai continuously a bit like a cron job would. The --interval flag (shorthand -i) defines an interval at which an import should be done.

This flag can be combined with source's period-filters such as MISP's --misp-period flag. As an example, the beneath command will import the last 15 minutes of MISP events as Sigma rules every 10 minutes.

sigmai -t directory --directory-path ~/rules -i 10m -s misp --misp-url https://localhost --misp-key CAFEBABE== --misp-period 15m

Tips & Tricks

Filter Your Queries

The sigmai-generated queries will hopefully cover more cases (log-sources, platforms, ...) than you actually need. Did you know that when compiling the Sigma rules with sigmac, you can filter rules to match your use-cases through the --filter flag (shorthand -f)?

Acknowledgements

Development of this project has been supported by NVISO Labs. Interested in this project? You might fit with us!

Many thanks to Florian Roth for his valuable feedback and without whom we wouldn't have Sigma in the first place.

License

© Maxime Thiebaut, 2020 — Licensed under the EUPL.