# Multidecoder
<a href="https://pypi.org/project/multidecoder/#history"><img src="https://img.shields.io/pypi/v/multidecoder.svg" alt="Latest Stable Release"></a>
Multidecoder is a python library and command line tool for extracting indicators of compromise (IOCs) from a file.
Multidecoder preserves the context of where and how an IOC is found to allow automated detection of patterns of obfuscation.
Multidecoder is currently in alpha, and may change in ways that breaks backwards compatibility as developement continues.
Indicators of compromise extracted by Multidecoder:
- network IOCS: urls, domains, emails, ip addressses
- executable filenames
- embedded PowerShell
- embedded PE files
- a customizable set of keywords
Deobfuscations and decodings supported:
- base64 encoding
- hexadecimal encoding
- string concatenation
- powershell escape characters
## Installing
Multidecoder can be installed from pypi using pip:
```
pip install -U multidecoder
```
Alternatly, it can also be installed from the repository:
```
pip install -U https://github.com/CybercentreCanada/Multidecoder/archive/main.zip
```
To test the latest development version, install from the dev branch:
```
pip install -U https://github.com/CybercenterCanada/Multidecoder/archive/dev.zip
```
## Command Line
After being installed Multidecoder can be run on a file from the command-line
```
> multidecoder file
```
which will output a list of indicators found.
Indicators are printed one per line, with a string representation of the context of the indicator followed by the indicator.
The raw json result can be output with the `--json` flag
```
> multidecoder --json file
```
if no filename is given multidecoder takes its standard input as the file to be scanned.
## Python library
Multidecoder can be used as a python library through the Multidecoder class,
which can scan data to give a dictionary tree similar to the command-line json output.
```
from multidecoder.multidecoder import Multidecoder
md = Multidecoder()
context_tree = md.scan(data)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/CybercentreCanada/Multidecoder",
"name": "multidecoder",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "malware, analysis, gc, canada, cse-cst, cse, cst, cyber, cccs",
"author": "CCCS Assemblyline development team",
"author_email": "assemblyline@cyber.gc.ca",
"download_url": "https://files.pythonhosted.org/packages/0d/54/b8eac7f7086534543e87e7b64eb343ac2acc4b9678053c51c5708e8c72b0/multidecoder-1.3.3.tar.gz",
"platform": null,
"description": "# Multidecoder\n\n<a href=\"https://pypi.org/project/multidecoder/#history\"><img src=\"https://img.shields.io/pypi/v/multidecoder.svg\" alt=\"Latest Stable Release\"></a>\n\nMultidecoder is a python library and command line tool for extracting indicators of compromise (IOCs) from a file.\nMultidecoder preserves the context of where and how an IOC is found to allow automated detection of patterns of obfuscation.\nMultidecoder is currently in alpha, and may change in ways that breaks backwards compatibility as developement continues.\n\nIndicators of compromise extracted by Multidecoder:\n- network IOCS: urls, domains, emails, ip addressses\n- executable filenames\n- embedded PowerShell\n- embedded PE files\n- a customizable set of keywords\n\nDeobfuscations and decodings supported:\n- base64 encoding\n- hexadecimal encoding\n- string concatenation\n- powershell escape characters\n\n## Installing\n\nMultidecoder can be installed from pypi using pip:\n```\npip install -U multidecoder\n```\n\nAlternatly, it can also be installed from the repository:\n```\npip install -U https://github.com/CybercentreCanada/Multidecoder/archive/main.zip\n```\n\nTo test the latest development version, install from the dev branch:\n```\npip install -U https://github.com/CybercenterCanada/Multidecoder/archive/dev.zip\n```\n\n## Command Line\n\nAfter being installed Multidecoder can be run on a file from the command-line\n```\n> multidecoder file\n```\nwhich will output a list of indicators found.\nIndicators are printed one per line, with a string representation of the context of the indicator followed by the indicator.\n\nThe raw json result can be output with the `--json` flag\n```\n> multidecoder --json file\n```\n\nif no filename is given multidecoder takes its standard input as the file to be scanned.\n\n## Python library\n\nMultidecoder can be used as a python library through the Multidecoder class,\nwhich can scan data to give a dictionary tree similar to the command-line json output.\n```\nfrom multidecoder.multidecoder import Multidecoder\n\nmd = Multidecoder()\ncontext_tree = md.scan(data)\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A context preserving IOC extraction library",
"version": "1.3.3",
"project_urls": {
"Bug Tracker": "https://github.com/CybercentreCanada/Multidecoder/issues",
"Homepage": "https://github.com/CybercentreCanada/Multidecoder"
},
"split_keywords": [
"malware",
" analysis",
" gc",
" canada",
" cse-cst",
" cse",
" cst",
" cyber",
" cccs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c64b8900a51dfa0d7ea72e6c57aa15f8134df6876d6d1d56b1fbf41dccb51a0c",
"md5": "6265c4dd730e499bc4493eecc7b0e323",
"sha256": "57837ff174b486a035c84b4c8eeda4282c7268ed188a34010760c98588f63117"
},
"downloads": -1,
"filename": "multidecoder-1.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6265c4dd730e499bc4493eecc7b0e323",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 105080,
"upload_time": "2024-04-24T19:26:53",
"upload_time_iso_8601": "2024-04-24T19:26:53.717076Z",
"url": "https://files.pythonhosted.org/packages/c6/4b/8900a51dfa0d7ea72e6c57aa15f8134df6876d6d1d56b1fbf41dccb51a0c/multidecoder-1.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0d54b8eac7f7086534543e87e7b64eb343ac2acc4b9678053c51c5708e8c72b0",
"md5": "ffd866543ab6f9a6ae7a20860e7e7637",
"sha256": "081d85c78568a6e57d53ed7b4b1d92a85425c3e2bb0de37ae829cb4d48dfd976"
},
"downloads": -1,
"filename": "multidecoder-1.3.3.tar.gz",
"has_sig": false,
"md5_digest": "ffd866543ab6f9a6ae7a20860e7e7637",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 88432,
"upload_time": "2024-04-24T19:26:54",
"upload_time_iso_8601": "2024-04-24T19:26:54.951459Z",
"url": "https://files.pythonhosted.org/packages/0d/54/b8eac7f7086534543e87e7b64eb343ac2acc4b9678053c51c5708e8c72b0/multidecoder-1.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-24 19:26:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CybercentreCanada",
"github_project": "Multidecoder",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "multidecoder"
}
JSON
