Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added module reloading API and CLI interface #243

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

calebstewart
Copy link
Owner

Description of Changes

This PR adds the ability to reload pwncat modules at runtime. This is facilitated through the addition of a new flag for the Manager.load_modules method, which now takes a force keyword argument, which forces reloading of previously loaded modules. Further, there is now a new Manager.reload_module method which accepts either a module instance or a module name to be reloaded specifically. Both load_modules and reload_module methods will also attempt to fix the current module context if a module is being reloaded, and reset any module configurations, which could fail if the module arguments have changed during reload. If a module-specific configuration fails to apply after reloading the module (likely because the module arguments changed on disk), a warning is printed and that configuration is lost.

Lastly, this PR adds new arguments to two pwncat commands: load and run. First, the load command now as either --force/-f or --reload/-r arguments. These are synonyms which force a reload of modules during loading (through the force argument of Manager.load_modules). Second, the run command now accepts a --reload/-r argument which forces the selected module to be reloaded via Manager.reload_module prior to execution, which should be useful when debugging a new module (or a misbehaving old module).

Fixes #241.

Please note any noqa: comments needed to appease flake8.

Major Changes Implemented:

  • Added force argument to Manager.load_modules to enable reloading modules.
  • Added the Manager.reload_module method to reload a specific module.
  • Added --force/-f and --reload/-r arguments to the load command (#241).
  • Added the --reload/-r argument to the run command to reload modules prior to executing.

Pre-Merge Tasks

  • Formatted all modified files w/ python-black
  • Sorted imports for modified files w/ isort
  • Ran flake8 on repo, and fixed any new problems w/ modified files
  • Ran pytest test cases
  • Added brief summary of updates to CHANGELOG (under [Unreleased])

For issues with pre-merge tasks, see CONTRIBUTING.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support reloading of custom modules using "reload"
1 participant