Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/boefje normalizer config models #3118

Merged
merged 47 commits into from
Jul 9, 2024

Conversation

Donnype
Copy link
Contributor

@Donnype Donnype commented Jun 20, 2024

Disclaimer

Forgive me father, for I have sinned: I did refactoring in my feature branch. Although I think refactoring is often a crucial part of a feature, in this case these were a bit unrelated. Nevertheless, note that I moved the test-directory from the katalogus dir to the central boefjes directory for consistency with the other services (and the fact that we don't have that many test files), and the same holds for the dependencies directory which contains dependencies not strictly related to the KATalogus API. Some are used by the boefjes workers as well. Just don't let the amount of files changed distract you: most were just moved.

Changes

This feature adds the config models in this overview (as part of this epic):

classDiagram

class organisation {
  pk
  id
  name
}

class boefje_config {
    id
    settings
    enabled
    boefje_id
    organisation_pk
}

boefje_config --> organisation
boefje_config --> boefje

class normalizer_config {
    id
    enabled
    normalizer_id
    organisation_pk
}

normalizer_config --> organisation
normalizer_config --> normalizer

class boefje {
    id
    plugin_id
    scan_level
    consumes
    produces
    version
    created
    description
    name
    environment_keys
    oci_image
    oci_arguments

    organisations
}

class normalizer {
    id
    plugin_id
    scan_level
    consumes
    produces
    version
    created
    description
    name
    environment_keys

    organisations
}
Loading

These changes should be backward compatible, as has been tested with migration tests. The API is left intact as well.

Issue link

Closes #3014

QA notes

Please verify that the KATalogus works properly, in terms of enabling/disabling and changing/updating/copying settings. Also please check that upgrading to this branch does not disable previously disabled plugins or delete your settings. That shouldn't happen.


Code Checklist

  • All the commits in this PR are properly PGP-signed and verified.
  • This PR only contains functionality relevant to the issue.
  • I have written unit tests for the changes or fixes I made.
  • I have checked the documentation and made changes where necessary.
  • I have performed a self-review of my code and refactored it to the best of my abilities.
  • Tickets have been created for newly discovered issues.
  • For any non-trivial functionality, I have added integration and/or end-to-end tests.
  • I have informed others of any required .env changes files if required and changed the .env-dist accordingly.
  • I have included comments in the code to elaborate on what is not self-evident from the code itself, including references to issues and discussions online, or implicit behavior of an interface.

Checklist for code reviewers:

Copy-paste the checklist from the docs/source/templates folder into your comment.


Checklist for QA:

Copy-paste the checklist from the docs/source/templates folder into your comment.

Donnype and others added 30 commits May 21, 2024 23:23
Fix the integration tests
Remove repository references in Rocky
Test upgrading and downgrading with uniqueness issue
Set empty not-nullable foreign key to repository to seeded "LOCAL" on downgrades
Improve update logic for local plugins, allowing overriding only specified fields
Set type to str again since the values were not compatible
Fix other references to the app module that has been removed
Update the other relevant documentation on seeding the KATalogus database, which is no longer needed

Signed-off-by: Donny Peeters <[email protected]>
Donnype and others added 10 commits June 11, 2024 10:11
…ormalizer-config-models

# Conflicts:
#	boefjes/boefjes/dependencies/plugins.py
#	boefjes/boefjes/katalogus/plugins.py
#	boefjes/boefjes/katalogus/root.py
#	boefjes/boefjes/storage/interfaces.py
#	boefjes/tests/integration/test_api.py
#	boefjes/tests/katalogus/test_plugins_api.py
Allow creation of static local plugins in the database as well, but only for the config models.
Do not allow updates on static plugin models in the database
@Donnype Donnype requested a review from a team as a code owner June 20, 2024 14:55
Copy link
Contributor

@ammar92 ammar92 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me in general, but I didn't dive into it too deeply because of its vastness.

Overal refactoring (and move of the katalogus module tests) seemed necessary and the tests look good.

boefjes/boefjes/sql/plugin_storage.py Outdated Show resolved Hide resolved
boefjes/boefjes/storage/memory.py Outdated Show resolved Hide resolved
@Donnype Donnype self-assigned this Jul 9, 2024
@stephanie0x00
Copy link
Contributor

Checklist for QA:

  • I have checked out this branch, and successfully ran a fresh make reset.
  • I confirmed that there are no unintended functional regressions in this branch:
    • I have managed to pass the onboarding flow
    • Objects and Findings are created properly
    • Tasks are created and completed properly
  • I confirmed that the PR's advertised feature or hotfix works as intended.
  • I checked the logs for errors and/or warnings and made issues where necessary

What works:

Looks good. Enabled all boefjes that do not require API keys and/or additional settings and they all run like a charm. Some normalizers throw errors, but those are different issues. Reports can be generated, all the links on the Katalogus details page are present and work.

What doesn't work:

n/a

Bug or feature?:

n/a

@underdarknl underdarknl merged commit 7cbf406 into main Jul 9, 2024
14 checks passed
@underdarknl underdarknl deleted the feature/boefje-normalizer-config-models branch July 9, 2024 18:26
jpbruinsslot added a commit that referenced this pull request Jul 16, 2024
* main: (31 commits)
  Refactor Task List and filters with error handlers for Scheduler  (#1957)
  Fix filtering on plugin_id for normalizers (#3226)
  Implement `structlog` (#3175)
  Gather BIT metrics [implementation] (#3122)
  Add observation data to observation table in OOI detail page (#3186)
  cve-2024-6387 from RickGeex (#3194)
  Recalculate bit when a config object changes (#3206)
  Use more concise regexes (#3181)
  Updated Django (#3217)
  Updated `zipp` (#3215)
  Feature/boefje normalizer config models (#3118)
  Updated `certifi` (#3209)
  Add pluginToggler.js to Aggregate Report (#3202)
  Update to Django 5.0 (#2939)
  Update Dockerfile, fix Sonarcloud issue (#3180)
  Better default list of world writable domains in CSP checker (#3165)
  Update 1.16 release notes (#3195)
  Remove non standard header findings and add deprecated headers findings (#3127)
  Fix/sonarcloud https redirect dockerfiles (#3185)
  Bump docker/build-push-action from 5 to 6 (#3164)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Migrate the Setting model to a BoefjeConfig model and Introduce a NormalizerConfig model
4 participants