Skip to content

Shared Steps

These are the shared steps for writing a module. Each page uses concrete examples to explain what to decide and what to write in code at that step.

#StepPage
1Module type and pathType and Location
2Base class and mixinsBase Classes and Mixins
3Metadata with update_infoupdate_info
4register_options / advanced optionsregister_options
5check / exploit / run / run_hostEntry Methods
6report_* / store_loot / credentialsSaving Results
7Cleanup with FileDropper and othersCleanup

For details specific to each module type, see Exploit, Auxiliary, and Post.