Skip to content

Commit d60dc62

Browse files
committed
CTI/FAQ: Add documentation on how being tagged as False Positive
1 parent 30b5144 commit d60dc62

4 files changed

Lines changed: 90 additions & 18 deletions

File tree

crowdsec-docs/sidebarsUnversioned.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -351,6 +351,11 @@ module.exports = {
351351
id: "troubleshooting/remediation_components",
352352
label: "Remediation Components",
353353
},
354+
{
355+
type: "doc",
356+
id: "troubleshooting/cti",
357+
label: "CTI",
358+
},
354359
],
355360
serviceApiSideBar: [
356361
{

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

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@ title: False Positives
44
sidebar_position: 7
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 fpURL = "https://hub-cdn.crowdsec.net/master/taxonomy/false_positives.json";
10+
export const fpURL =
11+
"https://hub-cdn.crowdsec.net/master/taxonomy/false_positives.json"
1112
export const columns = [
1213
{
1314
header: "Name",
@@ -17,10 +18,31 @@ export const columns = [
1718
header: "Description",
1819
accessorKey: "description",
1920
},
20-
];
21+
]
2122

2223
<GithubIconRender url={fpURL}></GithubIconRender>
2324

24-
2525
<TableRender columns={columns} url={fpURL}></TableRender>
2626

27+
## How to Get Tagged as a False Positive
28+
29+
To be marked as a false positive in the CrowdSec Threat Intelligence, you need to publicly share all the IP addresses and ranges you own.
30+
31+
Once your IP addresses are publicly available and accessible via HTTPS, you can contact support@crowdsec.net. Please include the URL of your IPs and ranges.
32+
33+
The CrowdSec team will do their best to update the CTI with false positive information, so your IPs are flagged correctly.
34+
35+
Here are some examples of providers who share their IPs and ranges:
36+
37+
- [Bing](https://www.bing.com/toolbox/bingbot.json)
38+
- [Google Bot](https://developers.google.com/search/apis/ipranges/googlebot.json)
39+
- [Cloudfront](https://d7uri8nf7uskq.cloudfront.net/tools/list-cloudfront-ips)
40+
- [Fastly](https://api.fastly.com/public-ip-list)
41+
42+
:::note
43+
44+
You don’t need to follow a specific format for the exposed list, but it’s recommended to keep the same format over time. Otherwise, the false positive enrichment may stop working.
45+
46+
It’s best to use CSV or JSON for the list format.
47+
48+
:::
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: Troubleshooting CTI
3+
id: cti
4+
---
5+
6+
import UnixWindowsK8sTabs from "../../src/components/UnixWindowsK8sTabs"
7+
8+
## Community support
9+
10+
Please try to resolve your issue by reading [the documentation](../cti_api/intro). If you're unable to find a solution, don't hesitate to seek assistance in:
11+
12+
- [Discourse](https://discourse.crowdsec.net/)
13+
- [Discord](https://discord.gg/crowdsec)
14+
15+
## False Positive
16+
17+
### How to Get Tagged as a False Positive
18+
19+
To be marked as a false positive in the CrowdSec Threat Intelligence, you need to publicly share all the IP addresses and ranges you own.
20+
21+
Once your IP addresses are publicly available and accessible via HTTPS, you can contact support@crowdsec.net. Please include the URL of your IPs and ranges.
22+
23+
The CrowdSec team will do their best to update the CTI with false positive information, so your IPs are flagged correctly.
24+
25+
Here are some examples of providers who share their IPs and ranges:
26+
27+
- [Bing](https://www.bing.com/toolbox/bingbot.json)
28+
- [Google Bot](https://developers.google.com/search/apis/ipranges/googlebot.json)
29+
- [Cloudfront](https://d7uri8nf7uskq.cloudfront.net/tools/list-cloudfront-ips)
30+
- [Fastly](https://api.fastly.com/public-ip-list)
31+
32+
:::note
33+
34+
You don’t need to follow a specific format for the exposed list, but it’s recommended to keep the same format over time. Otherwise, the false positive enrichment may stop working.
35+
36+
It’s best to use CSV or JSON for the list format.
37+
38+
:::

crowdsec-docs/unversioned/troubleshooting/intro.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,14 @@ We have extended our troubleshooting documentation to cover more common issues a
1515

1616
### [Remediation Components](/troubleshooting/remediation_components.mdx)
1717

18+
### [CTI](/troubleshooting/cti.mdx)
19+
1820
## Community support
1921

2022
Please try to resolve your issue by reading the documentation. If you're unable to find a solution, don't hesitate to seek assistance in:
2123

22-
- [Discourse](https://discourse.crowdsec.net/)
23-
- [Discord](https://discord.gg/crowdsec)
24+
- [Discourse](https://discourse.crowdsec.net/)
25+
- [Discord](https://discord.gg/crowdsec)
2426

2527
# FAQ
2628

@@ -64,9 +66,9 @@ If you need help for large scale deployment, please get in touch with us on the
6466

6567
Setting up a proxy works out of the box, the [net/http golang library](https://golang.org/src/net/http/transport.go) can handle those environment variables:
6668

67-
* `HTTP_PROXY`
68-
* `HTTPS_PROXY`
69-
* `NO_PROXY`
69+
- `HTTP_PROXY`
70+
- `HTTPS_PROXY`
71+
- `NO_PROXY`
7072

7173
For example:
7274

@@ -75,6 +77,7 @@ export HTTP_PROXY=http://<proxy_url>:<proxy_port>
7577
```
7678

7779
#### Systemd variable
80+
7881
On Systemd devices you have to set the proxy variable in the environment section for the CrowdSec service. To avoid overwriting the service file during an update, a folder is created in `/etc/systemd/system/crowdsec.service.d` and a file in it named `http-proxy.conf`. The content for this file should look something like this:
7982

8083
```bash title="systemctl edit crowdsec.service"
@@ -90,6 +93,7 @@ Then you can restart CrowdSec like this:
9093
`systemctl restart crowdsec`
9194

9295
#### Sudo
96+
9397
If you use `sudo cscli`, just add this line in `visudo` after setting up the previous environment variables:
9498

9599
```
@@ -146,20 +150,22 @@ CrowdSec Hub should be used when you have an issue with a parser, scenario or co
146150

147151
To disable the central API, simply comment out the [`online_client` section of the configuration file](/docs/next/configuration/crowdsec_configuration#online_client).
148152

149-
### Why are some scenarios/parsers "tainted" or "custom" ?
153+
### Why are some scenarios/parsers "tainted" or "custom" ?
150154

151155
When using `cscli` to list your parsers, scenarios and collections, some might appear as "tainted" or "local".
152156

153157
"tainted" items:
154-
- Originate from the hub
155-
- Were locally modified
156-
- Will not be automatically updated/upgraded by `cscli` operations (unless `--force` or similar is specified)
157-
- Won't be sent to Central API and won't appear in the Console (unless `cscli console enable tainted` has been specified)
158+
159+
- Originate from the hub
160+
- Were locally modified
161+
- Will not be automatically updated/upgraded by `cscli` operations (unless `--force` or similar is specified)
162+
- Won't be sent to Central API and won't appear in the Console (unless `cscli console enable tainted` has been specified)
158163

159164
"local" items:
160-
- Have been locally created by the user
161-
- Are not managed by `cscli` operations
162-
- Won't be sent to Central API and won't appear in the Console (unless `cscli console enable custom` has been specified)
165+
166+
- Have been locally created by the user
167+
- Are not managed by `cscli` operations
168+
- Won't be sent to Central API and won't appear in the Console (unless `cscli console enable custom` has been specified)
163169

164170
### Which information is sent to your services ?
165171

@@ -201,6 +207,7 @@ line: May 16 07:50:30 sd-126005 sshd[10041]: Invalid user git from 78.142.18.204
201207
├ 🟢 crowdsecurity/ssh-slow-bf
202208
└ 🟢 crowdsecurity/ssh-slow-bf_user-enum
203209
```
210+
204211
This command will allow you to see each parser behavior.
205212

206213
:::warning

0 commit comments

Comments
 (0)