KeyDive/docs/SYMBOLS.md

# Symbols

To utilize custom symbols with KeyDive, particularly when extracting Widevine L3 DRM keys from Android devices, you might need to generate a `symbols.xml` file using Ghidra. This file helps KeyDive accurately identify necessary symbols within the Widevine library, facilitating a more efficient extraction process. Below is a step-by-step guide on how to create a `symbols.xml` file using Ghidra:

### Extracting Symbols with Ghidra

#### 1. Preparing Ghidra
Ensure you have Ghidra installed on your system. If not, download it from the [Ghidra project page](https://ghidra-sre.org/) and follow the installation instructions.

#### 2. Importing the ELF Binary
- Launch Ghidra and start a new project (or open an existing one).
- Import the ELF binary file (e.g., the Widevine CDM library from the Android device) by navigating to `File` > `Import File` and selecting the binary.
- Choose the default options for the import settings, unless you have specific requirements.

#### 3. Analyzing the Binary
- Once the binary is imported, double-click on it in the project window to open it in the CodeBrowser tool.
- Begin the analysis by navigating to `Analysis` > `Auto Analyze` from the top menu.
- In the "Auto Analysis" window, ensure all relevant analyzers are selected, especially those related to symbol and function discovery. Click "Analyze" to start the process.
- Wait for the analysis to complete, which may take some time depending on the binary's size and complexity.

#### 4. Exporting Symbols as XML
- After analysis, navigate to `File` > `Export Program...`.
- In the "Export Program" window, choose the "XML" format from the dropdown menu.
- Click "Options" and ensure that only the "Symbols" option is selected. This step is crucial as it filters the export to include only the symbols necessary for KeyDive, making the XML file more manageable and relevant.
- Choose a destination for the `symbols.xml` file and confirm the export.

#### 5. Using the Symbols with KeyDive
Once you have the `symbols.xml` file:

- Ensure KeyDive is set up according to its documentation.
- When running KeyDive, use the `--symbols` argument to specify the path to your `symbols.xml` file. For example:
  ```shell
  python keydive.py --device <DEVICE_ID> --symbols /path/to/symbols_x86.xml
  ```
- Proceed with the key extraction process as detailed in KeyDive's usage instructions.

### Additional Tips

- **Understanding Symbols:** The `symbols.xml` file maps function names and variables within the Widevine CDM library, enabling KeyDive to correctly identify and hook into specific processes for key extraction.
- **Ghidra Compatibility:** Ensure your version of Ghidra supports the binary format you're analyzing. Newer versions of Ghidra typically offer better support for a wide range of binary formats.
- **Analysis Depth:** While a full analysis is recommended, you can customize the analysis options based on your understanding of the binary and the symbols you are specifically interested in. This can significantly reduce analysis time.
- **Security Considerations:** Be aware of the security implications of extracting and handling DRM keys. Always comply with legal restrictions and ethical guidelines when using tools like KeyDive and Ghidra for reverse engineering.

By following these steps, you can generate a `symbols.xml` file that aids in the effective use of KeyDive for educational, research, or security analysis purposes.
Release v1.0.2 2024-03-31 13:27:10 +00:00			`# Symbols`

			To utilize custom symbols with KeyDive, particularly when extracting Widevine L3 DRM keys from Android devices, you might need to generate a `symbols.xml` file using Ghidra. This file helps KeyDive accurately identify necessary symbols within the Widevine library, facilitating a more efficient extraction process. Below is a step-by-step guide on how to create a `symbols.xml` file using Ghidra:

			`### Extracting Symbols with Ghidra`

			`#### 1. Preparing Ghidra`
			`Ensure you have Ghidra installed on your system. If not, download it from the [Ghidra project page](https://ghidra-sre.org/) and follow the installation instructions.`

			`#### 2. Importing the ELF Binary`
			`- Launch Ghidra and start a new project (or open an existing one).`
			- Import the ELF binary file (e.g., the Widevine CDM library from the Android device) by navigating to `File` > `Import File` and selecting the binary.
			`- Choose the default options for the import settings, unless you have specific requirements.`

			`#### 3. Analyzing the Binary`
			`- Once the binary is imported, double-click on it in the project window to open it in the CodeBrowser tool.`
			- Begin the analysis by navigating to `Analysis` > `Auto Analyze` from the top menu.
			`- In the "Auto Analysis" window, ensure all relevant analyzers are selected, especially those related to symbol and function discovery. Click "Analyze" to start the process.`
			`- Wait for the analysis to complete, which may take some time depending on the binary's size and complexity.`

			`#### 4. Exporting Symbols as XML`
			- After analysis, navigate to `File` > `Export Program...`.
			`- In the "Export Program" window, choose the "XML" format from the dropdown menu.`
Update SYMBOLS.md 2024-03-31 13:37:26 +00:00			`- Click "Options" and ensure that only the "Symbols" option is selected. This step is crucial as it filters the export to include only the symbols necessary for KeyDive, making the XML file more manageable and relevant.`
Release v1.0.2 2024-03-31 13:27:10 +00:00			- Choose a destination for the `symbols.xml` file and confirm the export.

			`#### 5. Using the Symbols with KeyDive`
			Once you have the `symbols.xml` file:

			`- Ensure KeyDive is set up according to its documentation.`
			- When running KeyDive, use the `--symbols` argument to specify the path to your `symbols.xml` file. For example:
			```shell
			`python keydive.py --device <DEVICE_ID> --symbols /path/to/symbols_x86.xml`
			```
			`- Proceed with the key extraction process as detailed in KeyDive's usage instructions.`

			`### Additional Tips`

			- Understanding Symbols: The `symbols.xml` file maps function names and variables within the Widevine CDM library, enabling KeyDive to correctly identify and hook into specific processes for key extraction.
			`- Ghidra Compatibility: Ensure your version of Ghidra supports the binary format you're analyzing. Newer versions of Ghidra typically offer better support for a wide range of binary formats.`
			`- Analysis Depth: While a full analysis is recommended, you can customize the analysis options based on your understanding of the binary and the symbols you are specifically interested in. This can significantly reduce analysis time.`
			`- Security Considerations: Be aware of the security implications of extracting and handling DRM keys. Always comply with legal restrictions and ethical guidelines when using tools like KeyDive and Ghidra for reverse engineering.`

			By following these steps, you can generate a `symbols.xml` file that aids in the effective use of KeyDive for educational, research, or security analysis purposes.