aprig commited on
Commit
6372af7
·
verified ·
1 Parent(s): 680d020

README.md translated to Eng

Browse files
Files changed (1) hide show
  1. README.md +43 -42
README.md CHANGED
@@ -13,38 +13,39 @@ tags:
13
  - APTs
14
  language:
15
  - en
 
16
  ---
17
 
18
  # MALWARE-SAMPLES DATASET
19
- > **Disclaimer:** Este repositorio contiene **muestras reales de malware** en formato ejecutable (`.exe`) y artefactos derivados de su ejecución en la sandbox CAPEv2 (informes JSON/HTML, capturas de pantalla, archivos dropeados). **NO** ejecute ninguno de los binarios en máquinas en producción ni en equipos no aislados. Este README explica la estructura del dataset, metadatos, uso seguro y requisitos legales/éticos. Este dataset ha sido creado con fines meramente investigativos, los creadores **NO** nos hacemos responsables del uso dado por terceros.
20
 
21
  ---
22
 
23
 
24
- ## Contenido
25
 
26
- 1. [Descripción](#descripción)
27
- 2. [Origen y atribución](#origen-y-atribución)
28
- 3. [Estructura del dataset](#estructura-del-dataset)
29
- 4. [Descripción de archivos y formato](#descripción-de-archivos-y-formato)
30
- 5. [Configuración CAPEv2 sandbox](#configuración-capev2-sandbox)
31
- 6. [Contacto](#contacto)
32
  ---
33
 
34
- ## Descripción
35
 
36
- Este dataset agrupa únicamente las **muestras `.exe`** extraídas de tres repositorios públicos y sus resultados de ejecución en la sandbox **CAPEv2**. Para cada muestra incluye:
37
 
38
- - El binario (`.exe`)
39
- - `report.json` generado por CAPEv2
40
- - `report.html` (versión HTML del informe CAPEv2)
41
- - Capturas de pantalla tomadas por CAPE durante el análisis
42
- - Archivos dropeados durante la ejecución dinámica (si los hubo)
43
  ---
44
 
45
- ## Origen y atribución
46
 
47
- Las muestras originales proceden de los repositorios públicos (solo se incluyeron las muestras `.exe`):
48
 
49
  - `ytisf/theZoo` — https://github.com/ytisf/theZoo
50
  - `Pyran1/MalwareDatabase` — https://github.com/Pyran1/MalwareDatabase
@@ -52,27 +53,27 @@ Las muestras originales proceden de los repositorios públicos (solo se incluyer
52
  ---
53
 
54
 
55
- ## Estructura del dataset
56
 
57
- Estructura de alto nivel (raíz del repositorio):
58
 
59
  ```
60
  dataset/
61
  ├── JSONs/
62
- │ └── <md5>.json # report.json (renombrado por md5)
63
  ├── reports/
64
- │ └── <md5>.html # report.html (renombrado por md5)
65
  ├── screenshots/
66
- │ └── <md5>/ # md5 de la muestra de malware
67
  │ ├── 0001.png
68
  │ ├── 0002.png
69
  │ └── ...
70
  ├── binaries/
71
  │ └── <md5>
72
  | ├── <md5>.exe
73
- │ └── LICENSE.MD #Algunas muestras se encuentran bajo una licencia GPLv3
74
  └── dropped_files/
75
- └── <md5>/ # md5 de la muestra de malware
76
  ├── fileA
77
  ├── fileB
78
  └── ...
@@ -80,52 +81,52 @@ dataset/
80
 
81
  ---
82
 
83
- ## Descripción de archivos y formato
84
 
85
- - **`binaries/<md5>.exe`**
86
- Copia del ejecutable original. **No ejecutar** en equipos no controlados.
87
 
88
  - **`JSONs/<md5>.json`**
89
- Salida JSON del análisis CAPEv2: metadata, procesos, archivos dropeados, actividad de red, firmas, etc.
90
 
91
  - **`Reports/<md5>.html`**
92
- Versión HTML del informe generada por CAPEv2.
93
 
94
  - **`screenshots/<md5>/*.png`**
95
- Capturas de pantalla tomadas durante la ejecución dinámica.
96
 
97
  - **`dropped_files/<md5>/*`**
98
- Archivos que el malware dejó en disco durante su ejecución dentro de la sandbox.
99
 
100
  ---
101
 
102
 
103
- ## Configuración CAPEv2 sandbox
104
 
105
- > **Resumen:** Para analizar muestras con capacidades evasivas se realizaron ajustes en las configuraciones de la sandbox CAPEv2 utilizada durante la generación de este dataset. Con el fin de permitir la replicación del experimento, en el repositorio se incluyen los archivos de configuración utilizados (la carpeta `conf/` de CAPEv2) y el XML de máquina virtual KVM personalizada.
106
 
107
- ### ¿Qué contiene esta sección?
108
 
109
- Se publicará la siguiente estructura dentro del repositorio:
110
 
111
  ```
112
  CAPEv2 Configuration/
113
  ├── XML KVM/
114
- │ └── xml-custom-machine.xml # XML para configurar la VM en KVM
115
  └── conf/
116
- └── ... # Archivos y carpetas de configuración de CAPEv2
117
  ```
118
 
119
  - **`XML KVM/`**
120
- Contiene el descriptor XML de la máquina virtual (nombres indicativos: `xml-custom-machine.xml`). Este XML refleja la VM usada en los análisis (vCPU, memoria, dispositivos virtuales, discos, NICs simuladas, etc.) para que otros puedan importar/definir una VM equivalente en su entorno de virtualización.
121
 
122
  - **`conf/`**
123
- Copia de la carpeta `conf` utilizada por CAPEv2 en el experimento. Incluye los ficheros de configuración relevantes de CAPEv2 (rutas, timeouts, módulos habilitados, integración con el backend de análisis, parámetros de captura de red, etc.). **Nota:** cualquier dato sensible (credenciales, claves privadas) ha sido eliminado.
124
  ---
125
- ## Contacto
126
  ### Raúl Bayón Martínez
127
 
128
- PHD Student/Personal Investigador de la Universidad de León
129
 
130
  Email: rbaym@unileon.es
131
 
@@ -133,6 +134,6 @@ Email: rbaym@unileon.es
133
 
134
  ### Adrián Prieto González
135
 
136
- Personal Investigador de la Universidad de León
137
 
138
  Email: aprig@unileon.es
 
13
  - APTs
14
  language:
15
  - en
16
+ - es
17
  ---
18
 
19
  # MALWARE-SAMPLES DATASET
20
+ > **Disclaimer:** This repository contains **real samples of malware** that can be executed (`.exe`) and artifacts related with their execution in CAPEv2 sandbox (JSON/HTML reports, screenshots, dropped files). **DO NOT** execute any of those binaries in production machines or non-isolated environments. This README file explains how dataset is structured, its metadata, safe use as well as legal and ethical requirements. This dataset has been created for research purposes only. The creators **DO NOT** accept responsibility for its use by third parties.
21
 
22
  ---
23
 
24
 
25
+ ## Content
26
 
27
+ 1. [Description](#description)
28
+ 2. [Source and attribution](#source-and-attribution)
29
+ 3. [Dataset structure](#dataset-structure)
30
+ 4. [File description and format](#file-description-and-format)
31
+ 5. [CAPEv2 sandbox configuration](#capev2-sandbox-configuration)
32
+ 6. [Contact](#contact)
33
  ---
34
 
35
+ ## Description
36
 
37
+ This dataset only groups **.exe samples** extracted from three public repositories and their execution results in the CAPEv2 sandbox. For each sample, it includes:
38
 
39
+ - The binary (`.exe`)
40
+ - `report.json` generated by CAPEv2
41
+ - `report.html` (HTML version of thre report generated by CAPEv2)
42
+ - Screenshots taken by CAPE during the analysis
43
+ - Files dropped during dynamic execution (if any)
44
  ---
45
 
46
+ ## Source and attribution
47
 
48
+ The original binary samples were taken from public repositories (only `.exe` files were taken and used):
49
 
50
  - `ytisf/theZoo` — https://github.com/ytisf/theZoo
51
  - `Pyran1/MalwareDatabase` — https://github.com/Pyran1/MalwareDatabase
 
53
  ---
54
 
55
 
56
+ ## Dataset structure
57
 
58
+ High-level structure (repository root):
59
 
60
  ```
61
  dataset/
62
  ├── JSONs/
63
+ │ └── <md5>.json # report.json (renamed using md5)
64
  ├── reports/
65
+ │ └── <md5>.html # report.html (renamed using md5)
66
  ├── screenshots/
67
+ │ └── <md5>/ # md5 hash of the malware sample
68
  │ ├── 0001.png
69
  │ ├── 0002.png
70
  │ └── ...
71
  ├── binaries/
72
  │ └── <md5>
73
  | ├── <md5>.exe
74
+ │ └── LICENSE.MD #Some binary files are under a GPLv3 license
75
  └── dropped_files/
76
+ └── <md5>/ # md5 hash of the malware sample
77
  ├── fileA
78
  ├── fileB
79
  └── ...
 
81
 
82
  ---
83
 
84
+ ## File description and format
85
 
86
+ - **`binaries/<md5>/<md5>.exe`**
87
+ Copy of the original executable file. **DO NOT EXECUTE** on uncontrolled computers.
88
 
89
  - **`JSONs/<md5>.json`**
90
+ JSON output from CAPEv2 analysis: metadata, processes, dropped files, network activity, signatures, etc.
91
 
92
  - **`Reports/<md5>.html`**
93
+ HTML version of the report generated by CAPEv2.
94
 
95
  - **`screenshots/<md5>/*.png`**
96
+ Screenshots taken during dynamic execution.
97
 
98
  - **`dropped_files/<md5>/*`**
99
+ Files that the malware left on disk during its execution within the sandbox.
100
 
101
  ---
102
 
103
 
104
+ ## CAPEv2 sandbox configuration
105
 
106
+ > **Summary:** In order to analyse samples with evasive capabilities, adjustments were made to the CAPEv2 sandbox configurations used during the generation of this dataset. In order to allow replication of the experiment, the configuration files used (the CAPEv2 `conf/` folder) and the custom KVM virtual machine XML are included in the repository.
107
 
108
+ ### What does this section contain?
109
 
110
+ The following structure will be published within the repository:
111
 
112
  ```
113
  CAPEv2 Configuration/
114
  ├── XML KVM/
115
+ │ └── xml-custom-machine.xml # XML used to configure the VM in KVM
116
  └── conf/
117
+ └── ... # CAPEv2 configuration files and folders
118
  ```
119
 
120
  - **`XML KVM/`**
121
+ Contains the XML descriptor of the virtual machine (suggested names: `xml-custom-machine.xml`). This XML reflects the VM used in the analyses (vCPU, memory, virtual devices, disks, simulated NICs, etc.) so that others can import/define an equivalent VM in their virtualisation environment.
122
 
123
  - **`conf/`**
124
+ Copy of the `conf` folder used by CAPEv2 in the experiment. It includes the relevant CAPEv2 configuration files (paths, timeouts, enabled modules, integration with the analysis backend, network capture parameters, etc.). **Note:** any sensitive data (credentials, private keys) has been removed.
125
  ---
126
+ ## Contact
127
  ### Raúl Bayón Martínez
128
 
129
+ PHD Student/Research Staff from Universidad de León (Spain)
130
 
131
  Email: rbaym@unileon.es
132
 
 
134
 
135
  ### Adrián Prieto González
136
 
137
+ Research Staff from Universidad de León (Spain)
138
 
139
  Email: aprig@unileon.es