goby sdk 非官方版本 使用文档(2)

root8个月前Goby 非官方SDK 开发425
6、get_tasks 方法
I、调用文档
  1. get_tasks 接受参数:

def get_tasks(self, page=1, size=10, order_by='created_time', order='desc'):
  1. 功能:获取任务列表

  2. 调用方法

# 测试 获取任务列表 task_list = sdk.get_tasks(page=1,size=3) print(task_list)
  1. HTTP 默认请求

POST /api/v1/getTasks HTTP/1.1 Content-Type: application/json;charset=UTF-8 Content-Length: 73 Authorization: Basic dXNlcjpwYXNz host: 192.168.136.133:8361 Connection: close {"options":{"order":{"created_time":"desc"},"page":{"page":1,"size":15}}} HTTP/1.1 200 OK Content-Type: application/json Date: Mon, 10 Apr 2023 07: 15: 39 GMT Connection: close Content-Length: 20222 {    "statusCode": 200,    "messages": "",    "data": {        "lists": [            {                "taskId": "20230410043102",                "name": "",                "created_time": "2023-04-10 06:48:54",                "end_time": "2023-04-10 06:49:07",                "targets": "192.168.136.0/24",                "ports": "21,22,23,25,53,U:53,U:69,80,81,U:88,110,111,U:111,123,U:123,135,U:137,139,U:161,U:177,389,U:427,443,445,465,500,515,U:520,U:523,548,623,U:626,636,873,902,1080,1099,1433,U:1434,1521,U:1604,U:1645,U:1701,1883,U:1900,2049,2181,2375,2379,U:2425,3128,3306,3389,4730,U:5060,5222,U:5351,U:5353,5432,5555,5601,5672,U:5683,5900,5938,5984,6000,6379,7001,7077,8080,8081,8443,8545,8686,9000,9001,9042,9092,9100,9200,9418,9999,11211,U:11211,27017,U:33848,37777,50000,50070,61616",                "state": 4,                "progress": 0,                "memo": "{\"taskName\":\"\",\"taskId\":null,\"asset\":{\"ips\":[\"192.168.136.0/24\"],\"blackIps\":[],\"ports\":\"21,22,23,25,53,U:53,U:69,80,81,U:88,110,111,U:111,123,U:123,135,U:137,139,U:161,U:177,389,U:427,443,445,465,500,515,U:520,U:523,548,623,U:626,636,873,902,1080,1099,1433,U:1434,1521,U:1604,U:1645,U:1701,1883,U:1900,2049,2181,2375,2379,U:2425,3128,3306,3389,4730,U:5060,5222,U:5351,U:5353,5432,5555,5601,5672,U:5683,5900,5938,5984,6000,6379,7001,7077,8080,8081,8443,8545,8686,9000,9001,9042,9092,9100,9200,9418,9999,11211,U:11211,27017,U:33848,37777,50000,50070,61616\"},\"vulnerability\":{\"type\":\"0\",\"pocs_hosts\":{}},\"options\":{\"queue\":0,\"rate\":1000,\"random\":true,\"interface\":\"\",\"portScanMode\":0,\"checkAliveMode\":2,\"retryTimes\":0,\"socketTimeout\":6,\"proxy\":\"http://192.168.1.1:1080\",\"connectionSize\":100,\"screenshot\":false,\"screenshotRDP\":false,\"extractHost\":false,\"disableMdns\":null,\"disableUpnp\":null,\"matchPoCQuery\":null,\"fofaFetchSubdomainEnabled\":false,\"bruteforceSubdomainEnabled\":false,\"fofaKey\":\"\",\"fofaEmail\":\"\",\"fofaFetchSize\":100,\"pingFirst\":false,\"pingCheckSize\":10,\"pingConcurrent\":2,\"pingSendCount\":2,\"deepAnalysis\":true,\"scanICMP\":false,\"scanICMP6\":false,\"checkHoneyPot\":false,\"enableCrawler\":false,\"crawlerScope\":0,\"crawlerConcurrent\":5,\"crawlerMaxLinks\":50,\"crawlerMaxCrawlLinks\":1000,\"defaultUserAgent\":\"\",\"defaultDeepAnalysisCheckString\":\"\",\"hostListMode\":null,\"enableSutraCloud\":false,\"enableSutraQueryJson\":false}}",                "total": {                    "assets": 0,                    "ips": 0,                    "ports": 0,                    "vulnerabilities": 0,                    "allassets": 0,                    "allips": 0,                    "allports": 0,                    "allvulnerabilities": 0,                    "scan_ips": 0,                    "scan_ports": 91                },                "agenttaskid": ""            }        ],        "total": 11    } }
II、字段文档
  1. 请求字段

  • options: 获取任务列表的选项

    • order: 任务列表的排序方式,包含一个键值对

      • created_time: 按创建时间排序

      • desc: 降序排列

    • page: 分页信息,包含两个键值对

      • page: 当前页码

      • size: 每页展示的任务数目

  1. 返回字段

  • statusCode: 数字类型,表示操作的执行状态码,此处为200。

  • messages: 字符串类型,表示操作的执行消息,此处为空。

  • data: 对象类型,包含以下字段:

    • lists: 数组类型,包含一个列表对象,其中包含以下字段:

      • taskId: 字符串类型,表示任务ID,此处为"20230410043102"。

      • name: 字符串类型,表示任务名称,此处为空。

      • created_time: 字符串类型,表示任务创建时间,格式为"YYYY-MM-DD HH:MM:SS",此处为"2023-04-10 06:48:54"。

      • end_time: 字符串类型,表示任务结束时间,格式同上,此处为"2023-04-10 06:49:07"。

      • targets: 字符串类型,表示扫描的目标地址范围,此处为"192.168.136.0/24"。

      • ports: 字符串类型,表示扫描的端口号范围,此处为一个长字符串,包含多个端口号和协议类型,以逗号分隔。

      • state: 数字类型,表示任务状态,此处为4。

      • progress: 数字类型,表示任务完成进度,此处为0。

      • memo: 字符串类型,表示任务备注信息,包含各种设置和参数,此处是一个JSON格式的字符串。

      • total: 对象类型,包含以下字段:

        • assets: 数字类型,表示扫描到的资产数,此处为0。

        • ips: 数字类型,表示扫描到的IP地址数,此处为0。

        • ports: 数字类型,表示扫描到的端口数,此处为0。

        • vulnerabilities: 数字类型,表示扫描到的漏洞数,此处为0。

        • allassets: 数字类型,表示总的资产数,此处为0。

        • allips: 数字类型,表示总的IP地址数,此处为0。

        • allports: 数字类型,表示总的端口数,此处为0。

        • allvulnerabilities: 数字类型,表示总的漏洞数,此处为0。

        • scan_ips: 数字类型,表示扫描的IP地址数,此处为0。

        • scan_ports: 数字类型,表示扫描的端口数,此处为91。

      • agenttaskid: 字符串类型,表示代理任务ID,此处为空字符串。

    • total: 数字类型,表示列表的总数,此处为11。

