Skip to content

Commit

Permalink
Merge pull request #75 from redBorder/improvement/#19242_update_incid…
Browse files Browse the repository at this point in the history
…ents_doc

Improvement/#19242 update incidents documentation
  • Loading branch information
rgomezborder authored Nov 27, 2024
2 parents 7503c95 + ef5ce18 commit 6f5e0c3
Show file tree
Hide file tree
Showing 32 changed files with 256 additions and 19 deletions.
1 change: 1 addition & 0 deletions build_pdf/redborder_ndr_user_manual_book/en.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ nav:
- documentation/manager/dashboards/ch09_widgets_actions.md
- documentation/manager/incidents/ch01_incidents_list.md
- documentation/manager/incidents/ch05_incident_details/.md
- documentation/manager/incidents/ch21_incident_stats.md
- documentation/manager/apps/ch07_apps.md
- documentation/manager/apps/ch08_apps_menu.md
- documentation/manager/apps/ch09_views.md
Expand Down
1 change: 1 addition & 0 deletions build_pdf/redborder_ndr_user_manual_book/es.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ nav:
- documentation/manager/dashboards/ch09_widgets_actions.es.md
- documentation/manager/incidents/ch01_incidents_list.es.md
- documentation/manager/incidents/ch05_incident_details/.es.md
- documentation/manager/incidents/ch21_incident_stats.es.md
- documentation/manager/apps/ch07_apps.es.md
- documentation/manager/apps/ch08_apps_menu.es.md
- documentation/manager/apps/ch09_views.es.md
Expand Down
15 changes: 13 additions & 2 deletions docs/documentation/manager/incidents/ch01_incidents_list.es.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ Los incidentes se clasifican según su nivel de riesgo, enfocando la atención e

![Incidents view](images/incidents_list.es.png)

Access incidents through the top menu.
Accede a las incidencias a través del menú superior.

## Searching and Filtering Incidents
## Búsqueda y filtrado de incidentes

Busca, filtra y ordena incidentes fácilmente para enfocarte en los casos más relevantes.

Expand Down Expand Up @@ -41,12 +41,23 @@ Los campos de un incidente son los siguientes:

Las acciones que puedes realizar en un incidente incluyen:

- **Gestionar Múltiples Incidentes**: Haz clic en la casilla de verificación dentro de la cabecera de la lista de incidentes para seleccionar todos los disponibles en la página actual, o selecciona uno a uno utilizando la casilla ubicada a la izquierda de cada incidente. Al presionar el ícono de los tres puntos, podrás cambiar el estado, vincular o borrar los incidentes seleccionados.
- **Ver Detalles del Incidente**: Haz clic en el nombre del incidente para acceder a información detallada.
- **Ver Eventos del Incidente**: Haz clic en la fuente para revisar los eventos relacionados con el incidente.
- **Cambiar Estado del Incidente**: Actualiza el estado haciendo clic en el campo de estado.
- **Gestionar Incidente**: Haz clic en el ícono de configuración para entrar en modo de gestión del incidente.
- **Eliminar Incidente**: Haz clic en el ícono de basura para eliminar el incidente de la lista.

## Contadores de Incidentes

En la parte superior de la vista de incidentes se encuentra la siguiente información:

- **Total de Incidentes**: Total de incidentes visibles.
- **Incidentes Creados**: Total de incidentes creados en la última hora.
- **Incidentes Abiertos**: Total de incidentes con estado **Abierto**.
- **Incidentes No Asignados**: Total de incidentes que no han sido asignados a ningún usuario.
- **Resultados Coincidentes**: Total de incidentes que coinciden con los filtros y busqueda de la lista de incidentes.

## Barra Lateral de Incidente

Al hacer clic en el nombre del incidente, se abre un resumen en la barra lateral. Seleccionar **Ver Detalles del Incidente** o el ícono de configuración proporciona acceso completo a los detalles del incidente. Si el estado es **Nuevo**, se actualizará automáticamente a Abierto y asignará el incidente a ti para su gestión.
Expand Down
11 changes: 11 additions & 0 deletions docs/documentation/manager/incidents/ch01_incidents_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,23 @@ The fields of an incident are the following:

Actions you can perform on an incident include:

