Merge pull request #967 from s-ff/migrate-to-pyproject-toml

Migrate to pyproject toml

Author: mr-tz

floss/main.py

@@ -200,9 +200,11 @@ def make_parser(argv):
         type=str,
         choices=[l.value for l in Language if l != Language.UNKNOWN],
         default=Language.UNKNOWN.value,
-        help="use language-specific string extraction, auto-detect language by default, disable using 'none'"
-        if show_all_options
-        else argparse.SUPPRESS,
+        help=(
+            "use language-specific string extraction, auto-detect language by default, disable using 'none'"
+            if show_all_options
+            else argparse.SUPPRESS
+        ),
     )
     advanced_group.add_argument(
         "-l",
@@ -215,9 +217,11 @@ def make_parser(argv):
         type=lambda x: int(x, 0x10),
         default=None,
         nargs="+",
-        help="only analyze the specified functions, hex-encoded like 0x401000, space-separate multiple functions"
-        if show_all_options
-        else argparse.SUPPRESS,
+        help=(
+            "only analyze the specified functions, hex-encoded like 0x401000, space-separate multiple functions"
+            if show_all_options
+            else argparse.SUPPRESS
+        ),
     )
     advanced_group.add_argument(
         "--disable-progress",
@@ -228,17 +232,21 @@ def make_parser(argv):
         "--signatures",
         type=str,
         default=SIGNATURES_PATH_DEFAULT_STRING,
-        help="path to .sig/.pat file or directory used to identify library functions, use embedded signatures by default"
-        if show_all_options
-        else argparse.SUPPRESS,
+        help=(
+            "path to .sig/.pat file or directory used to identify library functions, use embedded signatures by default"
+            if show_all_options
+            else argparse.SUPPRESS
+        ),
     )
     advanced_group.add_argument(
         "-L",
         "--large-file",
         action="store_true",
-        help="allow processing files larger than {} MB".format(int(MAX_FILE_SIZE / MEGABYTE))
-        if show_all_options
-        else argparse.SUPPRESS,
+        help=(
+            "allow processing files larger than {} MB".format(int(MAX_FILE_SIZE / MEGABYTE))
+            if show_all_options
+            else argparse.SUPPRESS
+        ),
     )
     advanced_group.add_argument(
         "--version",

floss/render/default.py

@@ -91,15 +91,19 @@ def render_string_type_rows(results: ResultDocument) -> List[Tuple[str, str]]:
     return [
         (
             " static strings",
-            f"{len_ss:>{len(str(len_ss))}} ({len_chars_ss:>{len(str(len_chars_ss))}d} characters)"
-            if results.analysis.enable_static_strings
-            else DISABLED,
+            (
+                f"{len_ss:>{len(str(len_ss))}} ({len_chars_ss:>{len(str(len_chars_ss))}d} characters)"
+                if results.analysis.enable_static_strings
+                else DISABLED
+            ),
         ),
         (
             "  language strings",
-            f"{len_ls:>{len(str(len_ss))}} ({len_chars_ls:>{len(str(len_chars_ss))}d} characters)"
-            if results.metadata.language
-            else DISABLED,
+            (
+                f"{len_ls:>{len(str(len_ss))}} ({len_chars_ls:>{len(str(len_chars_ss))}d} characters)"
+                if results.metadata.language
+                else DISABLED
+            ),
         ),
         (
             " stack strings",

pyproject.toml

@@ -0,0 +1,84 @@
+# Copyright (C) 2024 Mandiant, Inc. All Rights Reserved.
+# Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at: [package root]/LICENSE.txt
+# Unless required by applicable law or agreed to in writing, software distributed under the License
+#  is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
+
+[build-system]
+requires = ["setuptools", "setuptools-scm"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "flare-floss"
+description = "FLARE Obfuscated String Solver"
+license = {file = "LICENSE.txt"}
+authors = [
+    {name = "Willi Ballenthin", email = "william.ballenthin@mandiant.com"},
+    {name = "Moritz Raabe", email = "moritz.raabe@mandiant.com"},
+]
+requires-python=">=3.8"
+keywords = ["floss", "malware", "analysis", "obfuscation", "strings", "FLARE"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Information Technology",
+    "License :: OSI Approved :: Apache Software License",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3",
+    "Topic :: Security",
+]
+
+dependencies = [
+    "tabulate==0.9.0",
+    "vivisect==1.1.1",
+    "viv-utils[flirt]==0.7.9",
+    "pydantic==1.10.9",
+    "tqdm==4.65.0",
+    "networkx==3.1",
+    "halo==0.0.31",
+    "rich==13.4.2",
+    "pefile>=2022.5.30",
+    "binary2strings==0.1.13",
+]
+dynamic = ["version", "readme"]
+
+[tool.setuptools.dynamic]
+version = {attr = "floss.version.__version__"}
+readme = {file = "README.md"}
+
+[tool.setuptools]
+packages = ["floss", "floss.sigs"]
+
+[project.optional-dependencies]
+dev = [
+    "pre-commit==3.5.0",
+    "pyyaml==6.0.1",
+    "pytest==8.0.2",
+    "pytest-sugar==0.9.4",
+    "pytest-instafail==0.5.0",
+    "pytest-cov==4.1.0",
+    "pycodestyle==2.11.1",
+    "black==23.12.1",
+    "isort==5.13.2",
+    "mypy==1.8.0",
+    # type stubs for mypy
+    "types-PyYAML==6.0.10",
+    "types-tabulate==0.9.0.20240106",
+]
+build = [
+    "pyinstaller==6.3.0",
+    "setuptools==69.1.1",
+    "build==1.0.3"
+]
+
+
+[project.urls]
+Homepage = "https://www.github.com/mandiant/flare-floss"
+Repository = "https://www.github.com/mandiant/flare-floss.git"
+Documentation = "https://github.com/mandiant/flare-floss/tree/master/doc"
+Signatures = "https://github.com/mandiant/flare-floss/tree/master/floss/sigs"
+
+[project.scripts]
+floss = "floss.main:main"