Skip to content

Commit ef0c21b

Browse files
analyzables and user events docs (#37)
* analyzables + user events * fix
1 parent 81c4bb4 commit ef0c21b

File tree

8 files changed

+56
-0
lines changed

8 files changed

+56
-0
lines changed
1.74 KB
Loading

docs/IntelOwl/static/artifacts.png

224 KB
Loading
226 KB
Loading
21.1 KB
Loading
255 KB
Loading
74.4 KB
Loading
180 KB
Loading

docs/IntelOwl/usage.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -712,3 +712,59 @@ If you want to remove a Job, you can click on the Job block and click "Remove br
712712
### Example output of a complex investigation
713713

714714
![investigation_screen.png](./static/investigation_screen.png)
715+
716+
## Analyzables (Artifacts)
717+
718+
With IntelOwl v6.4.0 we introduced the Analyzables.
719+
720+
An analyzable is the representation of an observable or a file, and is therefore a unique object that can be analyzed multiple times for different evaluations. This means that each job is linked to only one analyzable, but an analyzable can have multiple jobs linked to it.
721+
722+
Note: In the GUI, analyzables are called "artifacts".
723+
724+
### Verify the existence of one or more analyzables
725+
726+
You can go to the 'Artifacts' section and search for the existence of an analyzable. The table below shows the results, including the latest evaluation, if any (for more information about evaluation see the [Engine](#engine) section). If the analyzable does not exist, the 'not found' tag will be displayed.
727+
728+
![img.png](./static/artifacts.png)
729+
730+
## User Events
731+
732+
With IntelOwl v6.4.0 we introduced the user events.
733+
734+
User events allow users to generate reports about analyzables: indicating additional information or a custom evaluation.
735+
736+
User events types:
737+
738+
1. `Analyzable event`: the report entered refers to a single analyzable.
739+
2. `Ip wildcard event`: the report entered refers to a network. The report will impact both existing analyzables and new analyzables with IPs included in the network.
740+
3. `Domain wildcard event`: the report entered refers to a domain wildcard. The report will impact both existing analyzables and new analyzables for a domain that matches the wildcard.
741+
742+
### Add a new evaluation
743+
744+
If you want to add a new evaluation (both for existing and non-existing analyzables), you can click the "New evaluation" button that you can find on the top right of the History Page (evaluations tabs). The form will open with the fields to fill in to add the evaluation.
745+
746+
When you enter an analyzable or wildcard, the correct type is automatically calculated. If a wildcard is entered, the number of existing analyzables that match is displayed.
747+
748+
![img.png](./static/user_event_modal.png)
749+
750+
### Add a new evaluation for multiple analyzables
751+
752+
If you want to add a new evaluation for multiple analyzables, you can use the same form above by adding more "artifacts" fields using the button '+'.
753+
754+
![img.png](./static/multiple_analyzables_evaluation.png)
755+
756+
You can automatically populate the "artifacts" field of the form by selecting all the required columns in the results table of the Artifacts page and then clicking the "Your evaluation" button.
757+
758+
![img.png](./static/artifacts_your_evaluation.png)
759+
760+
## Engine
761+
762+
With IntelOwl v6.4.0 we introduced the engine.
763+
764+
Engine combines analyzer’s Data Models and User Reports to provide an evaluation of the analysis.
765+
766+
The result of this combination is also a [Data Model](#datamodels) and it can be found in the "Data Model" tab in the raw report of each job:
767+
![img.png](./static/job_data_model.png)
768+
769+
A preview of the evaluation, reliability and tags can also be seen in the investigation overview:
770+
![img.png](./static/investigation_engine.png)

0 commit comments

Comments
 (0)