Getting ready for v0!

If you encounter issues updating Surfactant due to dependencies, try upgrading the dependencies in your virtual environment with the --upgrade --force-reinstall pip options.

BREAKING CHANGE

• Including all files (for the given extractPaths) in the SBOM is now the default behavior, even if Surfactant doesn't recognize the file type. The include all files options have therefore been removed, and replaced with an omit unrecognized types option. To revert to the old behavior the --omit_unrecognized_types command line argument for a single run of Surfactant, or set the core.omit_unrecognized_types surfactant config option to true to use the old behavior for all Surfactant runs. In specimen configuration files, entries now support omitUnrecognizedTypes to apply the old behavior to only a particular group of extractPaths.

What's Changed

• Generate API pages for documentation website by @Moses-Mk in #275
• Added plugin list subcommand functionality by @willis89pr in #279
• Added enable and disable to plugins command by @willis89pr in #281
• Add plugin install and uninstall commands by @willis89pr in #283
• Update README.md plugins section by @willis89pr in #286
• Add dependency groups for dev, test, and docs tooling by @nightlark in #292
• plugin update-db by @willis89pr in #288
• Add include/exclude extensions options by @KendallHarterAtWork in #262
• Update configmanager.py to expand user directory in returned paths by @willis89pr in #304
• Native library detection plugin by @wangmot in #267
• Updatejsdb by @willis89pr in #298
• Remove ref name entry from .git_archival.txt by @nightlark in #308
• Add zlib file identification by @KendallHarterAtWork in #313
• Update PE subsystem type and machine type enums by @nightlark in #297
• Recognize Perl Scripts by @Eriken79 in #316
• Add initialization hook to plugin system by @willis89pr in #318
• Add options to merge command for controlling creation of system entry and type of relationships by @nightlark in #201
• Add information to docs showing overview of how Surfactant works by @nightlark in #321
• Refactor and Relocate Native Library Pattern Loading by @willis89pr in #320
• Refactor and Enhance Docker Scout Integration by @willis89pr in #322
• Add check for section header string table in ELF infoextractor by @JosephHAtWork in #317
• fix: crash when checking zlib magic bytes on empty or 1-byte files by @nightlark in #328
• feat: Add configuration option to enable/disable Docker Scout by @willis89pr in #326
• Add TUI for creating/modifying config files. by @KendallHarterAtWork in #287
• feat: Enhance JS database management with hashing and timestamp functionality by @willis89pr in #327
• Adding basic framework for the CLI, no changes to old cli. by @shaynakapadia in #261
• Refactor TOML file handling and improve code clarity by @willis89pr in #339
• Native Database Version Tracking by @willis89pr in #340
• feat: Generate SBOM for a single file by @nightlark in #330
• docs: Add core.include_all_files to list of settings by @nightlark in #346
• fix: Specimen config includeAllFiles option being ignored by @nightlark in #347
• Rename include all files to omit unrecognized types by @nightlark in #348
• fix: SPDX validation failure when no packages are present by @nightlark in #349
• Bump cyclonedx-python-lib from 7.6.2 to 8.5.0 by @dependabot in #284
• Bump cyclonedx-python-lib from 8.5.0 to 8.5.1 by @dependabot in #334
• Bump cyclonedx-python-lib from 8.5.1 to 8.7.0 by @dependabot in #344
• Bump cyclonedx-python-lib from 8.7.0 to 8.8.0 by @dependabot in #351
• Bump lief from 0.15.1 to 0.16.2 by @dependabot in #314
• Bump lief from 0.16.2 to 0.16.3 by @dependabot in #333
• Bump lief from 0.16.3 to 0.16.4 by @dependabot in #355
• Update textual requirement from ==0.88.* to >=0.88,<1.1 by @dependabot in #335
• Update pyelftools requirement from ==0.31.* to >=0.31,<0.33 by @dependabot in #354

New Contributors

• @Moses-Mk made their first contribution in #275
• @willis89pr made their first contribution in #279
• @JosephHAtWork made their first contribution in #317

Full Changelog: v0.0.0rc10...v0.0.0rc11