new: [yara_export] new export module

.github/workflows/python-package.yml

@@ -18,7 +18,7 @@ jobs:
     steps:
     - name: Install packages
       run: |
-        sudo apt-get install libpoppler-cpp-dev libzbar0 tesseract-ocr
+        sudo apt-get install libpoppler-cpp-dev libzbar0 tesseract-ocr yara
     - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v5

documentation/README.md

@@ -260,7 +260,7 @@ Module to expand country codes.
 
 An expansion module to query the CVE search API with a cpe code to get its related vulnerabilities.
 - **features**:
->The module takes a cpe attribute as input and queries the CVE search API to get its related vulnerabilities.
+>The module takes a cpe attribute as input and queries the CVE search API to get its related vulnerabilities.  
 >The list of vulnerabilities is then parsed and returned as vulnerability objects.
 >
 >Users can use their own CVE search API url by defining a value to the custom_API_URL parameter. If no custom API url is given, the default vulnerability.circl.lu api url is used.
@@ -766,7 +766,7 @@ Expansion module to fetch the html content from an url and convert it into markd
 HYAS Insight integration to MISP provides direct, high volume access to HYAS Insight data. It enables investigators and analysts to understand and defend against cyber adversaries and their infrastructure.
 - **features**:
 >This Module takes the IP Address, Domain, URL, Email, Phone Number, MD5, SHA1, Sha256, SHA512 MISP Attributes as input to query the HYAS Insight API.
-> The results of the HYAS Insight API are than are then returned and parsed into Hyas Insight Objects.
+> The results of the HYAS Insight API are than are then returned and parsed into Hyas Insight Objects. 
 >
 >An API key is required to submit queries to the HYAS Insight API.
 >
@@ -840,9 +840,9 @@ Module to access intelmqs eventdb.
 
 An expansion module to query IP2Location.io to gather more information on a given IP address.
 - **features**:
