mirror of
https://github.com/aljazceru/recon-pipeline.git
synced 2025-12-24 01:34:26 +01:00
* added tools command with placeholders for un/reinstall along with placeholder tests * added missing docs build dependency * updated documentation to reflect tools vs install * refactored some code for DRY, fixed up prior merge with master * fixed broken tests in test_recon_pipeline_shell * existing tests all passing * added tools list command * added tools list command * added tools reinstall * removed lint * fixed reinstall test * fixed install go test * fixed go install test again
This commit is contained in:
@@ -9,23 +9,23 @@ Commands
|
||||
|
||||
``recon-pipeline`` provides a handful of commands:
|
||||
|
||||
- ``install``
|
||||
- ``scan``
|
||||
- ``status``
|
||||
- ``database``
|
||||
- ``view``
|
||||
- :ref:`tools_command`
|
||||
- :ref:`scan_command`
|
||||
- :ref:`status_command`
|
||||
- :ref:`database_command`
|
||||
- :ref:`view_command`
|
||||
|
||||
All other available commands are inherited from `cmd2 <https://github.com/python-cmd2/cmd2>`_.
|
||||
|
||||
.. _install_command:
|
||||
.. _tools_command:
|
||||
|
||||
install
|
||||
#######
|
||||
tools
|
||||
#####
|
||||
|
||||
.. argparse::
|
||||
:module: pipeline.recon
|
||||
:func: install_parser
|
||||
:prog: install
|
||||
:func: tools_parser
|
||||
:prog: tools
|
||||
|
||||
|
||||
.. _database_command:
|
||||
|
||||
@@ -51,15 +51,15 @@ Both OSs After ``pipenv`` Install
|
||||
Everything Else
|
||||
###############
|
||||
|
||||
After installing the python dependencies, the recon-pipeline shell provides its own :ref:`install_command` command (seen below).
|
||||
A simple ``install all`` will handle all installation steps. Installation has **only** been tested on **Kali 2019.4 and Ubuntu 18.04/20.04**.
|
||||
After installing the python dependencies, the recon-pipeline shell provides its own :ref:`tools_command` command (seen below).
|
||||
A simple ``tools install all`` will handle all installation steps. Installation has **only** been tested on **Kali 2019.4 and Ubuntu 18.04/20.04**.
|
||||
|
||||
**Ubuntu Note (and newer kali versions)**: You may consider running ``sudo -v`` prior to running ``./recon-pipeline.py``. ``sudo -v`` will refresh your creds, and the underlying subprocess calls during installation won't prompt you for your password. It'll work either way though.
|
||||
|
||||
Individual tools may be installed by running ``install TOOLNAME`` where ``TOOLNAME`` is one of the known tools that make
|
||||
Individual tools may be installed by running ``tools install TOOLNAME`` where ``TOOLNAME`` is one of the known tools that make
|
||||
up the pipeline.
|
||||
|
||||
The installer maintains a (naive) list of installed tools at ``~/.local/recon-pipeline/tools/.tool-dict.pkl``. The installer in no way attempts to be a package manager. It knows how to execute the steps necessary to install its tools. Beyond that, it's
|
||||
The installer maintains a (naive) list of installed tools at ``~/.local/recon-pipeline/tools/.tool-dict.pkl``. The installer in no way attempts to be a package manager. It knows how to execute the steps necessary to install and remove its tools. Beyond that, it's
|
||||
like Jon Snow, **it knows nothing**.
|
||||
|
||||
Tools can also be uninstalled using the ``uninstall all`` command. It is also possible to individually uninstall them in the same manner as shown above.
|
||||
|
||||
@@ -11,10 +11,8 @@ provides the following two benefits:
|
||||
- Make sure two instances of the same task are not running simultaneously
|
||||
- Provide :ref:`visualization <visualization-ref-label>` of everything that’s going on
|
||||
|
||||
While in the ``recon-pipeline`` shell, running ``install luigi-service`` will copy the ``luigid.service``
|
||||
While in the ``recon-pipeline`` shell, running ``tools install luigi-service`` will copy the ``luigid.service``
|
||||
file provided in the repo to its appropriate systemd location and start/enable the service. The result is that the
|
||||
central scheduler is up and running easily.
|
||||
|
||||
The other option is to add ``--local-scheduler`` to your :ref:`scan_command` command from within the ``recon-pipeline`` shell.
|
||||
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ Setup
|
||||
#####
|
||||
|
||||
To use the web console, you'll need to :ref:`install the luigid service<install-ref-label>`. Assuming you've already
|
||||
installed ``pipenv`` and created a virtual environment, you can simply run the ``install luigi-service``
|
||||
installed ``pipenv`` and created a virtual environment, you can simply run the ``tools install luigi-service``
|
||||
from within the pipeline.
|
||||
|
||||
Dashboard
|
||||
|
||||
Reference in New Issue
Block a user