Port all plugins to `AnalysisPluginV0`

[ ] architecture_detection
[ ] binwalk
[ ] checksec
[ ] crypto_hints #1059
[ ] crypto_material
[ ] cve_lookup
[ ] cwe_checker
[ ] device_tree #1028
[ ] dummy
[ ] elf_analysis
[ ] example_plugin
[ ] file_system_metadata
[ ] file_type #1070
[ ] hardware_analysis
[ ] hash
[ ] hashlookup
[ ] information_leaks
[ ] init_systems
[ ] input_vectors
[ ] interesting_uris
[ ] ip_and_uri_finder
[ ] ipc
[ ] kernel_config
[ ] known_vulnerabilities
[ ] linter #1070
[ ] qemu_exec
[ ] software_components
[ ] string_evaluation
[ ] strings
[ ] tlsh
[ ] users_and_passwords

=====================

See https://github.com/fkie-cad/FACT_core/pull/987#pullrequestreview-1365009170

The minor part of the plugin version should be updated if the major version is 0. If the major version is >=1 and the result schema is different than the old one semver requires us to bump the major version.

If the result schema is different we have to migrate the results in the database.

Here is my WIP script which was intended for the device_tree plugin before #1027 existed. The alembic script did exactly what #1027 does but in the database.

diff --git a/src/storage/migration/__init__.py b/src/storage/migration/__init__.py
index d8d6b248..ceb39f04 100644
--- a/src/storage/migration/__init__.py
+++ b/src/storage/migration/__init__.py
@@ -9,6 +9,7 @@ from storage.db_connection import AdminConnection

 def db_needs_migration():
+    return False
     with OperateInDirectory(get_src_dir()):  # alembic must be executed from src for paths to line up
         with AdminConnection().engine.connect() as db:
             alembic_cfg_path = Path(__file__).parent.parent.parent / 'alembic.ini'
diff --git a/src/storage/migration/versions/a1c21b3422a7_plugin_device_tree_add_schema.py b/src/storage/migration/versions/a1c21b3422a7_plugin_device_tree_add_schema.py
new file mode 100644
index 00000000..c02f1348
--- /dev/null
+++ b/src/storage/migration/versions/a1c21b3422a7_plugin_device_tree_add_schema.py
@@ -0,0 +1,97 @@
+"""plugin_device_tree_add_schema
+
+Revision ID: a1c21b3422a7
+Revises: 221cfef47173
+Create Date: 2023-04-24 11:18:50.037043
+
+"""
+from alembic import op
+import sqlalchemy as sa
+from alembic import context
+
+from sqlalchemy.dialects.postgresql import ARRAY, CHAR, JSONB, VARCHAR
+from sqlalchemy.ext.mutable import MutableDict, MutableList
+
+
+# revision identifiers, used by Alembic.
+revision = 'a1c21b3422a7'
+down_revision = '221cfef47173'
+branch_labels = None
+depends_on = None
+
+# The version we downgrade to
+PLUGIN_OLD_VERSION = "1.0"
+# The version we upgrade to
+PLUGIN_NEW_VERSION = "2.0.0"
+# All versions (with possibly all different schemas) we can upgrade from
+PLUGIN_UPGRADALBE_VERSIONS = [PLUGIN_OLD_VERSION]
+PLUGIN = "device_tree"
+
+
+# References https://stackoverflow.com/questions/43153346/update-column-content-during-alembic-migration
+def upgrade() -> None:
+    connection = context.get_bind()
+
+    # Define the table
+    # XXX Should this maybe be dynamically generated by reflection?
+    analysis_table = sa.Table(
+        "analysis",
+        sa.MetaData(),
+        sa.Column("uid", VARCHAR(78)),
+        sa.Column("plugin", VARCHAR(64)),
+        sa.Column("plugin_version", VARCHAR(16)),
+        sa.Column("result", MutableDict.as_mutable(JSONB), default={}),
+    )
+
+    a = connection.execute(
+        sa.select([analysis_table.c.uid, analysis_table.c.result,],).where(
+            analysis_table.c.plugin == PLUGIN,
+            analysis_table.c.plugin_version.in_(PLUGIN_UPGRADALBE_VERSIONS),
+        ),
+    ).fetchall()
+
+    for uid, old_result in a:
+        new_result = {"result": old_result}
+        connection.execute(
+            analysis_table.update().where(
+                analysis_table.c.uid == uid,
+                analysis_table.c.plugin == PLUGIN,
+            ).values(
+                result=new_result,
+                plugin_version=PLUGIN_NEW_VERSION,
+            )
+        )
+
+
+def downgrade() -> None:
+    connection = context.get_bind()
+
+    # Define the table
+    # XXX Should this maybe be dynamically generated by reflection?
+    analysis_table = sa.Table(
+        "analysis",
+        sa.MetaData(),
+        sa.Column("uid", VARCHAR(78)),
+        sa.Column("plugin", VARCHAR(64)),
+        sa.Column("plugin_version", VARCHAR(16)),
+        sa.Column("result", MutableDict.as_mutable(JSONB), default={}),
+    )
+
+    a = connection.execute(
+        sa.select([analysis_table.c.uid, analysis_table.c.plugin, analysis_table.c.result,],).where(
+            analysis_table.c.plugin == "device_tree",
+            analysis_table.c.plugin_version == PLUGIN_NEW_VERSION,
+        ),
+    ).fetchall()
+
+    for uid, plugin, new_result in a:
+        old_result = new_result.pop("result")
+        connection.execute(
+            analysis_table.update().where(
+                analysis_table.c.uid == uid,
+                analysis_table.c.plugin == plugin,
+            ).values(
+                result=old_result,
+                plugin_version=PLUGIN_OLD_VERSION,
+            )
+        )

fkie-cad / FACT_core

Port all plugins to `AnalysisPluginV0` #1047