psengine 2.3.0__tar.gz → 2.4.0__tar.gz

{psengine-2.3.0 → psengine-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: psengine
-Version: 2.3.0
+Version: 2.4.0
 Summary: psengine is a simple, yet elegant, library for rapid development of integrations with Recorded Future.
 Author-email: Moise Medici <moise.medici@recordedfuture.com>, Patrick Kinsella <patrick.kinsella@recordedfuture.com>, Ernest Bartosevic <ernest.bartosevic@recordedfuture.com>
 License-Expression: MIT

{psengine-2.3.0 → psengine-2.4.0}/psengine/_version.py

@@ -11,4 +11,4 @@
 # accessed from any third party API.                                                         #
 ##############################################################################################
 
-__version__ = '2.3.0'
+__version__ = '2.4.0'

{psengine-2.3.0 → psengine-2.4.0}/psengine/analyst_notes/note_mgr.py

@@ -111,7 +111,7 @@ class AnalystNoteMgr:
             'label': label,
             'source': source,
             'serialization': serialization,
-            'taggedText': tagged_text,
+            'tagged_text': tagged_text,
             'limit': min(max_results, notes_per_page),
         }
         data = {key: val for key, val in data.items() if val is not None}

{psengine-2.3.0 → psengine-2.4.0}/psengine/enrich/lookup.py

@@ -21,6 +21,7 @@ from .models.base_enriched_entity import BaseEnrichedEntity
 from .models.lookup import (
     CVSS,
     CVSSV3,
+    CVSSV4,
     CVSSRating,
     DnsPortCert,
     EnterpriseList,
@@ -32,6 +33,7 @@ from .models.lookup import (
     RawRisk,
     RiskMapping,
     RiskyCIDRPIP,
+    Scanner,
 )
 
 
@@ -46,6 +48,7 @@ class EnrichedIP(BaseEnrichedEntity):
     dns_port_cert: Optional[DnsPortCert] = Field(alias='dnsPortCert', default=None)
     location: Optional[IPLocation] = None
     risky_cidr_ips: Optional[list[RiskyCIDRPIP]] = Field(alias='riskyCIDRIPs', default=None)
+    scanner: Optional[Scanner] = None
 
 
 class EnrichedDomain(BaseEnrichedEntity):
@@ -103,6 +106,7 @@ class EnrichedVulnerability(BaseEnrichedEntity):
     cvss: Optional[CVSS] = None
     cvss_ratings: list[CVSSRating] = Field(alias='cvssRatings', default=None)
     cvssv3: Optional[CVSSV3] = None
+    cvssv4: Optional[CVSSV4] = None
     nvd_description: Optional[str] = Field(alias='nvdDescription', default=None)
     nvd_references: Optional[list[NvdReference]] = Field(alias='nvdReferences', default=None)
     raw_risk: Optional[list[RawRisk]] = Field(alias='rawrisk', default=None)

{psengine-2.3.0 → psengine-2.4.0}/psengine/enrich/models/lookup.py

@@ -206,6 +206,50 @@ class CVSSV3(RFBaseModel):
     availability_impact: Optional[str] = Field(alias='availabilityImpact', default=None)
 
 
+class CVSSV4(RFBaseModel):
+    subsequent_system_integrity: Optional[str] = Field(
+        alias='subsequentSystemIntegrity', default=None
+    )
+    provider_urgency: Optional[str] = Field(alias='providerUrgency', default=None)
+    attack_requirements: Optional[str] = Field(alias='attackRequirements', default=None)
+    vulnerable_system_confidentiality: Optional[str] = Field(
+        alias='vulnerableSystemConfidentiality', default=None
+    )
+    vulnerability_response_effort: Optional[str] = Field(
+        alias='vulnerabilityResponseEffort', default=None
+    )
+    threat_score: Optional[float] = Field(alias='threatScore', default=None)
+    subsequent_system_availability: Optional[str] = Field(
+        alias='subsequentSystemAvailability', default=None
+    )
+    base_severity: Optional[str] = Field(alias='baseSeverity', default=None)
+    base_score: Optional[float] = Field(alias='baseScore', default=None)
+    user_interaction: Optional[str] = Field(alias='userInteraction', default=None)
+    attack_vector: Optional[str] = Field(alias='attackVector', default=None)
+    source: Optional[str] = None
+    vulnerable_system_integrity: Optional[str] = Field(
+        alias='vulnerableSystemIntegrity', default=None
+    )
+    vulnerable_system_availability: Optional[str] = Field(
+        alias='vulnerableSystemAvailability', default=None
+    )
+    modified: Optional[datetime] = None
+    vector_string: Optional[str] = Field(alias='vectorString', default=None)
+    recovery: Optional[str] = None
+    version: Optional[str] = None
+    threat_severity: Optional[str] = Field(alias='threatSeverity', default=None)
+    privileges_required: Optional[str] = Field(alias='privilegesRequired', default=None)
+    exploit_maturity: Optional[str] = Field(alias='exploitMaturity', default=None)
+    safety: Optional[str] = None
+    subsequent_system_confidentiality: Optional[str] = Field(
+        alias='subsequentSystemConfidentiality', default=None
+    )
+    automatable: Optional[str] = None
+    value_density: Optional[str] = Field(alias='valueDensity', default=None)
+    attack_complexity: Optional[str] = Field(alias='attackComplexity', default=None)
+    created: Optional[datetime] = None
+
+
 ###########################################################
 # Raw Risk
 ###########################################################
@@ -260,6 +304,45 @@ class DnsPortCert(RFBaseModel):
     ports: Optional[list[Port]] = None
 
 
+###########################################################
+# Scanner
+###########################################################
+class Tag(RFBaseModel):
+    verdict_details: Optional[list[str]] = Field(default=None, alias='verdictDetails')
+    entity: list[IdNameType]
+
+
+class Ports(RFBaseModel):
+    tcp: list[int]
+
+
+class Evidence(RFBaseModel):
+    name: str = Field(alias='Name')
+    mitigation_string: str = Field(default=None, alias='MitigationString')
+    evidence_string: str = Field(alias='EvidenceString', default=None)
+    rule: str = Field(alias='Rule')
+    criticality: float = Field(alias='Criticality')
+    timestamp: datetime = Field(alias='Timestamp')
+    criticality_label: str = Field(alias='CriticalityLabel')
+    sources_count: float = Field(alias='SourcesCount')
+    sightings_count: float = Field(alias='SightingsCount')
+    sources: list[str] = Field(alias='Sources')
+
+
+class Scanner(RFBaseModel):
+    last_seen: str = Field(alias='lastSeen')
+    tags: Tag
+    verdict: str
+    scanned_ip_countries: list[str] = Field(alias='scannedIpCountries')
+    rdns: list[str]
+    scanner_country: str = Field(alias='scannerCountry')
+    ports: Ports
+    global_scanner: bool = Field(alias='globalScanner')
+    user_agents: list[str] = Field(alias='userAgents', default=None)
+    web_requests: list[str] = Field(alias='webRequests', default=None)
+    evidence: Optional[list[Evidence]] = []
+
+
 ###########################################################
 # NVD
 ###########################################################

{psengine-2.3.0 → psengine-2.4.0}/psengine/entity_match/entity_match.py

@@ -68,6 +68,13 @@ class ResolvedEntity(RFBaseModel):
 
     This class supports string representation of `ResolvedEntity` instances.
 
+    Hashing:
+        Returns a hash value based on the entity `id_` if found, else the hash of the name.
+
+    Equality:
+        Checks equality between two `ResolvedEntity` instances based on the `id_` if the entity was
+        found else the name.
+
     String Representation:
         Returns a string representation of the `ResolvedEntity` instance including the
         entity match name, type, and ID.
@@ -91,3 +98,13 @@ class ResolvedEntity(RFBaseModel):
         if isinstance(self.content, IdNameType):
             return f'Entity: {self.entity}, Type: {self.content.type_}, ID: {self.content.id_}'
         return f'Entity: {self.entity}, {self.content}'
+
+    def __hash__(self):
+        if hasattr(self.content, 'id_'):
+            return hash(self.content.id_)
+        return hash(self.entity)
+
+    def __eq__(self, other: 'ResolvedEntity'):
+        if hasattr(self.content, 'id_') and hasattr(other.content, 'id_'):
+            return self.content.id_ == other.content.id_
+        return self.entity == other.entity

{psengine-2.3.0 → psengine-2.4.0}/psengine/entity_match/entity_match_mgr.py

@@ -48,7 +48,7 @@ class EntityMatchMgr:
             Optional[Union[list, str]], Doc('Type or list of types of the entity, if known.')
         ] = None,
         limit: Annotated[int, Doc('Maximum number of matches to return.')] = DEFAULT_LIMIT,
-    ) -> Annotated[list[ResolvedEntity], Doc('List of resolved entity matches.')]:
+    ) -> Annotated[list[ResolvedEntity], Doc('List of deduplicated resolved entity matches.')]:
         """Match a text string using the entity match API.
 
         Endpoint:
@@ -65,7 +65,7 @@ class EntityMatchMgr:
         response = self.rf_client.request('post', EP_ENTITY_MATCH, data=request_body.json())
         response = [IdNameType.model_validate(d) for d in response.json()]
         return (
-            [ResolvedEntity(entity=d.name, is_found=bool(d.id_), content=d) for d in response]
+            list({ResolvedEntity(entity=d.name, is_found=bool(d.id_), content=d) for d in response})
             if response
             else [ResolvedEntity(entity=entity_name, is_found=False, content='Entity ID not found')]
         )

{psengine-2.3.0 → psengine-2.4.0}/psengine.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: psengine
-Version: 2.3.0
+Version: 2.4.0
 Summary: psengine is a simple, yet elegant, library for rapid development of integrations with Recorded Future.
 Author-email: Moise Medici <moise.medici@recordedfuture.com>, Patrick Kinsella <patrick.kinsella@recordedfuture.com>, Ernest Bartosevic <ernest.bartosevic@recordedfuture.com>
 License-Expression: MIT

{psengine-2.3.0 → psengine-2.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "psengine"
-version = "2.3.0"
+version = "2.4.0"
 readme = "README.md"
 license = "MIT"
 requires-python = ">=3.9, <3.14"