{"id":13540337,"url":"https://github.com/decalage2/oletools","last_synced_at":"2025-05-14T21:00:33.393Z","repository":{"id":39458871,"uuid":"59367670","full_name":"decalage2/oletools","owner":"decalage2","description":"oletools - python tools to analyze MS OLE2 files (Structured Storage, Compound File Binary Format) and MS Office documents, for malware analysis, forensics and debugging.","archived":false,"fork":false,"pushed_at":"2025-04-23T20:56:39.000Z","size":5360,"stargazers_count":3044,"open_issues_count":503,"forks_count":572,"subscribers_count":100,"default_branch":"master","last_synced_at":"2025-04-28T00:56:29.082Z","etag":null,"topics":["compound","forensics","macros","malware-analysis","ms-office-documents","ole-files","olefile","parser","pyparsing","python","python-library","rtf","security","vba"],"latest_commit_sha":null,"homepage":"http://www.decalage.info/python/oletools","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/decalage2.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2016-05-21T15:37:49.000Z","updated_at":"2025-04-25T08:26:46.000Z","dependencies_parsed_at":"2023-02-06T09:16:27.960Z","dependency_job_id":"b39320e9-64d3-45fb-b0e4-a087e700523e","html_url":"https://github.com/decalage2/oletools","commit_stats":{"total_commits":1310,"total_committers":59,"mean_commits":"22.203389830508474","dds":0.6396946564885496,"last_synced_commit":"83c1e66d8848e1cb1f7b997bd4200fc3cc56d2e9"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decalage2%2Foletools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decalage2%2Foletools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decalage2%2Foletools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decalage2%2Foletools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/decalage2","download_url":"https://codeload.github.com/decalage2/oletools/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252835026,"owners_count":21811469,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["compound","forensics","macros","malware-analysis","ms-office-documents","ole-files","olefile","parser","pyparsing","python","python-library","rtf","security","vba"],"created_at":"2024-08-01T09:01:47.073Z","updated_at":"2025-05-07T07:38:46.679Z","avatar_url":"https://github.com/decalage2.png","language":"Python","readme":"python-oletools\n===============\n[![PyPI](https://img.shields.io/pypi/v/oletools.svg)](https://pypi.org/project/oletools/)\n[![Build Status](https://travis-ci.org/decalage2/oletools.svg?branch=master)](https://travis-ci.org/decalage2/oletools)\n[![Say Thanks!](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/decalage2)\n\n[oletools](http://www.decalage.info/python/oletools) is a package of python tools to analyze\n[Microsoft OLE2 files](http://en.wikipedia.org/wiki/Compound_File_Binary_Format) \n(also called Structured Storage, Compound File Binary Format or Compound Document File Format), \nsuch as Microsoft Office 97-2003 documents, MSI files or Outlook messages, mainly for malware analysis, \nforensics and debugging. \nIt is based on the [olefile](http://www.decalage.info/olefile) parser. \n\nIt also provides tools to analyze RTF files and files based on the [OpenXML format](https://en.wikipedia.org/wiki/Office_Open_XML) \n(aka OOXML) such as MS Office 2007+ documents, XPS or MSIX files.\n\nFor example, oletools can detect, extract and analyse VBA macros, OLE objects, Excel 4 macros (XLM) and DDE links.\n\nSee [http://www.decalage.info/python/oletools](http://www.decalage.info/python/oletools) for more info.  \n\n**Quick links:** \n[Home page](http://www.decalage.info/python/oletools) - \n[Download/Install](https://github.com/decalage2/oletools/wiki/Install) -\n[Documentation](https://github.com/decalage2/oletools/wiki) -\n[Report Issues/Suggestions/Questions](https://github.com/decalage2/oletools/issues) -\n[Contact the Author](http://decalage.info/contact) - \n[Repository](https://github.com/decalage2/oletools) -\n[Updates on Twitter](https://twitter.com/decalage2)\n[Cheatsheet](https://github.com/decalage2/oletools/blob/master/cheatsheet/oletools_cheatsheet.pdf)\n\nNote: python-oletools is not related to OLETools published by BeCubed Software.\n\nNews\n----\n\n- **2024-07-02 v0.60.2**:\n    - olevba: \n      - fixed a bug in open_slk (issue #797, PR #769)\n      - fixed a bug due to new PROJECTCOMPATVERSION record in dir stream (PR #723, issues #700, #701, #725, #791, #808, #811, #833)\n    - oleobj: fixed SyntaxError with Python 3.12 (PR #855), SyntaxWarning (PR #774)\n    - rtfobj: fixed SyntaxError with Python 3.12 (PR #854)\n    - clsid: added CLSIDs for MSI, Zed\n    - ftguess: added MSI, PNG and OneNote formats\n    - pyxswf: fixed python 3.12 compatibility (PR #841, issue #813)\n    - setup/requirements: allow pyparsing 3 to solve install issues (PR #812, issue #762)\n- **2022-05-09 v0.60.1**:\n    - olevba: \n      - fixed a bug when calling XLMMacroDeobfuscator (PR #737)\n      - removed keyword \"sample\" causing false positives\n    - oleid: fixed OleID init issue (issue #695, PR #696)\n    - oleobj: \n      - added simple detection of CVE-2021-40444 initial stage\n      - added detection for customUI onLoad\n      - improved handling of incorrect filenames in OLE package (PR #451)\n    - rtfobj: fixed code to find URLs in OLE2Link objects for Py3 (issue #692)\n    - ftguess: \n      - added PowerPoint and XPS formats (PR #716)\n      - fixed issue with XPS and malformed documents (issue #711)\n      - added XLSB format (issue #758)\n    - improved logging with common module log_helper (PR #449)\n- **2021-06-02 v0.60**:\n    - ftguess: new tool to identify file formats and containers (issue #680)\n    - oleid: (issue #679)\n        - each indicator now has a risk level\n        - calls ftguess to identify file formats  \n        - calls olevba+mraptor to detect and analyse VBA+XLM macros \n    - olevba:\n        - when XLMMacroDeobfuscator is available, use it to extract and deobfuscate XLM macros\n    - rtfobj:\n        - use ftguess to identify file type of OLE Package (issue #682)\n        - fixed bug in re_executable_extensions\n    - crypto: added PowerPoint transparent password '/01Hannes Ruescher/01' (issue #627)\n    - setup: XLMMacroDeobfuscator, xlrd2 and pyxlsb2 added as optional dependencies \n\nSee the [full changelog](https://github.com/decalage2/oletools/wiki/Changelog) for more information.\n\nTools:\n------\n\n### Tools to analyze malicious documents\n\n- [oleid](https://github.com/decalage2/oletools/wiki/oleid): to analyze OLE files to detect specific characteristics usually found in malicious files.\n- [olevba](https://github.com/decalage2/oletools/wiki/olevba): to extract and analyze VBA Macro source code from MS Office documents (OLE and OpenXML).\n- [MacroRaptor](https://github.com/decalage2/oletools/wiki/mraptor): to detect malicious VBA Macros\n- [msodde](https://github.com/decalage2/oletools/wiki/msodde): to detect and extract DDE/DDEAUTO links from MS Office documents, RTF and CSV\n- [pyxswf](https://github.com/decalage2/oletools/wiki/pyxswf): to detect, extract and analyze Flash objects (SWF) that may\n  be embedded in files such as MS Office documents (e.g. Word, Excel) and RTF,\n  which is especially useful for malware analysis.\n- [oleobj](https://github.com/decalage2/oletools/wiki/oleobj): to extract embedded objects from OLE files.\n- [rtfobj](https://github.com/decalage2/oletools/wiki/rtfobj): to extract embedded objects from RTF files.\n\n### Tools to analyze the structure of OLE files\n\n- [olebrowse](https://github.com/decalage2/oletools/wiki/olebrowse): A simple GUI to browse OLE files (e.g. MS Word, Excel, Powerpoint documents), to\n  view and extract individual data streams.\n- [olemeta](https://github.com/decalage2/oletools/wiki/olemeta): to extract all standard properties (metadata) from OLE files.\n- [oletimes](https://github.com/decalage2/oletools/wiki/oletimes): to extract creation and modification timestamps of all streams and storages.\n- [oledir](https://github.com/decalage2/oletools/wiki/oledir): to display all the directory entries of an OLE file, including free and orphaned entries.\n- [olemap](https://github.com/decalage2/oletools/wiki/olemap): to display a map of all the sectors in an OLE file.\n\n\nProjects using oletools:\n------------------------\n\noletools are used by a number of projects and online malware analysis services,\nincluding\n[ACE](https://github.com/IntegralDefense/ACE),\n[ADAPT](https://www.blackhat.com/eu-23/briefings/schedule/index.html#unmasking-apts-an-automated-approach-for-real-world-threat-attribution-35162),\n[Anlyz.io](https://sandbox.anlyz.io/),\n[AssemblyLine](https://www.cse-cst.gc.ca/en/assemblyline),\n[Binary Refinery](https://github.com/binref/refinery),\n[CAPE](https://github.com/kevoreilly/CAPEv2),\n[CinCan](https://cincan.io),\n[Cortex XSOAR (Palo Alto)](https://cortex.marketplace.pan.dev/marketplace/details/Oletools/),\n[Cuckoo Sandbox](https://github.com/cuckoosandbox/cuckoo),\n[DARKSURGEON](https://github.com/cryps1s/DARKSURGEON),\n[Deepviz](https://sandbox.deepviz.com/),\n[DIARIO](https://diario.elevenpaths.com/),\n[dridex.malwareconfig.com](https://dridex.malwareconfig.com),\n[EML Analyzer](https://github.com/ninoseki/eml_analyzer),\n[EXPMON](https://pub.expmon.com/),\n[FAME](https://certsocietegenerale.github.io/fame/),\n[FLARE-VM](https://github.com/fireeye/flare-vm),\n[GLIMPS Malware](https://www.glimps.fr/en/glimps-malware-2/),\n[Hybrid-analysis.com](https://www.hybrid-analysis.com/),\n[InQuest Labs](https://labs.inquest.net/),\n[IntelOwl](https://github.com/certego/IntelOwl),\n[Joe Sandbox](https://www.document-analyzer.net/),\n[Laika BOSS](https://github.com/lmco/laikaboss),\n[MacroMilter](https://github.com/sbidy/MacroMilter),\n[mailcow](https://mailcow.email/),\n[malshare.io](https://malshare.io),\n[malware-repo](https://github.com/Tigzy/malware-repo),\n[Malware Repository Framework (MRF)](https://www.adlice.com/download/mrf/),\n[MalwareBazaar](https://bazaar.abuse.ch/),\n[olefy](https://github.com/HeinleinSupport/olefy),\n[Pandora](https://github.com/pandora-analysis/pandora),\n[PeekabooAV](https://github.com/scVENUS/PeekabooAV),\n[pcodedmp](https://github.com/bontchev/pcodedmp),\n[PyCIRCLean](https://github.com/CIRCL/PyCIRCLean),\n[QFlow](https://www.quarkslab.com/products-qflow/),\n[Qu1cksc0pe](https://github.com/CYB3RMX/Qu1cksc0pe),\n[Tylabs QuickSand](https://github.com/tylabs/quicksand),\n[REMnux](https://remnux.org/),\n[Snake](https://github.com/countercept/snake),\n[SNDBOX](https://app.sndbox.com),\n[Splunk add-on for MS O365 Email](https://splunkbase.splunk.com/app/5365/),\n[SpuriousEmu](https://github.com/ldbo/SpuriousEmu),\n[Strelka](https://github.com/target/strelka),\n[stoQ](https://stoq.punchcyber.com/),\n[Sublime Platform/MQL](https://docs.sublimesecurity.com/docs/enrichment-functions),\n[Subparse](https://github.com/jstrosch/subparse),\n[TheHive/Cortex](https://github.com/TheHive-Project/Cortex-Analyzers),\n[ThreatBoook](https://s.threatbook.com/),\n[TSUGURI Linux](https://tsurugi-linux.org/),\n[Vba2Graph](https://github.com/MalwareCantFly/Vba2Graph),\n[Viper](http://viper.li/),\n[ViperMonkey](https://github.com/decalage2/ViperMonkey),\n[YOMI](https://yomi.yoroi.company),\nand probably [VirusTotal](https://www.virustotal.com), \n[FileScan.IO](https://www.filescan.io). \nAnd quite a few [other projects on GitHub](https://github.com/search?q=oletools\u0026type=Repositories).\n(Please [contact me]((http://decalage.info/contact)) if you have or know\na project using oletools)\n\n\nDownload and Install:\n---------------------\n\nThe recommended way to download and install/update the **latest stable release**\nof oletools is to use [pip](https://pip.pypa.io/en/stable/installing/):\n\n- On Linux/Mac: `sudo -H pip install -U oletools[full]`\n- On Windows: `pip install -U oletools[full]`\n\nThis should automatically create command-line scripts to run each tool from\nany directory: `olevba`, `mraptor`, `rtfobj`, etc.\n\nThe keyword `[full]` means that all optional dependencies will be installed, such as XLMMacroDeobfuscator.\nIf you prefer a lighter version without optional dependencies, just remove `[full]` from the command line.\n \n\nTo get the **latest development version** instead:\n\n- On Linux/Mac: `sudo -H pip install -U https://github.com/decalage2/oletools/archive/master.zip`\n- On Windows: `pip install -U https://github.com/decalage2/oletools/archive/master.zip`\n\nSee the [documentation](https://github.com/decalage2/oletools/wiki/Install)\nfor other installation options.\n\nDocumentation:\n--------------\n\nThe latest version of the documentation can be found [online](https://github.com/decalage2/oletools/wiki), otherwise\na copy is provided in the doc subfolder of the package.\n\n\nHow to Suggest Improvements, Report Issues or Contribute:\n---------------------------------------------------------\n\nThis is a personal open-source project, developed on my spare time. Any contribution, suggestion, feedback or bug \nreport is welcome.\n\nTo suggest improvements, report a bug or any issue, please use the \n[issue reporting page](https://github.com/decalage2/oletools/issues), providing all the\ninformation and files to reproduce the problem. \n\nYou may also [contact the author](http://decalage.info/contact) directly to provide feedback.\n\nThe code is available in [a GitHub repository](https://github.com/decalage2/oletools). You may use it\nto submit enhancements using forks and pull requests.\n\nLicense\n-------\n\nThis license applies to the python-oletools package, apart from the thirdparty folder which contains third-party files \npublished with their own license.\n\nThe python-oletools package is copyright (c) 2012-2024 Philippe Lagadec (http://www.decalage.info)\n\nAll rights reserved.\n\nRedistribution and use in source and binary forms, with or without modification,\nare permitted provided that the following conditions are met:\n\n * Redistributions of source code must retain the above copyright notice, this\n   list of conditions and the following disclaimer.\n * Redistributions in binary form must reproduce the above copyright notice,\n   this list of conditions and the following disclaimer in the documentation\n   and/or other materials provided with the distribution.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND\nANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\nWARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\nDISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\nFOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\nDAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\nSERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\nCAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\nOR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\nOF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n\n----------\n\nolevba contains modified source code from the officeparser project, published\nunder the following MIT License (MIT):\n\nofficeparser is copyright (c) 2014 John William Davison\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","funding_links":[],"categories":["Python","\u003ca id=\"e1fc1d87056438f82268742dc2ba08f5\"\u003e\u003c/a\u003e事件响应\u0026\u0026取证\u0026\u0026内存取证\u0026\u0026数字取证","Rich Text Format (7)","Tools","Rich Text Format","其他_安全与渗透","Blue Team","Malware Reversing","\u003ca id=\"ecb63dfb62722feb6d43a9506515b4e3\"\u003e\u003c/a\u003e新添加"],"sub_categories":["\u003ca id=\"1fc5d3621bb13d878f337c8031396484\"\u003e\u003c/a\u003e取证\u0026\u0026Forensics\u0026\u0026数字取证\u0026\u0026内存取证","Metadata Forensics","网络服务_其他","Malware Analysis","Static Analysis"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdecalage2%2Foletools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdecalage2%2Foletools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdecalage2%2Foletools/lists"}