binareio · binareio · Mar 26, 2024 · Feb 15, 2024 · Feb 15, 2024 · Feb 16, 2024
diff --git a/.gitignore b/.gitignore
diff --git a/src/common/models/models.py b/src/common/models/models.py
@@ -93,6 +93,10 @@ class SearchOptions(BaseModel):
     days: Optional[int] = Field(default=None, description="Number of days back when the CVEs were last modified", alias="days-back", ge=0)
     deprecated: Optional[bool] = Field(default=False, description="If set to true, will fetch only the deprecated CPE names", alias="deprecated")
     profile: Optional[bool] = Field(default=None, description="Would also run the profile execution of the search and save the results in a file")
+    epssScoreGt: Optional[float] = Field(default=None, description="Filter by EPSS score greater than", alias="epss-score-gt", gt=0)   # New field for EPSS score greater than
+    epssScoreLt: Optional[float] = Field(default=None, description="Filter by EPSS score less than", alias="epss-score-lt", gt=0)  # New field for EPSS score less than
+    epssPercGt: Optional[float] = Field(default=None, description="Filter by EPSS percentile greater than", alias="epss-perc-gt", ge=0, le=1)  # New field for EPSS percentile greater than
+    epssPercLt: Optional[float] = Field(default=None, description="Filter by EPSS percentile less than", alias="epss-perc-lt", ge=0, le=1) # New field for EPSS percentile less than
     output: OutputType = Field(default=OutputType.json, description="Define the output format")
 
     class Config:

diff --git a/src/common/search.py b/src/common/search.py
@@ -12,7 +12,7 @@
 import re
 import json
 from typing import List, Iterator
-from sqlalchemy import Boolean
+from sqlalchemy import Boolean,  cast, Numeric
 from sqlalchemy.sql import text, expression
 from sqlalchemy.orm import aliased
 from generic import ApplicationContext
@@ -40,6 +40,17 @@ def search_cves(appctx: ApplicationContext, opts: SearchOptions):
 
         # prepare the search query
         query = session.query(cve_table)
+        # Filter by EPSS score
+        if opts.epssScoreGt is not None:
+            query = query.filter(cast(cve_table.data['metrics']['epss']['score'].astext, Numeric) > opts.epssScoreGt)
+        if opts.epssScoreLt is not None:
+            query = query.filter(cast(cve_table.data['metrics']['epss']['score'].astext, Numeric) < opts.epssScoreLt)
+
+        # Filter by EPSS percentile
+        if opts.epssPercGt is not None:
+            query = query.filter(cast(cve_table.data['metrics']['epss']['percentile'].astext, Numeric) > opts.epssPercGt)
+        if opts.epssPercLt is not None:
+            query = query.filter(cast(cve_table.data['metrics']['epss']['percentile'].astext, Numeric) < opts.epssPercLt)
 
         # filter by the cve IDS, either directly specified in the search options
         if opts.cveId:

diff --git a/src/config/setenv/config.ini b/src/config/setenv/config.ini
@@ -41,7 +41,7 @@ file.max.count = 10
 [fetch]
 
 ; NIST CVE API
-url.cve = https://services.nvd.nist.gov/rest/json/cves/2.0 
+url.cve = https://services.nvd.nist.gov/rest/json/cves/2.0
 
 ; NIST CPE API
 url.cpe = https://services.nvd.nist.gov/rest/json/cpes/2.0
@@ -55,6 +55,9 @@ url.cwe = https://cwe.mitre.org/data/xml/views/2000.xml.zip
 ; MITRE CAPEC source file
 url.capec = https://capec.mitre.org/data/xml/views/3000.xml.zip
 
+; Cynetia EPSS source file
+url.epss = https://epss.cyentia.com
+
 ; API_KEY set the value of API key obtained from NVD
 api_key = ${NVD_API_KEY}
 

diff --git a/src/config/setenv/setenv_dev.ini b/src/config/setenv/setenv_dev.ini
@@ -12,3 +12,4 @@ export FCDB_DB_POOL_OVERFLOW=5
 
 export FCDB_HOST=localhost
 export FCDB_PORT=5432
+
diff --git a/src/db/scripts/versions/9a14a98e9e6d_add_epss_table.py b/src/db/scripts/versions/9a14a98e9e6d_add_epss_table.py
@@ -0,0 +1,42 @@
+"""Add EPSS table
+
+Revision ID: 9a14a98e9e6d
+Revises: 2f14a6a5afe8
+Create Date: 2024-03-12 13:30:54.706771
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '9a14a98e9e6d'
+down_revision = '2f14a6a5afe8'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('epss',
+    sa.Column('id', sa.Integer(), nullable=False),
+    sa.Column('cve_id', sa.String(length=20), nullable=True, comment='The ID of the CVE'),
+    sa.Column('epss_score', sa.Float(), nullable=False, comment='the score of the epss'),
+    sa.Column('percentile', sa.Float(), nullable=False, comment='the percentile of the epss'),
+    sa.Column('date', sa.DateTime(), nullable=False, comment='Date when the EPSS record has been downloaed'),
+    sa.Column('changed', sa.Boolean(), nullable=True, comment='indicate if epss_score has been changed'),
+    sa.PrimaryKeyConstraint('id'),
+    comment='Table that contains the list of EPSS'
+    )
+    op.create_index('epss_idx1', 'epss', ['cve_id'], unique=False)
+    op.create_index(op.f('ix_epss_cve_id'), 'epss', ['cve_id'], unique=False)
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_index(op.f('ix_epss_cve_id'), table_name='epss')
+    op.drop_index('epss_idx1', table_name='epss')
+    op.drop_table('epss')
+    # ### end Alembic commands ###
+
diff --git a/src/db/tables.py b/src/db/tables.py
@@ -5,7 +5,7 @@
 """
 
 # coding: utf-8
-from sqlalchemy import (Column, DateTime, Integer, String, Boolean, text,
+from sqlalchemy import (Column, DateTime, Integer, String, Boolean, Float, text,
                         UniqueConstraint, Index, Text)
 from sqlalchemy.ext.declarative import declarative_base
 from sqlalchemy.dialects.postgresql.json import JSONB
@@ -145,3 +145,17 @@ class Capec(Base):
     description = Column(Text, comment=u"the description of the CAPEC")
     data = Column(JSONB, comment=u'CAPEC JSON representation')
 
+# ------------------------------------------------------------------------------
+class Epss(Base):
+    __tablename__ = 'epss'
+    __table_args__ = (
+        Index('epss_idx1', 'cve_id'),
+        {u'comment': u'Table that contains the list of EPSS'}
+    )
+
+    id = Column(Integer, primary_key=True)
+    cve_id = Column(String(20), index=True, comment=u'The ID of the CVE')
+    epss_score = Column(Float, nullable=False, comment=u"the score of the epss")
+    percentile = Column(Float, nullable=False, comment=u"the percentile of the epss")
+    date = Column(DateTime, nullable=False, comment=u"Date when the EPSS record has been downloaed")
+    changed = Column(Boolean, comment=u'indicate if epss_score has been changed')
Original file line number	Diff line number	Diff line change
Expand Up		@@ -12,3 +12,4 @@ export FCDB_DB_POOL_OVERFLOW=5

		export FCDB_HOST=localhost
		export FCDB_PORT=5432