更多使用说明访问:https://www.exp-9.com
7、get_statistics_data 方法
I、调用文档
  1. get_statistics_data 接受参数:

def get_statistics_data(self, task_id):
  1. 功能:获取任务的统计数据

  2. 调用方法

# 获取任务的统计数据 task_id = "20230403082842" statistics_data = sdk.get_statistics_data(task_id) print(statistics_data)
  1. HTTP 默认请求

POST /api/v1/getStatisticsData HTTP/1.1 Content-Type: application/json;charset=UTF-8 Content-Length: 27 Authorization: Basic dXNlcjpwYXNz host: 192.168.136.133:8361 Connection: close {"taskId":"20230404080804"} HTTP/1.1 200 OK Content-Type: application/json Date: Mon, 10 Apr 2023 07:23:47 GMT Content-Length: 1541 Connection: close {"statusCode":200,"messages":"","data":{"taskId":"20230404080804","total":{"assets":10,"ips":5,"ports":14,"vulnerabilities":0,"allassets":10,"allips":5,"allports":18,"allvulnerabilities":0,"scan_ips":0,"scan_ports":0},"software_products":[{"name":"Windows10","value":1,"source":null},{"name":"Windows","value":1,"source":null},{"name":"Vmware","value":1,"source":null},{"name":"VMware-Authentication Service","value":1,"source":null},{"name":"Ubuntu-system","value":1,"source":null}],"software_companies":[{"name":"other","value":2,"source":null},{"name":"Vmware, Inc.","value":1,"source":null},{"name":"VMware, Inc.","value":1,"source":null},{"name":"Oracle Corporation","value":1,"source":null},{"name":"Microsoft Corporation","value":1,"source":null}],"hardware_products":null,"hardware_companies":null,"vulnerabilities":null,"parent_category":[{"name":"Support System","value":2,"source":null},{"name":"Software System","value":2,"source":null},{"name":"Enterprise Application","value":1,"source":null}],"favicons":null,"fids":[{"name":"bclL6A9aXzKBK/xoJrZeckSQ7gymt98+","value":1,"source":{"fohash":"bclL6A9aXzKBK/xoJrZeckSQ7gymt98+"}},{"name":"OW8AeC9cKwa8TI0980pN7obnRtGFlnWv","value":1,"source":{"fohash":"OW8AeC9cKwa8TI0980pN7obnRtGFlnWv"}}],"ips":[{"name":"192.168.136.1","value":7},{"name":"192.168.136.132","value":3}],"ports":[{"name":"7001","value":1,"source":null},{"name":"6379","value":1,"source":null},{"name":"3389","value":1,"source":null},{"name":"1080","value":1,"source":null},{"name":"902","value":1,"source":null}]}}
II、字段文档
  1. 请求字段

  • taskId:任务ID,指定要获取统计数据的任务ID。

  1. 返回字段

  • statusCode:响应状态码,本例中为200,表示请求成功。

  • messages:消息,本例中为空字符串。

  • data:数据主体,包含了统计数据信息。

  • taskId:任务ID,本例中为20230404080804。

  • total:总体统计数据,包含以下字段:

    • assets:资产数量,本例中为10。

    • ips:IP数量,本例中为5。

    • ports:端口数量,本例中为14。

    • vulnerabilities:漏洞数量,本例中为0。

    • allassets:所有资产数量,本例中为10。

    • allips:所有IP数量,本例中为5。

    • allports:所有端口数量,本例中为18。

    • allvulnerabilities:所有漏洞数量,本例中为0。

    • scan_ips:扫描IP数量,本例中为0。

    • scan_ports:扫描端口数量,本例中为0。

  • software_products:软件产品列表,包含以下字段:

    • name:产品名称。

    • value:产品数量。

    • source:数据来源。

  • software_companies:软件公司列表,包含以下字段:

    • name:公司名称。

    • value:公司数量。

    • source:数据来源。

  • hardware_products:硬件产品列表,本例中为null。

  • hardware_companies:硬件公司列表,本例中为null。

  • vulnerabilities:漏洞列表,本例中为null。

  • parent_category:父级分类列表,包含以下字段:

    • name:分类名称。

    • value:分类数量。

    • source:数据来源。

  • favicons:收藏夹图标列表,本例中为null。

  • fids:收藏夹ID列表,包含以下字段:

    • name:收藏夹ID。

    • value:ID数量。

    • source:数据来源。

  • ips:IP地址列表,包含以下字段:

    • name:IP地址。

    • value:IP地址对应的数量。

  • ports:端口列表,包含以下字段:

    • name:端口号。

    • value:端口号对应的数量。

