fixed docstring issue in object. Edited TODO/CHANGELOG.

savon-noir · savon-noir · commit dda7d823879f · 2013-05-17T01:42:23.000+02:00
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -1,3 +1,12 @@
+v0.2.1, 17/05/2013 -- Code Docstring and added support for additional data
+                    - added support for scripts in NmapService
+                    - added support for hosts extra data in NmapHost (uptime, distance,...)
+                    - added support for OS fingerprint data in NmapHost
+                    - added python docstrings for all modules
+                    - added sphinx documentation
+                    - reviewed API for libnmap objects
+                    - fixed errors with hash() in diff
+                    - fixed errors/exceptions in NmapParser
 v0.2.0, 18/04/2013 -- Added Serialization and Plugin support
                     - added serialization encoders and decoders for NmapReport
                     - added basic plugin capability to NmapReport
diff --git a/TODO b/TODO
@@ -1,12 +1,8 @@
-- Add Sphinx DocStrings
-- NmapParser should be able to be fully generic and return Objects
-- NmapParser should not need a XML root
+- complete unit tests
+- complete Sphinx DocStrings
 - Add new plugins to support import/export from mysql, couchdb, csv
-- support iterators for NmapReport::scanned_hosts
-- add support for parsing os version (fingerprint)
+- support iterators for NmapReport::hosts
 - add unittest for udp scans, ping sweeping
 - add support for 'resume' capability (see nmap --resume)
-- review thread management for NmapProcess
-- add a safe_run toggle in constructor of NmapProcess to cloak unsecure options like -oN, -oG, -oX 
 - add support for "not shown ports" (extra ports) in NmapHost (via NmapParser)
 - add API support in NmapReport for returning nmap_run data
diff --git a/libnmap/objects.py b/libnmap/objects.py
@@ -386,29 +386,29 @@ def __init__(self, portid, protocol='tcp', state=None,
         if service_extras is not None:
             self._service_extras = service_extras
 
-    """
-        Compares two NmapService objects to see if they are the same or
-        if one of them changed.
+    def __eq__(self, other):
+        """
+            Compares two NmapService objects to see if they are the same or
+            if one of them changed.
 
-        :param other: NmapService
+            :param other: NmapService
 
-        :return: boolean
-    """
-    def __eq__(self, other):
+            :return: boolean
+        """
         rval = False
         if(self.__class__ == other.__class__ and self.id == other.id):
             rval = (self.changed(other) == 0)
         return rval
 
-    """
-        Compares two NmapService objects to see if they are different
-        if one of them changed.
+    def __ne__(self, other):
+        """
+            Compares two NmapService objects to see if they are different
+            if one of them changed.
 
-        :param other: NmapService
+            :param other: NmapService
 
-        :return: boolean
-    """
-    def __ne__(self, other):
+            :return: boolean
+        """
         rval = True
         if(self.__class__ == other.__class__ and self.id == other.id):
             rval = (self.changed(other) > 0)
@@ -426,70 +426,68 @@ def __hash__(self):
         return (hash(self.port) ^ hash(self.protocol) ^ hash(self.state) ^
                 hash(self.service) ^ hash(self.banner))
 
-    """
-        Checks if a NmapService is different from another.
+    def changed(self, other):
+        """
+            Checks if a NmapService is different from another.
 
-        :param other: NmapService
+            :param other: NmapService
 
-        :return: boolean
-    """
-    def changed(self, other):
+            :return: boolean
+        """
         return len(self.diff(other).changed())
 
-    """
-        Accessor for port.
-
-        :return: integer or -1
-    """
     @property
     def port(self):
-        return self._portid
+        """
+            Accessor for port.
 
-    """
-        Accessor for protocol
+            :return: integer or -1
+        """
+        return self._portid
 
-        :return: string
-    """
     @property
     def protocol(self):
-        return self._protocol
+        """
+            Accessor for protocol
 
-    """
-        Accessor for service's state (open, filtered, closed,...)
+            :return: string
+        """
+        return self._protocol
 
-        :return: string
-    """
     @property
     def state(self):
-        return self._state['state'] if 'state' in self._state else None
+        """
+            Accessor for service's state (open, filtered, closed,...)
 
-    """
-        Accessor for service dictionnary.
+            :return: string
+        """
+        return self._state['state'] if 'state' in self._state else None
 
-        :return: dict
-    """
     @property
     def service(self):
-        return self._service['name'] if 'name' in self._service else None
+        """
+            Accessor for service dictionnary.
 
-    """
-        Tells if the port was open or not
+            :return: dict or None
+        """
+        return self._service['name'] if 'name' in self._service else None
 
-        :return: boolean
-    """
     def open(self):
-        return (True
-                if 'state' in self._state and self._state['state'] == 'open'
-                else False)
+        """
+            Tells if the port was open or not
 
-    """
-        Accessor for the service's banner. Only available if the nmap option
-        -sV or similar was used.
+            :return: boolean
+        """
+        return 'state' in self._state and self._state['state'] == 'open'
 
-        :return: string
-    """
     @property
     def banner(self):
+        """
+            Accessor for the service's banner. Only available
+            if the nmap option -sV or similar was used.
+
+            :return: string
+        """
         notrelevant = ['name', 'method', 'conf']
         b = ''
         if 'method' in self._service and self._service['method'] == "probed":
@@ -498,14 +496,14 @@ def banner(self):
                               if k not in notrelevant])
         return b
 
