Mixins and APIs

An index of mixins added to modules with include or prepend to provide shared functionality. See Base Classes and Mixins for how to choose them.

Communication

Mixin	Main APIs	Page
HttpClient	send_request_cgi	HttpClient / send_request_cgi
Tcp	connect / sock	Tcp
HttpServer	on_request_uri	HttpServer
SSH	ssh_client_defaults	SSH
SMB::Client family	smb_login and others	SMB

Execution Models and Delivery

Mixin	Main APIs	Page
Scanner	run_host	Scanner
AuthBrute	build_credential_collection	AuthBrute
CmdStager	execute_cmdstager	CmdStager
AutoCheck (prepend)	Automatic check	AutoCheck
FileDropper	register_file_for_cleanup	FileDropper

Storage and Session Operations

Mixin	Main APIs	Page
Report	report_* / store_loot	Report
Post::Common / File / OS-specific	cmd_exec / read_file	Post Mixins

Combination Patterns

Goal	Example combination
HTTP RCE exploit	AutoCheck + HttpClient + CmdStager + FileDropper
HTTP scanning across hosts	HttpClient + Scanner + Report
SSH dictionary login	SSH::Options + AuthBrute + Scanner + Report
SMB share enumeration	SMB::Client(+Authenticated) + Scanner + Report
Browser trap	HttpServer(+HTML)
Linux post-exploitation collection	Post + File + Unix + Report

Mixins also exist for other protocols such as LDAP, MSSQL, DCERPC, and Postgres under lib/msf/core/exploit/remote/. Before adding new communication code, check which mixin existing modules for the same protocol include.