8、asset_search 方法
I、调用文档
  1. asset_search 接受参数:

def asset_search(self, task_id, query='', page=1, page_size=20,order_by={'vulnerabilities': 'desc', 'assets': 'desc'}):
  1. 功能:根据查询条件搜索资产

  2. 调用方法

# 测试资产搜索 asset_search = sdk.asset_search(task_id="20230403070712") print(asset_search)
  1. HTTP 默认请求

POST /api/v1/assetSearch HTTP/1.1 Content-Type: application/json;charset=UTF-8 Content-Length: 134 Authorization: Basic dXNlcjpwYXNz host: 192.168.136.133:8361 Connection: close {"query":"taskId=\"20230404080804\" && ()","options":{"order":{"vulnerabilities":"desc","assets":"desc"},"page":{"page":1,"size":20}}} HTTP/1.1 200 OK Content-Type: application/json Date: Mon, 10 Apr 2023 07:23:47 GMT Connection: close Content-Length: 6842 {"statusCode":200,"messages":"","data":{"query":"taskId=\"20230404080804\" \u0026\u0026 ()","options":{"TaskID":"20230404080804","Page":1,"size":20,"OrderField":"","OrderASC":""},"taskId":"20230404080804","query_total":{"ips":5,"ports":17,"protocols":13,"assets":10,"vulnerabilities":0,"dist_ports":14,"dist_protocols":11,"dist_assets":10,"dist_vulnerabilities":0},"total":{"assets":10,"ips":5,"ports":18,"vulnerabilities":0,"allassets":0,"allips":0,"allports":0,"allvulnerabilities":0,"scan_ips":0,"scan_ports":0},"ips":[{"ip":"192.168.136.1","mac":"00:50:56:c0:00:08","os":"","hostname":"PC-202211290939,PC-202211290939\n","honeypot":"0","ports":[{"port":"139","baseprotocol":"tcp"},{"port":"1080","baseprotocol":"tcp"},{"port":"22","baseprotocol":"tcp"},{"port":"135","baseprotocol":"tcp"},{"port":"137","baseprotocol":"udp"},{"port":"7001","baseprotocol":"tcp"},{"port":"3389","baseprotocol":"tcp"},{"port":"6379","baseprotocol":"tcp"},{"port":"902","baseprotocol":"tcp"},{"port":"3306","baseprotocol":"tcp"},{"port":"443","baseprotocol":"tcp"},{"port":"445","baseprotocol":"tcp"}],"protocols":{"192.168.136.1:1080":{"port":"1080","hostinfo":"192.168.136.1:1080","url":"","product":"Proxy server","protocol":"socks5","json":"","fid":[""],"products":["Proxy server"],"protocols":["socks5"]},"192.168.136.1:135":{"port":"135","hostinfo":"192.168.136.1:135","url":"","product":"","protocol":"unknown","json":"","fid":[""],"products":[""],"protocols":["unknown"]},"192.168.136.1:137":{"port":"137","hostinfo":"192.168.136.1:137","url":"","product":"","protocol":"netbios","json":"","fid":[""],"products":[""],"protocols":["netbios"]},"192.168.136.1:139":{"port":"139","hostinfo":"192.168.136.1:139","url":"","product":"","protocol":"netbios-ssn","json":"","fid":[""],"products":[""],"protocols":["netbios-ssn"]},"192.168.136.1:3389":{"port":"3389","hostinfo":"192.168.136.1:3389","url":"","product":"Microsoft-Windows远程连接|Windows10","protocol":"rdp","json":"","fid":[""],"products":["Microsoft-Windows远程连接","Windows10"],"protocols":["rdp"]},"192.168.136.1:445":{"port":"445","hostinfo":"192.168.136.1:445","url":"","product":"Windows","protocol":"smb","json":"","fid":[""],"products":["Windows"],"protocols":["smb"]},"192.168.136.1:6379":{"port":"6379","hostinfo":"192.168.136.1:6379","url":"","product":"","protocol":"unknown","json":"","fid":[""],"products":[""],"protocols":["unknown"]},"192.168.136.1:7001":{"port":"7001","hostinfo":"192.168.136.1:7001","url":"","product":"JSP","protocol":"http","json":"","fid":["OW8AeC9cKwa8TI0980pN7obnRtGFlnWv"],"products":["JSP"],"protocols":["http","web"]},"192.168.136.1:902":{"port":"902","hostinfo":"192.168.136.1:902","url":"","product":"VMware-Authentication Service","protocol":"vmware_authentication_daemon","json":"","fid":[""],"products":["VMware-Authentication Service"],"protocols":["vmware_authentication_daemon"]}},"tags":[{"rule_id":"30000001","product":"Vmware","company":"Vmware, Inc.","level":"1","category":"Virtualization","parent_category":"Support System","softhard":"2","version":""},{"rule_id":"270","product":"JSP","company":"Oracle Corporation","level":"4","category":"Scripting Language","parent_category":"Support System","softhard":"2","version":""},{"rule_id":"7220","product":"Windows","company":"Microsoft Corporation","level":"2","category":"Operating System","parent_category":"Software System","softhard":"2","version":"10.0.19041 Ntlm 15"},{"rule_id":"19961","product":"Windows10","company":"Microsoft Corporation","level":"2","category":"Operating System","parent_category":"Software System","softhard":"2","version":""},{"rule_id":"7203","product":"Microsoft-Windows远程连接","company":"Microsoft Corporation","level":"3","category":"Other Enterprise Application","parent_category":"Enterprise Application","softhard":"2","version":""},{"rule_id":"7206","product":"VMware-Authentication Service","company":"VMware, Inc.","level":"3","category":"Other Enterprise Application","parent_category":"Enterprise Application","softhard":"2","version":""},{"rule_id":"710524","product":"Proxy server","company":"other","level":"3","category":"Service","parent_category":"Support System","softhard":"2","version":""}],"vulnerabilities":null,"screenshots":null,"favicons":null,"hostnames":[""]},{"ip":"192.168.136.132","mac":"","os":"","hostname":"","honeypot":"0","ports":[{"port":"80","baseprotocol":"tcp"},{"port":"22","baseprotocol":"tcp"}],"protocols":{"192.168.136.132:22":{"port":"22","hostinfo":"192.168.136.132:22","url":"","product":"Ubuntu-system|OpenSSH","protocol":"ssh","json":"","fid":[""],"products":["Ubuntu-system","OpenSSH"],"protocols":["ssh"]},"192.168.136.132:80":{"port":"80","hostinfo":"192.168.136.132:80","url":"","product":"Ubuntu-system|Nginx","protocol":"http","json":"","fid":["bclL6A9aXzKBK/xoJrZeckSQ7gymt98+"],"products":["Ubuntu-system","Nginx"],"protocols":["http","web"]}},"tags":[{"rule_id":"209","product":"Nginx","company":"other","level":"3","category":"Service","parent_category":"Support System","softhard":"2","version":"1.18.0"},{"rule_id":"4528","product":"Ubuntu-system","company":"Canonical Ltd.","level":"2","category":"Operating System","parent_category":"Software System","softhard":"2","version":""},{"rule_id":"7512","product":"OpenSSH","company":"other","level":"3","category":"Other Support System","parent_category":"Support System","softhard":"2","version":"8.2p1"}],"vulnerabilities":null,"screenshots":null,"favicons":null,"hostnames":[""]},{"ip":"192.168.136.2","mac":"","os":"","hostname":"","honeypot":"0","ports":[{"port":"53","baseprotocol":"udp"},{"port":"53","baseprotocol":"tcp"}],"protocols":{"192.168.136.2:53":{"port":"53","hostinfo":"192.168.136.2:53","url":"","product":"","protocol":"dns","json":"","fid":[""],"products":[""],"protocols":["dns"]}},"tags":null,"vulnerabilities":null,"screenshots":null,"favicons":null,"hostnames":[""]},{"ip":"192.168.136.0","mac":"","os":"","hostname":"","honeypot":"0","ports":[{"port":"53","baseprotocol":"udp"}],"protocols":{},"tags":null,"vulnerabilities":null,"screenshots":null,"favicons":null,"hostnames":[""]},{"ip":"192.168.136.255","mac":"","os":"","hostname":"","honeypot":"0","ports":[{"port":"53","baseprotocol":"udp"}],"protocols":{},"tags":null,"vulnerabilities":null,"screenshots":null,"favicons":null,"hostnames":[""]}],"products":{"software":{"total_assets":2,"risk_assets":0,"lists":[{"name":"Vmware","company":"Vmware, Inc.","total_assets":1,"risk_assets":0},{"name":"Nginx","company":"other","total_assets":1,"risk_assets":0}]},"hardware":{"total_assets":0,"risk_assets":0,"lists":null}},"companies":{"software":{"total_assets":2,"risk_assets":0,"lists":[{"name":"Vmware, Inc.","total_assets":1,"risk_assets":0},{"name":"other","total_assets":1,"risk_assets":0}]},"hardware":{"total_assets":0,"risk_assets":0,"lists":null}}}}
II、字段文档
  1. 请求字段

  • query:查询字符串,用于指定查询的条件

  • options:查询选项,包含两个子属性:

    • order:排序选项,指定查询结果的排序方式,包含两个子属性:

      • vulnerabilities:漏洞数排序,desc表示降序,asc表示升序

      • assets:资产数排序,desc表示降序,asc表示升序

    • page:分页选项,指定查询结果的分页信息,包含两个子属性:

      • page:页码,从1开始

      • size:每页记录数,最大值为100

  1. 返回字段

  • statusCode: 返回状态码,200表示请求成功,4xx表示客户端请求错误,5xx表示服务器错误。

  • messages: 返回的消息,这里为空。

  • data: 返回的数据对象,包含以下字段:

    • query: 查询的任务ID以及其他查询参数。

    • options: 查询选项,包括任务ID、分页参数、排序字段和排序方式等。

    • taskId: 任务ID。

    • query_total: 总计数量,包括不同类型的资产、IP、端口、漏洞等数量。

      • "ips": 表示查询的IP地址数量。

  • "ports": 表示查询的端口号数量。

  • "protocols": 表示查询的协议数量。

  • "assets": 表示查询的资产总数,即具有唯一IP地址和端口号的组合数。

  • "vulnerabilities": 表示查询的漏洞总数。

  • "dist_ports": 表示查询的不同端口号数量。

  • "dist_protocols": 表示查询的不同协议数量。

  • "dist_assets": 表示查询的不同资产总数,即具有唯一IP地址和端口号的组合数。

  • "dist_vulnerabilities": 表示查询的不同漏洞总数。

    • total: 查询结果的总计数量,包括不同类型的资产、IP、端口、漏洞等数量。

    • ips: 查询结果中的IP列表,包含以下字段:

      • ip: IP地址。

      • mac: MAC地址。

      • os: 操作系统信息。

      • hostname: 主机名。

      • honeypot: 是否为蜜罐,0表示不是,1表示是。

      • ports: 开放的端口列表,包含以下字段:

        • port: 端口号。

        • baseprotocol: 协议类型。

      • protocols: IP对应的协议及相关信息,以端口号为键,值包含以下字段:

        • port: 端口号。

        • hostinfo: IP和端口号的组合。

        • url: URL地址。

        • product: 产品名称。

        • protocol: 协议类型。

        • json: 其他相关信息。

        • fid: 与该协议相关的漏洞ID列表。

        • products: 产品名称列表。

        • protocols: 协议类型列表。

      • tags: 与该IP相关的标签列表,包含以下字段:

        • rule_id: 标签ID。

        • product: 产品名称。

        • company: 公司名称。

        • level: 标签级别。

        • category: 标签分类。

        • parent_category: 父级标签分类。

        • softhard: 软硬件类型。

        • version: 产品版本号。

        • "vulnerabilities":null:表示该IP地址没有已知的漏洞。

    • "screenshots":null:表示没有获取到该IP地址的屏幕截图信息。

    • "favicons":null:表示没有获取到该IP地址的网站图标信息。

    • "hostnames":[""]:表示该IP地址没有已知的主机名。

  • products:该字段包含了发现的软件和硬件产品的信息。它有两个子字段:software和hardware。

    • software:表示已发现的软件产品信息。它包括以下三个子字段:

      • total_assets:表示该软件产品的总数。

      • risk_assets:表示该软件产品中有多少存在安全风险。

      • lists:表示该软件产品的列表,其中每个元素都包含以下三个字段:

        • name:表示该软件产品的名称。

        • company:表示该软件产品的公司名称。

        • total_assets:表示该软件产品的总数。

        • risk_assets:表示该软件产品中有多少存在安全风险。

    • hardware:表示已发现的硬件产品信息。它包括以下三个子字段:

      • total_assets:表示该硬件产品的总数。

      • risk_assets:表示该硬件产品中有多少存在安全风险。

      • lists:表示该硬件产品的列表,其中每个元素都包含以下三个字段:

        • name:表示该硬件产品的名称。

        • company:表示该硬件产品的公司名称。

        • total_assets:表示该硬件产品的总数。

        • risk_assets:表示该硬件产品中有多少存在安全风险。

  • companies:表示已发现的公司信息。它包括以下两个子字段:

    • software:表示已发现的软件产品信息。它包括以下三个子字段:

    • total_assets:表示该软件产品的总数。

    • risk_assets:表示该软件产品中存在安全风险的数量。

    • lists:表示该软件产品列表,其中包括以下信息:

      • name:表示软件产品名称。

      • total_assets:表示该软件产品的数量。

      • risk_assets:表示该软件产品中存在安全风险的数量。

  • hardware:表示已发现的硬件产品信息。它包括以下三个子字段:

  • total_assets:表示该硬件产品的总数。

  • risk_assets:表示该硬件产品中存在安全风险的数量。

  • lists:表示该硬件产品列表

