fix: simplified the extraports structs

Author: savon-noir

.pre-commit-config.yaml

@@ -1,24 +1,34 @@
 exclude: ^(test/|.tox/|docs)
 repos:
--   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.3.0
-    hooks:
-    - id: check-yaml
-    - id: end-of-file-fixer
-    - id: trailing-whitespace
--   repo: https://github.com/psf/black
-    rev: 24.3.0
-    hooks:
-    - id: black
-      args: [--line-length=79]
-      files: ^libnmap
--   repo: https://github.com/pre-commit/mirrors-isort
-    rev: v5.6.4
-    hooks:
-    - id: isort
-      args: [--multi-line=3, --line-length=79, --profile=black]
--   repo: https://gitlab.com/pycqa/flake8
-    rev: 3.8.4
-    hooks:
-    - id: flake8
-      exclude: ^libnmap/(test/|docs/|examples/)
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v2.3.0
+  hooks:
+  - id: check-yaml
+  - id: end-of-file-fixer
+  - id: trailing-whitespace
+- repo: https://github.com/psf/black
+  rev: 24.3.0
+  hooks:
+  - id: black
+    args: [--line-length=79]
+    files: ^libnmap
+- repo: https://github.com/pre-commit/mirrors-isort
+  rev: v5.6.4
+  hooks:
+  - id: isort
+    args: [--multi-line=3, --line-length=79, --profile=black]
+- repo: https://gitlab.com/pycqa/flake8
+  rev: 3.8.4
+  hooks:
+  - id: flake8
+    exclude: ^libnmap/(test/|docs/|examples/)
+- repo: local
+  hooks:
+  - id: pytest-check
+    name: pytest-check
+    stages: [pre-commit]
+    types: [python]
+    entry: pytest --cov=libnmap/ --ignore=libnmap/test/test_backend_plugin_factory.py
+    language: system
+    pass_filenames: false
+    always_run: true

libnmap/objects/__init__.py

@@ -2,6 +2,6 @@
 
 from libnmap.objects.host import NmapHost
 from libnmap.objects.report import NmapReport
-from libnmap.objects.service import NmapExtraPort, NmapService
+from libnmap.objects.service import NmapService
 
-__all__ = ["NmapReport", "NmapHost", "NmapService", "NmapExtraPort"]
+__all__ = ["NmapReport", "NmapHost", "NmapService"]

libnmap/objects/host.py

@@ -465,9 +465,10 @@ def id(self):
     @property
     def extraports(self):
         """
-        Returns a list of NmapExtraPort objects
+        Returns a list of extraport dict with
+        with struct { count: "123", state: "filtered, extrareasons: [{}] }
 
-        :return: list of NmapExtraPort objects
+        :return: list of extraport dict
         """
         return self._extraports
 

libnmap/objects/service.py

@@ -366,52 +366,3 @@ def diff(self, other):
         :return: NmapDiff object
         """
         return NmapDiff(self, other)
-
-
-class NmapExtraPort(object):
-    """
-    NmapExtraPort is an object which documents unlisted ports/services
-    which are possibly closed, filtered, ignored,...
-    """
-
-    def __init__(self, xdict):
-        """
-        Constructor
-        :param xdict: python dict containing the following structure:
-                      {
-                         'state': <str>,
-                         'count': <int>,
-                         'reasons': [{'reason': <str>, 'count' <int>}]
-                      }
-        """
-        self._count = xdict.get("count", 0)
-        self._state = xdict.get("state", "unknown")
-        self._reasons = xdict.get("reasons", [])
-
-    @property
-    def extra_count(self):
-        """
-        Accessor for the number of extraports
-
-        :return: int
-        """
-        return int(self._count)
-
-    @property
-    def extra_state(self):
-        """
-        Accessor for the state of extraports listed
-
-        :return: string
-        """
-        return self._state
-
-    @property
-    def extra_reasons(self):
-        """
-        Return the first reason available for the extraport listed.
-
-        :return: dict, empty if no extraports reason available
-        """
-
-        return self._reasons

libnmap/parser.py

@@ -11,7 +11,7 @@
 
 from xml.etree.ElementTree import iselement as et_iselement
 
-from libnmap.objects import NmapExtraPort, NmapHost, NmapReport, NmapService
+from libnmap.objects import NmapHost, NmapReport, NmapService
 
 
 class NmapParser(object):
@@ -469,9 +469,9 @@ def __parse_extraports(cls, extraports_data):
         :param extraports_data: XML data for extraports
         :type extraports_data: xml.ElementTree.Element or a string
 
-        :return: python dict with following keys: state, count, reason
+        :return: python dict with following keys: state, count, reasons
         """
