feat: add some doc.

HXSecurity · tscuite · Sep 15, 2023 · Aug 17, 2023 · Aug 18, 2023 · Aug 18, 2023
commit a41a7bbcee51fcbd30be61e4430b9b0b211da7b5
diff --git a/dongtai_web/aggr_vul/app_vul_list.py b/dongtai_web/aggr_vul/app_vul_list.py
@@ -13,6  13,7 @@
 from dongtai_common.common.utils import make_hash
 from dongtai_common.endpoint import R, UserEndPoint
 from dongtai_common.models import APP_LEVEL_RISK, APP_VUL_ORDER
 from dongtai_common.models.agent_method_pool import VulMethodPool
 from dongtai_common.models.dast_integration import IastDastIntegrationRelation
 from dongtai_common.models.vulnerablity import (
     IastVulnerabilityDocument,
@@ -22,81  23,24 @@
 from dongtai_common.utils.const import OPERATE_GET
 from dongtai_common.utils.db import SearchLanguageMode
 from dongtai_conf import settings
-from dongtai_conf.patch import patch_point
 from dongtai_conf.patch import patch_point, to_patch
 from dongtai_conf.settings import ELASTICSEARCH_STATE
 from dongtai_engine.elatic_search.data_correction import data_correction_interpetor
 from dongtai_web.aggregation.aggregation_common import turnIntListOfStr
 from dongtai_web.serializers.aggregation import AggregationArgsSerializer
 from dongtai_web.serializers.vul import VulSerializer
-from rest_framework import serializers
-from dongtai_web.utils import get_response_serializer
-from drf_spectacular.utils import extend_schema
 from dongtai_web.utils import extend_schema_with_envcheck
 
 INT_LIMIT: int = 2**64 - 1
 
 
-class AppVulSerializer(serializers.ModelSerializer):
-    level_name = serializers.CharField()
-    server_type = serializers.CharField()
-    is_header_vul = serializers.CharField()
-    agent__project_name = serializers.CharField()
-    agent__server__container = serializers.CharField()
-    agent__language = serializers.CharField()
-    agent__bind_project_id = serializers.CharField()
-    header_vul_urls = serializers.ListField()
-    dastvul__vul_type = serializers.CharField()
-    dastvul_count = serializers.CharField()
-    dast_validation_status = serializers.CharField()
-    strategy__vul_name = serializers.CharField()
-    project__name = serializers.CharField()
-    server__container = serializers.CharField()
-    project_version__version_name = serializers.CharField()
-
-    class Meta:
-        model = IastVulnerabilityModel
-        fields = [
-            "id",
-            "uri",
-            "http_method",
-            "top_stack",
-            "bottom_stack",
-            "level_id",
-            "taint_position",
-            "status_id",
-            "first_time",
-            "latest_time",
-            "strategy__vul_name",
-            "language",
-            "project__name",
-            "server__container",
-            "project_id",
-            "strategy_id",
-            "project_version_id",
-            "project_version__version_name",
-            "level_name",
-            "server_type",
-            "is_header_vul",
-            "agent__project_name",
-            "agent__server__container",
-            "agent__language",
-            "agent__bind_project_id",
-            "header_vul_urls",
-            "dastvul__vul_type",
-            "dastvul_count",
-            "dast_validation_status",
-        ]
-
-
-_NewResponseSerializer = get_response_serializer(AppVulSerializer(many=True))
-
-
 class GetAppVulsList(UserEndPoint):
-    @extend_schema(
     @extend_schema_with_envcheck(
         request=AggregationArgsSerializer,
-        tags=[_("Vulnerability"), OPERATE_GET, "集成"],
         tags=[_("Vulnerability"), OPERATE_GET],
         summary="应用漏洞列表",
-        responses={200: _NewResponseSerializer},
     )
     @to_patch
     def post(self, request):
         """
         :param request:
@@ -234,6  178,7 @@ def post(self, request):
             lambda: 0,
             {item["iastvul_id"]: item["dastvul_count"] for item in dastvul_rel_count_res},
         )
         has_vul_method_pool_set = set(VulMethodPool.objects.filter(vul_id__in=vul_ids).values_list("vul_id", flat=True))
         if vul_data:
             for item in vul_data:
                 item["level_name"] = APP_LEVEL_RISK.get(str(item["level_id"]), "")
@@ -247,6  192,7 @@ def post(self, request):
                 item["dastvul__vul_type"] = dast_vul_types_dict[item["id"]]
                 item["dastvul_count"] = dastvul_rel_count_res_dict[item["id"]]
                 item["dast_validation_status"] = bool(dastvul_rel_count_res_dict[item["id"]])
                 item["has_vul_method_pool"] = item["id"] in has_vul_method_pool_set
                 end["data"].append(item)
         # all Iast Vulnerability Status
         status = IastVulnerabilityStatus.objects.all()

diff --git a/dongtai_web/dongtai_sca/views/newpackage.py b/dongtai_web/dongtai_sca/views/newpackage.py
@@ -17,22  17,14 @@
 class PackageListArgsSerializer(serializers.Serializer):
     page_size = serializers.IntegerField(default=20, help_text=_("Number per page"))
     page = serializers.IntegerField(default=1, help_text=_("Page index"))
-    language_ids = serializers.ListField(
-        required=False,
-        child=serializers.IntegerField(help_text=_("language")),
-        help_text="筛选语言id: 1 Java 2 Python 3 PHP 4 Go",
-    )
-    license_ids = serializers.ListField(
-        required=False, child=serializers.IntegerField(help_text=_("license")), help_text="筛选, 许可证id, 该id范围可在组件概况获取"
-    )
-    level_ids = serializers.ListField(
-        required=False, child=serializers.IntegerField(help_text=_("level")), help_text="筛选, 危险等级id"
-    )
-    project_id = serializers.IntegerField(required=False, help_text="项目id")
-    project_version_id = serializers.IntegerField(required=False, help_text="项目版本id")
-    keyword = serializers.CharField(required=False, help_text="搜索关键字")
-    order_field = serializers.ChoiceField(["vul_count", "level"], default="vul_count", help_text="排序字段")
-    order = serializers.ChoiceField(["desc", "asc"], default="desc", help_text="排序方式")
     language_ids = serializers.ListField(required=False, child=serializers.IntegerField(help_text=_("language")))
     license_ids = serializers.ListField(required=False, child=serializers.IntegerField(help_text=_("license")))
     level_ids = serializers.ListField(required=False, child=serializers.IntegerField(help_text=_("level")))
     project_id = serializers.IntegerField(required=False, help_text=_("Page index"))
     project_version_id = serializers.IntegerField(required=False, help_text=_("Page index"))
     keyword = serializers.CharField(required=False, help_text=_("search_keyword"))
     order_field = serializers.ChoiceField(["vul_count", "level"], default="vul_count")
     order = serializers.ChoiceField(["desc", "asc"], default="desc")
 
 
 class PackeageScaAssetSerializer(PackeageScaAssetDetailSerializer):
@@ -57,6  49,7 @@ class Meta:
             "language_id",
             "aql",
             "vul_count_groupby_level",
             "is_focus",
         ]
 
 
@@ -66,7  59,7 @@ class Meta:
 class PackageList(UserEndPoint):
     @extend_schema_with_envcheck_v2(
         request=PackageListArgsSerializer,
-        tags=[_("Component"), OPERATE_GET, "集成"],
         tags=[_("Component"), OPERATE_GET],
         summary=_("Component List"),
         responses={200: _NewResponseSerializer},
     )
@@ -92,7  85,7 @@ def post(self, request):
             q = q & Q(aql__contains=ser.validated_data["keyword"])
         order = ("-" if ser.validated_data["order"] == "desc" else "")   ser.validated_data["order_field"]
         page_info, data = self.get_paginator(
-            AssetV2Global.objects.filter(q).order_by(order).all(),
             AssetV2Global.objects.filter(q).order_by("-is_focus", order).all(),
             ser.validated_data["page"],
             ser.validated_data["page_size"],
         )

diff --git a/dongtai_web/views/vul_details.py b/dongtai_web/views/vul_details.py
@@ -9,6  9,7 @@
 from rest_framework import serializers
 
 from dongtai_common.endpoint import R, UserEndPoint
 from dongtai_common.models.agent_method_pool import VulMethodPool
 from dongtai_common.models.hook_type import HookType
 from dongtai_common.models.project import IastProject
 from dongtai_common.models.project_version import IastProjectVersion
@@ -116,8  117,8 @@ def get_server(self):
             "command": "",
         }
 
     @staticmethod
     def parse_graphy(
-        self,
         graphy,
         extend_black_list: list | None = None,
         extend_white_list: list | None = None,
@@ -135,7  136,7 @@ def parse_graphy(
 
         results = []
         try:
-            if graphy is None:
             if not graphy:
                 return results
             method_note_pool = json.loads(graphy)[0]
             method_counts = len(method_note_pool)
@@ -327,6  328,7 @@ def get_vul(self, projects):
             "method_pool_id": vul.method_pool_id,
             "project_id": project_id,
             "is_need_http_detail": is_need_http_detail(strategy_name),
             "has_vul_method_pool": VulMethodPool.objects.filter(vul_id=vul.id).exists(),
         }
 
     def get_strategy(self):
@@ -454,68  456,9 @@ def get_graph_and_headers(self, data):
         ]
         return res
 
-    @extend_schema_with_envcheck(
-        response_bodys=[
-            {
-                "name": _("Get data sample"),
-                "description": _(
-                    "The aggregation results are programming language, risk level, vulnerability type, project"
-                ),
-                "value": {
-                    "status": 201,
-                    "msg": "success",
-                    "data": {
-                        "vul": {
-                            "url": "http://localhost:81/captcha/captchaImage",
-                            "uri": "/captcha/captchaImage",
-                            "agent_name": "Mac OS X-localhost-v1.0.0-d24bf703ca62499ebdd12770708296f5",
-                            "http_method": "GET",
-                            "type": "Weak Random Number Generation",
-                            "taint_position": None,
-                            "first_time": 1631089870,
-                            "latest_time": 1631089961,
-                            "project_name": "demo-4.6.1",
-                            "project_version": "V1.0",
-                            "language": "JAVA",
-                            "level": "LOW",
-                            "level_type": 3,
-                            "counts": 6,
-                            "req_header": 'GET /captcha/captchaImage?type=math HTTP/1.1\nhost:localhost:81\nconnection:keep-alive\nsec-ch-ua:"Google Chrome";v="93", " Not;A Brand";v="99", "Chromium";v="93"\nsec-ch-ua-mobile:?0\nuser-agent:Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/93.0.4577.63 Safari/537.36\nsec-ch-ua-platform:"macOS"\naccept:image/avif,image/webp,image/apng,image/svg xml,image/*,*/*;q=0.8\nsec-fetch-site:same-origin\nsec-fetch-mode:no-cors\nsec-fetch-dest:image\nreferer:http://localhost:81/login\naccept-encoding:gzip, deflate, br\naccept-language:zh-CN,zh;q=0.9\ncookie:JSESSIONID=4bada2e5-d848-4218-8e24-3b28f765b986\n',
-                            "response": "None\n\nNone",
-                            "graph": None,
-                            "context_path": "127.0.0.1",
-                            "client_ip": "127.0.0.1",
-                            "status": "Confirmed",
-                            "taint_value": None,
-                            "param_name": {},
-                            "method_pool_id": None,
-                            "project_id": 69,
-                        },
-                        "server": {
-                            "name": "server.name",
-                            "hostname": "localhost",
-                            "ip": "localhost",
-                            "port": 81,
-                            "container": "Apache Tomcat/9.0.41",
-                            "server_type": "apache tomcat",
-                            "container_path": "/Users/erzhuangniu/workspace/vul/demo-4.6.1",
-                            "runtime": "OpenJDK Runtime Environment",
-                            "environment": "java.runtime.name=OpenJDK Runtime Environment, spring.output.ansi.enabled=always, project.name=demo-4.6.1, sun.boot.library.path=/Users/erzhuangniu/Library/Java/JavaVirtualMachines/corretto-1.8.0_292/Contents/Home/jre/lib, java.vm.version=25.292-b10, gop",
-                            "command": "com.ruoyi.demoApplication",
-                        },
-                        "strategy": {
-                            "desc": "Verifies that weak sources of entropy are not used.",
-                            "sample_code": "",
-                            "repair_suggestion": None,
-                        },
-                    },
-                },
-            }
-        ],
-        description=_("Use the corresponding id of the vulnerability to query the details of the vulnerability"),
     @extend_schema(
         summary="获取漏洞详情",
-        tags=["Vulnerability", "集成"],
-        response_schema=_ResponseSerializer,
         tags=["Vulnerability"],
     )
     def get(
         self,