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 or auxiliary (the types the planner emits).

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

Fetch full module metadata (options, targets, rank, description, …).

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) -> MsfRpcClient

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.