-    """
-        Gives a python dictionary of the nse scripts results.
-        The dict key is the name (id) of the nse script and
-        the value is the output of the script.
-
-        :return: dict
-    """
     def scripts_results(self):
+        """
+            Gives a python dictionary of the nse scripts results.
+            The dict key is the name (id) of the nse script and
+            the value is the output of the script.
+
+            :return: dict
+        """
         scripts_dict = None
         try:
             scripts_dict = dict([(bdct['id'], bdct['output'])
@@ -514,44 +512,43 @@ def scripts_results(self):
             pass
         return scripts_dict
 
-    """
-        Accessor for the id() of the NmapService. This is used for
-        diff()ing NmapService object via NmapDiff.
-
-        :return: tuple
-    """
     @property
     def id(self):
-        return (self.protocol, self.port)
+        """
+            Accessor for the id() of the NmapService. This is used for
+            diff()ing NmapService object via NmapDiff.
 
-    """
-        Return a python dict representation of the NmapService object.
-        This is used to diff() NmapService objects via NmapDiff.
+            :return: tuple
+        """
+        return (self.protocol, self.port)
 
-        :return: dict
-    """
     def get_dict(self):
+        """
+            Return a python dict representation of the NmapService object.
+            This is used to diff() NmapService objects via NmapDiff.
+
+            :return: dict
+        """
         return ({'id': str(self.id), 'port': str(self.port),
                  'protocol': self.protocol, 'banner': self.banner,
                  'service': self.service, 'state': self.state})
 
-    """
-        Calls NmapDiff to check the difference between self and
-        another NmapService object.
-        Will return a NmapDiff object.
-        This objects return python set() of keys describing the elements
-        which have changed, were added, removed or kept unchanged.
-
-        :return: NmapDiff object
-    """
     def diff(self, other):
+        """
+            Calls NmapDiff to check the difference between self and
+            another NmapService object.
+            Will return a NmapDiff object.
+            This objects return python set() of keys describing the elements
+            which have changed, were added, removed or kept unchanged.
+
+            :return: NmapDiff object
+        """
         return NmapDiff(self, other)
 
 
 class NmapReport(object):
     """
-        :todo:
-                - remove get_raw_data makes no sens
+        :todo: remove get_raw_data makes no sense
     """
     def __init__(self, raw_data=None):
         self._nmaprun = {}
@@ -645,9 +642,9 @@ def __is_consistent(self):
         r = False
         rd = self.get_raw_data()
         _consistent_keys = ['_nmaprun', '_scaninfo', '_hosts', '_runstats']
-        if (set(_consistent_keys) == set(rd.keys()) and
-                len([k for k in rd.keys() if rd[k] is not None]) == 4):
-                r = True
+        if(set(_consistent_keys) == set(rd.keys()) and
+           len([k for k in rd.keys() if rd[k] is not None]) == 4):
+            r = True
         return r
 
     def get_dict(self):
diff --git a/setup.py b/setup.py
@@ -2,7 +2,7 @@
 
 setup(
     name='libnmap',
-    version='0.2',
+    version='0.2.1',
     author='Ronald Bister',
     author_email='mini.pelle@gmail.com',
     packages=['libnmap', 'libnmap.plugins', 'libnmap.test'],
