oletools

v0.60.1

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 For more information about how to use this package see README

Latest version published 2 years ago

License: BSD-2-Clause

PyPI

GitHub

Package Health Score

61 / 100

security
No known security issues
popularity
Popular
maintenance
Inactive
community
Sustainable

Popularity

Popular

GitHub Stars: 2.75K
Forks: 553
Contributors: 40

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package oletools, we found that it has been starred 2,751 times.

Security

No known security issues

Security and license risk for latest version

Release Date: May 9, 2022
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 1
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

BSD-2-Clause

Security Policy

We found a way for you to contribute to the project! Looks like oletools is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

Open Issues: 448
Open PR: 46
Last Release: 2 years ago
Last Commit: 4 days ago

Further analysis of the maintenance status of oletools based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for oletools is that it hasn't seen any new versions released to PyPI in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Sustainable

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 40
Funding: No

With more than 10 contributors for the oletools repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like oletools is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: ==2.7.*, ==3.4.*, ==3.5.*, ==3.6.*, ==3.7.*, ==3.8.*, ==3.9.*

Age: 12 years
Latest Release: 2 years ago
Dependencies: 6 Direct / 9 Total
Versions: 41
Maintainers: 1
Wheels: OS Independent

Not sure how to use oletools?

To help you get started, we've collected the most common ways that oletools is being used within popular public projects.

decalage2 / oletools / tests / rtfobj / test_issue_185.py View on Github

def test_skip_space_after_bin_control_word(self):
        data = testdata_reader.read_encrypted('rtfobj/issue_185.rtf.zip')
        rtfp = rtfobj.RtfObjParser(data)
        rtfp.parse()
        objects = rtfp.objects

        self.assertTrue(len(objects) == 1)

View more ways to use oletools

python-oletools

oletools is a package of python tools to analyze Microsoft OLE2 files (also called Structured Storage, Compound File Binary Format or Compound Document File Format), such as Microsoft Office documents or Outlook messages, mainly for malware analysis, forensics and debugging. It is based on the olefile parser. See for more info.

Quick links: Home page -Download/Install

Note: python-oletools is not related to OLETools published by BeCubed Software.

News

