Assign new string constant DFXML_VERSION as default value

Signed-off-by: Alex Nelson <[email protected]>

Author: ajnelson-nist

dfxml/__init__.py

@@ -61,6 +61,9 @@
 
 tsk_virtual_filenames = set(['$FAT1','$FAT2'])
 
+# This version string is the version of the DFXML Schema.
+DFXML_VERSION = "2.0.0-beta.0"
+
 XMLNS_DC = "http://purl.org/dc/elements/1.1/"
 XMLNS_DFXML = "http://www.forensicswiki.org/wiki/Category:Digital_Forensics_XML"
 XMLNS_DELTA = "http://www.forensicswiki.org/wiki/Forensic_Disk_Differencing"

dfxml/bin/Extractor.py

@@ -70,7 +70,7 @@ def extract_files(image_path, outdir, dfxml_path=None, file_predicate=is_file, f
     _path_for_iterparse = dfxml_path or image_path
 
     #Set up base manifest to track extracted files
-    base_manifest = Objects.DFXMLObject(version="2.0.0-beta.0")
+    base_manifest = Objects.DFXMLObject()
     base_manifest.program = sys.argv[0]
     if sys.argv[0] == os.path.basename(__file__):
         base_manifest.program_version = __version__

dfxml/bin/cat_fileobjects.py

@@ -39,7 +39,7 @@ def main():
 <dfxml
   xmlns="%s"
   xmlns:delta="%s"
-  version="2.0.0-beta.0">
+  version="%s">
   <metadata/>
   <creator>
     <program>%s</program>
@@ -51,7 +51,7 @@ def main():
   <source>
     <image_filename>%s</image_filename>
   </source>\
-""" % (dfxml.XMLNS_DFXML, dfxml.XMLNS_DELTA, sys.argv[0], __version__, " ".join(sys.argv), args.filename))
+""" % (dfxml.XMLNS_DFXML, dfxml.XMLNS_DELTA, dfxml.DFXML_VERSION, sys.argv[0], __version__, " ".join(sys.argv), args.filename))
 
     ET.register_namespace("delta", dfxml.XMLNS_DELTA)
 

dfxml/bin/cat_partitions.py

@@ -39,7 +39,7 @@
 _logger = logging.getLogger(os.path.basename(__file__))
 
 def main():
-    d = Objects.DFXMLObject(version="2.0.0-beta.0")
+    d = Objects.DFXMLObject()
 
     d.program = sys.argv[0]
     d.program_version = __version__

dfxml/bin/idifference.py

@@ -365,6 +365,7 @@ def to_xml(self):
             exit(1)
 
         metadict = dict()
+        metadict["DFXML_VERSION"] = dfxml.DFXML_VERSION
         metadict["XMLNS_DFXML"] = dfxml.XMLNS_DFXML
         metadict["XMLNS_DELTA"] = dfxml.XMLNS_DELTA
         metadict["program"] = sys.argv[0]
@@ -377,7 +378,7 @@ def to_xml(self):
         xmlfile.write("""\
 <?xml version="1.0" encoding="UTF-8"?>
 <dfxml
-  version="2.0.0-beta.0"
+  version="%(DFXML_VERSION)s"
   xmlns='%(XMLNS_DFXML)s'
   xmlns:dc='http://purl.org/dc/elements/1.1/'
   xmlns:delta='%(XMLNS_DELTA)s'

dfxml/bin/make_differential_dfxml.py

@@ -103,7 +103,7 @@ def make_differential_dfxml(
     _logger.debug("diff_mask_set = " + repr(diff_mask_set))
 
     #d: The container DFXMLObject, ultimately returned.
-    d = Objects.DFXMLObject(version="2.0.0-beta.0")
+    d = Objects.DFXMLObject()
     if sys.argv[0] == os.path.basename(__file__):
         d.program = sys.argv[0]
         d.program_version = __version__

dfxml/bin/walk_to_dfxml.py

@@ -210,7 +210,7 @@ def main() -> None:
             using_threading = False
             _logger.warning("Python queue support not available.  (If running Ubuntu, this is in package python3-queuelib.)  Running in single thread only.")
 
-    dobj = Objects.DFXMLObject(version="2.0.0-beta.0")
+    dobj = Objects.DFXMLObject()
     dobj.program = sys.argv[0]
     dobj.program_version = __version__
     dobj.command_line = " ".join(sys.argv)

dfxml/objects.py

@@ -232,11 +232,11 @@ def child_objects(self):
 
 class DFXMLObject(AbstractParentObject):
 
-    def __init__(self, *args, **kwargs) -> None:
+    def __init__(self, *args: typing.Any, version: str = dfxml.DFXML_VERSION, **kwargs: typing.Any) -> None:
         self.command_line = kwargs.get("command_line")
         self.program = kwargs.get("program")
         self.program_version = kwargs.get("program_version")
-        self.version = kwargs.get("version")
+        self.version = version
         self.sources = kwargs.get("sources", [])
         self.dc = kwargs.get("dc", dict())
         self.externals = kwargs.get("externals", OtherNSElementList())

dfxml/writer.py

@@ -16,6 +16,8 @@
 import __main__
 import psutil
 
+from dfxml import DFXML_VERSION
+
 __version__="0.2.0"
 
 ###
@@ -84,7 +86,7 @@ def __init__(self,heartbeat=None,filename=None,prettyprint=False):
         """
         self.t0 = time.time()
         self.tlast = time.time()
-        self.doc = ET.Element('dfxml', {'version':'2.0.0-beta.0'})
+        self.doc = ET.Element('dfxml', {'version': DFXML_VERSION})
         self.add_DFXML_creator(self.doc)
         self.filename = filename
         self.timers = {}

tests/misc_object_tests/ByteRun_test.py

@@ -246,7 +246,7 @@ def test_glomming_fill():
         raise
 
 def test_hash_properties():
-    dobj = Objects.DFXMLObject(version="2.0.0-beta.0")
+    dobj = Objects.DFXMLObject()
 
     fobj = Objects.FileObject()
     dobj.append(fobj)