职业功能的API
专业特性API包括一些方法，这些方法可以访问Metasploit Pro用户界面中的许多顶级特性。这些方法包括启动发现扫描、从其他工具导入数据、启动自动exploit、运行bruteforce攻击和生成报告。由于这些方法的设计目的是通过用户界面公开所有可用的功能，因此它们接受大量参数。
pro.start_discover
箴。start_discover方法是后台方法，它在Metasploit Pro用户界面中驱动扫描操作。此操作启动对一系列IP地址的发现扫描，识别活动主机，开放服务，并从发现的服务中提取信息。结果数据存储在后端数据库中。箴。start_discover方法以单个哈希参数的形式接受大量选项，并返回一个可以使用Pro任务API监视的任务ID。
散列内的各个选项在下面定义。
“诱导多能性”
此选项决定扫描中包含哪些IP地址和IP范围。这个选项是一个IP地址和/或IP范围的数组。
- 要求——是的
- 例子- ["192.168.0.0/24"]
工作空间
此选项指示此扫描应属于的项目名称。这与用户界面中列出的项目全名相关联。
- 要求——是的
- 例子——Project1
用户名
此选项指定哪个Pro用户名此扫描任务应归因于。如果未指定，则使用具有管理权限的第一个用户。
- 要求——不
- 例子——管理
DS_BLACKLIST_HOSTS
这个选项决定了在ips范围内哪些地址应该被排除在扫描之外。多个条目应该用空格分隔。
- 要求——不
- 例子——192.168.0.1
DS_PORTSCAN_SPEED
这个选项应该是偏执狂、鬼祟、礼貌、正常、好斗或疯狂。这些选项对应于Nmap安全扫描程序中的常见选项，并逐步提高扫描速度。对于本地以太网来说，crazy实际上是一个合理的设置。
- 要求——不
- 例子——疯了
ds_ports_extra.
此选项允许在扫描中包含其他TCP端口。端口以Nmap格式指定(范围之间用“-”和“逗号”分隔)。
- 要求——不
- 例子- 1 - 65535
DS_PORTS_BLACKLIST
此选项定义了应该始终排除的端口列表。
- 要求——不
- 例子1723 - 9100,
DS_PORTS_CUSTOM
此选项覆盖内置端口列表（派生从加载的漏洞模块），并且只扫描列出的端口。
- 要求——不
- 例子- 1-1024
DS_PORTSCAN_TIMEOUT
该选项设置扫描程序在单个主机上花费的最大时间(以秒为单位)。如果您使用另一个选项增加要扫描的端口范围，那么这个范围也应该增加。300秒(5分钟)是一个合理的设置，即使对过滤严重的网络。
- 要求——不
- 例子- 300
DS_PORTSCAN_SOURCE_PORT
此选项配置扫描的源端口。将其设置为80、53或20通常可以绕过配置不佳的防火墙和访问列表。
- 要求——不
- 例子- 53年
ds_customnmap.
这个选项可以用来完全覆盖通常由Pro使用的Nmap命令行，并替换它(不包括主机和端口)。
- 要求——不
- 例子-旧金山- o
DS_UDP_PROBES
此选项可用于禁用UDP服务探针通过将其设置为FALSE（否则启用）。
- 要求——不
- 例子——错误
DS_FINGER_USERS
此选项可用于禁用手指服务(79/tcp)自动获取用户名，默认情况下发生时启用。
- 要求——不
- 例子——错误
ds_snmp_scan.
此选项可用于禁用默认扫描中通常包含的SNMP扫描器。这个扫描程序尝试猜测每个目标主机的少量通用SNMP社区。
- 要求——不
- 例子——错误
DS_IDENTIFY_SERVICES
此选项可用于禁用服务标识阶段，该阶段通常在第一次传递中没有标识一个或多个服务时触发。
- 要求——不
- 例子——错误
DS_SMBUSER.
如果提供了有效的用户名和密码，则可以使用此选项从SMB服务提取额外的信息。
- 要求——不
- 例子——管理员
ds_smbpass.
此选项定义与DS_SMBUser选项对应的密码。
- 要求——不
- 例子——S3cr3t
DS_SMBDomain
此选项定义与DS_SMBUser选项对应的域。
- 要求——不
- 例子-集团
DS_DRY_RUN
此选项设置为true时，将导致任务显示它会做什么，但实际上并不会发送任何网络流量。
- 要求——不
- 例子——真正的
ds_single_scan.
当设置为true时，将顺序扫描每个主机，而不是一次扫描多个主机。有助于减少数据包丢失在特别差的网络。
- 要求——不
- 例子——真正的
DS_FAST_DETECT
当设置为true时，该选项将限制扫描到一小组TCP端口。
- 要求——不
- 例子——真正的
请求示例
使用默认设置要扫描192.168.0.0/24的示例请求将如下：
壳牌
1
［“pro.start_discover”，“<标记>”，
2
｛
3.
“ips”＝>［“192.168.0.0 / 24”］，
4
“工作区”＝>“Project1”
5
｝
6
］
如果我们改变相同的请求来扫描所有的65535 TCP端口，它看起来像:
壳牌
1
［“pro.start_discover”，“<标记>”，
2
｛
3.
“ips”＝>［“192.168.0.0 / 24”］，
4
“工作区”＝>“Project1”，
5
“DS_PORTS_CUSTOM”＝>“1 - 65535”
6
｝
7
］
反应示例
json
1
｛“task_id”＝＞“109”｝
pro.start_import
箴。start_import方法驱动Metasploit Pro用户界面中的导入操作。此方法假设文件已经在本地磁盘上(相对于Metasploit Pro系统)，或者暴露控制台已经配置了一个或多个活动站点。若要导入任意数据而不必先将文件上传到服务器，请参阅pro.import_data方法相反。箴。start_import方法以单个哈希参数的形式接受大量选项，并返回一个可以使用Pro任务API监视的任务ID。
散列内的各个选项在下面定义。
工作空间
此选项指示此导入应属于的项目名称。这与用户界面中列出的项目全名相关联。
- 要求——是的
- 例子——Project1
用户名
此选项指定该任务应归于哪个专业用户名。如果未指定，则使用具有管理权限的第一个用户。
- 要求——不
- 例子——管理
DS_PATH
此选项指定要导入的服务器-本地文件路径。如果您是从远程系统调用这个API，那么调用pro会更有意义。import_data API。
- 要求——不
- 例子- / tmp / nexpose.xml
DS_BLACKLIST_HOSTS
此选项确定应从导入中排除哪些地址。多个条目应该用空格分隔。
- 要求——不
- 例子——192.168.0.1
DS_PRESERVE_HOSTS
此选项可用于防止导入期间对现有主机的修改。
- 要求——不
- 例子——真正的
DS_REMOVE_FILE
此选项告诉服务将在导入后删除指定为DS_Path的文件。
- 要求——不
- 例子——真正的
DS_ImportTags
此选项指示在处理Metasploit Pro导出文件时是否导入标记以及主机数据。
- 要求——不
- 例子——错误
ds_nexpose_console.
该选项与DS_NEXPOSE_SITE参数结合使用时，可用于直接从每个配置的暴露控制台导入数据。保留此空白，以便从文件路径导入。
- 要求——不
- 例子- EnterpriseScanner.
DS_NEXPOSE_SITE
该选项与DS_NEXPOSE_CONSOLE参数结合使用时，可用于直接从现有的exposure站点导入数据。保留此空白，以便从文件路径导入。
- 要求——不
- 例子——金融
请求示例
导入暴露导出XML的示例请求如下:
壳牌
1
［“pro.start_import”，“<标记>”，
2
｛
3.
“工作区”＝>“Project1”，
4
“ds_path”＝>“/tmp/nexpose.xml”
5
｝
6
］
反应示例
json
1
｛“task_id”＝＞“109”｝
pro.start_import_creds
箴。Start_import_creds方法用于导入凭证(用户、密码、散列和密钥)。这个方法假设一个文件已经在本地磁盘上(相对于Metasploit Pro系统)。箴。start_import_creds方法以单个哈希参数的形式接受大量选项，并返回一个可以使用Pro任务API监视的任务ID。
散列中的各个选项在下表中定义。
工作空间
此选项指示此导入应属于的项目名称。这与用户界面中列出的项目全名相关联。
- 要求——是的
- 例子——Project1
用户名
此选项指定该任务应归于哪个专业用户名。如果未指定，则使用具有管理权限的第一个用户。
- 要求——不
- 例子——管理
DS_IMPORT_PATH
此选项指定要导入的服务器-本地文件路径。
- 要求——不
- 例子- / tmp / wordlist.txt
DS_FTYPE
这个选项告诉服务这是哪种类型的导入。它应该是“userpass”、“user”、“pass”、“pwdump”或“ssh_keys”中的一个。
- 要求——不
- 例子——通过
DS_NAME
此选项指示此导入数据集的唯一名称。
- 要求——不
- 例子——common_passwords
DS_DESC
此选项提供了对导入数据的用户可见的描述
- 要求——不
- 例子- 常见的密码
DS_ORIG_FILE_NAME
此选项指示凭据数据的原始文件名。
- 要求——不
- 例子——my_passwords.txt
DS_REMOVE_FILE
此选项指示服务是否应该在导入本地文件后删除该文件。
- 要求——不
- 例子——真正的
请求示例
壳牌
1
［“pro.start_import_creds”，“<标记>”，
2
｛
3.
“工作区”＝>“Project1”，
4
“DS_IMPORT_PATH”＝>“/ tmp / pwdump.txt”，
5
“DS_FTYPE”＝>“pwdump”，
6
“DS_NAME”＝>“domain_dump”，
7
“DS_DESC”＝>"来自DC的密码哈希"，
8
“ds_remove_file”＝>假
9
｝
10
］
反应示例
json
1
｛“task_id”＝＞“109”｝
pro.start_nexpose
箴。方法start_expose用于通过Metasploit Pro服务直接启动暴露扫描。箴。start_exposure方法以单个哈希参数的形式接受大量选项，并返回一个可以使用Pro任务API监视的任务ID。
散列中的各个选项在下表中定义。
工作空间
此选项指示此导入应属于的项目名称。这与用户界面中列出的项目全名相关联。
- 要求——是的
- 例子——Project1
用户名
此选项指定该任务应归于哪个专业用户名。如果未指定，则使用具有管理权限的第一个用户。
- 要求——不
- 例子——管理
DS_WHITELIST_HOSTS
此选项指示此导入应属于的项目名称。这与用户界面中列出的项目全名相关联。
- 要求——是的
- 例子——192.168.0.0 / 24
DS_BLACKLIST_HOSTS
此选项指定该任务应归于哪个专业用户名。如果未指定，则使用具有管理权限的第一个用户。
- 要求——不
- 例子——192.168.0.3
ds_nexpose_host.
此选项指定要扫描的地址和网络范围的列表。
- 要求——不
- 例子——127.0.0.1
DS_NEXPOSE_PORT
此选项指定暴露控制台的端口。
- 要求——不
- 例子- 3780
DS_NEXPOSE_USER
此选项为公开控制台指定一个有效的用户名。
- 要求——不
- 例子——nxadmin
nexpose_pass
此选项指定用户帐户的密码。它使用不同的语法来防止在Event表中记录密码。
- 要求——不
- 例子——S3cr3t
DS_SCAN_TEMPLATE
选项指定要使用的扫描模板。常用的模板包括:pentest-audit全审计、用尽审计、discovery、aggressive-discovery和dos-audit。
- 要求——不
- 例子——pentest-audit
请求示例
下面显示了一个请求开始一个新的暴露扫描的示例:
壳牌
1
［“pro.start_nexpose”，“<标记>”，
2
｛
3.
“工作区”＝>“Project1”，
4
“DS_WHITELIST_HOSTS”＝>“192.168.0.0 / 24”，
5
“DS_NEXPOSE_HOST”＝>“127.0.0.1”，
6
“DS_NEXPOSE_PORT”＝>3780，
7
“DS_NEXPOSE_USER”＝>“nxadmin”，
8
“nexpose_pass”＝>“s3cr3t”，
9
“DS_SCAN_TEMPLATE”＝>“pentest-audit”
10
｝
11
］
反应示例
json
1
｛“task_id”＝＞“109”｝
pro.start_bruteforce
箴。方法start_bruteforce用于启动一个新的Bruteforce任务。箴。start_bruteforce方法以单个哈希参数的形式接受大量选项，并返回一个可以使用Pro任务API监视的任务ID。brute任务要求通过扫描、导入或暴露首先显示主机和服务。
散列中的各个选项在下表中定义。
工作空间
此选项指示此导入应属于的项目名称。这与用户界面中列出的项目全名相关联。
- 要求——是的
- 例子——Project1
用户名
此选项指定该任务应归于哪个专业用户名。如果未指定，则使用具有管理权限的第一个用户。
- 要求——不
- 例子——管理
DS_WHITELIST_HOSTS
此选项指定要测试的地址和网络范围的列表。
- 要求——是的
- 例子——192.168.0.0 / 24
DS_BLACKLIST_HOSTS
此选项指定要从目标范围中排除的地址和网络范围的列表。
- 要求——不
- 例子——192.168.0.3
DS_STOP_ON_SUCCESS
此选项指示bruteforce攻击是否应该在破解第一个帐户后继续测试服务。
- 要求——是的
- 例子——真正的
DS_VERBOSE
此选项指示在bruteforce期间显示多少诊断信息。
- 要求——不
- 例子——真正的
DS_INCLUDE_KNOWN
此选项指示bruteforce攻击是否应该使用以前找到的凭据。
- 要求——是的
- 例子——真正的
DS_DRY_RUN
该选项指示是否跳过bruteforce攻击，只显示测试过的用户名和密码。
- 要求——不
- 例子——真正的
DS_BRUTEFORCE_SCOPE
此选项指示在何种野蛮模式下操作。这是以下设置之一:快速、默认、正常、深度、已知、导入或50k。
- 要求——是的
- 例子- 普通的
ds_bruteforce_speed
此选项指定执行蛮力攻击的速度。这是以下设置之一:缓慢，缓慢，潜行，正常，快速，或涡轮。
- 要求——是的
- 例子- 涡轮增长
ds_bruteforce_services.
此选项指定要测试的协议。多个协议之间应该用空格隔开。可用协议包括:SMB、Postgres、DB2、MySQL、MSSQL、Oracle、HTTP、HTTPS、SSH、Telnet、FTP、EXEC、LOGIN、SHELL、VNC、SNMP。
- 要求——是的
- 例子- - - - - - SSH
ds_bruteforce_getsession.
此选项指定是否使用被破解的帐户来访问被测试的系统。
- 要求——是的
- 例子——真正的
ds_quickmode_creds.
此选项指定要作为蛮力攻击的一部分使用的额外凭据。语法是“用户名”，后面跟着一个空格，然后是“密码”，每个凭据的新行“\n”。
- 要求——不
- 例子——用户名密码\ n
DS_PAYLOAD_METHOD
此选项确定在打开会话时使用何种连接方法，它可以是自动、反向或绑定。
- 要求——不
- 例子——汽车
DS_PAYLOAD_TYPE
该选项决定是选择mepreter会话类型还是shell会话类型。
- 要求——不
- 例子——meterpreter
DS_PAYLOAD_PORTS
此选项指定用于绑定和反向连接的端口范围。
- 要求——不
- 例子- 4000 - 5000
ds_smb_domains.
此选项指定一个域列表，由空格分隔，当使用NTLM的强制协议时使用。
- 要求——不
- 例子——Domain1
DS_PRESERVE_DOMAINS
此选项指定是否使用先前确定的每个用户名和密码的原始域名。
- 要求——不
- 例子——真正的
DS_CRED_FILE_IDS
此选项指定要在这个brute - force任务中包含哪些导入的凭据文件。这需要了解导入的凭据文件id。
- 要求——不
- 例子- 34
ds_maxguesseSperservice.
此选项指定每个服务的最大身份验证尝试次数，默认值为0，是无限制的。
- 要求——不
- 例子- 100
DS_MAXMINUTESPERSERVICE
该选项指定在每个服务上花费的最大时间(以分钟为单位)，默认值为0，是无限的。
- 要求——不
- 例子- 60
DS_MAXGUESSESPERUSER
此选项指定每个唯一用户帐户尝试的最大猜测次数，默认为0，即无限制。
- 要求——不
- 例子- 3
DS_MAXMINUTESOVERALL
这个选项指定了整个bruteforce任务的最大运行时间，默认值为0，是无限的。
- 要求——不
- 例子- 30
DS_MAXGUESSESOVERALL
该选项指定要尝试的最大猜测次数，默认值为0，不受限制。
- 要求——不
- 例子- 1000
ds_bruteforce_skip_blank_passwords.
该选项指定是否完全跳过空白密码，默认为false。
- 要求——不
- 例子——真正的
DS_BRUTEFORCE_SKIP_MACHINE_NAMES
此选项指定是否跳过机器名作为单词列表的密码种子源，默认为false。
- 要求——不
- 例子——真正的
DS_BRUTEFORCE_SKIP_BUILTIN_WINDOWS_ACCOUNTS
此选项指定是否跳过通常没有弱密码的内置Windows帐户(服务帐户)。
- 要求——不
- 例子——真正的
DS_BRUTEFORCE_SKIP_BLANK_BUILTIN_UNIX_ACCOUNTS
此选项指定是否跳过通常有弱密码的内置Unix帐户(服务帐户)。
- 要求——不
- 例子——真正的
DS_BRUTEFORCE_RECOMBINE_CREDS
此选项指定是否重新组合已知的、导入的和其他凭证以创建单词列表。
- 要求——不
- 例子——真正的
DS_MSSQL_WINDOWS_AUTH
此选项表示MSSQL服务器身份验证应该使用NTLM而不是标准模式。默认为false。
- 要求——不
- 例子——真正的
启动新的BruteForce任务的示例请求：
请求示例
壳牌
1
［“pro.start_bruteforce”，“<标记>”，
2
｛
3.
“工作区”＝>“Project1”，
4
“DS_WHITELIST_HOSTS”＝>“192.168.0.0 / 24”，
5
“DS_BRUTEFORCE_SCOPE”＝>“违约”，
6
“DS_BRUTEFORCE_SERVICES”＝>“SSH HTTP”，
7
“DS_BRUTEFORCE_SPEED”＝>“涡轮”，
8
“DS_INCLUDE_KNOWN”＝>正常的,
9
“ds_bruteforce_getsession”＝>真的
10
｝
11
］
反应示例
json
1
｛“task_id”＝＞“109”｝
pro.start_exploit
箴。start_exploit方法驱动Metasploit Pro用户界面中的exploit操作。箴。start_exploit方法以单个哈希参数的形式接受大量选项，并返回一个可以使用Pro任务API监视的任务ID。利用操作需要主机、服务和可选的漏洞，然后才能使用。这可以首先使用扫描、导入和暴露操作来完成。
散列中的各个选项在下表中定义。
工作空间
此选项指示此导入应属于的项目名称。这与用户界面中列出的项目全名相关联。
- 要求——是的
- 例子——Project1
用户名
此选项指定该任务应归于哪个专业用户名。如果未指定，则使用具有管理权限的第一个用户。
- 要求——不
- 例子——管理
DS_WHITELIST_HOSTS
此选项指示此导入应属于的项目名称。这与用户界面中列出的项目全名相关联。
- 要求——是的
- 例子——192.168.0.0 / 24
DS_BLACKLIST_HOSTS
此选项指定该任务应归于哪个专业用户名。如果未指定，则使用具有管理权限的第一个用户。
- 要求——不
- 例子——192.168.0.3
ds_whitelist_ports.
此选项指定剥削任务期间允许的端口。此默认值为1-65535（所有端口）。
- 要求——不
- 例子- 1 - 1000
DS_BLACKLIST_PORTS
这个选项决定哪些地址应该被排除在测试之外。多个条目应该用空格分隔。此选项指定在开发任务期间要避免的端口列表。
- 要求——不
- 例子- 80443
DS_MinimumRank
此选项指定漏洞利用的最低可靠性级别，包括剥削任务。这是以下设置之一，按照责任的增加：低，平均，正常，良好，伟大或优秀。
- 要求——是的
- 例子——伟大的
DS_EXPLOIT_SPEED
此选项指示要并行运行多少漏洞。默认值是5，合理的最大值是10，这取决于资源的分配方式。
- 要求——是的
- 例子- 5
DS_EXPLOIT_TIMEOUT
此选项设置任何单个漏洞可以运行的最大时间。设置这个低于2分钟可以防止一些exploit的工作。
- 要求——不
- 例子- 5
DS_LimitSessions
此选项确定是否尝试避免利用已具有活动会话的系统。默认值为真。
- 要求——不
- 例子——错误
DS_IgnoreFragileDevices
此选项指定是否避免在公共测试期间已知已知的系统运行利用。这是基于内部黑名单，并导致打印机，并且利用引擎自动跳过许多网络设备。该设置默认为true。
- 要求——不
- 例子——错误
ds_filterbyos
此选项指示漏洞利用引擎在将漏洞利用与主机匹配时使用操作系统信息。只有当对操作系统签名的信心很高时，漏洞才会被跳过。这个选项的默认值是true。
- 要求——不
- 例子——错误
ds_onlymatch.
此选项，当设置为True时，将引擎匹配匹配的指令匹配但实际上并未运行它们。默认设置为false。
- 要求——不
- 例子——错误
DS_MATCH_VULNS
此选项指示利用引擎根据漏洞引用匹配漏洞。该设置默认为true。
- 要求——是的
- 例子——错误
DS_MATCH_PORTS
此选项指示利用引擎匹配基于开放服务的利用。该设置默认为true。
- 要求——是的
- 例子——错误
DS_PAYLOAD_METHOD
此选项确定在打开会话时使用何种连接方法，它可以是自动、反向或绑定。
- 要求——不
- 例子——汽车
DS_PAYLOAD_TYPE
该选项决定是选择mepreter会话类型还是shell会话类型。
- 要求——不
- 例子——meterpreter
DS_PAYLOAD_PORTS
此选项指定用于绑定和反向连接的端口范围。
- 要求——不
- 例子- 4000 - 5000
DS_EVASION_LEVEL_TCP
此选项指定0到3之间的传输级别逃避水平。
- 要求——不
- 例子－ 1
DS_EVASION_LEVEL_APP
此选项指定介于0和3之间的应用程序级回避级别。
- 要求——不
- 例子－ 1
DS_ModuleFilter
这个选项指定允许运行的模块名的白名单，用逗号分隔。默认情况下，所有模块都被认为满足其他条件。
- 要求——不
- 例子-利用/ windows / smb / psexec
通过网络范围运行漏洞的示例请求:
请求示例
壳牌
1
［“pro.start_exploit”，“<标记>”，
2
｛
3.
“工作区”＝>“Project1”，
4
“DS_WHITELIST_HOSTS”＝>“192.168.0.0 / 24”，
5
“DS_MinimumRank”＝>“伟大”，
6
“DS_EXPLOIT_SPEED”＝>5，
7
“ds_exploit_timeout”＝>2，
8
“ds_limitsessions”＝>真的,
9
“ds_match_vulns”＝>真的,
10
“DS_MATCH_PORTS”＝>真的
11
｝
12
］
反应示例
json
1
｛“task_id”＝＞“109”｝
pro.start_cleanup
箴。start_cleanup方法驱动Metasploit Pro用户界面中的Cleanup操作。箴。start_cleanup方法以单个哈希参数的形式接受许多选项，并返回一个可以使用Pro任务API监视的任务ID。
散列中的各个选项在下表中定义。
工作空间
此选项指示此导入应属于的项目名称。这与用户界面中列出的项目全名相关联。
- 要求是的
- 例子——Project1
用户名
此选项指定该任务应归于哪个专业用户名。如果未指定，则使用具有管理权限的第一个用户。
- 要求——不
- 例子——管理
DS_SESSIONS
此选项指定要关闭的会话ID列表。这些是RPC服务会话ID。
- 要求——是的
- 例子- 1 2 3
DS_DBSESSIONS
此选项根据会话id的数据库标识符指定会话id列表。
- 要求——不
- 例子1002年- 1001年
请求示例
壳牌
1
［“pro.start_cleanup”，“<标记>”，
2
｛
3.
“工作区”＝>“Project1”，
4
“DS_SESSIONS”＝>“100 101 102”，
5
｝
6
］
反应示例
json
1
｛“task_id”＝＞“109”｝
pro.start_collect
箴。start_collect方法驱动Metasploit Pro用户界面中的Collect操作。箴。start_collect方法以单个Response:参数的形式接受许多选项，并返回一个可以使用Pro任务API监视的任务ID。
散列中的各个选项在下表中定义。
工作空间
此选项指示此导入应属于的项目名称。这与用户界面中列出的项目全名相关联。
- 要求——是的
- 例子——Project1
用户名
此选项指定该任务应归于哪个专业用户名。如果未指定，则使用具有管理权限的第一个用户。
- 要求——不
- 例子——管理
DS_SESSIONS
此选项指定要关闭的会话ID列表。这些是RPC服务会话ID。
- 要求——是的
- 例子- 1 2 3
DS_COLLECT_SYSINFO
该选项指示是否应该获取基本的系统信息。
- 要求——是的
- 例子——真正的
DS_COLLECT_PASSWD
该选项指示是否应该获取密码和散列值。
- 要求——是的
- 例子——真正的
DS_COLLECT_SCREENSHOTS
该选项指示是否应该截图。
- 要求——是的
- 例子——真正的
DS_COLLECT_SSH
该选项指示是否应该获取ssh密钥信息。
- 要求——是的
- 例子——真正的
DS_COLLECT_FILES
该选项指示是否应该获取与模式匹配的特定文件。
- 要求——是的
- 例子——真正的
ds_collect_files_pattern.
此选项将文件模式设置为自动下载。
- 要求——不
- 例子- * . doc
DS_COLLECT_FILES_COUNT
此选项设置每个会话可下载的最大文件数。
- 要求——不
- 例子- 100
DS_COLLECT_FILES_SIZE
此选项设置每个文件可下载的最大文件大小，单位为千字节。
- 要求——不
- 例子- 40
请求示例
壳牌
1
［“pro.start_collect”，“<标记>”，
2
｛
3.
“工作区”＝>“Project1”，
4
“DS_SESSIONS”＝>“100 101 102”，
5
“DS_COLLECT_SYSINFO”＝>真的,
6
“ds_collect_passwd”＝>真的,
7
“DS_COLLECT_SCREENSHOTS”＝>真的,
8
“DS_COLLECT_SSH”＝>真的,
9
“DS_COLLECT_FILES”＝>假
10
｝
11
］
反应示例
json
1
｛“task_id”＝＞“109”｝
pro.start_report
箴。start_report方法在Metasploit Pro用户界面中驱动报表操作。箴。start_report方法以单个哈希参数的形式接受许多选项，并返回一个可以使用Pro任务API监视的任务ID。
散列中的各个选项在下表中定义。
workspace_name
要用于为报表收集数据的工作区的名称。
- 要求——是的
- 例子——Project1
- 类型——字符串
的名字
报告将被保存为。
- 要求——是的
- 例子——reportABC
- 类型——字符串
report_type
要生成的报告类型。report_type可以是activity, audit, credentials, collected_evidence, compromised_hosts, custom, fisma, mm_auth, mm_pnd, mm_segment, pci, services, social_engineering，或webapp_assessment。
- 要求——是的
- 例子——审计
- 类型——字符串
report_template
用于自定义报表的模板。要指定模板，请输入自定义Jasper JRXML模板的完整文件路径。
- 要求——是的
- 例子——/道路/ / custom.jrxml
- 类型——字符串
不要使用这个字段，除非report_type被设置为'custom'。
created_by
报告应归属的用户名。
- 要求——是的
- 例子——管理
- 类型——字符串
file_formats
您希望为报告生成的文件格式。可用的文件格式包括PDF、HTML、RTF、XML和Word;但是，每种报表类型可用的文件格式都不同。
- 要求——是的
- 例子- - - - - - pdf
- 类型——数组
活动、Web应用程序评估、FISMA和PCI报告不包括Word格式。
只有PCI和FISMA报表支持XML格式。
电子邮件_recipients.
报告应通过电子邮件发送到的地址。地址可以用逗号、分号、换行符或空格分隔。
- 要求——不
- 例子——joe@mail.com, jon@mail.com
- 类型——字符串
mask_credentials
启用或禁用报告中凭据的屏蔽。将此选项设置为true或false。
- 要求——不
- 例子——真正的
- 类型——布尔
included_addresses
包括报告中的指定主机。
- 要求——不
- 例子——192.168.1.0/24
- 类型——字符串
excluded_addresses
排除报告中指定的主机。
- 要求——不
- 例子——192.168.1.1
- 类型——字符串
logo_path
将自定义徽标添加到报表的封面页。
- 要求——不
- 类型——字符串
您必须指定映像的完整路径。图像必须具有agif、png、jpg或jpeg文件类型。
se_campaign_id
您希望用于为报告收集数据的社会工程活动的ID。
- 要求——不
- 例子－ 1
- 类型——整数
仅限于社会工程报告的此字段。
部分
标识要包含在报告中的部分。只包括指定的部分。否则，如果不指定此选项，将包含所有部分。要查看报告的部分名称，请使用pro。list_report_types方法。
- 要求——不
- 例子- cover, project_summary, task_details
- 类型——数组
usernames_reported
在报告的执行摘要部分包括活动用户列表。您必须提供一个用逗号分隔的用户名列表。
- 要求——不
- 例子—admin1, admin
- 类型——字符串
请求示例
壳牌
1
［“pro.report_start”，“<标记>”，
2
｛
3.
工作区:workspace_name,
4
姓名：“default_ # {Time.now.to_i}”，
5
report_type::审计,
6
created_by:“whoareyou”，
7
file_formats:［: pdf］
8
｝
9
］
pro.report_list.
箴。Report_list方法显示已在指定工作区中生成的所有报告。
pro.list_report_types
pro.list_report_types方法显示可以在工作区中生成的所有报告类型。
pro.report_download
箴。Report_download方法下载指定的报告及其构件。
pro.report_artifact_download
箴。Report_artifact_download方法下载指定的报告构件。
pro.start_export
箴。start_export方法驱动Metasploit Pro用户界面中的导出操作。
散列中的各个选项在下表中定义。
workspace_name
要从中导出数据的工作区的名称。
- 要求——是的
- 例子——project1
- 类型——字符串
export_type
- 要求——是的
created_by
导出应该归于的用户名。
- 要求——是的
- 例子——管理
- 类型——字符串
的名字
导出文件将被保存为。
- 要求——不
- 例子——reportABC
- 类型——字符串
mask_credentials
启用或禁用导出中凭据的屏蔽。将此选项设置为true或false。
- 要求——不
- 例子——真正的
- 类型——布尔
included_addresses
在导出中包含指定的主机。
- 要求——不
- 例子——192.168.1.0/24
- 类型——字符串
excluded_addresses
从导出中排除指定的主机。
- 要求——不
- 例子——192.168.1.1
- 类型——字符串
pro.export_list
箴。方法显示在指定工作区中生成的所有导出。
pro.export_download
pro.export_download方法下载指定的导出文件。