Skip to content

Commit 9d345e7

Browse files
author
Georges Bossert
committed
fix(broken-links): fix getting started section
1 parent 278202a commit 9d345e7

File tree

2 files changed

+41
-41
lines changed

2 files changed

+41
-41
lines changed

docs/getting_started/best_practices.md

+25-25
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ In the current cybersecurity landscape, organizations face significant challenge
44

55
### Rules Configuration
66

7-
Our extensive catalog of over 900 rules, each [associated with a TTP from the MITRE ATT&CK framework](https://docs.sekoia.io/xdr/features/detect/built_in_detection_rules/), is categorized by four levels of effort. This enables targeted and effective defense against threats. The normalization of events via [intake formats](https://github.com/SEKOIA-IO/intake-formats/blob/main/doc/structured_event.md) and the use of [ECS taxonomy](https://www.elastic.co/guide/en/ecs/current/ecs-reference.html) allows for technology-agnostic integration, facilitating the production of detection rules based on the [SIGMA models](https://docs.sekoia.io/xdr/features/detect/sigma/), our specific [anomaly detection engine](https://docs.sekoia.io/xdr/features/detect/anomaly/) and even the [IOC Detection](https://docs.sekoia.io/xdr/features/detect/iocdetection/) & [Collections](https://docs.sekoia.io/xdr/features/detect/ioccollections/).
7+
Our extensive catalog of over 900 rules, each [associated with a TTP from the MITRE ATT&CK framework](../xdr/features/detect/built_in_detection_rules.md), is categorized by four levels of effort. This enables targeted and effective defense against threats. The normalization of events via [intake formats](https://github.com/SEKOIA-IO/intake-formats/blob/main/doc/structured_event.md) and the use of [ECS taxonomy](https://www.elastic.co/guide/en/ecs/current/ecs-reference.html) allows for technology-agnostic integration, facilitating the production of detection rules based on the [SIGMA models](../xdr/features/detect/sigma.md), our specific [anomaly detection engine](../xdr/features/detect/anomaly.md) and even the [IOC Detection](../xdr/features/detect/iocdetection.md) & [Collections](../xdr/features/detect/ioccollections.md).
88

99
**Recommendations:**
1010

11-
- **Activate all [effort level](https://docs.sekoia.io/xdr/features/detect/rules_catalog/#effort-level) 1 and 2 rules** during the initial setup of your community.
11+
- **Activate all [effort level](../xdr/features/detect/rules_catalog.md#effort-level) 1 and 2 rules** during the initial setup of your community.
1212

13-
- **Configure the Rules Settings** to [enable new rules](https://docs.sekoia.io/xdr/features/detect/rules_catalog/#automatically) up to the Intermediate level.
13+
- **Configure the Rules Settings** to [enable new rules](../xdr/features/detect/rules_catalog.md#automatically) up to the Intermediate level.
1414

15-
- **Fine-tune detection rules** after each false positive alert through the [available options](https://docs.sekoia.io/xdr/features/detect/rules_catalog/#limiting-the-scope-of-a-rule), primarily using alert filters.
15+
- **Fine-tune detection rules** after each false positive alert through the [available options](../xdr/features/detect/rules_catalog.md#limiting-the-scope-of-a-rule), primarily using alert filters.
1616

1717
- **Activate a new wave of higher effort level rules** after the initial RUN period, representing:
1818

@@ -33,10 +33,10 @@ To ensure comprehensive and effective coverage, it is crucial to configure your
3333
- **2 company wide Network Based Intake** (e.g., Loadbalancer/Reverse-Proxy, Proxy, DNS). They help monitor internal network traffic and detect anomalies such as lateral movements by attackers and suspicious communications.
3434
- **1 company wide Email Security Based Intake** (e.g., Office, ProofPoint, Vade) **with security options enabled**. This helps identify phishing attacks, malware transmitted via email, and other email-related threats.
3535
- **1 Identity and Access Management Based Intake** for **on-premise** environments (e.g., Active Directory, Okta, Wallix) **and 1 for cloud** environments if applicable (e.g., Azure Entra ID, Cloudflare Access Requests, Google Workspace). This helps detect suspicious activities related to user access, such as unauthorized login attempts and privilege changes, and ensures security oversight across both on-premise and cloud environments.
36-
- **Activity Logs**: Ensure that [Sekoia.io activity logs](https://docs.sekoia.io/integration/integrations/application/sekoiaio_activity_logs/) are activated. This allows monitoring actions and changes within the Sekoia.io platform itself, ensuring complete transparency and traceability.
37-
- **No intake should have zero events received** in the past 7 days. An intake without events can indicate a configuration or data collection issue, compromising threat detection capability. Ensure that notifications are configured to alert in the case of [an event drop for an intake](https://docs.sekoia.io/getting_started/notifications-Examples/#intakes).
36+
- **Activity Logs**: Ensure that [Sekoia.io activity logs](../integration/categories/applicative/sekoiaio_activity_logs.md) are activated. This allows monitoring actions and changes within the Sekoia.io platform itself, ensuring complete transparency and traceability.
37+
- **No intake should have zero events received** in the past 7 days. An intake without events can indicate a configuration or data collection issue, compromising threat detection capability. Ensure that notifications are configured to alert in the case of [an event drop for an intake](./notifications-Examples.md#intakes).
3838

39-
- **Use the [Sekoia.io Forwarder](https://docs.sekoia.io/integration/ingestion_methods/syslog/sekoiaio_forwarder/)** each time you need to forward On Premise events via syslog protocol to Sekoia.io SOC Platform to ease discriminate logs before adding them the relevant Intake Key. It also is the only log forwarder that our Support team will be able to provide you with assistance.
39+
- **Use the [Sekoia.io Forwarder](../integration/ingestion_methods/syslog/sekoiaio_forwarder.md)** each time you need to forward On Premise events via syslog protocol to Sekoia.io SOC Platform to ease discriminate logs before adding them the relevant Intake Key. It also is the only log forwarder that our Support team will be able to provide you with assistance.
4040

4141

4242
### Events Quality
@@ -51,7 +51,7 @@ The quality of events is crucial for accurate and effective detection. Here are
5151
Our product is designed to focus on high-priority threats, enabling expert resources to conduct a manageable number of quality investigations each day. By creating alert filters, you can ensure that alerts are raised for the right reasons, enhancing the efficiency and effectiveness of your security operations.
5252

5353
- **Monitor the average number of Alerts per Intake** to identify intakes generating too many or too few alerts.
54-
- **Limit the number of Daily New Alerts** at a manageable level for your team (by experience, around 6 to 8 per day per analyst, or 60 per day) and prioritise the [tuning of a rule](https://docs.sekoia.io/xdr/features/investigate/alerts/#create-an-alert-filter) over automating its status change if no defensive action is to be taken.
54+
- **Limit the number of Daily New Alerts** at a manageable level for your team (by experience, around 6 to 8 per day per analyst, or 60 per day) and prioritise the [tuning of a rule](../xdr/features/investigate/alerts.md#create-an-alert-filter) over automating its status change if no defensive action is to be taken.
5555
- **Track the Weekly and Monthly volume of New Alerts** to evaluate the evolution of threats and the performance of detection rules.
5656
- **Assess the number of Daily New Cases** to understand workload and the effectiveness of response processes. In general, the number of case(s) per day does not exceed 1, as it is cconsidered as a very important incident.
5757
- **Ensure no sleeping alert is older than 1 week** without status "Closed" or "Rejected".
@@ -66,27 +66,27 @@ Playbooks complement operational optimization by automating various types of man
6666

6767
- **Keep the number of playbook executions per day low**: Aim for less than 60 executions per playbook per day, aligning with the number of raised alerts. Each playbook should have a specific objective to meet a particular need.
6868
- **Design playbooks with simplicity in mind**: On average, each playbook should be composed of less than 15 modules, including:
69-
- **1 [Trigger](https://docs.sekoia.io/xdr/features/automate/triggers/)** such as the “Manual trigger” or “Alert created” trigger **with a filter condition** to start the playbook only for relevant cases.
70-
- **Some [Operator](https://docs.sekoia.io/xdr/features/automate/operators/) modules** like "[Condition](https://docs.sekoia.io/xdr/features/automate/operators/#condition)" and "[Foreach](https://docs.sekoia.io/xdr/features/automate/operators/#foreach)" to halt the playbook execution if new information gathered during the process indicates that the playbook is unnecessary in the current context.
71-
- **A majority of [Action](https://docs.sekoia.io/xdr/features/automate/actions/) modules** making it easily understandable for new team members and maintainable over time. To give you more details on the top 10 most used playbook Actions, here is a list:
72-
73-
1. [Read JSON File](https://docs.sekoia.io/xdr/features/automate/library/fileutils/#read-json-file)
74-
2. [Comment Alert](https://docs.sekoia.io/xdr/features/automate/library/sekoia-io/#comment-alert)
75-
3. [Get Alert](https://docs.sekoia.io/xdr/features/automate/library/sekoia-io/#get-alert)
76-
4. [Request URL](https://docs.sekoia.io/xdr/features/automate/library/http/#request-url)
77-
5. [Update Alert Status](https://docs.sekoia.io/xdr/features/automate/library/sekoia-io/#update-alert-status)
78-
6. [Get Events](https://docs.sekoia.io/xdr/features/automate/library/sekoia-io/#get-events)
79-
7. [VirusTotal Scan URL](https://docs.sekoia.io/xdr/features/automate/library/virustotal/#scan-url)
80-
8. [Get Event Field Common Values](https://docs.sekoia.io/xdr/features/automate/library/sekoia-io/#get-event-field-common-values)
81-
9. [Edit Alert](https://docs.sekoia.io/xdr/features/automate/library/sekoia-io/#edit-alert)
82-
10. [VirusTotal Scan Hash](https://docs.sekoia.io/xdr/features/automate/library/virustotal/#scan-hash)
83-
84-
For instance, the following [playbook template](https://docs.sekoia.io/xdr/features/automate/build-playbooks/#templates) composed of 9 modules (1 Trigger, 1 Operator, 7 Actions) answers the need of adding a domain in a blocklist (IOC Collection).
69+
- **1 [Trigger](../xdr/features/automate/triggers.md)** such as the “Manual trigger” or “Alert created” trigger **with a filter condition** to start the playbook only for relevant cases.
70+
- **Some [Operator](../xdr/features/automate/operators.md) modules** like "[Condition](../xdr/features/automate/operators.md#condition)" and "[Foreach](../xdr/features/automate/operators.md#foreach)" to halt the playbook execution if new information gathered during the process indicates that the playbook is unnecessary in the current context.
71+
- **A majority of [Action](../xdr/features/automate/actions.md) modules** making it easily understandable for new team members and maintainable over time. To give you more details on the top 10 most used playbook Actions, here is a list:
72+
73+
1. [Read JSON File](../integration/action_library/generic/fileutils.md#read-json-file)
74+
2. [Comment Alert](../integration/action_library/generic/sekoia-io.md#comment-alert)
75+
3. [Get Alert](../integration/action_library/generic/sekoia-io.md#get-alert)
76+
4. [Request URL](../integration/action_library/generic/http.md#request-url)
77+
5. [Update Alert Status](../integration/action_library/generic/sekoia-io.md#update-alert-status)
78+
6. [Get Events](../integration/action_library/generic/sekoia-io.md#get-events)
79+
7. [VirusTotal Scan URL](../integration/action_library/threat_intelligence/virustotal.md#scan-url)
80+
8. [Get Event Field Common Values](../integration/action_library/generic/sekoia-io.md#get-event-field-common-values)
81+
9. [Edit Alert](../integration/action_library/generic/sekoia-io.md#edit-alert)
82+
10. [VirusTotal Scan Hash](../integration/action_library/threat_intelligence/virustotal.md#scan-hash)
83+
84+
For instance, the following [playbook template](../xdr/features/automate/build-playbooks.md#templates) composed of 9 modules (1 Trigger, 1 Operator, 7 Actions) answers the need of adding a domain in a blocklist (IOC Collection).
8585

8686
![playbook_example](/assets/getting_started/playbook_example.png){: style="max-width:100%"}
8787

8888
- **Ensure the duration of each Action** within playbooks is less than 10 seconds to reduce the chance of a timeout with most third-party tools you interact with.
89-
- **Track the overall [duration of playbook executions](https://docs.sekoia.io/xdr/features/automate/navigate-playbooks/#playbook-runs)** for each playbook to complete its execution in less than 1 minute.
89+
- **Track the overall [duration of playbook executions](../xdr/features/automate/navigate-playbooks.md#playbook-runs)** for each playbook to complete its execution in less than 1 minute.
9090
- **Ensure no playbook is having an issue** that is visible with the status "Trigger crashed" and "Configuration issues".
9191
- **Keep a low number of "Ready to start" playbooks**, for instance less than 2, to avoid activation issue after a long period of configuration due to confict with recent evolutions of your community.
9292

docs/getting_started/regions.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -38,19 +38,19 @@ For companies wishing to host their data in France:
3838
</tr>
3939
<tr>
4040
<td>API</td>
41-
<td><a href="https://api.sekoia.io">https://api.sekoia.io</a></td>
41+
<td><em>https://api.sekoia.io</em></td>
4242
</tr>
4343
<tr>
4444
<td>HTTP Intake</td>
45-
<td><a href="https://intake.sekoia.io/">https://intake.sekoia.io</a></td>
45+
<td><em>https://intake.sekoia.io</em></td>
4646
</tr>
4747
<tr>
4848
<td>Syslog Intake</td>
49-
<td><a href="intake.sekoia.io:10514">intake.sekoia.io:10514</a></td>
49+
<td><em>intake.sekoia.io:10514</em></td>
5050
</tr>
5151
<tr>
5252
<td>Syslog RELP Intake</td>
53-
<td><a href="app.sekoia.io:11514">app.sekoia.io:11514</a></td>
53+
<td><em>app.sekoia.io:11514</em></td>
5454
</tr>
5555
</tbody>
5656
</table>
@@ -79,19 +79,19 @@ SecNumCloud compliant infrastructure - For companies requiring PCI/DSS complianc
7979
</tr>
8080
<tr>
8181
<td>API</td>
82-
<td><a href="https://fra2.app.sekoia.io/api/">https://fra2.app.sekoia.io/api/</a></td>
82+
<td><em>https://fra2.app.sekoia.io/api/</em></td>
8383
</tr>
8484
<tr>
8585
<td>HTTP Intake</td>
86-
<td><a href="https://fra2.app.sekoia.io/api/v1/intake-http/">https://fra2.app.sekoia.io/api/v1/intake-http/</a></td>
86+
<td><em>https://fra2.app.sekoia.io/api/v1/intake-http/</em></td>
8787
</tr>
8888
<tr>
8989
<td>Syslog Intake</td>
90-
<td><a href="fra2.app.sekoia.io:10514">fra2.app.sekoia.io:10514</a></td>
90+
<td><em>fra2.app.sekoia.io:10514</em></td>
9191
</tr>
9292
<tr>
9393
<td>Syslog RELP Intake</td>
94-
<td><a href="fra2.app.sekoia.io:11514">fra2.app.sekoia.io:11514</a></td>
94+
<td><em>fra2.app.sekoia.io:11514</em></td>
9595
</tr>
9696
</tbody>
9797
</table>
@@ -164,19 +164,19 @@ For companies requiring their data to be hosted in Monaco:
164164
</tr>
165165
<tr>
166166
<td>API</td>
167-
<td><a href="https://mco1.app.sekoia.io/api/">https://mco1.app.sekoia.io/api/</a></td>
167+
<td><em>https://mco1.app.sekoia.io/api/</em></td>
168168
</tr>
169169
<tr>
170170
<td>HTTP Intake</td>
171-
<td><a href="https://mco1.app.sekoia.io/api/v1/intake-http/">https://mco1.app.sekoia.io/api/v1/intake-http/</a></td>
171+
<td><em>https://mco1.app.sekoia.io/api/v1/intake-http/</em></td>
172172
</tr>
173173
<tr>
174174
<td>Syslog Intake</td>
175-
<td><a href="mco1.app.sekoia.io:10514">mco1.app.sekoia.io:10514</a></td>
175+
<td><em>mco1.app.sekoia.io:10514</em></td>
176176
</tr>
177177
<tr>
178178
<td>Syslog RELP Intake</td>
179-
<td><a href="mco1.app.sekoia.io:11514">mco1.app.sekoia.io:11514</a></td>
179+
<td><em>mco1.app.sekoia.io:11514</em></td>
180180
</tr>
181181
</tbody>
182182
</table>
@@ -205,19 +205,19 @@ UAE1 is our middle eastern region hosted in Azure (UAE North, Dubai).
205205
</tr>
206206
<tr>
207207
<td>API</td>
208-
<td><a href="https://app.uae1.sekoia.io/api">https://app.uae1.sekoia.io/api</a></td>
208+
<td><em>https://app.uae1.sekoia.io/api</em></td>
209209
</tr>
210210
<tr>
211211
<td>HTTP Intake</td>
212-
<td><a href="https://app.uae1.sekoia.io/api/v1/intake-http">https://app.uae1.sekoia.io/api/v1/intake-http</a></td>
212+
<td><em>https://app.uae1.sekoia.io/api/v1/intake-http</em></td>
213213
</tr>
214214
<tr>
215215
<td>Syslog Intake</td>
216-
<td><a href="app.uae1.sekoia.io:10514">app.uae1.sekoia.io:10514</a></td>
216+
<td><em>app.uae1.sekoia.io:10514</em></td>
217217
</tr>
218218
<tr>
219219
<td>Syslog RELP Intake</td>
220-
<td><a href="app.uae1.sekoia.io:11514">app.uae1.sekoia.io:11514</a></td>
220+
<td><em>app.uae1.sekoia.io:11514</em></td>
221221
</tr>
222222
</tbody>
223223
</table>

0 commit comments

Comments
 (0)