2022-05-09 v0.60.1:
- olevba:
  - fixed a bug when calling XLMMacroDeobfuscator (PR #737)
  - removed keyword "sample" causing false positives
- oleid: fixed OleID init issue (issue #695, PR #696)
- oleobj:
  - added simple detection of CVE-2021-40444 initial stage
  - added detection for customUI onLoad
  - improved handling of incorrect filenames in OLE package (PR #451)
- rtfobj: fixed code to find URLs in OLE2Link objects for Py3 (issue #692)
- ftguess:
  - added PowerPoint and XPS formats (PR #716)
  - fixed issue with XPS and malformed documents (issue #711)
  - added XLSB format (issue #758)
- 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)
  - each indicator now has a risk level
  - calls ftguess to identify file formats
  - calls olevba+mraptor to detect and analyse VBA+XLM macros
- olevba:
  - when XLMMacroDeobfuscator is available, use it to extract and deobfuscate XLM macros
- rtfobj:
  - use ftguess to identify file type of OLE Package (issue #682)
  - fixed bug in re_executable_extensions
- crypto: added PowerPoint transparent password '/01Hannes Ruescher/01' (issue #627)
- setup: XLMMacroDeobfuscator, xlrd2 and pyxlsb2 added as optional dependencies
2021-05-07 v0.56.2:
- olevba:
  - updated plugin_biff to v0.0.22 to fix a bug (issues #647, #674)
- olevba, mraptor:
  - added detection of Workbook_BeforeClose (issue #518)
- rtfobj:
  - fixed bug when OLE package class name ends with null characters (issue #507, PR #648)
- oleid:
  - fixed bug in check_excel (issue #584, PR #585)
- clsid:
  - added several CLSIDs related to MS Office click-to-run issue CVE-2021-27058
  - added checks to ensure that all CLSIDs are uppercase (PR #678)
2021-04-02 v0.56.1:
- olevba:
  - fixed bug when parsing some malformed files (issue #629)
- oleobj:
  - fixed bug preventing detection of links 'externalReference', 'frame', 'hyperlink' (issue #641, PR #670)
- setup:
  - avoid installing msoffcrypto-tool when platform is PyPy+Windows (issue #473)
  - PyPI version is now a wheel package to improve installation and avoid antivirus false positives due to test files (issues #215, #398)
2020-09-28 v0.56:
- olevba/mraptor:
  - added detection of trigger _OnConnecting
- olevba:
  - updated plugin_biff to v0.0.17 to improve Excel 4/XLM macros parsing
  - added simple analysis of Excel 4/XLM macros in XLSM files (PR #569)
  - added detection of template injection (PR #569)
  - added detection of many suspicious keywords (PR #591 and #569, see )
  - improved MHT detection (PR #532)
  - added --no-xlm option to disable Excel 4/XLM macros parsing (PR #532)
  - fixed bug when decompressing raw chunks in VBA (issue #575)
  - fixed bug with email package due to monkeypatch for MHT parsing (issue #602, PR #604)
  - fixed option --relaxed (issue #596, PR #595)
  - enabled relaxed mode by default (issues #477, #593)
  - fixed detect_vba_macros to always return VBA code as unicode on Python 3 (issues #455, #477, #587, #593)
  - replaced option --pcode by --show-pcode and --no-pcode, replaced optparse by argparse (PR #479)
- oleform: improved form parsing (PR #532)
- oleobj: "Ole10Native" is now case insensitive (issue #541)
- clsid: added PDF (issue #552), Microsoft Word Picture (issue #571)
- ppt_parser: fixed bug on Python 3 (issues #177, #607, PR #450)
2019-12-03 v0.55:
- olevba:
  - added support for SLK files and XLM macro extraction from SLK
  - VBA Stomping detection
  - integrated pcodedmp to extract and disassemble P-code
  - detection of suspicious keywords and IOCs in P-code
  - new option --pcode to display P-code disassembly
  - improved detection of auto execution triggers
- rtfobj: added URL carver for CVE-2017-0199
- better handling of unicode for systems with locale that does not support UTF-8, e.g. LANG=C (PR #365)
- tests:
  - test files can now be encrypted, to avoid antivirus alerts (PR #217, issue #215)
  - tests that trigger antivirus alerts have been temporarily disabled (issue #215)

See the full changelog for more information.

Tools:

Tools to analyze malicious documents

oleid: to analyze OLE files to detect specific characteristics usually found in malicious files.
olevba: to extract and analyze VBA Macro source code from MS Office documents (OLE and OpenXML).
MacroRaptor: to detect malicious VBA Macros
msodde: to detect and extract DDE/DDEAUTO links from MS Office documents, RTF and CSV
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: to extract embedded objects from OLE files.
rtfobj: to extract embedded objects from RTF files.

Tools to analyze the structure of OLE files

olebrowse: A simple GUI to browse OLE files (e.g. MS Word, Excel, Powerpoint documents), to view and extract individual data streams.
olemeta: to extract all standard properties (metadata) from OLE files.
oletimes: to extract creation and modification timestamps of all streams and storages.
oledir: to display all the directory entries of an OLE file, including free and orphaned entries.
olemap: to display a map of all the sectors in an OLE file.

Projects using oletools:

oletools are used by a number of projects and online malware analysis services, including ACE, Anlyz.io, AssemblyLine, CAPE, CinCan, Cuckoo Sandbox, DARKSURGEON, Deepviz, DIARIO, dridex.malwareconfig.com, EML Analyzer, FAME, FLARE-VM, Hybrid-analysis.com, IntelOwl, Joe Sandbox, Laika BOSS, MacroMilter, mailcow, malshare.io, malware-repo, Malware Repository Framework (MRF), MalwareBazaar, olefy, Pandora, PeekabooAV, pcodedmp, PyCIRCLean, REMnux, Snake, SNDBOX, Splunk add-on for MS O365 Email, SpuriousEmu, Strelka, stoQ, Sublime Platform/MQL, TheHive/Cortex, TSUGURI Linux, Vba2Graph, Viper, ViperMonkey, YOMI, and probably VirusTotal, FileScan.IO. And quite a few other projects on GitHub. (Please contact me if you have or know a project using oletools)

Download and Install:

The recommended way to download and install/update the latest stable release of oletools is to use pip:

On Linux/Mac: sudo -H pip install -U oletools[full]
On Windows: 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:

On Linux/Mac: sudo -H pip install -U https://github.com/decalage2/oletools/archive/master.zip
On Windows: pip install -U https://github.com/decalage2/oletools/archive/master.zip

See the documentation for other installation options.

Documentation:

The latest version of the documentation can be found online, otherwise a copy is provided in the doc subfolder of the package.

How to Suggest Improvements, Report Issues or Contribute:

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, providing all the information and files to reproduce the problem.

You may also contact the author directly to provide feedback.

The code is available in a GitHub repository. You may use it to submit enhancements using forks and pull requests.

License

This license applies to the python-oletools package, apart from the thirdparty folder which contains third-party files published with their own license.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

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):

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.

oletools dependencies

colorclass easygui msoffcrypto-tool olefile pcodedmp pyparsing

FAQs

What is oletools?

Python tools to analyze security characteristics of MS Office and OLE files (also called Structured Storage, Compound F... Visit Snyk Advisor to see a full health score report for oletools, including popularity, security, maintenance & community analysis.

Is oletools popular?

The python package oletools receives a total of 55,853 weekly downloads. As such, oletools popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is oletools well maintained?

We found indications that oletools is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is oletools safe to use?

The python package oletools was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 10 May-2024, at 09:50 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Not sure how to use oletools?

python-oletools

News

Tools:

Tools to analyze malicious documents

Tools to analyze the structure of OLE files

Projects using oletools:

Download and Install:

Documentation:

How to Suggest Improvements, Report Issues or Contribute:

License

oletools dependencies

FAQs

What is oletools?

Is oletools popular?

Is oletools well maintained?

Is oletools safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues