Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve CPE parsing #915

Merged
merged 2 commits into from
Nov 3, 2023
Merged

Improve CPE parsing #915

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
174c5fa
Add: Improve error handling for converting a CPE to the URI format
bjoernricks Nov 3, 2023
c8814d0
Add: Allow parsing CPEs with parts containing a colon
bjoernricks Nov 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 32 additions & 2 deletions pontos/cpe/_cpe.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,10 @@
return ""
if value == NA:
return value
return _transform_for_uri(value)
try:
return _transform_for_uri(value)
except Exception as e:
raise CPEParsingError(f"Can't bind '{value}' for URI") from e

Check warning on line 259 in pontos/cpe/_cpe.py

View check run for this annotation

Codecov / codecov/patch

pontos/cpe/_cpe.py#L258-L259 

Added lines #L258 - L259 were not covered by tests


def unbind_value_uri(value: Optional[str]) -> Optional[str]:
Expand Down Expand Up @@ -318,6 +321,33 @@
return result


def split_cpe(cpe: str) -> list[str]:
"""
Split a CPE into its parts
"""
if "\\:" in cpe:
# houston we have a problem
# the cpe string contains an escaped colon (:)
parts = []
index = 0
start_index = 0
stripped_cpe = cpe
while index < len(cpe):
if index > 0 and cpe[index] == ":" and cpe[index - 1] != "\\":
part = cpe[start_index:index]
parts.append(part)
start_index = index + 1
stripped_cpe = cpe[start_index:]
index += 1

if stripped_cpe:
parts.append(stripped_cpe)
else:
parts = cpe.split(":")

return parts


@dataclass(frozen=True) # should require keywords only with Python >= 3.10
class CPE:
"""
Expand Down Expand Up @@ -389,7 +419,7 @@
Create a new CPE from a string
"""
cleaned_cpe = cpe.strip().lower()
parts = cpe.split(":")
parts = split_cpe(cleaned_cpe)

if is_uri_binding(cleaned_cpe):
values: dict[str, Optional[str]] = dict(
Expand Down
80 changes: 76 additions & 4 deletions tests/cpe/test_cpe.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,58 @@
import unittest

from pontos.cpe import ANY, CPE, NA, CPEParsingError, Part
from pontos.cpe._cpe import split_cpe


class SplitCpeTestCase(unittest.TestCase):
def test_split_uri_cpe(self):
parts = split_cpe("cpe:/o:microsoft:windows_xp:::pro")

self.assertEqual(len(parts), 7)
self.assertEqual(parts[0], "cpe")
self.assertEqual(parts[1], "/o")
self.assertEqual(parts[2], "microsoft")
self.assertEqual(parts[3], "windows_xp")
self.assertEqual(parts[4], "")
self.assertEqual(parts[5], "")
self.assertEqual(parts[6], "pro")

def test_split_formatted_cpe(self):
parts = split_cpe(
"cpe:2.3:a:microsoft:internet_explorer:8.0.6001:beta:*:*:*:*:*:*"
)

self.assertEqual(len(parts), 13)
self.assertEqual(parts[0], "cpe")
self.assertEqual(parts[1], "2.3")
self.assertEqual(parts[2], "a")
self.assertEqual(parts[3], "microsoft")
self.assertEqual(parts[4], "internet_explorer")
self.assertEqual(parts[5], "8.0.6001")
self.assertEqual(parts[6], "beta")
self.assertEqual(parts[7], "*")
self.assertEqual(parts[8], "*")
self.assertEqual(parts[9], "*")
self.assertEqual(parts[10], "*")
self.assertEqual(parts[11], "*")
self.assertEqual(parts[12], "*")

parts = split_cpe("cpe:2.3:a:foo:bar\:mumble:1.0:*:*:*:*:*:*:*")

self.assertEqual(len(parts), 13)
self.assertEqual(parts[0], "cpe")
self.assertEqual(parts[1], "2.3")
self.assertEqual(parts[2], "a")
self.assertEqual(parts[3], "foo")
self.assertEqual(parts[4], "bar\\:mumble")
self.assertEqual(parts[5], "1.0")
self.assertEqual(parts[6], "*")
self.assertEqual(parts[7], "*")
self.assertEqual(parts[8], "*")
self.assertEqual(parts[9], "*")
self.assertEqual(parts[10], "*")
self.assertEqual(parts[11], "*")
self.assertEqual(parts[12], "*")


class CPETestCase(unittest.TestCase):
Expand Down Expand Up @@ -390,10 +442,10 @@ def test_formatted_unbind_examples(self):
self.assertEqual(cpe.part, Part.APPLICATION)
self.assertEqual(cpe.vendor, "microsoft")
self.assertEqual(cpe.product, "internet_explorer")
# self.assertEqual(cpe.version, "8\.0\.6001")
self.assertEqual(cpe.version, "8\.0\.6001")
self.assertEqual(cpe.update, "beta")
self.assertEqual(cpe.language, ANY)
self.assertEqual(cpe.edition, ANY)
self.assertEqual(cpe.language, ANY)
self.assertEqual(cpe.sw_edition, ANY)
self.assertEqual(cpe.target_sw, ANY)
self.assertEqual(cpe.target_hw, ANY)
Expand Down Expand Up @@ -463,14 +515,34 @@ def test_formatted_unbind_examples(self):
self.assertEqual(cpe.target_hw, "80gb")
self.assertEqual(cpe.other, ANY)

cpe = CPE.from_string("cpe:2.3:a:foo:bar\:mumble:1.0:*:*:*:*:*:*:*")
self.assertFalse(cpe.is_uri_binding())
self.assertTrue(cpe.is_formatted_string_binding())
self.assertEqual(cpe.part, Part.APPLICATION)
self.assertEqual(cpe.vendor, "foo")
self.assertEqual(cpe.product, "bar\:mumble")
self.assertEqual(cpe.version, "1\.0")
self.assertEqual(cpe.update, ANY)
self.assertEqual(cpe.edition, ANY)
self.assertEqual(cpe.language, ANY)
self.assertEqual(cpe.sw_edition, ANY)
self.assertEqual(cpe.target_sw, ANY)
self.assertEqual(cpe.target_hw, ANY)
self.assertEqual(cpe.other, ANY)

def test_as_uri_binding(self):
cpe_string = "cpe:2.3:a:microsoft:internet_explorer:8\\.*:sp?"
cpe = CPE.from_string(cpe_string)
cpe = CPE.from_string("cpe:2.3:a:microsoft:internet_explorer:8\\.*:sp?")
self.assertEqual(
cpe.as_uri_binding(),
"cpe:/a:microsoft:internet_explorer:8.%02:sp%01",
)

cpe = CPE.from_string("cpe:2.3:a:cgiirc:cgi\:irc:0.5.7:*:*:*:*:*:*:*")
self.assertEqual(
cpe.as_uri_binding(),
"cpe:/a:cgiirc:cgi%3airc:0.5.7",
)

def test_as_uri_binding_with_edition(self):
cpe_string = "cpe:2.3:a:hp:insight_diagnostics:7.4.0.1570:-:*:*:online:win2003:x64"
cpe = CPE.from_string(cpe_string)
Expand Down