Merge branch 'develop' into stable

.github/ISSUE_TEMPLATE/bug_report.md

@@ -23,8 +23,10 @@ Steps to reproduce the behavior:
 **Expected behavior**
 A clear and concise description of what you expected to happen.
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+**Example output**
+Please copy and paste the text demonstrating the issue, ideally with verbose output turned on (`vol.py -vvv ...`).  
+
+Text is preferred to screenshots for searching and to talk about specific parts of the output.
 
 **Additional information**
 Add any other information about the problem here.

.github/workflows/black.yml

@@ -0,0 +1,13 @@
+name: Black python linter
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      - uses: psf/black@stable
+        with:
+          options: "--check --diff --verbose"
+          src: "./volatility3"

.github/workflows/build-pypi.yml

@@ -18,7 +18,7 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        python-version: ["3.6"]
+        python-version: ["3.7"]
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}

.github/workflows/codeql.yml

@@ -0,0 +1,74 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "develop" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "develop" ]
+  schedule:
+    - cron: '16 8 * * 0'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-20.04
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        queries: security-and-quality # ,security-extended
+
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        category: "/language:${{matrix.language}}"

.github/workflows/test.yaml

@@ -6,7 +6,7 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        python-version: ["3.6"]
+        python-version: ["3.7"]
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}

README.md

@@ -20,7 +20,7 @@ more details.
 
 ## Requirements
 
