Python tools to analyze security characteristics of MS Office and OLE files (also called Structured Storage, Compound File Binary Format or Compound Document File Format), for Malware Analysis and Incident Response #DFIR
|PyPI| |Build Status| |Say Thanks!|
oletools <http://www.decalage.info/python/oletools>__ is a package of
python tools to analyze Microsoft OLE2 files <http://en.wikipedia.org/wiki/Compound_File_Binary_Format>__
(also called Structured Storage, Compound File Binary Format or Compound
Document File Format), such as Microsoft Office 97-2003 documents, MSI
files or Outlook messages, mainly for malware analysis, forensics and
debugging. It is based on the
olefile <http://www.decalage.info/olefile>__ parser.
It also provides tools to analyze RTF files and files based on the
OpenXML format <https://en.wikipedia.org/wiki/Office_Open_XML>__ (aka
OOXML) such as MS Office 2007+ documents, XPS or MSIX files.
For example, oletools can detect, extract and analyse VBA macros, OLE objects, Excel 4 macros (XLM) and DDE links.
See http://www.decalage.info/python/oletools for more info.
Quick links: Home page <http://www.decalage.info/python/oletools>__ -
Download/Install <https://github.com/decalage2/oletools/wiki/Install>__
Documentation <https://github.com/decalage2/oletools/wiki>__ -
Report Issues/Suggestions/Questions <https://github.com/decalage2/oletools/issues>__Contact the Author <http://decalage.info/contact>__ -
Repository <https://github.com/decalage2/oletools>__ - Updates on Twitter <https://twitter.com/decalage2>__
Cheatsheet <https://github.com/decalage2/oletools/blob/master/cheatsheet/oletools_cheatsheet.pdf>__Note: python-oletools is not related to OLETools published by BeCubed Software.
2024-07-02 v0.60.2:
olevba:
oleobj: fixed SyntaxError with Python 3.12 (PR #855), SyntaxWarning (PR #774)
rtfobj: fixed SyntaxError with Python 3.12 (PR #854)
clsid: added CLSIDs for MSI, Zed
ftguess: added MSI, PNG and OneNote formats
pyxswf: fixed python 3.12 compatibility (PR #841, issue #813)
setup/requirements: allow pyparsing 3 to solve install issues (PR #812, issue #762)
2022-05-09 v0.60.1:
olevba:
oleid: fixed OleID init issue (issue #695, PR #696)
oleobj:
rtfobj: fixed code to find URLs in OLE2Link objects for Py3 (issue #692)
ftguess:
improved logging with common module log_helper (PR #449)
2021-06-02 v0.60:
ftguess: new tool to identify file formats and containers (issue #680)
oleid: (issue #679)
olevba:
rtfobj:
crypto: added PowerPoint transparent password '/01Hannes Ruescher/01' (issue #627)
setup: XLMMacroDeobfuscator, xlrd2 and pyxlsb2 added as optional dependencies
See the full changelog <https://github.com/decalage2/oletools/wiki/Changelog>__ for
more information.
Tools to analyze malicious documents
- `oleid <https://github.com/decalage2/oletools/wiki/oleid>`__: to
analyze OLE files to detect specific characteristics usually found in
malicious files.
- `olevba <https://github.com/decalage2/oletools/wiki/olevba>`__: to
extract and analyze VBA Macro source code from MS Office documents
(OLE and OpenXML).
- `MacroRaptor <https://github.com/decalage2/oletools/wiki/mraptor>`__:
to detect malicious VBA Macros
- `msodde <https://github.com/decalage2/oletools/wiki/msodde>`__: to
detect and extract DDE/DDEAUTO links from MS Office documents, RTF
and CSV
- `pyxswf <https://github.com/decalage2/oletools/wiki/pyxswf>`__: to
detect, extract and analyze Flash objects (SWF) that may be embedded
in files such as MS Office documents (e.g. Word, Excel) and RTF,
which is especially useful for malware analysis.
- `oleobj <https://github.com/decalage2/oletools/wiki/oleobj>`__: to
extract embedded objects from OLE files.
- `rtfobj <https://github.com/decalage2/oletools/wiki/rtfobj>`__: to
extract embedded objects from RTF files.
Tools to analyze the structure of OLE files
olebrowse <https://github.com/decalage2/oletools/wiki/olebrowse>__:
A simple GUI to browse OLE files (e.g. MS Word, Excel, Powerpoint
documents), to view and extract individual data streams.olemeta <https://github.com/decalage2/oletools/wiki/olemeta>__: to
extract all standard properties (metadata) from OLE files.oletimes <https://github.com/decalage2/oletools/wiki/oletimes>__:
to extract creation and modification timestamps of all streams and
storages.oledir <https://github.com/decalage2/oletools/wiki/oledir>__: to
display all the directory entries of an OLE file, including free and
orphaned entries.olemap <https://github.com/decalage2/oletools/wiki/olemap>__: to
display a map of all the sectors in an OLE file.oletools are used by a number of projects and online malware analysis
services, including ACE <https://github.com/IntegralDefense/ACE>,
ADAPT <https://www.blackhat.com/eu-23/briefings/schedule/index.html#unmasking-apts-an-automated-approach-for-real-world-threat-attribution-35162>,
Anlyz.io <https://sandbox.anlyz.io/>,
AssemblyLine <https://www.cse-cst.gc.ca/en/assemblyline>, Binary Refinery <https://github.com/binref/refinery>,
CAPE <https://github.com/ctxis/CAPE>,
CinCan <https://cincan.io>, Cortex XSOAR (Palo Alto) <https://cortex.marketplace.pan.dev/marketplace/details/Oletools/>,
Cuckoo Sandbox <https://github.com/cuckoosandbox/cuckoo>,
DARKSURGEON <https://github.com/cryps1s/DARKSURGEON>,
Deepviz <https://sandbox.deepviz.com/>,
DIARIO <https://diario.elevenpaths.com/>,
dridex.malwareconfig.com <https://dridex.malwareconfig.com>, EML Analyzer <https://github.com/ninoseki/eml_analyzer>,
EXPMON <https://pub.expmon.com/>,
FAME <https://certsocietegenerale.github.io/fame/>,
FLARE-VM <https://github.com/fireeye/flare-vm>, GLIMPS Malware <https://www.glimps.fr/en/glimps-malware-2/>,
Hybrid-analysis.com <https://www.hybrid-analysis.com/>, InQuest Labs <https://labs.inquest.net/>,
IntelOwl <https://github.com/certego/IntelOwl>, Joe Sandbox <https://www.document-analyzer.net/>, Laika BOSS <https://github.com/lmco/laikaboss>,
MacroMilter <https://github.com/sbidy/MacroMilter>,
mailcow <https://mailcow.email/>,
malshare.io <https://malshare.io>,
malware-repo <https://github.com/Tigzy/malware-repo>, Malware Repository Framework (MRF) <https://www.adlice.com/download/mrf/>,
MalwareBazaar <https://bazaar.abuse.ch/>,
olefy <https://github.com/HeinleinSupport/olefy>,
Pandora <https://github.com/pandora-analysis/pandora>,
PeekabooAV <https://github.com/scVENUS/PeekabooAV>,
pcodedmp <https://github.com/bontchev/pcodedmp>,
PyCIRCLean <https://github.com/CIRCL/PyCIRCLean>,
QFlow <https://www.quarkslab.com/products-qflow/>,
Qu1cksc0pe <https://github.com/CYB3RMX/Qu1cksc0pe>, Tylabs QuickSand <https://github.com/tylabs/quicksand>,
REMnux <https://remnux.org/>,
Snake <https://github.com/countercept/snake>,
SNDBOX <https://app.sndbox.com>, Splunk add-on for MS O365 Email <https://splunkbase.splunk.com/app/5365/>,
SpuriousEmu <https://github.com/ldbo/SpuriousEmu>,
Strelka <https://github.com/target/strelka>,
stoQ <https://stoq.punchcyber.com/>, Sublime Platform/MQL <https://docs.sublimesecurity.com/docs/enrichment-functions>,
Subparse <https://github.com/jstrosch/subparse>,
TheHive/Cortex <https://github.com/TheHive-Project/Cortex-Analyzers>,
ThreatBoook <https://s.threatbook.com/>, TSUGURI Linux <https://tsurugi-linux.org/>,
Vba2Graph <https://github.com/MalwareCantFly/Vba2Graph>,
Viper <http://viper.li/>,
ViperMonkey <https://github.com/decalage2/ViperMonkey>,
YOMI <https://yomi.yoroi.company>, and probably
VirusTotal <https://www.virustotal.com>,
FileScan.IO <https://www.filescan.io>. And quite a few other projects on GitHub <https://github.com/search?q=oletools&type=Repositories>.
(Please contact me <(http://decalage.info/contact)>__ if you have or
know a project using oletools)
The recommended way to download and install/update the latest stable
release of oletools is to use
pip <https://pip.pypa.io/en/stable/installing/>__:
sudo -H pip install -U oletools[full]pip install -U oletools[full]This should automatically create command-line scripts to run each tool
from any directory: olevba, mraptor, rtfobj, etc.
The keyword [full] means that all optional dependencies will be
installed, such as XLMMacroDeobfuscator. If you prefer a lighter version
without optional dependencies, just remove [full] from the command
line.
To get the latest development version instead:
sudo -H pip install -U https://github.com/decalage2/oletools/archive/master.zippip install -U https://github.com/decalage2/oletools/archive/master.zipSee the
documentation <https://github.com/decalage2/oletools/wiki/Install>__
for other installation options.
The latest version of the documentation can be found
online <https://github.com/decalage2/oletools/wiki>__, otherwise a
copy is provided in the doc subfolder of the package.
This is a personal open-source project, developed on my spare time. Any contribution, suggestion, feedback or bug report is welcome.
To suggest improvements, report a bug or any issue, please use the
issue reporting page <https://github.com/decalage2/oletools/issues>__,
providing all the information and files to reproduce the problem.
You may also contact the author <http://decalage.info/contact>__
directly to provide feedback.
The code is available in a GitHub repository <https://github.com/decalage2/oletools>__. You may use it to
submit enhancements using forks and pull requests.
This license applies to the python-oletools package, apart from the thirdparty folder which contains third-party files published with their own license.
The python-oletools package is copyright (c) 2012-2024 Philippe Lagadec (http://www.decalage.info)
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
olevba contains modified source code from the officeparser project, published under the following MIT License (MIT):
officeparser is copyright (c) 2014 John William Davison
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
.. |PyPI| image:: https://img.shields.io/pypi/v/oletools.svg :target: https://pypi.org/project/oletools/ .. |Build Status| image:: https://travis-ci.org/decalage2/oletools.svg?branch=master :target: https://travis-ci.org/decalage2/oletools .. |Say Thanks!| image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg :target: https://saythanks.io/to/decalage2
FAQs
Python tools to analyze security characteristics of MS Office and OLE files (also called Structured Storage, Compound File Binary Format or Compound Document File Format), for Malware Analysis and Incident Response #DFIR
We found that oletools demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.