更多使用说明访问:https://www.exp-9.com
9、get_value_category 方法
I、调用文档
  1. get_value_category 接受参数:

def get_value_category(self, task_id):
  1. 功能:获取任务 产品类别

  2. 调用方法

# 测试 产品类别 value_category = sdk.get_value_category(task_id="20230403070712") print(value_category)
  1. HTTP 默认请求

POST /api/v1/getValueCategory HTTP/1.1 Content-Type: application/json;charset=UTF-8 Content-Length: 27 Authorization: Basic dXNlcjpwYXNz host: 192.168.136.133:8361 Connection: close {"taskId":"20230404080804"} HTTP/1.1 200 OK Content-Type: application/json Date: Mon, 10 Apr 2023 07:23:47 GMT Content-Length: 122 Connection: close {"statusCode":200,"messages":"","data":{"hardwares":[{"name":"Virtualization","value":1,"source":null}],"softwares":null}}
II、字段文档
  1. 请求字段

  • "taskId":表示要查询的任务 ID。

  1. 返回字段

  • statusCode:响应的状态码,表示请求成功(200)

  • messages:响应中的消息,这里为空字符串

  • data:响应数据,包括以下两个字段:

    • hardwares:硬件信息,是一个列表,每个元素是一个字典,包括以下三个字段:

      • name:硬件名称

      • value:硬件数量

      • source:硬件来源

    • softwares:软件信息,是一个字典,包括以下三个字段:

      • name:软件名称

      • value:软件数量

      • source:软件来源

