diff --git a/oletools/README.html b/oletools/README.html index c075957..52f4109 100644 --- a/oletools/README.html +++ b/oletools/README.html @@ -23,6 +23,51 @@
Note: python-oletools is not related to OLETools published by BeCubed Software.
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, PeekabooAV, pcodedmp, PyCIRCLean, REMnux, Snake, SNDBOX, Splunk add-on for MS O365 Email, SpuriousEmu, Strelka, stoQ, TheHive/Cortex, TSUGURI Linux, Vba2Graph, Viper, ViperMonkey, YOMI, and probably VirusTotal. And quite a few other projects on GitHub. (Please contact me if you have or know a project 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)
The recommended way to download and install/update the latest stable release of oletools is to use pip:
sudo -H pip install -U oletoolspip install -U oletoolssudo -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.zipThe code is available in a GitHub repository. 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-2021 Philippe Lagadec (http://www.decalage.info)
+The python-oletools package is copyright (c) 2012-2022 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:
The recommended Python version to run oletools is the latest Python 3.x (3.7 for now). Python 2.7 is still supported, but as it will become end of life in 2020 (see https://pythonclock.org/), it is highly recommended to switch to Python 3 now.
+The recommended Python version to run oletools is the latest Python 3.x (3.9 for now). Python 2.7 is still supported for the moment, even if it reached end of life in 2020 (for projects still using Python 2/PyPy 2 such as ViperMonkey). It is highly recommended to switch to Python 3 if possible.
Pip is included with Python since version 2.7.9 and 3.4. If it is not installed on your system, either upgrade Python or see https://pip.pypa.io/en/stable/installing/
To download and install/update the latest release version of oletools, run the following command in a shell:
+To download and install/update the latest release version of oletools with all its dependencies, run the following command in a shell:
+sudo -H pip install -U oletools[full]
+The keyword [full] means that all optional dependencies will be installed, such as XLMMacroDeobfuscator. If you prefer a lighter version without optional dependencies, use the following command instead:
sudo -H pip install -U oletools
Replace pip by pip3 or pip2 to install on a specific Python version.
Important: Since version 0.50, pip will automatically create convenient command-line scripts in /usr/local/bin to run all the oletools from any directory.
To download and install/update the latest release version of oletools, run the following command in a cmd window:
+To download and install/update the latest release version of oletools with all its dependencies, run the following command in a cmd window:
+pip install -U oletools[full]
+The keyword [full] means that all optional dependencies will be installed, such as XLMMacroDeobfuscator. If you prefer a lighter version without optional dependencies, use the following command instead:
pip install -U oletools
Replace pip by pip3 or pip2 to install on a specific Python version.
Note: with Python 3, you may need to open a cmd window with Administrator privileges in order to run pip and install for all users. If that is not possible, you may also install only for the current user by adding the --user option:
If you want to benefit from the latest improvements in the development version, you may also use pip:
sudo -H pip install -U https://github.com/decalage2/oletools/archive/master.zip
+Note that it will install oletools without optional dependencies such as XLMMacroDeobfuscator, so you may need to install them separately.
Replace pip by pip3 or pip2 to install on a specific Python version.
pip install -U https://github.com/decalage2/oletools/archive/master.zip
+Note that it will install oletools without optional dependencies such as XLMMacroDeobfuscator, so you may need to install them separately.
Replace pip by pip3 or pip2 to install on a specific Python version.
Note: with Python 3, you may need to open a cmd window with Administrator privileges in order to run pip and install for all users. If that is not possible, you may also install only for the current user by adding the --user option:
pip3 install -U --user https://github.com/decalage2/oletools/archive/master.zip
diff --git a/oletools/doc/Install.md b/oletools/doc/Install.md
index 01c0375..fd8dba9 100644
--- a/oletools/doc/Install.md
+++ b/oletools/doc/Install.md
@@ -4,9 +4,10 @@ How to Download and Install oletools
Pre-requisites
--------------
-The recommended Python version to run oletools is the latest **Python 3.x** (3.7 for now).
-Python 2.7 is still supported, but as it will become end of life in 2020 (see https://pythonclock.org/), it is highly
-recommended to switch to Python 3 now.
+The recommended Python version to run oletools is the latest **Python 3.x** (3.9 for now).
+Python 2.7 is still supported for the moment, even if it reached end of life in 2020
+(for projects still using Python 2/PyPy 2 such as ViperMonkey).
+It is highly recommended to switch to Python 3 if possible.
Recommended way to Download+Install/Update oletools: pip
--------------------------------------------------------
@@ -16,10 +17,16 @@ system, either upgrade Python or see https://pip.pypa.io/en/stable/installing/
### Linux, Mac OSX, Unix
-To download and install/update the latest release version of oletools,
+To download and install/update the latest release version of oletools with all its dependencies,
run the following command in a shell:
```text
+sudo -H pip install -U oletools[full]
+```
+The keyword `[full]` means that all optional dependencies will be installed, such as XLMMacroDeobfuscator.
+If you prefer a lighter version without optional dependencies, use the following command instead:
+
+```text
sudo -H pip install -U oletools
```
@@ -30,10 +37,16 @@ in /usr/local/bin to run all the oletools from any directory.
### Windows
-To download and install/update the latest release version of oletools,
+To download and install/update the latest release version of oletools with all its dependencies,
run the following command in a cmd window:
```text
+pip install -U oletools[full]
+```
+The keyword `[full]` means that all optional dependencies will be installed, such as XLMMacroDeobfuscator.
+If you prefer a lighter version without optional dependencies, use the following command instead:
+
+```text
pip install -U oletools
```
@@ -62,6 +75,8 @@ you may also use pip:
```text
sudo -H pip install -U https://github.com/decalage2/oletools/archive/master.zip
```
+Note that it will install oletools without optional dependencies such as XLMMacroDeobfuscator,
+so you may need to install them separately.
Replace `pip` by `pip3` or `pip2` to install on a specific Python version.
@@ -70,6 +85,8 @@ Replace `pip` by `pip3` or `pip2` to install on a specific Python version.
```text
pip install -U https://github.com/decalage2/oletools/archive/master.zip
```
+Note that it will install oletools without optional dependencies such as XLMMacroDeobfuscator,
+so you may need to install them separately.
Replace `pip` by `pip3` or `pip2` to install on a specific Python version.
diff --git a/oletools/doc/License.html b/oletools/doc/License.html
index ba2fc2c..7f9d8b2 100644
--- a/oletools/doc/License.html
+++ b/oletools/doc/License.html
@@ -18,7 +18,7 @@
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-2020 Philippe Lagadec (http://www.decalage.info)
+The python-oletools package is copyright (c) 2012-2022 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: