olevba: prevent side effects on python lib "email"

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a bug report to help us fix issues
+
+---
+
+**Affected tool:**
+olevba, mraptor, rtfobj, oleid, etc
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**File/Malware sample to reproduce the bug**
+Please attach the file in a password protected zip archive, or provide a link where it can be downloaded (e.g. Hybrid Analysis, preferably not VirusTotal which requires paid access). If not possible, please provide a hash.
+
+**How To Reproduce the bug**
+Steps to reproduce the behavior, including the full command line or the options you used.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Console output / Screenshots**
+If applicable, add screenshots to help explain your problem.
+Use the option "-l debug" to add debugging information, if possible.
+
+**Version information:**
+ - OS: Windows/Linux/Mac/Other
+ - OS version: x.xx - 32/64 bits
+ - Python version: 2.7/3.6 - 32/64 bits
+ - oletools version: 
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.gitignore

@@ -56,7 +56,7 @@ coverage.xml
 
 # Translations
 *.mo
-*.pot
+#*.pot
 
 # Django stuff:
 *.log

.travis.yml

@@ -1,7 +1,19 @@
 language: python
-
-python:
-  - "2.7"
 cache: pip
+sudo: false
+
+matrix:
+  include:
+    - python: 2.7
+    - python: 3.5
+    - python: 3.6
+    - python: 3.7
+    - python: 3.8
+    - python: pypy
+    - python: pypy3
+
+install:
+  - pip install msoffcrypto-tool
+
 script:
   - python setup.py test

INSTALL.txt

@@ -1,16 +1,12 @@
-How to Download and Install python-oletools
-===========================================
+How to Download and Install oletools
+====================================
 
 Pre-requisites
 --------------
 
-The recommended Python version to run oletools is Python 2.7.
-Python 2.6 is also supported, but as it is not tested as often as 2.7, some features
-might not work as expected.
-
-Since v0.50, oletools can also run with Python 3.x. As this is quite new, please
-report any issue you may encounter.
-
+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.
 
 Recommended way to Download+Install/Update oletools: pip
 --------------------------------------------------------
@@ -23,7 +19,11 @@ 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:
 
+```text
 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.
@@ -33,7 +33,19 @@ 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:
 
+```text
 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:
+
+```text
+pip3 install -U --user oletools
+```
 
 **Important**: Since version 0.50, pip will automatically create convenient command-line scripts
 to run all the oletools from any directory: olevba, mraptor, oleid, rtfobj, etc.
@@ -47,30 +59,49 @@ you may also use pip:
 
 ### Linux, Mac OSX, Unix
 
+```text
 sudo -H pip install -U https://github.com/decalage2/oletools/archive/master.zip
+```
+
+Replace `pip` by `pip3` or `pip2` to install on a specific Python version.
 
 ### Windows
 
+```text
 pip install -U https://github.com/decalage2/oletools/archive/master.zip
+```
+
+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:
 
+```text
+pip3 install -U --user https://github.com/decalage2/oletools/archive/master.zip
+```
 
 How to install offline - Computer without Internet access
 ---------------------------------------------------------
 
 First, download the oletools archive on a computer with Internet access:
-* Latest stable version: from https://github.com/decalage2/oletools/releases
+* Latest stable version: from https://pypi.org/project/oletools/ or https://github.com/decalage2/oletools/releases
 * Development version: https://github.com/decalage2/oletools/archive/master.zip
 
 Copy the archive file to the target computer.
 
 On Linux, Mac OSX, Unix, run the following command using the filename of the
 archive that you downloaded:
 
+```text
 sudo -H pip install -U oletools.zip
+```
 
 On Windows:
 
+```text
 pip install -U oletools.zip
+```
 
 
 Old school install using setup.py
@@ -88,9 +119,12 @@ Then extract the archive, open a shell and go to the oletools directory.
 
 ### Linux, Mac OSX, Unix
 
+```text
 sudo -H python setup.py install
+```
 
 ### Windows:
 
+```text
 python setup.py install
-
+```

LICENSE.md

@@ -0,0 +1,52 @@
+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-2019 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:
+
+ * 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):
+
+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.

MANIFEST.in

@@ -0,0 +1,14 @@
+include install.bat
+include INSTALL.txt
+include README.md
+include requirements.txt
+include oletools/README.rst
+include oletools/README.html
+include oletools/LICENSE.txt
+include oletools/DocVarDump.vba
+recursive-include oletools/thirdparty *.*
+recursive-include cheatsheet *.*
+global-exclude *.pyc
+
+recursive-include tests *.py
+graft tests/test-data