delete ThreatImpact

Author: dejima-shikou

api/app/alembic/versions/4912bc5835e5_delete_threat_impact.py

@@ -0,0 +1,38 @@
+"""delete_threat_impact
+
+Revision ID: 4912bc5835e5
+Revises: 884b692bb1e6
+Create Date: 2024-12-13 01:01:34.420806
+
+"""
+
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "4912bc5835e5"
+down_revision = "884b692bb1e6"
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column("topic", "threat_impact")
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column(
+        "topic",
+        sa.Column(
+            "threat_impact",
+            sa.INTEGER(),
+            server_default=sa.text("3"),
+            autoincrement=False,
+            nullable=False,
+        ),
+    )
+    op.alter_column("topic", "threat_impact", server_default=None)
+    # ### end Alembic commands ###

api/app/business/ssvc_business.py

@@ -8,14 +8,14 @@ def _sum_ssvc_priority_count(topic_ids: list[str], topic_ids_dict: dict, count_k
     out_of_cycle = models.SSVCDeployerPriorityEnum.OUT_OF_CYCLE.value
     scheduled = models.SSVCDeployerPriorityEnum.SCHEDULED.value
     defer = models.SSVCDeployerPriorityEnum.DEFER.value
-    sum_threat_impact_count = {immediate: 0, out_of_cycle: 0, scheduled: 0, defer: 0}
+    sum_ssvc_priority_count = {immediate: 0, out_of_cycle: 0, scheduled: 0, defer: 0}
     for topic_id in topic_ids:
         current_count = topic_ids_dict[topic_id][count_key]
-        sum_threat_impact_count[immediate] += current_count[immediate]
-        sum_threat_impact_count[out_of_cycle] += current_count[out_of_cycle]
-        sum_threat_impact_count[scheduled] += current_count[scheduled]
-        sum_threat_impact_count[defer] += current_count[defer]
-    return sum_threat_impact_count
+        sum_ssvc_priority_count[immediate] += current_count[immediate]
+        sum_ssvc_priority_count[out_of_cycle] += current_count[out_of_cycle]
+        sum_ssvc_priority_count[scheduled] += current_count[scheduled]
+        sum_ssvc_priority_count[defer] += current_count[defer]
+    return sum_ssvc_priority_count
 
 
 def get_topic_ids_summary_by_service_id_and_tag_id(
@@ -64,7 +64,7 @@ def get_topic_ids_summary_by_service_id_and_tag_id(
                 tmp_topic_ids_dict["unsolved_ssvc_priority_count"][ssvc_priority.value] += 1
                 tmp_topic_ids_dict["is_solved"] = False
 
-    # Sort topic_id according to threat_impact and updated_at
+    # Sort topic_id according to highest_ssvc_priority and updated_at
     topic_ids_sorted = sorted(
         topic_ids_dict.values(),
         key=lambda x: (

api/app/command.py

@@ -95,7 +95,7 @@ def search_topics_internal(
     offset: int = 0,
     limit: int = 10,
     sort_key: schemas.TopicSortKey = schemas.TopicSortKey.CVSS_V3_SCORE_DESC,
-    threat_impacts: list[int] | None = None,
+    cvss_v3_scores: list[float] | None = None,
     title_words: list[str | None] | None = None,
     abstract_words: list[str | None] | None = None,
     tag_ids: list[str | None] | None = None,
@@ -109,10 +109,10 @@ def search_topics_internal(
     pteam_id: UUID | None = None,
 ) -> dict:
     # search conditions
-    search_by_threat_impacts_stmt = (
+    search_by_cvss_v3_scores_stmt = (
         true()
-        if threat_impacts is None  # do not filter by threat_impact
-        else models.Topic.threat_impact.in_(threat_impacts)
+        if cvss_v3_scores is None  # do not filter by cvss_v3_score
+        else models.Topic.cvss_v3_score.in_(cvss_v3_scores)
     )
     search_by_tag_ids_stmt = (
         true()
@@ -206,7 +206,7 @@ def search_topics_internal(
     )
 
     search_conditions = [
-        search_by_threat_impacts_stmt,
+        search_by_cvss_v3_scores_stmt,
         search_by_tag_ids_stmt,
         search_by_misp_tag_ids_stmt,
         search_by_topic_ids_stmt,

api/app/models.py

@@ -579,7 +579,6 @@ def __init__(self, *args, **kwargs) -> None:
     topic_id: Mapped[StrUUID] = mapped_column(primary_key=True)
     title: Mapped[Str255]
     abstract: Mapped[str]
-    threat_impact: Mapped[int]
     created_by: Mapped[StrUUID] = mapped_column(ForeignKey("account.user_id"), index=True)
     created_at: Mapped[datetime] = mapped_column(server_default=current_timestamp())
     updated_at: Mapped[datetime] = mapped_column(server_default=current_timestamp())

api/app/routers/topics.py

@@ -52,7 +52,7 @@ def search_topics(
     offset: int = Query(0, ge=0),
     limit: int = Query(10, ge=1, le=100),  # 10 is default in web/src/pages/TopicManagement.jsx
     sort_key: schemas.TopicSortKey = Query(schemas.TopicSortKey.CVSS_V3_SCORE_DESC),
-    threat_impacts: list[int] | None = Query(None),
+    cvss_v3_scores: list[float] | None = Query(None),
     topic_ids: list[str] | None = Query(None),
     title_words: list[str] | None = Query(None),
     abstract_words: list[str] | None = Query(None),
@@ -70,7 +70,7 @@ def search_topics(
     """
     Search topics by following parameters with sort and pagination.
 
-    - threat_impacts
+    - cvss_v3_scores
     - title_words
     - abstract_words
     - tag_names
@@ -149,13 +149,13 @@ def search_topics(
                 continue
             fixed_abstract_words.add(abstract_word)
 
-    fixed_threat_impacts: set[int] = set()
-    if threat_impacts is not None:
-        for threat_impact in threat_impacts:
+    fixed_cvss_v3_scores: set[float] = set()
+    if cvss_v3_scores is not None:
+        for cvss_v3_score in cvss_v3_scores:
             try:
-                int_val = int(threat_impact)
-                if int_val in {1, 2, 3, 4}:
-                    fixed_threat_impacts.add(int_val)
+                float_val = float(cvss_v3_score)
+                if float_val <= 10.0 and float_val >= 0:
+                    fixed_cvss_v3_scores.add(float_val)
             except ValueError:
                 pass
 
@@ -164,7 +164,7 @@ def search_topics(
         offset=offset,
         limit=limit,
         sort_key=sort_key,
-        threat_impacts=None if threat_impacts is None else list(fixed_threat_impacts),
+        cvss_v3_scores=None if cvss_v3_scores is None else list(fixed_cvss_v3_scores),
         title_words=None if title_words is None else list(fixed_title_words),
         abstract_words=None if abstract_words is None else list(fixed_abstract_words),
         tag_ids=None if tag_names is None else list(fixed_tag_ids),
@@ -203,8 +203,6 @@ def create_topic(
 ):
     """
     Create a topic.
-    - `threat_impact` : The value is in 1, 2, 3, 4.
-      (immediate: 1, off-cycle: 2, acceptable: 3, none: 4)
     - `tags` : Optional. The default is an empty list.
     - `misp_tags` : Optional. The default is an empty list.
     - `actions` : Optional. The default is an empty list.
@@ -270,7 +268,6 @@ def create_topic(
         topic_id=str(topic_id),
         title=data.title,
         abstract=data.abstract,
-        threat_impact=data.threat_impact,
         created_by=current_user.user_id,
         created_at=now,
         updated_at=now,
@@ -348,11 +345,6 @@ def update_topic(
             status_code=status.HTTP_400_BAD_REQUEST,
             detail="Cannot specify None for abstract",
         )
-    if "threat_impact" in update_data.keys() and data.threat_impact is None:
-        raise HTTPException(
-            status_code=status.HTTP_400_BAD_REQUEST,
-            detail="Cannot specify None for threat_impact",
-        )
     if "tags" in update_data.keys() and data.tags is None:
         raise HTTPException(
             status_code=status.HTTP_400_BAD_REQUEST,
@@ -389,8 +381,6 @@ def update_topic(
         topic.title = data.title
     if data.abstract is not None:
         topic.abstract = data.abstract
-    if data.threat_impact is not None:
-        topic.threat_impact = data.threat_impact
     if data.exploitation is not None:
         previous_exploitation = topic.exploitation
         topic.exploitation = data.exploitation

api/app/schemas.py

@@ -2,7 +2,7 @@
 from enum import Enum
 from uuid import UUID
 
-from pydantic import BaseModel, ConfigDict, Field, field_validator
+from pydantic import BaseModel, ConfigDict, Field
 
 from app.constants import DEFAULT_ALERT_SSVC_PRIORITY
 from app.models import (
@@ -135,11 +135,6 @@ class MispTagResponse(ORMModel):
     tag_name: str
 
 
-def threat_impact_range(value):
-    assert value is None or 0 < value <= 4, "Specify a threat_impact between 1 and 4"
-    return value
-
-
 class TopicEntry(ORMModel):
     topic_id: UUID
     title: str
@@ -151,15 +146,12 @@ class Topic(TopicEntry):
     topic_id: UUID
     title: str
     abstract: str
-    threat_impact: int
     created_by: UUID
     created_at: datetime
     exploitation: ExploitationEnum | None
     automatable: AutomatableEnum | None
     cvss_v3_score: float | None
 
-    _threat_impact_range = field_validator("threat_impact", mode="before")(threat_impact_range)
-
 
 class TopicResponse(Topic):
     tags: list[TagResponse]
@@ -207,29 +199,23 @@ class ActionUpdateRequest(ORMModel):
 class TopicCreateRequest(ORMModel):
     title: str
     abstract: str
-    threat_impact: int
     tags: list[str] = []
     misp_tags: list[str] = []
     actions: list[ActionCreateRequest] = []
     exploitation: ExploitationEnum | None = None
     automatable: AutomatableEnum | None = None
     cvss_v3_score: float | None = None
 
-    _threat_impact_range = field_validator("threat_impact", mode="before")(threat_impact_range)
-
 
 class TopicUpdateRequest(ORMModel):
     title: str | None = None
     abstract: str | None = None
-    threat_impact: int | None = None
     tags: list[str] | None = None
     misp_tags: list[str] | None = None
     exploitation: ExploitationEnum | None = None
     automatable: AutomatableEnum | None = None
     cvss_v3_score: float | None = None
 
-    _threat_impact_range = field_validator("threat_impact", mode="before")(threat_impact_range)
-
 
 class PTeamInfo(PTeamEntry):
     alert_slack: Slack

api/app/tests/medium/constants.py

@@ -61,7 +61,6 @@
     "topic_id": uuid4(),
     "title": "topic one",
     "abstract": "abstract one",
-    "threat_impact": 1,
     "tags": [TAG1],
     "misp_tags": [MISPTAG1],
     "actions": [],
@@ -73,7 +72,6 @@
     "topic_id": uuid4(),
     "title": "topic two",
     "abstract": "abstract two",
-    "threat_impact": 2,
     "tags": [TAG1],
     "misp_tags": [],
     "actions": [],
@@ -84,7 +82,6 @@
     "topic_id": uuid4(),
     "title": "topic three",
     "abstract": "abstract three",
-    "threat_impact": 1,
     "tags": [TAG1, TAG3],
     "misp_tags": [],
     "actions": [],
@@ -95,7 +92,6 @@
     "topic_id": uuid4(),
     "title": "topic four",
     "abstract": "abstract four",
-    "threat_impact": 2,
     "tags": [TAG3],
     "misp_tags": [],
     "actions": [],