10、get_children_category 方法
I、调用文档
  1. get_children_category 接受参数:

def get_children_category(self, task_id, parent_category):
  1. 功能:获取子类别列表

  2. 调用方法

# 测试 get_children_category 函数 response = sdk.get_children_category(task_id="20230403070712", parent_category="Support System") print(response)
  1. HTTP 默认请求

POST /api/v1/getChildrenCategory HTTP/1.1 Content-Type: application/json;charset=UTF-8 Content-Length: 75 Authorization: Basic dXNlcjpwYXNz host: 192.168.136.133:8361 Connection: close {"query":"taskId=\"20230404080804\" && parent_category=\"Support System\""} HTTP/1.1 200 OK Content-Type: application/json Date: Mon, 10 Apr 2023 08:04:24 GMT Content-Length: 264 Connection: close {"statusCode":200,"messages":"","data":{"total":5,"lists":[{"name":"Service","value":2,"source":null},{"name":"Virtualization","value":1,"source":null},{"name":"Scripting Language","value":1,"source":null},{"name":"Other Support System","value":1,"source":null}]}}
II、字段文档
  1. 请求字段

  • query: 查询条件,格式为taskId="20230404080804" && parent_category="Support System",表示查询指定任务ID下的“Support System”类别的子类别信息。该查询条件是基于布尔逻辑表达式的,由多个条件通过逻辑运算符组合而成。

  1. 返回字段

  • statusCode:响应状态码,此处为200,表示请求成功。

  • messages:响应消息,此处为空字符串。

  • data:响应数据,是一个包含总数和列表的对象。

    • total:表示列表中元素的总数。

    • lists:表示元素列表,是一个包含多个元素对象的数组。

      • name:元素名称。

      • value:元素的值。

      • source:元素来源,此处为null。


相关文章

goby sdk 非官方版本

goby sdk 非官方版本

非官方版本的 Goby SDK 是由一些技术人员基于官方版本进行开发和改进的,旨在提供更加丰富的功能和更好的性能。它们可能包含一些官方版本不具备的功能或者对官方版本的一些限制进行了解除,可以更好地满足...

goby sdk 非官方版本 使用文档(1)

一、Api类1、get_poc_list 方法I、调用文档get_poc_list 接受参数:get_poc_list(self, query="vultype=2", reloa...

goby sdk 非官方版本 使用文档(3)

11、get_ip_info 方法 I、调用文档get_ip_info 接受参数:def get_ip_info(self, task_id, ip):功能:获取IP详细信息调用方法# 测试第二页,点...

goby sdk 非官方版本 使用文档(4)

16、get_vulnerability_search 方法 I、调用文档get_vulnerability_search 接受参数:def get_vulnerability_search(self...

发表评论    

◎欢迎参与讨论,请在这里发表您的看法、交流您的观点。