->The module takes an IP address attribute as input and queries the IP2Location.io API.
->Free plan user will get the basic geolocation informaiton, and different subsription plan will get more information on the IP address.
-> Refer to [pricing page](https://www.ip2location.io/pricing) for more information on data available for each plan.
+>The module takes an IP address attribute as input and queries the IP2Location.io API.  
+>Free plan user will get the basic geolocation informaiton, and different subsription plan will get more information on the IP address. 
+> Refer to [pricing page](https://www.ip2location.io/pricing) for more information on data available for each plan. 
 >
 >More information on the responses content is available in the [documentation](https://www.ip2location.io/ip2location-documentation).
 - **input**:
@@ -878,7 +878,7 @@ Module to query an IP ASN history service (https://github.com/D4-project/IPASN-H
 
 An expansion module to query ipinfo.io to gather more information on a given IP address.
 - **features**:
->The module takes an IP address attribute as input and queries the ipinfo.io API.
+>The module takes an IP address attribute as input and queries the ipinfo.io API.  
 >The geolocation information on the IP address is always returned.
 >
 >Depending on the subscription plan, the API returns different pieces of information then:
@@ -904,7 +904,7 @@ An expansion module to query ipinfo.io to gather more information on a given IP
 IPQualityScore MISP Expansion Module for IP reputation, Email Validation, Phone Number Validation, Malicious Domain and Malicious URL Scanner.
 - **features**:
 >This Module takes the IP Address, Domain, URL, Email and Phone Number MISP Attributes as input to query the IPQualityScore API.
-> The results of the IPQualityScore API are than returned as IPQS Fraud and Risk Scoring Object.
+> The results of the IPQualityScore API are than returned as IPQS Fraud and Risk Scoring Object. 
 > The object contains a copy of the enriched attribute with added tags presenting the verdict based on fraud score,risk score and other attributes from IPQualityScore.
 - **input**:
 >A MISP attribute of type IP Address(ip-src, ip-dst), Domain(hostname, domain), URL(url, uri), Email Address(email, email-src, email-dst, target-email, whois-registrant-email) and Phone Number(phone-number, whois-registrant-phone).
@@ -1243,7 +1243,7 @@ Module to get information from AlienVault OTX.
 An expansion module to query the CIRCL Passive SSH.
 - **features**:
 >The module queries the Passive SSH service from CIRCL.
->
+> 
 > The module can be used an hover module but also an expansion model to add related MISP objects.
 >
 - **input**:
@@ -1965,7 +1965,7 @@ Module to query a local instance of uwhois (https://github.com/rafiot/uwhoisd).
 <img src=logos/whoisfreaks.png height=60>
 
 An expansion module for https://whoisfreaks.com/ that will provide an enriched analysis of the provided domain, including WHOIS and DNS information.
-Our Whois service, DNS Lookup API, and SSL analysis, equips organizations with comprehensive threat intelligence and attack surface analysis capabilities for enhanced security.
+Our Whois service, DNS Lookup API, and SSL analysis, equips organizations with comprehensive threat intelligence and attack surface analysis capabilities for enhanced security. 
 Explore our website's product section at https://whoisfreaks.com/ for a wide range of additional services catering to threat intelligence and attack surface analysis needs.
 - **features**:
 >The module takes a domain as input and queries the Whoisfreaks API with it.
@@ -2104,7 +2104,7 @@ Module to process a query on Yeti.
 > - https://github.com/sebdraven/pyeti
 - **requirements**:
 > - pyeti
-> - API key
+> - API key 
 
 -----
 
@@ -2261,7 +2261,7 @@ Simple export of a MISP event to PDF.
 >  'Activate_galaxy_description' is a boolean (True or void) to activate the description of event related galaxies.
 >  'Activate_related_events' is a boolean (True or void) to activate the description of related event. Be aware this might leak information on confidential events linked to the current event !
 >  'Activate_internationalization_fonts' is a boolean (True or void) to activate Noto fonts instead of default fonts (Helvetica). This allows the support of CJK alphabet. Be sure to have followed the procedure to download Noto fonts (~70Mo) in the right place (/tools/pdf_fonts/Noto_TTF), to allow PyMisp to find and use them during PDF generation.
->  'Custom_fonts_path' is a text (path or void) to the TTF file of your choice, to create the PDF with it. Be aware the PDF won't support bold/italic/special style anymore with this option
+>  'Custom_fonts_path' is a text (path or void) to the TTF file of your choice, to create the PDF with it. Be aware the PDF won't support bold/italic/special style anymore with this option 
 - **input**:
 >MISP Event
 - **output**:
@@ -2357,6 +2357,25 @@ This module is used to create a VirusTotal Graph from a MISP event.
 
 -----
 
+#### [yara_export](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/export_mod/yara_export.py)
+
+<img src=logos/yara.png height=60>
+
+This module is used to export MISP events to YARA.
+- **features**:
+>The module will dynamically generate YARA rules for attributes that are marked as to IDS. Basic metadata about the event is added to the rule.
+>Attributes that are already YARA rules are also exported, with a rewritten rule name.
+- **input**:
+>Attributes and Objects.
+- **output**:
+>A YARA file that can be used with the YARA scanning tool.
+- **references**:
+>https://virustotal.github.io/yara/
+- **requirements**:
+>yara-python python library
+
+-----
+
 ## Import Modules
 
 #### [cof2misp](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/import_mod/cof2misp.py)

documentation/generate_documentation.py

@@ -1,7 +1,6 @@
 # -*- coding: utf-8 -*-
 import os
 import json
-import sys
 from pathlib import Path
 
 module_types = ['expansion', 'export_mod', 'import_mod']

documentation/mkdocs/expansion.md

@@ -257,7 +257,7 @@ Module to expand country codes.
 
 An expansion module to query the CVE search API with a cpe code to get its related vulnerabilities.
 - **features**:
->The module takes a cpe attribute as input and queries the CVE search API to get its related vulnerabilities.
+>The module takes a cpe attribute as input and queries the CVE search API to get its related vulnerabilities.  
 >The list of vulnerabilities is then parsed and returned as vulnerability objects.
 >
 >Users can use their own CVE search API url by defining a value to the custom_API_URL parameter. If no custom API url is given, the default vulnerability.circl.lu api url is used.
@@ -763,7 +763,7 @@ Expansion module to fetch the html content from an url and convert it into markd
 HYAS Insight integration to MISP provides direct, high volume access to HYAS Insight data. It enables investigators and analysts to understand and defend against cyber adversaries and their infrastructure.
 - **features**:
 >This Module takes the IP Address, Domain, URL, Email, Phone Number, MD5, SHA1, Sha256, SHA512 MISP Attributes as input to query the HYAS Insight API.
-> The results of the HYAS Insight API are than are then returned and parsed into Hyas Insight Objects.
+> The results of the HYAS Insight API are than are then returned and parsed into Hyas Insight Objects. 
 >
 >An API key is required to submit queries to the HYAS Insight API.
 >
@@ -837,9 +837,9 @@ Module to access intelmqs eventdb.
 
 An expansion module to query IP2Location.io to gather more information on a given IP address.
 - **features**:
->The module takes an IP address attribute as input and queries the IP2Location.io API.
->Free plan user will get the basic geolocation informaiton, and different subsription plan will get more information on the IP address.
-> Refer to [pricing page](https://www.ip2location.io/pricing) for more information on data available for each plan.
+>The module takes an IP address attribute as input and queries the IP2Location.io API.  
+>Free plan user will get the basic geolocation informaiton, and different subsription plan will get more information on the IP address. 
+> Refer to [pricing page](https://www.ip2location.io/pricing) for more information on data available for each plan. 
 >
 >More information on the responses content is available in the [documentation](https://www.ip2location.io/ip2location-documentation).
 - **input**:
@@ -875,7 +875,7 @@ Module to query an IP ASN history service (https://github.com/D4-project/IPASN-H
 
 An expansion module to query ipinfo.io to gather more information on a given IP address.
 - **features**:
->The module takes an IP address attribute as input and queries the ipinfo.io API.
+>The module takes an IP address attribute as input and queries the ipinfo.io API.  
 >The geolocation information on the IP address is always returned.
 >
 >Depending on the subscription plan, the API returns different pieces of information then:
@@ -901,7 +901,7 @@ An expansion module to query ipinfo.io to gather more information on a given IP
 IPQualityScore MISP Expansion Module for IP reputation, Email Validation, Phone Number Validation, Malicious Domain and Malicious URL Scanner.
 - **features**:
 >This Module takes the IP Address, Domain, URL, Email and Phone Number MISP Attributes as input to query the IPQualityScore API.
-> The results of the IPQualityScore API are than returned as IPQS Fraud and Risk Scoring Object.
+> The results of the IPQualityScore API are than returned as IPQS Fraud and Risk Scoring Object. 
 > The object contains a copy of the enriched attribute with added tags presenting the verdict based on fraud score,risk score and other attributes from IPQualityScore.
 - **input**:
 >A MISP attribute of type IP Address(ip-src, ip-dst), Domain(hostname, domain), URL(url, uri), Email Address(email, email-src, email-dst, target-email, whois-registrant-email) and Phone Number(phone-number, whois-registrant-phone).
@@ -1240,7 +1240,7 @@ Module to get information from AlienVault OTX.
 An expansion module to query the CIRCL Passive SSH.
 - **features**:
 >The module queries the Passive SSH service from CIRCL.
->
+> 
 > The module can be used an hover module but also an expansion model to add related MISP objects.
 >
 - **input**:
@@ -1962,7 +1962,7 @@ Module to query a local instance of uwhois (https://github.com/rafiot/uwhoisd).
 <img src=../logos/whoisfreaks.png height=60>
 
 An expansion module for https://whoisfreaks.com/ that will provide an enriched analysis of the provided domain, including WHOIS and DNS information.
-Our Whois service, DNS Lookup API, and SSL analysis, equips organizations with comprehensive threat intelligence and attack surface analysis capabilities for enhanced security.
+Our Whois service, DNS Lookup API, and SSL analysis, equips organizations with comprehensive threat intelligence and attack surface analysis capabilities for enhanced security. 
 Explore our website's product section at https://whoisfreaks.com/ for a wide range of additional services catering to threat intelligence and attack surface analysis needs.
 - **features**:
 >The module takes a domain as input and queries the Whoisfreaks API with it.
@@ -2101,6 +2101,6 @@ Module to process a query on Yeti.
 > - https://github.com/sebdraven/pyeti
 - **requirements**:
 > - pyeti
-> - API key
+> - API key 
 
 -----

documentation/mkdocs/export_mod.md

@@ -245,3 +245,22 @@ This module is used to create a VirusTotal Graph from a MISP event.
 >vt_graph_api, the python library to query the VirusTotal graph API
 
 -----
+
+#### [yara_export](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/export_mod/yara_export.py)
+
+<img src=../logos/yara.png height=60>
+
+This module is used to export MISP events to YARA.
+- **features**:
+>The module will dynamically generate YARA rules for attributes that are marked as to IDS. Basic metadata about the event is added to the rule.
+>Attributes that are already YARA rules are also exported, with a rewritten rule name.
+- **input**:
+>Attributes and Objects.
+- **output**:
+>A YARA file that can be used with the YARA scanning tool.
+- **references**:
+>https://virustotal.github.io/yara/
+- **requirements**:
+>yara-python python library
+
+-----

documentation/website/export_mod/yara_export.json

@@ -0,0 +1,13 @@
+{
+    "description": "This module is used to export MISP events to YARA.",
+    "logo": "yara.png",
+    "requirements": [
+        "yara-python python library"
+    ],
+    "features": "The module will dynamically generate YARA rules for attributes that are marked as to IDS. Basic metadata about the event is added to the rule.\nAttributes that are already YARA rules are also exported, with a rewritten rule name.",
+    "references": [
+        "https://virustotal.github.io/yara/"
+    ],
+    "input": "Attributes and Objects.",
+    "output": "A YARA file that can be used with the YARA scanning tool."
+}