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

add nerd observable analyzer #2377

Merged
merged 4 commits into from
Oct 29, 2024
Merged

add nerd observable analyzer #2377

merged 4 commits into from
Oct 29, 2024

Conversation

standa4
Copy link
Contributor

@standa4 standa4 commented Jun 12, 2024

(Please add to the PR name the issue/s that this PR would close if merged by using a Github keyword. Example: <feature name>. Closes #999. If your PR is made by a single commit, please add that clause in the commit too. This is all required to automate the closure of related issues.)

Description

New observable analyzer for https://nerd.cesnet.cz/ service.

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality).

Checklist

  • I have read and understood the rules about how to Contribute to this project
  • The pull request is for the branch develop
  • A new plugin (analyzer, connector, visualizer, playbook, pivot or ingestor) was added or changed, in which case:
    • I strictly followed the documentation "How to create a Plugin"
    • Usage file was updated.
    • Advanced-Usage was updated (in case the plugin provides additional optional configuration).
    • I have dumped the configuration from Django Admin using the dumpplugin command and added it in the project as a data migration. ("How to share a plugin with the community")
    • If a File analyzer was added and it supports a mimetype which is not already supported, you added a sample of that type inside the archive test_files.zip and you added the default tests for that mimetype in test_classes.py.
    • If you created a new analyzer and it is free (does not require any API key), please add it in the FREE_TO_USE_ANALYZERS playbook by following this guide.
    • Check if it could make sense to add that analyzer/connector to other freely available playbooks.
    • I have provided the resulting raw JSON of a finished analysis and a screenshot of the results.
    • If the plugin interacts with an external service, I have created an attribute called precisely url that contains this information. This is required for Health Checks.
    • If the plugin requires mocked testing, _monkeypatch() was used in its class to apply the necessary decorators.
    • I have added that raw JSON sample to the MockUpResponse of the _monkeypatch() method. This serves us to provide a valid sample for testing.
  • If external libraries/packages with restrictive licenses were used, they were added in the Legal Notice section.
  • Linters (Black, Flake, Isort) gave 0 errors. If you have correctly installed pre-commit, it does these checks and adjustments on your behalf.
  • I have added tests for the feature/bug I solved (see tests folder). All the tests (new and old ones) gave 0 errors.
  • If changes were made to an existing model/serializer/view, the docs were updated and regenerated (check CONTRIBUTE.md).
  • If the GUI has been modified:
    • I have a provided a screenshot of the result in the PR.
    • I have created new frontend tests for the new component or updated existing ones.
  • After you had submitted the PR, if DeepSource, Django Doctors or other third-party linters have triggered any alerts during the CI checks, I have solved those alerts.

Important Rules

  • If you miss to compile the Checklist properly, your PR won't be reviewed by the maintainers.
  • Everytime you make changes to the PR and you think the work is done, you should explicitly ask for a review. After being reviewed and received a "change request", you should explicitly ask for a review again once you have made the requested changes.

@mlodic
Copy link
Member

mlodic commented Jun 13, 2024

thanks! we'll help you finish this PR!

@vaclavbartos
Copy link

Hello, author of NERD here.
Thanks for this pull request. We just wanted to create a NERD plugin and found out it's already there as a PR. Good job!

Neverthless, we installed and tested it and we think there is still some space for improvement (e.g. in handling of 404 return code, which is not always an error, it is also returned if NERD just doesn't have data about the queried IP (not a good design choice, I know), which should still be considered SUCCESS in IntelOwl). Also, if I understand the documentation correctly, there should be more files than just the source code (e.g. the result of dumpplugin).

@standa4, if you give write access to your fork to me (@vaclavbartos) and my colleague (@Michalsus), so we can push into this PR, we will help to improve and finish it.

@mlodic
Copy link
Member

mlodic commented Aug 30, 2024

@vaclavbartos feel free to open a new pull request at anytime. It's not mandatory to continue from this one.

@standa4
Copy link
Contributor Author

standa4 commented Aug 31, 2024

Hello, I can add @vaclavbartos and his colleague to my fork so they can finish it. I made this code during the Honeynet project workshop (IntelOwl training) and wanted to share the code. Unfortunately I could not find free time to finish this PR.

@vaclavbartos
Copy link

@standa4 Thanks for the access. We'll push the updates soon...

Co-authored-by: Michalius <xmatejm00@vutbr.cz>
Co-authored-by: standa4 <stanislavb@seznam.cz>
@Michalsus
Copy link
Contributor

Hello, here are some screenshots of results and a raw JSON of one of the scans.
Screenshot from 2024-10-07 18-11-11
Screenshot from 2024-10-07 18-10-23
Screenshot from 2024-10-07 18-08-41
job#32_report.json

@mlodic
Copy link
Member

mlodic commented Oct 21, 2024

hey, thanks for the PR! Would you mind following the PR checklist and fixing linters?

@mlodic mlodic merged commit 9b4acde into intelowlproject:develop Oct 29, 2024
11 checks passed
@mlodic
Copy link
Member

mlodic commented Oct 29, 2024

I helped to finish the last steps! finally completed!

@vaclavbartos
Copy link

Thanks!

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.

4 participants