Struct MsfRpcClient 

pub struct MsfRpcClient { /* private fields */ }

Implementations

impl MsfRpcClient

pub fn new( host: &str, port: u16, username: &str, password: &str, ssl: bool, ) -> Self

pub fn login(&mut self) -> Result<MSFLoginResult>

pub fn logout(&mut self)

pub fn is_authenticated(&self) -> bool

pub fn get_workspaces(&self) -> Result<MSFWorkspacesResult>

pub fn get_hosts(&self, workspace: Option<&str>) -> Result<MSFHostsResult>

pub fn check_host_exists( &self, address: &str, workspace: Option<&str>, ) -> Result<MSFHostCheckResult>

pub fn rpc_call( &self, method: &str, params: &[MsgValue], timeout_secs: u64, ) -> Result<MsgValue>

Generic authenticated RPC call: [method, token, ...params].

Used by the exploitation layer for module discovery, execution and job monitoring. Returns the raw msgpack response so the caller can map it to strongly typed models.

pub fn module_exists(&self, module_type: &str, name: &str) -> Result<bool>

Verify that a module exists on the connected Metasploit instance. module_type is exploit, auxiliary or post.

Distinguishes three outcomes: the module exists (Ok(true)), it does not exist (Ok(false)), or the lookup itself failed (Err).

pub fn module_info(&self, module_type: &str, name: &str) -> Result<MsgValue>

Fetch full module metadata via module.info.

The RPC module.info handler accepts [ModuleType, ModuleName] on all supported framework releases. A modern server answers with a rich metadata map for known modules and an error map ― classifiable as “module not found” or an RPC failure ― for unknown ones. Only very old frameworks still expect the single full-name signature; when the modern response signals an argument-shape mismatch (rather than a missing module) we fall back to that form once.

pub fn module_options(&self, module_type: &str, name: &str) -> Result<MsgValue>

Fetch the datastore options for a module via module.options. Mirrors the module.info lookup logic (modern form first, legacy single-name fallback reserved for servers that reject the modern one).

pub fn list_modules_for_type(&self, module_type: &str) -> Result<Vec<MSFModule>>

List every module of the given RPC type currently loaded by the instance. Returns full refnames including the type prefix, e.g. auxiliary/scanner/http/robots_txt.

RPC listing methods take no arguments; passing a module name to them is ignored (or rejected by stricter servers) and would never be a valid existence probe.

pub fn list_modules(&self) -> Result<Vec<MSFModule>>

Load the union of all exploit, auxiliary and post modules known to the connected instance. Used by the process pipeline so suggestions are grounded in what the instance can actually run.

pub fn module_execute( &self, module_type: &str, name: &str, options: &BTreeMap<String, String>, payload: Option<&str>, ) -> Result<MsgValue>

Execute a module. Returns a map containing job_id on success or an error payload on failure.

pub fn job_list(&self) -> Result<MsgValue>

List all running jobs. Response map: { "jobs": { "0": {...}, ... } }.

pub fn job_info(&self, job_id: &str) -> Result<MsgValue>

Fetch status of a single job by id.

pub fn job_stop(&self, job_id: &str) -> Result<MsgValue>

Stop a running job by id.

pub fn session_list(&self) -> Result<MsgValue>

List current sessions. Response map: { "sessions": { "1": {...}, ... } }.

pub fn db_loots(&self, workspace: &str) -> Result<MsgValue>

List loot records for a workspace.

Trait Implementations

impl Clone for MsfRpcClient

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MsfRpcClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.