Merge branch 'master' into master

Author: wh0am1i

README.rst

@@ -634,7 +634,7 @@ The following are the interfaces and instructions provided by the SDK:
 
    1.dork_search(dork, page=0, resource="host", facets=None)
      search the data of the specified page according to dork
-   2.multi_page_search(dork, page=1, resource="host", facets=None)
+   2.multi_page_search(dork, page=1, start_page=1, resource="host", facets=None)
      search multiple pages of data according to dork
    3.resources_info()
      get current user information

docs/README_CN.md

@@ -506,8 +506,8 @@ zm = ZoomEye(api_key="01234567-acbd-00000-1111-22222222222")
 
 	1.dork_search(dork, page=0, resource="host", facets=None)
 	  根据 dork 搜索指定页的数据
-	2.multi_page_search(dork, page=1, resource="host", facets=None)
-	  根据 dork 搜索多页数据
+	2.multi_page_search(dork, page=1, start_page=1, resource="host", facets=None)
+	  根据 dork 搜索多页数据，支持从指定的页数开始下载
 	3.resources_info()
 	  获取当前用户的信息
 	4.show_count()
@@ -557,7 +557,7 @@ soft********11180040.b***c.net ['126.***.***.40']
 {'product': [{'name': '', 'count': 28323128}, {'name': 'BusyBox telnetd', 'count': 10180912}, {'name': 'Linux telnetd', ......
 ```
 
->`multi_page_search()` 同样也可以进行搜索，当需要获取大量数据时使用该函数，其中 `page` 字段表示获取多少页的数据；而 `dork_search()` 仅获取指定页的数据。
+>`multi_page_search()` 同样也可以进行搜索，当需要获取大量数据时使用该函数，其中 `page` 字段表示获取多少页的数据, `start_page`字段表示从第几页开始获取；而 `dork_search()` 仅获取指定页的数据。
 
 #### 5.数据筛选
 在 SDK 中提供了 `dork_filter()` 函数，我们可以更加方便对数据进行筛选，提取指定的数据字段，如下：

setup.py

@@ -24,7 +24,7 @@
     long_description=README,
     long_description_content_type='text/x-rst',
     author='404 Team@Knownsec',
-    url='https://github.com/knownsec/zoomeye-python',
+    url='https://github.com/knownsec/zoomeye-python',  #
     packages=['zoomeye'],
     entry_points={'console_scripts': ['zoomeye=zoomeye.cli:main']},
     install_requires=DEPENDENCIES,

zoomeye/cli.py

@@ -51,23 +51,23 @@ def main():
     parser_info.set_defaults(func=core.info)
 
     # query zoomeye data
-    parser_search = subparsers.add_parser(
+    P_search = subparsers.add_parser(
         "search",
         help="Search the ZoomEye database"
     )
 
-    parser_search.add_argument(
+    P_search.add_argument(
         "dork",
         help="The ZoomEye search keyword or ZoomEye exported file"
     )
-    parser_search.add_argument(
+    P_search.add_argument(
         "-num",
         default=20,
         help="The number of search results that should be returned, support 'all'",
         type=str,
         metavar='value'
     )
-    parser_search.add_argument(
+    P_search.add_argument(
         "-facet",
         default=None,
         nargs='?',
@@ -80,7 +80,7 @@ def main():
         '''),
         metavar='field'
     )
-    parser_search.add_argument(
+    P_search.add_argument(
         "-filter",
         default=None,
         metavar='field=regexp',
@@ -93,7 +93,7 @@ def main():
               web field: [app,headers,keywords,title,site,city,country,webapp,component,framework,server,waf,os,timestamp,*]
         ''')
     )
-    parser_search.add_argument(
+    P_search.add_argument(
         '-stat',
         default=None,
         metavar='field',
@@ -106,7 +106,7 @@ def main():
               web field: [webapp,component,framework,server,waf,os,country]
         ''')
     )
-    parser_search.add_argument(
+    P_search.add_argument(
         "-save",
         default=None,
         metavar='field=regexp',
@@ -118,18 +118,18 @@ def main():
         type=str,
         const='all'
     )
-    parser_search.add_argument(
+    P_search.add_argument(
         "-count",
         help="The total number of results in ZoomEye database for a search",
         action="store_true"
     )
-    parser_search.add_argument(
+    P_search.add_argument(
         "-figure",
         help="Pie chart or bar chart showing data，can only be used under facet and stat",
         choices=('pie', 'hist'),
         default=None
     )
-    parser_search.add_argument(
+    P_search.add_argument(
         "-type",
         help=(
             """
@@ -139,7 +139,7 @@ def main():
         choices={'web', 'host'},
         default="host"
     )
-    parser_search.add_argument(
+    P_search.add_argument(
         "-force",
         help=(
             """
@@ -148,12 +148,13 @@ def main():
         ),
         action="store_true"
     )
-    parser_search.set_defaults(func=core.search)
+    P_search.set_defaults(func=core.search)
 
     # initial account configuration related commands
-    parser_init = subparsers.add_parser("init", help="Initialize the token for ZoomEye-python")
-    parser_init.add_argument("-apikey", help="ZoomEye API Key", default=None, metavar='[api key]')
-    parser_init.set_defaults(func=core.init)
+
+    P_init = subparsers.add_parser("init", help="Initialize the token for ZoomEye-python.")
+    P_init.add_argument("-apikey", help="ZoomEye API Key", default=None, metavar='[api key]')
+    P_init.set_defaults(func=core.init)
 
     parser_ip_info = subparsers.add_parser("ip", help="Query IP information")
     parser_ip_info.add_argument("ip", help="search device IP", metavar='ip', type=str)
@@ -219,8 +220,9 @@ def main():
     parser_domain.set_defaults(func=core.associated_domain_query)
 
     args = parser.parse_args()
+    ver=args.version
 
-    if args.version:
+    if ver:
         get_version()
         exit(0)
 

zoomeye/config.py

@@ -11,6 +11,7 @@
 """
 from zoomeye import __version__, __site__
 
+seconds_of_fiveday = 60 * 60 * 24 * 5
 
 # save api key file and json web token file path 保存API密钥文件和json web令牌文件路径
 ZOOMEYE_CONFIG_PATH = "~/.config/zoomeye/setting"
@@ -19,7 +20,7 @@
 ZOOMEYE_CACHE_PATH = "~/.config/zoomeye/cache"
 
 # cache expired time, five day 缓存过期时间，5天
-EXPIRED_TIME = 60 * 60 * 24 * 5
+EXPIRED_TIME = seconds_of_fiveday
 
 # print data max length 打印数据
 STRING_MAX_LENGTH = 23

zoomeye/core.py

@@ -16,7 +16,8 @@
 zoomeye_dir = os.path.expanduser(config.ZOOMEYE_CONFIG_PATH)
 
 
-def init_key(key):
+def init_key(key): #初始化API密钥并将其保存在本地配置文件中
+
     """
     initialize through the api key, write the api key to the local configuration file,
     theoretically it will never expire unless you remake the api key
@@ -43,7 +44,7 @@ def init_key(key):
     os.chmod(key_file, 0o600)
 
 
-def init(args):
+def init(args):#根据用户输入的参数来选择初始化方法，可以通过API密钥来进行初始化
     """
     the initialization processing function will select the initialization method according to the user's input.
     :param args:
@@ -55,11 +56,11 @@ def init(args):
         init_key(api_key)
         return
     # invalid parameter
-    show.printf("input parameter error", color="red")
+    show.printf("input parameter error!", color="red")
     show.printf("please run <zoomeye init -h> for help.", color="red")
 
 
-def search(args):
+def search(args):#进行搜索操作，根据用户输入的搜索条件进行搜索
     dork = args.dork
     num = int(args.num)
     facet = args.facet
@@ -93,7 +94,7 @@ def search(args):
     show.printf("please run <zoomeye search -h> for help.")
 
 
-def info(args):
+def info(args):#打印当前用户的身份和本月剩余的数据配额
     """
     used to print the current identity of the user and the remaining data quota for the month
     :param args:
@@ -111,7 +112,7 @@ def info(args):
         show.printf("quota_info: {}".format(user_data["quota_info"]))
 
 
-def ip_history(args):
+def ip_history(args):#查询设备的历史信息
     """
     query device history
     please see: https://www.zoomeye.org/doc#history-ip-search
@@ -141,7 +142,7 @@ def ip_history(args):
     zm.show_fields()
 
 
-def clear_file(args):
+def clear_file(args):#清除用户设置和ZoomEye缓存数据
     """
     clear user setting and zoomeye cache data
     """
@@ -165,7 +166,7 @@ def clear_file(args):
     show.printf("clear complete!", color='green')
 
 
-def information_ip(args):
+def information_ip(args):#获取特定IP的信息
     ip = args.ip
     filters = args.filter
     # determine whether the input is an IP address by regular
@@ -185,7 +186,7 @@ def information_ip(args):
     infor.show_information()
 
 
-def associated_domain_query(args):
+def associated_domain_query(args):#关联域名查询
     q = args.q
     resource = args.type
     page = args.page

zoomeye/data.py

@@ -162,10 +162,10 @@ def regexp(keys, field_table, data_list):
     return result
 
 
-def filter_search_data(keys, field_table, data):
+def filter_search_data(datakeys, field_table, data):
     """
     get the data of the corresponding field
-    :param keys: list, user input field
+    :param datakeys: list, user input field
     :param field_table: dict, fileds
     :param data: list, zoomeye api data
     :return: list, ex: [[1,2,3...],[1,2,3...],[1,2,3...]...]
@@ -174,7 +174,7 @@ def filter_search_data(keys, field_table, data):
     for d in data:
         item = []
         zmdict = ZoomEyeDict(d)
-        for key in keys:
+        for key in datakeys:
             if field_table.get(key.strip()) is None:
                 support_fields = ','.join(list(field_table.keys()))
                 show.printf("filter command has unsupport fields [{}], support fields has [{}]"
@@ -259,7 +259,7 @@ def process_filter(fields, data, tables):
     return result_data, has_equal, not_equal
 
 
-class Cache:
+class Cache:#用于缓存从API获取的数据或从本地文件中读取数据
     """
     used to cache the data obtained from the api to the local,
     or directly clip the file from the local.
@@ -333,7 +333,7 @@ def update(self):
         pass
 
 
-class CliZoomEye:
+class CliZoomEye:#处理与ZoomEye搜索相关的功能，如默认显示、过滤、统计等
 
     def __init__(self, dork, num, resource, facet=None, force=False):
         self.dork = dork
@@ -586,7 +586,7 @@ def count(self):
         show.printf(self.total)
 
 
-class HistoryDevice:
+class HistoryDevice:#处理获取主机历史数据的功能
     """
     obtain the user's identity information and determine whether to use the IP history search function
     """
@@ -704,7 +704,7 @@ def filter_fields(self, fields):
         show.print_filter_history(not_equal, result_data[:self.num], has_equal)
 
 
-class IPInformation:
+class IPInformation:#用于查询特定IP地址的信息
     """
     query IP information
     """
@@ -736,17 +736,17 @@ def filter_information(self, filters):
         result_data, has_equal, not_equal = process_filter(filters, info_data, fields_ip)
         if len(result_data) == 0:
             return
-        for item in not_equal:
-            if fields_ip.get(item.strip()) is None:
+        for items in not_equal:
+            if fields_ip.get(items.strip()) is None:
                 support_fields = ','.join(list(fields_ip.keys()))
                 show.printf(
-                    "filter command has unsupport fields [{}], support fields has [{}]".format(item, support_fields),
+                    "filter command has unsupport fields [{}], support fields has [{}]".format(items, support_fields),
                     color='red')
                 exit(0)
         show.print_info_filter(not_equal, result_data, has_equal)
 
 
-class DomainSearch:
+class DomainSearch:#用于查询相关域名或子域名
     """
     query relation domain or sub domain
     """

zoomeye/file.py

@@ -24,17 +24,17 @@ def get_api_key(path) -> str:
     :param path:
     :return:
     """
-    key_file = zoomeye_dir + "/apikey"
+    key_fl = zoomeye_dir + "/apikey"
     # api key config does not exits
     # raise FileNotFoundError
-    if not os.path.exists(key_file):
+    if not os.path.exists(key_fl):
         raise FileNotFoundError("not found api key config")
     # determine whether the permission of the configuration file is read-only,
     # if not, set it to read-only
-    if not oct(os.stat(key_file).st_mode).endswith("600"):
-        os.chmod(key_file, 0o600)
+    if not oct(os.stat(key_fl).st_mode).endswith("600"):
+        os.chmod(key_fl, 0o600)
     # return read file content
-    with open(key_file, 'r') as f:
+    with open(key_fl, 'r') as f:
         return f.read().strip()
 
 
@@ -44,19 +44,19 @@ def get_jwt_token(path) -> str:
     :param path:
     :return:
     """
-    key_file = zoomeye_dir + "/jwt"
+    key_fl = zoomeye_dir + "/jwt"
     # json web token does not exits
     # raise FileNotFoundError
-    if not os.path.exists(key_file):
+    if not os.path.exists(key_fl):
         raise FileNotFoundError("not found access token config")
 
 
     # determine whether the permission of the configuration file is read-only,
     # if not, set it to read-only
-    if not oct(os.stat(key_file).st_mode).endswith("600"):
-        os.chmod(key_file, 0o600)
+    if not oct(os.stat(key_fl).st_mode).endswith("600"):
+        os.chmod(key_fl, 0o600)
     # return read config content
-    with open(key_file, 'r') as f:
+    with open(key_fl, 'r') as f:
         return f.read().strip()