Skip to content

Commit 6f2db53

Browse files
committed
Improve documentation
1 parent 8fb4720 commit 6f2db53

File tree

7 files changed

+80
-13
lines changed

7 files changed

+80
-13
lines changed

crowdsec-docs/sidebarsUnversioned.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,10 @@ module.exports = {
1818
"cti_api/taxonomy/cti_object",
1919
"cti_api/taxonomy/scores",
2020
"cti_api/taxonomy/scenarios",
21-
"cti_api/taxonomy/classifications",
2221
"cti_api/taxonomy/behaviors",
22+
"cti_api/taxonomy/classifications",
2323
"cti_api/taxonomy/false_positives",
24+
"cti_api/taxonomy/benign",
2425
],
2526
},
2627
{

crowdsec-docs/src/components/tableRender.js

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import BrowserOnly from '@docusaurus/BrowserOnly';
55
import {useColorMode} from '@docusaurus/theme-common';
66

77

8-
const TableRender = ({ columns, url }) => {
8+
const TableRender = ({ columns, url, include=[], exclude=[] }) => {
99
const [jsonContent, setJsonContent] = useState()
1010
const {colorMode} = useColorMode();
1111

@@ -38,7 +38,16 @@ const TableRender = ({ columns, url }) => {
3838
// filter duplicate names
3939
const item = data[key];
4040
const name = item["name"];
41-
41+
for (let i = 0; i < exclude.length; i++) {
42+
if (name.includes(exclude[i])) {
43+
return
44+
}
45+
}
46+
for (let i = 0; i < include.length; i++) {
47+
if (!name.includes(include[i])) {
48+
return
49+
}
50+
}
4251
if (names.includes(name)) {
4352
return
4453
}
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
id: benign
3+
title: Benign Classifications
4+
sidebar_position: 7
5+
---
6+
7+
import TableRender from "@site/src/components/tableRender"
8+
import GithubIconRender from "@site/src/components/githubIconRender"
9+
10+
export const classificationsURL =
11+
"https://hub-cdn.crowdsec.net/master/taxonomy/classifications.json"
12+
export const columns = [
13+
{
14+
header: "Name",
15+
accessorKey: "name",
16+
},
17+
{
18+
header: "Description",
19+
accessorKey: "description",
20+
},
21+
]
22+
export const include = ["scanner:"]
23+
24+
<GithubIconRender url={classificationsURL}></GithubIconRender>
25+
26+
IPs in this category may raise alerts, but they are not inherently dangerous. These IPs often belong to organizations that perform legitimate activities, such as internet-wide scanning or security research.
27+
28+
IPs belonging to those categories will have the `benign` [reputation](/u/cti_api/taxonomy/cti_object#reputation).
29+
30+
:::note
31+
32+
Blocking these IPs may not be necessary unless their behavior directly impacts your operations.
33+
34+
:::
35+
36+
<TableRender
37+
columns={columns}
38+
url={classificationsURL}
39+
include={include}
40+
></TableRender>

crowdsec-docs/unversioned/cti_api/taxonomy/classifications.mdx

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@ title: Classifications
44
sidebar_position: 5
55
---
66

7-
import TableRender from '@site/src/components/tableRender';
8-
import GithubIconRender from '@site/src/components/githubIconRender';
7+
import TableRender from "@site/src/components/tableRender"
8+
import GithubIconRender from "@site/src/components/githubIconRender"
99

10-
export const classificationsURL = "https://hub-cdn.crowdsec.net/master/taxonomy/classifications.json";
10+
export const classificationsURL =
11+
"https://hub-cdn.crowdsec.net/master/taxonomy/classifications.json"
1112
export const columns = [
1213
{
1314
header: "Name",
@@ -17,9 +18,15 @@ export const columns = [
1718
header: "Description",
1819
accessorKey: "description",
1920
},
20-
];
21+
]
22+
export const exclude = ["scanner:"]
2123

2224
<GithubIconRender url={classificationsURL}></GithubIconRender>
2325

26+
This classification page provides a taxonomy of IP addresses that exhibit potentially suspicious behaviors. These classifications are designed to help you identify and respond to various threat actors and malicious activities.
2427

25-
<TableRender columns={columns} url={classificationsURL}></TableRender>
28+
<TableRender
29+
columns={columns}
30+
url={classificationsURL}
31+
exclude={exclude}
32+
></TableRender>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: cti_object
3-
title: CTI Format
3+
title: Format
44
sidebar_position: 2
55
---
66

crowdsec-docs/unversioned/cti_api/taxonomy/false_positives.mdx

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: false_positives
3-
title: False Positives
3+
title: Safe Classifications
44
sidebar_position: 7
55
---
66

@@ -22,11 +22,21 @@ export const columns = [
2222

2323
<GithubIconRender url={fpURL}></GithubIconRender>
2424

25+
IPs in this category are considered completely safe and trusted. Alerts triggered by these IPs are likely due to misconfiguration or overly sensitive alerting rules.
26+
27+
IPs belonging to those categories will have the `safe` [reputation](/u/cti_api/taxonomy/cti_object#reputation).
28+
29+
:::warning
30+
31+
You might want to investigate any alerts associated with these IPs to ensure your configuration is correct.
32+
33+
:::
34+
2535
<TableRender columns={columns} url={fpURL}></TableRender>
2636

27-
## How to Get Tagged as a False Positive
37+
## How to Get Tagged as Safe
2838

29-
To be able to be classified as a false positive, you need a proper technical justification of why your IP might be misclassified as a threat. This part is to be reviewed and validated by crowdsec.
39+
To be able to be classified as a safe IP, you need a proper technical justification of why your IP might be misclassified as a threat. This part is to be reviewed and validated by crowdsec.
3040

3141
You also need public documentation stating the IP, ranges, and/or reverse DNS associated with the assets in question. This data must be machine-readable (no HTML, no PDF, etc.).
3242

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: scores
3-
title: CTI Scores
3+
title: Scores
44
sidebar_position: 3
55
---
66

0 commit comments

Comments
 (0)