-Volatility 3 requires Python 3.6.0 or later. To install the most minimal set of dependencies (some plugins will not work) use a command such as:
+Volatility 3 requires Python 3.7.0 or later. To install the most minimal set of dependencies (some plugins will not work) use a command such as:
 
 ```shell
 pip3 install -r requirements-minimal.txt

development/mac-kdk/parse_pbzx2.py

@@ -17,61 +17,54 @@ def seekread(f, offset = None, length = 0, relative = True):
         f.seek(offset, [0, 1, 2][relative])
     if length:
         return f.read(length)
+    return None
 
 
 def parse_pbzx(pbzx_path):
     section = 0
     xar_out_path = '%s.part%02d.cpio.xz' % (pbzx_path, section)
-    f = open(pbzx_path, 'rb')
-    # pbzx = f.read()
-    # f.close()
-    magic = seekread(f, length = 4)
-    if magic != 'pbzx':
-        raise RuntimeError("Error: Not a pbzx file")
-    # Read 8 bytes for initial flags
-    flags = seekread(f, length = 8)
-    # Interpret the flags as a 64-bit big-endian unsigned int
-    flags = struct.unpack('>Q', flags)[0]
-    xar_f = open(xar_out_path, 'wb')
-    while flags & (1 << 24):
-        # Read in more flags
+    with open(pbzx_path, 'rb') as f:
+        # pbzx = f.read()
+        # f.close()
+        magic = seekread(f, length = 4)
+        if magic != 'pbzx':
+            raise RuntimeError("Error: Not a pbzx file")
+        # Read 8 bytes for initial flags
         flags = seekread(f, length = 8)
+        # Interpret the flags as a 64-bit big-endian unsigned int
         flags = struct.unpack('>Q', flags)[0]
-        # Read in length
-        f_length = seekread(f, length = 8)
-        f_length = struct.unpack('>Q', f_length)[0]
-        xzmagic = seekread(f, length = 6)
-        if xzmagic != '\xfd7zXZ\x00':
-            # This isn't xz content, this is actually _raw decompressed cpio_ chunk of 16MB in size...
-            # Let's back up ...
-            seekread(f, offset = -6, length = 0)
-            # ... and split it out ...
-            f_content = seekread(f, length = f_length)
-            section += 1
-            decomp_out = '%s.part%02d.cpio' % (pbzx_path, section)
-            g = open(decomp_out, 'wb')
-            g.write(f_content)
-            g.close()
-            # Now to start the next section, which should hopefully be .xz (we'll just assume it is ...)
-            xar_f.close()
-            section += 1
-            new_out = '%s.part%02d.cpio.xz' % (pbzx_path, section)
-            xar_f = open(new_out, 'wb')
-        else:
-            f_length -= 6
-            # This part needs buffering
-            f_content = seekread(f, length = f_length)
-            tail = seekread(f, offset = -2, length = 2)
-            xar_f.write(xzmagic)
-            xar_f.write(f_content)
-            if tail != 'YZ':
-                xar_f.close()
-                raise RuntimeError("Error: Footer is not xar file footer")
-    try:
-        f.close()
-        xar_f.close()
-    except IOError:
-        pass
+        while flags & (1 << 24):
+            with open(xar_out_path, 'wb') as xar_f:
+                xar_f.seek(0, os.SEEK_END)
+                # Read in more flags
+                flags = seekread(f, length = 8)
+                flags = struct.unpack('>Q', flags)[0]
+                # Read in length
+                f_length = seekread(f, length = 8)
+                f_length = struct.unpack('>Q', f_length)[0]
+                xzmagic = seekread(f, length = 6)
+                if xzmagic != '\xfd7zXZ\x00':
+                    # This isn't xz content, this is actually _raw decompressed cpio_ chunk of 16MB in size...
+                    # Let's back up ...
+                    seekread(f, offset = -6, length = 0)
+                    # ... and split it out ...
+                    f_content = seekread(f, length = f_length)
+                    section += 1
+                    decomp_out = '%s.part%02d.cpio' % (pbzx_path, section)
+                    with open(decomp_out, 'wb') as g:
+                        g.write(f_content)
+                    # Now to start the next section, which should hopefully be .xz (we'll just assume it is ...)
+                    section += 1
+                    xar_out_path = '%s.part%02d.cpio.xz' % (pbzx_path, section)
+                else:
+                    f_length -= 6
+                    # This part needs buffering
+                    f_content = seekread(f, length = f_length)
+                    tail = seekread(f, offset = -2, length = 2)
+                    xar_f.write(xzmagic)
+                    xar_f.write(f_content)
+                    if tail != 'YZ':
+                        raise RuntimeError("Error: Footer is not xar file footer")
 
 
 def main():

doc/source/conf.py

@@ -121,6 +121,7 @@ def setup(app):
 
     extensions.append('sphinx_autodoc_typehints')
 except ImportError:
+    # If the autodoc typehints extension isn't available, carry on regardless
     pass
 
 # Add any paths that contain templates here, relative to this directory.

requirements-dev.txt

@@ -16,7 +16,7 @@ pycryptodome
 
 # This can improve error messages regarding improperly configured ISF files,
 # but is only recommended for development
-# jsonschema>=2.3.0
+jsonschema>=2.3.0
 
 # This is required for memory acquisition via leechcore/pcileech.
 leechcorepyc>=2.4.0

setup.py

@@ -6,45 +6,47 @@
 
 from volatility3.framework import constants
 
-with open("README.md", "r", encoding = "utf-8") as fh:
+with open("README.md", "r", encoding="utf-8") as fh:
     long_description = fh.read()
 
+
 def get_install_requires():
     requirements = []
-    with open("requirements-minimal.txt", "r", encoding="utf-8") as fh:
+    with open("requirements-minimal.txt", "r", encoding = "utf-8") as fh:
         for line in fh.readlines():
             stripped_line = line.strip()
             if stripped_line == "" or stripped_line.startswith("#"):
                 continue
             requirements.append(stripped_line)
     return requirements
 
-setuptools.setup(name = "volatility3",
-                 description = "Memory forensics framework",
-                 version = constants.PACKAGE_VERSION,
-                 license = "VSL",
-                 keywords = "volatility memory forensics framework windows linux volshell",
-                 author = "Volatility Foundation",
-                 long_description = long_description,
-                 long_description_content_type = "text/markdown",
-                 author_email = "[email protected]",
-                 url = "https://github.com/volatilityfoundation/volatility3/",
-                 project_urls = {
-                     "Bug Tracker": "https://github.com/volatilityfoundation/volatility3/issues",
-                     "Documentation": "https://volatility3.readthedocs.io/",
-                     "Source Code": "https://github.com/volatilityfoundation/volatility3",
-                 },
-                 python_requires = '>=3.6.0',
-                 include_package_data = True,
-                 exclude_package_data = {
-                     '': ['development', 'development.*'],
-                     'development': ['*']
-                 },
-                 packages = setuptools.find_namespace_packages(exclude = ["development", "development.*"]),
-                 entry_points = {
-                     'console_scripts': [
-                         'vol = volatility3.cli:main',
-                         'volshell = volatility3.cli.volshell:main',
-                     ],
-                 },
-                 install_requires = get_install_requires())
+setuptools.setup(
+    name="volatility3",
+    description="Memory forensics framework",
+    version=constants.PACKAGE_VERSION,
+    license="VSL",
+    keywords="volatility memory forensics framework windows linux volshell",
+    author="Volatility Foundation",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    author_email="[email protected]",
+    url="https://github.com/volatilityfoundation/volatility3/",
+    project_urls={
+        "Bug Tracker": "https://github.com/volatilityfoundation/volatility3/issues",
+        "Documentation": "https://volatility3.readthedocs.io/",
+        "Source Code": "https://github.com/volatilityfoundation/volatility3",
+    },
+    python_requires=">=3.7.0",
+    include_package_data=True,
+    exclude_package_data={"": ["development", "development.*"], "development": ["*"]},
+    packages=setuptools.find_namespace_packages(
+        exclude=["development", "development.*"]
+    ),
+    entry_points={
+        "console_scripts": [
+            "vol = volatility3.cli:main",
+            "volshell = volatility3.cli.volshell:main",
+        ],
+    },
+    install_requires=get_install_requires(),
+)