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.

Sign up for GitHub

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 a note about testing analyzers outside of the Sensoroni Docker container #11384

Merged
merged 2 commits into from
Sep 25, 2023
Merged

Add a note about testing analyzers outside of the Sensoroni Docker container #11384

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c95af6b
Add a note about testing analyzers outside of the Sensoroni Docker co…
weslambert Sep 25, 2023
7cb9b5f
Add the blank line that was removed from the previous commit
weslambert Sep 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions salt/sensoroni/files/analyzers/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,12 @@ The analyzer itself will only run when a user in SOC enqueues an analyzer job, s
python -m urlhaus '{"artifactType":"url","value":"https://bigbadbotnet.invalid",...}'
```

To manually test an analyzer outside of the Sensoroni Docker container, use a command similar to the following:

```bash
PYTHONPATH=. python urlhaus/urlhaus.py '{"artifactType":"url","value":"https://bigbadbotnet.invalid",...}'
```

It is up to each analyzer to determine whether the provided input is compatible with that analyzer. This is assisted by the analyzer metadata, as described earlier in this document, with the use of the `supportedTypes` list.

Once the analyzer completes its functionality, it must terminate promptly. See the following sections for more details on expected internal behavior of the analyzer.
Expand Down
Loading