- **Manage Multiple Incidents**: Click the checkbox within the header of the incident list to select all available incidents on the current page, or select one by one using the checkbox located to the left of each incident. By pressing the three-dot icon, you will be able to change the status, link or delete the selected incidents.
- **View Incident Details**: Click the incident name to access detailed information.
- **View Incident Events**: Click the source to review related incident events.
- **Change Incident Status**: Update the status by clicking on the status field.
- **Manage Incident**: Click the settings icon to enter incident management mode.
- **Delete Incident**: Click the trash icon to remove the incident from the list.

## Incident Counters

At the top of the incident view you will find the following information:

- **Total Incidents**: Total number of visible incidents.
- **Created Incidents**: Total number of incidents created in the last hour.
- **Open Incidents**: Total number of incidents with status **Open**.
- **Unassigned Incidents**: Total number of incidents that have not been assigned to any user.
- **Matching Results**: Total number of incidents that match the filters and search in the incident list.

## Incident Sidebar

Clicking the incident name opens a summary in the sidebar. Selecting **View Incident Details** or the settings icon provides full access to the incident details. If the status is **New**, it will automatically update to Open and assign the incident to you for management.
Expand Down
95 changes: 86 additions & 9 deletions docs/documentation/manager/incidents/ch05_incident_details.es.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Detalles del Incidente

La página de detalles del incidente ofrece información completa sobre un incidente, lo que ayuda a diagnosticarlo, contenerlo y solucionarlo. Incluye un encabezado, un gráfico de ataque y varias pestañas para acceder a las secciones **Vista general**, **Detección**, **Respuesta**, **Worklog** e **Informe**.

## Overview del Incidente

Esta vista proporciona información detallada sobre el incidente, permitiendo a los usuarios documentar cada paso del proceso de respuesta.
En el encabezado de la página **Detalles del incidente**, puede ver el estado y la prioridad, el nombre del incidente y qué fuente lo informó junto con la marca de tiempo, una descripción, quién ha sido asignado al incidente y las tácticas MITRE ATT&CK®.

### Overview

Expand All @@ -14,7 +16,66 @@ La sección de Resumen resume la información clave del incidente, mostrando:

Un gráfico interactivo visualiza las relaciones entre los observables, permitiendo a los usuarios comprender rápidamente sus conexiones.

![Overview del icnidente](images/incidents_overview.es.png)
![Overview del incidente](images/incidents_overview.es.png)

Puedes realizar las siguientes acciones dentro de la sección de Detalles del incidente:

=== "Editar el título"

Puedes modificar el título del incidente presionando el ícono de editar ubicado al lado del **título** del incidente.

![Edit title](images/edit_incident_title.es.png)

=== "Editar descripción"

Puedes modificar la descripción del incidente presionando el ícono de editar ubicado al lado de la **Descripción** del incidente.

![Edit description](images/edit_incident_description.es.png)

=== "Editar estado"

Puedes modificar el estado del incidente presionando el dropdown de **Estado**.

![Edit status](images/edit_incident_status.es.png)

=== "Asignar usuarios"

Puedes asignar diferentes usuarios presionando el ícono de editar ubicado al lado de **Usuarios Asignados**. El usuario asignado recibirá una notificación de que ha sido asignado al incidente en cuestión.

![Assing user](images/edit_incident_user.es.png)

#### Gráfica de Detalles del incidente

El gráfico de **Detalles del incidente** que se encuentra en la parte superior de la página presenta una visualización de las relaciones entre eventos que llevaron al incidente.

La relación entre los nodos se muestra en la etiqueta de la flecha direccional que conecta a otros nodos. Cuando hay varios nodos que se han unificado en un objeto y comparten una flecha direccional, puede pasar el cursor sobre un nodo para resaltar los demás nodos que tienen una relación con él.

Puede realizar las siguientes acciones:

| Icono | Descripción |
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| :material-plus: | Haga clic en este icono para reducir la vista de la información dentro del panel. |
| :material-minus: | Haga clic en este icono para ampliar la información dentro del panel. |
| :material-refresh: | Haga clic en este icono para realinear los nodos y centrar nuevamente el gráfico. |
| :material-arrow-expand: | Haga clic en este icono para centrar nuevamente el gráfico dentro del panel cuando este se expande a pantalla completa. |

Al hacer clic en un nodo, se abre una barra lateral que proporciona información detallada y útil sobre el elemento seleccionado.

![Overview graph](images/overview_graph_sidebar.es.png)

