Go to file
Alexandre Dulaunoy ab6f94d7c0
Merge pull request #82 from MISP/dependabot/pip/cryptography-41.0.4
build(deps): bump cryptography from 41.0.3 to 41.0.4
2023-09-22 09:50:43 +02:00
MUA python3 2017-05-24 15:49:49 +02:00
certs new: Add support for STARTTLS and SSL 2018-05-07 11:22:52 +02:00
mail2misp chg: Bump deps 2023-02-16 16:17:37 +01:00
tests chg: Bump config test 2021-09-30 11:46:36 +02:00
.gitignore chg: add gitignore, cleanup 2018-05-04 14:24:02 +02:00
.gitmodules - Remove submodule again as I noticed it was already present, sorry… 2018-06-12 23:50:34 +09:00
.travis.yml fix: [travis] chardet dep 2021-09-30 09:50:32 +09:00
LICENSE Create LICENSE 2017-10-13 16:59:01 +02:00
README.md chg: [doc] travis link 2021-10-01 12:47:35 +09:00
__init__.py new: Make it a lib, add test cases 2018-05-14 17:42:06 -04:00
fake_smtp.py chg: [smtp] Added ident option 2021-10-01 11:26:56 +09:00
fake_smtp_config.py-example chg: [smtp] Added ident option 2021-10-01 11:26:56 +09:00
mail_to_misp.py chg: Cleanup, bump deps, bump readme 2020-06-16 12:03:59 +02:00
mail_to_misp_config.py-example new: [tag] Added an id tag the event if multiple m2m instances are used 2021-09-30 14:55:39 +09:00
mail_to_misp_forward.py new: Support email forwarding 2018-05-07 14:02:01 +02:00
poetry.lock build(deps): bump cryptography from 41.0.3 to 41.0.4 2023-09-21 21:22:42 +00:00
pyproject.toml chg: Bump deps 2023-08-21 14:31:22 +02:00
requirements.txt chg: Bump req file 2023-08-21 14:32:12 +02:00
setup.py new: Add setup.py 2019-07-18 16:34:05 +02:00


Build Status codecov


Connect your mail infrastructure to MISP in order to create events based on the information contained within mails.


  • Extraction of URLs and IP addresses (and port numbers) from free text emails
  • Extraction of hostnames from URLs
  • Extraction of hashes (MD5, SHA1, SHA256)
  • DNS expansion
  • Custom filter list for lines containing specific words
  • Subject filters
  • Respecting TLP classification mentioned in free text (including optional spelling robustness)
  • Refanging of URLs ('hxxp://...')
  • Add tags automatically based on key words (configurable)
  • Add tags automatically depending on the presence of other tags (configurable)
  • Add tags automatically depending on presence of hashes (e.g. for automatic expansion)
  • Ignore 'whitelisted' domains (configurable)
  • Specify a stop word term to no further process input
  • Configurable list of attributes not to enable the IDS flag
  • Automatically create 'external analysis' links based on filter list (e.g. VirusTotal, malwr.com)
  • Automatically create 'internal reference' links based on filter list
  • Detection of forwarded messages
  • Process attachments as malware samples or specify that they are processed as benign files (m2m_attachment_keyword)

You can send mails with attachments to mail_to_misp and tell it, to treat the attachment as a benign document (in contrast to the default behaviour: treating it as a malware sample). You need to set a keyword in the configuration: m2m_attachment_keyword = 'attachment:benign'

  • Logging to syslog
  • Remove "[tags]", "Re:" and "Fwd:" from subjects
  • Optionally attach entire mail to event
  • Contains now a fake-smtpd spamtrap which delivers IoCs/mails to MISP
  • Automatically filter out attributes that are on a server side warning list (enforcewarninglist=True)
  • Support for value sighting (sighting=True, sighting_source="YOUR_MAIL_TO_MISP_IDENTIFIER")
  • Auto-publish when key:yourkey is specified in mail (configurable, m2m_key, m2m_auto_distribution) The m2m_key configuration is used to specify a secret only you and your users know. If you know the key, you can send a mail to your mail_to_misp instance, and when this key is present in the body of the message, it will automatically publish the event. So let's assume your config says: m2m_key = 'ABCDEFGHIJKLMN0PQRSTUVWXYZ' If you send a mail to mail_to_misp containing: key:ABCDEFGHIJKLMN0PQRSTUVWXYZ the event is automatically published. If you don't want to use this feature, just don't put it in the message body. The distribution is defined in the configuration as well: m2m_auto_distribution = '3' # 3 = All communities

For OSINT collection purposes (like collecting URLs to OSINT reports), you can tell mail_to_misp to only extract URLs (--urlsonly) and append them to a predefined MISP event (--event N). The subject of such a mail goes into the comment field of the value.