-        rdict = {"state": "", "count": "", "reasons": []}
+        rdict = {"state": "", "count": "", "extrareasons": []}
         xelement = cls.__format_element(extraports_data)
         extraports_dict = cls.__format_attributes(xelement)
 
@@ -480,9 +480,8 @@ def __parse_extraports(cls, extraports_data):
         for xelt in xelement:
             if xelt.tag == "extrareasons":
                 extrareasons_dict = cls.__format_attributes(xelt)
-                rdict["reasons"].append(extrareasons_dict)
-        robj = NmapExtraPort(rdict)
-        return robj
+                rdict["extrareasons"].append(extrareasons_dict)
+        return rdict
 
     @classmethod
     def __parse_script_table(cls, script_table):

libnmap/test/files/2_hosts.json

@@ -10,14 +10,14 @@
 class TestExtraPorts(unittest.TestCase):
     def setUp(self):
         fdir = os.path.dirname(os.path.realpath(__file__))
-        _extrareason = [
+        _extrareasons = [
             {"reason": "filtered", "count": "3"},
             {"reason": "resets", "count": "7"},
         ]
         self.flist = [
             {
                 "path": "%s/%s" % (fdir, "files/extra_ports.xml"),
-                "extrareason": _extrareason,
+                "extrareasons": _extrareasons,
             }
         ]
 
@@ -26,12 +26,14 @@ def test_extraports(self):
             rep1 = NmapParser.parse_fromfile(fentry["path"])
             ep_list = rep1.hosts[0].extraports
             self.assertEqual(len(ep_list), 2)
-            self.assertEqual(ep_list[0].extra_count, 65509)
-            self.assertEqual(ep_list[0].extra_state, "closed")
-            self.assertEqual(len(ep_list[0].extra_reasons), 1)
-            self.assertEqual(ep_list[1].extra_count, 10)
-            self.assertEqual(len(ep_list[1].extra_reasons), 2)
-            self.assertEqual(ep_list[1].extra_reasons, fentry["extrareason"])
+            self.assertEqual(ep_list[0]["count"], "65509")
+            self.assertEqual(ep_list[0]["state"], "closed")
+            self.assertEqual(len(ep_list[0]["extrareasons"]), 1)
+            self.assertEqual(ep_list[1]["count"], "10")
+            self.assertEqual(len(ep_list[1]["extrareasons"]), 2)
+            self.assertEqual(
+                ep_list[1]["extrareasons"], fentry["extrareasons"]
+            )
 
 
 if __name__ == "__main__":

libnmap/test/test_extraports.py

@@ -181,25 +181,6 @@ def test_host_api(self):
         self.assertEqual(len(h2.get_open_ports()), 3)
         self.assertEqual(h2.get_service(22, "tcp").state, "open")
 
-    def test_extra_ports(self):
-        h1 = NmapParser.parse(host1)
-        h2 = NmapParser.parse(host2)
-
-        self.assertEqual(
-            h1.extraports_state["state"],
-            {"count": "995", "state": "WILLY_WONCKA"},
-        )
-        self.assertEqual(
-            h1.extraports_reasons, [{"reason": "conn-refused", "count": "995"}]
-        )
-
-        self.assertEqual(
-            h2.extraports_state["state"], {"count": "995", "state": "closed"}
-        )
-        self.assertEqual(
-            h2.extraports_reasons, [{"reason": "conn-refused", "count": "995"}]
-        )
-
     def test_diff_host(self):
         h1 = NmapParser.parse(host1)
         h2 = NmapParser.parse(host2)