Skip to content

Commit f20bbaa

Browse files
authored
Merge pull request #657 from crowdsecurity/ese-improve-cti-docs
Improve cti docs
2 parents e76fec4 + 78f43aa commit f20bbaa

File tree

2 files changed

+19
-21
lines changed

2 files changed

+19
-21
lines changed

crowdsec-docs/unversioned/cti_api/taxonomy/cti_fields.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -400,8 +400,7 @@ Longitude of the IP, when available.
400400
"days_age" : 40,
401401
}
402402
```
403-
404-
The geo location information about the IP address.
403+
Historical information we have collected about the IP.
405404

406405
### `first_seen`
407406

@@ -411,7 +410,7 @@ The geo location information about the IP address.
411410
"first_seen" : "2022-01-01T00:00:00+00:00"
412411
```
413412

414-
Date of the first time this IP was reported. Please note that due to "progressive data degradation" this date might be later than the first time the IP was actually seen.
413+
Date of the first time this IP was reported. Please note that due to our progressive data degradation mechanism this date might be later than the first time the IP was actually seen.
415414

416415
### `last_seen`
417416

@@ -450,7 +449,7 @@ Delta in days between first and last seen timestamps.
450449
```json
451450
"behaviors" : [
452451
{
453-
"name" : "protocol:protocol:behavior",
452+
"name" : "protocol:behavior",
454453
"label" : "Protocol Behavior",
455454
"description" : "Protocol Behavior description"
456455
}
@@ -527,7 +526,7 @@ The possible false positives and classifications attributed to this IP address.
527526
]
528527
```
529528

530-
A list of false positives tags associated with the IP. Any IP with `false_positives` tags shouldn't be considered as malicious.
529+
A list of false positive tags associated with the IP. Any IP with `false_positives` tags shouldn't be considered as malicious.
531530

532531
#### `name`
533532

@@ -566,14 +565,14 @@ Human-friendly description of the false positive.
566565
```json
567566
"classifications" : [
568567
{
569-
"name" : "classifications",
568+
"name" : "classification",
570569
"label" : "Classification",
571570
"description" : "Classification description"
572571
}
573572
]
574573
```
575574

576-
A list of `classifications` tags associated with the IP.
575+
A list of `classification` tags associated with the IP.
577576

578577
#### `name`
579578

@@ -666,7 +665,7 @@ Human-friendly description of the scenario.
666665
]
667666
```
668667

669-
A list of Mitre techniques associated with the IP.
668+
A list of Mitre techniques associated with the IP. More detail on the Mitre Att&ck can be found [here](https://attack.mitre.org/techniques/enterprise/).
670669

671670
### `name`
672671

@@ -725,7 +724,7 @@ A list of CVEs for which the IP has been reported for.
725724
},
726725
```
727726

728-
The top 10 reports repartition by country about the IP, as a percentage
727+
The top 10 countries targeted by the IP. The numbers represent the percentage of the total number of attacks.
729728

730729
## `scores`
731730

@@ -764,9 +763,9 @@ The top 10 reports repartition by country about the IP, as a percentage
764763
}
765764
```
766765

767-
Indicators of Malevolence computed on different time periods.
766+
Indicators of Malevolence computed over different time periods.
768767

769-
:warning: All scores are from a scall of 0 to 5.
768+
:warning: All scores are on a scale from 0 to 5.
770769

771770
### `overall`
772771

@@ -1101,4 +1100,4 @@ Only present for the `fire` route.
11011100

11021101
Only present for the `fire` route.
11031102

1104-
Date at which the IP address expire from the community blocklist.
1103+
Date at which the IP address expires from the community blocklist.

crowdsec-docs/unversioned/cti_api/taxonomy/scores.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,18 @@ sidebar_position: 3
66

77

88

9-
The scores are indicators of malevolence associated with an IP address, computed over several periods of time : 1 day, 1 week, 1 month and overall.
9+
While CrowdSec already provides ready-made scores for common usecases such as background noise score, the scores in this section offer a more in-depth breakdown of the information we have collected about an IP. They can be used both to help categorize alerts and to build internal products for your organizations needs. These scores are indicators of malevolence associated with an IP address, computed over several periods of time : 1 day, 1 week, 1 month and overall.
1010

11-
For a given period, the indicator of malevolence is summarized under the `total` key with a value ranging from **0** (no reports) to **5** (high malevolence).
12-
13-
This value is a summary based on 4 components (see below) also ranging from **0** (Not Applicable/ Missing) to **5** (High), comparing to all the the signals reported by the community.
11+
For a given period, each indicator is provided with a value ranging from **0** (lowest value) to **5** (highest value). The following table describes the indicators in more detail.
1412

1513
| indicator | explaination |
1614
|-----------|--------------|
17-
|Aggressiveness | _What is the intensity of the attack?_ This component measures the number of attacks reported over a period of time. |
18-
|Threat Level | _How serious is the type of threats reported?_ The category of attacks reported by the community defines the danger induced by the attacks. An IP known for crawling and scanning will have a lower threat level than an IP reported for brute-force and exploits. This score ranges from 1 (mainly crawling) to 5 (exploit). 0 is the default for unknown scenarios |
19-
|Trust| _What is the level of confidence in the actors which reported the IP address?_ This component is based on the reputation (age, number of reports) and the diversity (number of IP ranges, AS Numbers) of all the actors reporting the IP. It ranges from **0** (low\_confidence) to **5** (high confidence). |
20-
| Anomaly | _What are the red flags associated with this IP address?_ It analyses the static description of the reported IP address and checks for red flags which can be linked to evidence of malicious activities |
21-
| Total | Aggregation of 4 component calculated on threats reported by the community and described below. |
15+
|Aggressiveness | _What is the intensity of the attack?_ <br /> This component measures the number of attacks reported over a period of time. |
16+
|Threat | _How dangerous are the attacks?_ <br /> This component measures how dangerous an IP is based on the type of attacks we usually see it attempt. An IP known for crawling and scanning will have a lower threat level than an IP reported for brute-force and exploits. This score ranges from 1 (mainly crawling) to 5 (exploit). 0 is the default for unknown scenarios |
17+
|Trust| _What is the level of confidence in the actors which reported the IP address?_ <br /> This component measures the degree of trust we have in the reports that we received about this IP. It is based on the reputation (age, number of reports) and the diversity (number of IP ranges, AS Numbers) of all security engines reporting the IP. |
18+
| Anomaly | _Are there any red flags associated with the device behind this IP address?_ <br /> This score is based on static properties of the machine behind the IP. For instance a machine exposing old and vulnerable software will have a high anomaly score. |
19+
| Total | Aggregation of the 4 components above. |
2220

21+
For a more in-depth explanation on how we compute these scores, refer to our [blog article](https://www.crowdsec.net/blog/crowdsec-cti-scoring-system).
2322

2423
The `ip_range_score` is the score of malevolence associated with an IP range, ranging from *0* (No IP reported) to *5* (massively reported). It is calculated based on the number of IPs belonging to this range that were reported by the community as malicious

0 commit comments

Comments
 (0)