#### Ver Tácticas de MITRE ATT&CK

El modal de MITRE muestra las tácticas, técnicas y subtécnicas de MITRE ATT&CK® que impactan el incidente.

![Mitre](images/mitre.es.png)

#### Incidentes vinculados

La vinculación de incidentes mejora la gestión de incidentes al agrupar incidentes relacionados y establecer una relación bidireccional entre ellos, lo que agiliza el flujo de trabajo de respuesta a incidentes.

Puede vincular dos o más incidentes y, una vez vinculados, su relación se muestra en el sidebar Incidentes vinculados dentro de los detalles del incidente. Además, los incidentes se pueden desvincular directamente desde este sidebar según sea necesario.

![Linked incidents](images/linked_incidents.es.png)

### Detección

Expand All @@ -26,20 +87,34 @@ La sección de **Detección** enumera los eventos relevantes y sus observables y

La sección de **Respuesta** presenta un **playbook**, una guía paso a paso adaptada al tipo de incidente. Los playbooks aseguran un enfoque sistemático de respuesta, con tareas organizadas por fase. Cada tarea incluye una descripción, espacio para comentarios de los usuarios y un marcador de finalización.

!!!info "Note"
Puede administrar los **playbooks** asignados a los incidentes a través de la función Playbooks en la sección Herramientas (Herramientas > Playbooks).

Cada fase enumera las tareas que deben completarse secuencialmente. Los usuarios pueden documentar sus acciones y marcar las tareas como realizadas.

![Respuesta](images/incidents_response.es.png)

En este ejemplo, el playbook contiene cuatro fases:

- **Identificación**
- **Contención**
- **Erradicación**
- **Recuperación**
=== "Identificación"

Cada fase enumera las tareas que deben completarse secuencialmente. Los usuarios pueden documentar sus acciones y marcar las tareas como realizadas.
La fase de **Identificación** del proceso de respuesta a incidentes se centra en validar la amenaza y decidir si se justifica una investigación más exhaustiva. Esta fase implica revisar el incidente para confirmar que es un verdadero positivo e indicativo de un comportamiento anómalo, analizar los indicadores relevantes, confirmar la validez del incidente, asignar un estado adecuado, documentar todas las pruebas y notificar a las partes involucradas.

=== "Contención"

La fase de **Contención** del proceso de respuesta a incidentes implica la identificación de los hosts afectados y la contención de los indicadores de vulnerabilidad para evitar la propagación de actividades maliciosas. Esta fase también incluye la implementación de un monitoreo adicional para detectar cualquier actividad maliciosa en curso relacionada con el incidente e identificar vulnerabilidades que puedan haberse explotado.

=== "Erradicación"

La fase de **erradicación** del proceso de respuesta a incidentes se centra en mitigar o remediar vulnerabilidades, eliminar contenido malicioso y validar la erradicación de la amenaza. También implica restaurar los hosts afectados e implementar la supervisión para garantizar que el sistema se recupere por completo del incidente.

=== "Recuperación"

La fase de **Recuperación** del proceso de respuesta a incidentes implica restaurar los sistemas y servicios a sus operaciones normales, garantizando que el entorno sea seguro y completamente funcional para reanudar las actividades comerciales.

### Worklog

El **Worlog** documenta todas las acciones realizadas por los usuarios en el incidente. Los usuarios pueden ver, filtrar y añadir comentarios manualmente según sea necesario.
El **Worlog** documenta todas las acciones realizadas por los usuarios en el incidente. Los usuarios pueden ver, filtrar y añadir / editar / eleminar comentarios manualmente según sea necesario.

![Worklog](images/incidents_workload.es.png)

Expand All @@ -57,7 +132,9 @@ Los usuarios pueden añadir notas al worklog haciendo clic en **Añadir Nota**,
- Bloques de código y formato de texto
- Otras opciones de formato

### Report
### Informe

La página **Informe** dentro de Detalles del incidente proporciona información resumida del incidente generada por IA, que se puede editar, formatear con Markdown y descargar como un solo archivo de informe. Si los detalles del incidente cambian, se pueden volver a generar secciones individuales para obtener contenido actualizado generado por IA. Estas actualizaciones se pueden editar y descargar nuevamente para crear un informe actualizado.

Genera el informe del incidente usando Redborder AI.

Expand Down
Loading

0 comments on commit 6f5e0c3

Please sign in to comment.