Commit f003f27eeaaa68314d036e6e062d8380111588df
1 parent
6301c9cf
updated install.txt for github
Showing
1 changed file
with
63 additions
and
34 deletions
INSTALL.txt
| 1 | -How to Download and Install python-oletools | ||
| 2 | -=========================================== | ||
| 3 | - | ||
| 4 | -Pre-requisites | ||
| 5 | --------------- | ||
| 6 | - | ||
| 7 | -For now, python-oletools require Python 2.x. | ||
| 8 | -They are not compatible with Python 3.x yet. | ||
| 9 | - | ||
| 10 | - | ||
| 11 | -For command-line tools | ||
| 12 | ----------------------- | ||
| 13 | - | ||
| 14 | -To use python-oletools from the command line as analysis tools, you may simply | ||
| 15 | -download the zip archive from https://bitbucket.org/decalage/oletools/downloads | ||
| 16 | -and extract the files in the directory of your choice. | ||
| 17 | - | ||
| 18 | -You may then add the directory to your PATH environment variable to access the | ||
| 19 | -tools from anywhere. | ||
| 20 | - | ||
| 21 | - | ||
| 22 | -For python applications | ||
| 23 | ----------------------- | ||
| 24 | - | ||
| 25 | -If you plan to use python-oletools with other Python applications or your own | ||
| 26 | -scripts, the simplest solution is to use "pip install oletools" or | ||
| 27 | -"easy_install oletools" to download and install the package in one go. | ||
| 28 | - | ||
| 29 | -Otherwise you may download/extract the zip archive from | ||
| 30 | -https://bitbucket.org/decalage/oletools/downloads) in a temporary directory and | ||
| 31 | -run "python setup.py install". | ||
| 32 | -On Windows, you may also double-click on install.bat. | ||
| 33 | - | ||
| 34 | - | 1 | +How to Download and Install python-oletools |
| 2 | +=========================================== | ||
| 3 | + | ||
| 4 | +Pre-requisites | ||
| 5 | +-------------- | ||
| 6 | + | ||
| 7 | +For now, python-oletools require Python 2.x. | ||
| 8 | +They are not compatible with Python 3.x yet. | ||
| 9 | + | ||
| 10 | + | ||
| 11 | +For command-line tools | ||
| 12 | +---------------------- | ||
| 13 | + | ||
| 14 | +To use python-oletools from the command line as analysis tools, you may simply | ||
| 15 | +download the latest release archive from | ||
| 16 | +https://github.com/decalage2/oletools/releases | ||
| 17 | +and extract the files into the directory of your choice. | ||
| 18 | + | ||
| 19 | +You may also download the latest development version from | ||
| 20 | +https://github.com/decalage2/oletools/archive/master.zip with the most recent | ||
| 21 | +features. | ||
| 22 | + | ||
| 23 | +Another possibility is to use a git client to clone the repository | ||
| 24 | +(https://github.com/decalage2/oletools.git) into a folder. | ||
| 25 | +You can then update it easily in the future. | ||
| 26 | + | ||
| 27 | +### Windows | ||
| 28 | + | ||
| 29 | +You may add the oletools directory to your PATH environment variable to access | ||
| 30 | +the tools from anywhere. | ||
| 31 | + | ||
| 32 | +### Linux, Mac OSX, Unix | ||
| 33 | + | ||
| 34 | +It is very convenient to create symbolic links to each tool in one of the bin | ||
| 35 | +directories in order to run them as shell commands from anywhere. For example, | ||
| 36 | +here is how to create an executable link "olevba" in /usr/local/bin pointing to | ||
| 37 | +olevba.py, assuming oletools was unzipped into /opt/oletools: | ||
| 38 | + | ||
| 39 | + chmod +x /opt/oletools/oletools/olevba.py | ||
| 40 | + ln -s /opt/oletools/oletools/olevba.py /usr/local/bin/olevba | ||
| 41 | + | ||
| 42 | +Then the olevba command can be used from any directory: | ||
| 43 | + | ||
| 44 | + user@remnux:~/MalwareZoo/VBA$ olevba dridex427.xls |less | ||
| 45 | + | ||
| 46 | + | ||
| 47 | + | ||
| 48 | +For python applications | ||
| 49 | +----------------------- | ||
| 50 | + | ||
| 51 | +If you plan to use python-oletools with other Python applications or your own | ||
| 52 | +scripts, the simplest solution is to run "pip install oletools" or | ||
| 53 | +"easy_install oletools" to download and install the package in one go. | ||
| 54 | +Pip is included with Python since version 2.7.9. | ||
| 55 | + | ||
| 56 | +IMPORTANT: to update oletools if it is already installed, you must run | ||
| 57 | +"pip install -U oletools", otherwise pip will not update it. | ||
| 58 | + | ||
| 59 | +Alternatively if you prefer the old school way, you may download the | ||
| 60 | +latest archive from https://github.com/decalage2/oletools/releases, extract it | ||
| 61 | +into a temporary directory and run "python setup.py install". | ||
| 62 | + | ||
| 63 | + |