Installation

The installation of the objection python component should be relatively simple. In fact, a simple git clone and pip install will suffice. Installing objection from pypi will be possible soon™.

toc

• prerequisites
• 'native' installation

prerequisites

Before continuing with the installation though, make sure you have the following prerequisites met:

• python version 3.3+. Check your version with: python -V, upgrade/install using your distributions package manager.
• pip version 9.0. Check your version with: pip --version, upgrade with: pip install pip --upgrade.
• (optionally) virtualenv version 15+. Check your version with: virtualenv --version, upgrade/install with: pip install virtualenv --upgrade.

'native' installation

By 'native', we are referring to a non-virtualenv installation, where all of the objection dependencies will be installed in your operating systems module path. There is nothing wrong with this really, but some may prefer to have isolated environments for certain programs. If this is you, check out the next section.

1. Make sure your system meets the prerequisites detailed in the previous section.

2. Next, clone this repository:

git clone https://github.com/sensepost/objection.git

3. Once cloned, cd to the new objection directory, and install the dependencies using pip. We will also pass on the --editable flag (until objection is uploaded to pypi) so that future updates are as simple as as git pull:

cd objection/

pip install --editable .

4. Once the dependencies are installed, the objection command should be available in your PATH. In some shells, it may be necessary to run hash -r before the command will be available.

'virtual' installation

By 'virtual', we are referring to the fact that objection will be installed in an isolated python virtual environment. For many, this is the preferred option as objection dependencies will have no effect on any locally installed dependencies.

1. Make sure your system meets the prerequisites detailed in the previous section, including the virtualenv command.

2. Create a new virtual environment with:

virtualenv --python=python3 ~/virtual-python3

3. Activate your new python virtual environment with:

source ~/virtual-python3

4. Next, clone this repository:

git clone https://github.com/sensepost/objection.git

5. Once cloned, cd to the new objection directory, and install the dependencies using pip. We will also pass on the --editable flag (until objection is uploaded to pypi) so that future updates are as simple as as git pull:

cd objection/

pip install --editable .

4. Once the dependencies are installed, the objection command should be available in your PATH every time you activate your virtual environment. In some shells, it may be necessary to run hash -r before the command will be available.