osinturlcollection: "|/path/to/mail_to_misp.py --urlsonly --event 12345 -"

Pass parameters in the email body


# Examples
m2m:attachment:benign  # Email attachment considered benign (attachment in MISP, malware-sample by default)
m2m:attach_original_mail:1  # Attach the full original email to the MISP Event (may contain private information)

m2m:m2mkey:YOUSETYOURKEYHERE  # Key required for some actions
# The following key are ignored if M2M:m2mkey is invalid
m2m:distribution:<0-3,5> # Note: impossible to pass a sharing group yet.
m2m:publish:1  # Autopublish


The implemented workflow is mainly for mail servers like Postfix. Client side implementations exist but are no longer supported:

  1. Postfix and others

Email -> mail_to_misp

  1. Apple Mail [unmaintained]

Email -> Apple Mail -> Mail rule -> AppleScript -> mail_to_misp -> PyMISP -> MISP

  1. Mozilla Thunderbird [unmaintained]

Email -> Thunderbird -> Mail rule -> filterscript -> thunderbird_wrapper -> mail_to_misp -> PyMISP -> MISP


Postfix (or other MTA) - preferred method

  1. Setup a new email address in the aliases file (e.g. /etc/aliases) and configure the correct path:

misp_handler: "|/path/to/mail_to_misp.py -"

  1. Rebuild the DB:

$ sudo newaliases

  1. Configure mail_to_misp_config.py

You should now be able to send your IoC-containing mails to misp_handler@YOURDOMAIN.

Bonus: Fake-SMTPD spamtrap

If you want to process all incoming junk mails automatically and collect the contained information in a separate throw-away MISP instance, you could use the fake_smtp.py script. It listens on port 25, accepts all mails and pushes them through mail_to_misp to a MISP instance. It can also be configured to listen on an SSL port. (465)

  1. Configure mail_to_misp_config.py

  2. cp fake_smtp_config.py-example fake_smtp_config.py

  3. Make port 25 accessible to normal users

$ sudo apt install authbind
$ sudo touch /etc/authbind/byport/25
$ sudo chown misp:misp /etc/authbind/byport/25
$ sudo chmod 770 /etc/authbind/byport/25
  1. Run fake_smtp.py

$ python3 fake_smtp.py

Apple Mail [unmaintained]

  1. Mail rule script
  • git clone this repository
  • open the AppleScript file MUA/Apple/Mail/MISP Mail Rule Action.txt in Apple's 'Script Editor'
  • adjust the path to the python installation and location of the mail_to_misp.py script
  • save it in ~/Library/Application Scripts/com.apple.mail/
  1. Create a mail rule based on your needs, executing the AppleScript defined before
  2. Configure mail_to_misp_config.py

Thunderbird [unmaintained]

  1. Git clone https://github.com/rommelfs/filterscript and install plugin (instructions within the project description)
  2. Mail rule script
  • git clone this repository
  • open the bash script MUA/Mozilla/Thunderbird/thunderbird_wrapper.sh and adujst the paths
  • adjust the path to the python installation and location of the mail_to_misp.py script
  1. Create a mail rule based on your needs, executing the thunderbird_wrapper.sh script
  2. Configure mail_to_misp_config.py

You should be able to create MISP events now.

Outlook [unmaintained]

Outlook is not implemented due to lack of test environment. However, it should be feasible to do it this way:

import win32com.client
import pythoncom

class Handler_Class(object):
    def OnNewMailEx(self, receivedItemsIDs):
        for ID in receivedItemsIDs.split(","):
            # Microsoft.Office.Interop.Outlook _MailItem properties:
            # https://msdn.microsoft.com/en-us/library/microsoft.office.interop.outlook._mailitem_properties.aspx
            mailItem = outlook.Session.GetItemFromID(ID)
            print "Subj: " + mailItem.Subject
            print "Body: " + mailItem.Body.encode( 'ascii', 'ignore' )
            print "========"

outlook = win32com.client.DispatchWithEvents("Outlook.Application", Handler_Class)

(from: https://blog.matthewurch.ca/?p=236)

Obviously, you would like to filter mails based on subject or from address and pass subject and body to mail_to_misp.py in order to do something useful. Pull-requests welcome for actual implementations :)


The easy way

pip install --user poetry

# Install other python requirements
poetry install -E fileobjects -E openioc -E virustotal -E email -E url

# Test if the script is working
./mail_to_misp.py -h


Thunderbird [unmaintained]


This software is licensed under GNU Affero General Public License version 3

  • Copyright (C) 2017 - 2019 Sascha Rommelfangen, Raphaël Vinot
  • Copyright (C) 2017 - 2021 CIRCL - Computer Incident Response Center Luxembourg