fritap

Simplifying SSL/TLS traffic analysis for researchers by making SSL decryption effortless.

https://github.com/fkie-cad/fritap

Keywords

Repository

Simplifying SSL/TLS traffic analysis for researchers by making SSL decryption effortless.

README.md

Real-time key extraction and traffic decryption for security research

friTap

friTap is a powerful tool designed to assist researchers in analyzing network traffic encapsulated in SSL/TLS. With its ability to automate key extraction, friTap is especially valuable when dealing with malware analysis or investigating privacy issues in applications. By simplifying the process of decrypting and inspecting encrypted traffic, friTap empowers researchers to uncover critical insights with ease.

Key features include seamless support for automated SSL/TLS key extraction, making it an ideal choice for scenarios requiring rapid and accurate traffic analysis. Whether you’re dissecting malicious network behavior or assessing data privacy compliance, friTap streamlines your workflow.

For more details, explore the OSDFCon webinar slides or check out our blog post.

This project was inspired by SSL_Logger and currently supports all major operating systems (Linux, Windows, Android). More platforms and libraries will be added in future releases.

Key Features

The main features of friTap are:

• TLS key extraction in real time (-k key.log)
• Decryption of TLS payload as PCAP in real time (-p plaintext.pcap)
• Library analysis and debugging (--list-libraries)
• Integration with Python. Learn more
• Support for custom Frida scripts. Details
• Support of most common SSL libraries (OpenSSL, BoringSSL, NSS, GnuTLS, etc.)

Installation

Installation is simply a matter of pip3 install fritap. This will give you the fritap command. You can update an existing fritap installation with pip3 install --upgrade fritap.

Usage

On Linux/Windows/MacOS we can easily attach to a process by entering its name or its PID:

bash $ sudo fritap --pcap mycapture.pcap thunderbird

For mobile applications we just have to add the -m parameter to indicate that we are now attaching (or spawning) an Android or iOS app:

bash $ fritap -m -k keys.log com.example.app

Further ensure that the frida-server is running on the Android/iOS device.

Remember when working with the pip installation you have to invoke the fritap command with sudo a little bit different. Either as module: bash $ sudo -E python3 -m friTap.friTap --pcap mycapture.pcap thunderbird or directly invoking the script: ```bash $ which friTap /home/daniel/.local/bin/friTap

$ sudo -E /home/daniel/.local/bin/friTap ```

friTap can also be used as a Python library within your project: python from friTap import SSL_Logger For more details on integrating friTap into your Python project, check out the INTEGRATION.md guide.

friTap allows you to enhance its functionality by providing a custom Frida script during your session. This custom script will be invoked just before friTap applies its own hooks. To do so, use the -c parameter (more). More examples on using friTap can be found in the USAGE.md. A detailed introduction using friTap on Android is under EXAMPLE.md as well.

Hooking Libraries Without Symbols

In certain scenarios, the library we want to hook offers no symbols or is statically linked with other libraries, making it challenging to directly hook functions. For example Cronet (libcronet.so) and Flutter (libflutter.so) are often statically linked with BoringSSL.

Despite the absence of symbols, we can still use friTap for parsing and hooking.

Hooking by Byte Patterns

To solve this, we can use friTap with byte patterns to hook the desired functions. You can provide friTap with a JSON file that contains byte patterns for hooking specific functions, based on architecture and platform using the --patterns <byte-pattern-file.json> option. In order to apply the apprioate hooks for the various byte patterns we distinguish between different hooking categories. These categories include:

• Dump-Keys
• Install-Key-Log-Callback
• KeyLogCallback-Function
• SSL_Read
• SSL_Write

Each category has a primary and fallback byte pattern, allowing flexibility when the primary pattern fails. For libraries like BoringSSL, where TLS functionality is often statically linked into other binaries, we developed a tool called BoringSecretHunter. This tool automatically identifies the necessary byte patterns to hook BoringSSL by byte-pattern matching. BoringSecretHunter is available as a Docker container with pre-configured Ghidra environment:

```bash

Create directories and copy target libraries

mkdir -p binary results cp /path/to/libflutter.so binary/

Run BoringSecretHunter

docker run --rm -v "$(pwd)/binary":/usr/local/src/binaries -v "$(pwd)/results":/host_output boringsecrethunter

Use generated patterns with friTap

fritap --patterns results/libflutter.sopatterns.json -k keys.log targetapp ```

More about the different hooking categories can be found in usage of byte-patterns in friTap.

Hooking by Offsets

Alternatively, you can use the --offsets <offset-file.json> option to hook functions using known offsets. friTap allows you to specify user-defined offsets (relative to the base address of the targeting SSL/socket library) or absolute virtual addresses for function resolution. This is done through a JSON file, which is passed using the --offsets parameter.

If the --offsets parameter is used, friTap will only overwrite the function addresses specified in the JSON file. For functions that are not specified, friTap will attempt to detect the addresses automatically (using symbols).

Problems

The absence of traffic or incomplete traffic capture in the resulting pcap file (-p ) may stem from various causes. Before submitting a new issue, consider attempting the following solutions:

Default Socket Information

There might be instances where friTap fails to retrieve socket information. In such scenarios, running friTap with default socket information (--enable_default_fd) could resolve the issue. This approach utilizes default socket information (127.0.0.1:1234 to 127.0.0.1:2345) for all traffic when the file descriptor (FD) cannot be used to obtain socket details:

bash fritap -m --enable_default_fd -p plaintext.pcap com.example.app

Handling Subprocess Traffic

Traffic originating from a subprocess could be another contributing factor. To capture this traffic, friTap can leverage Frida's spawn gating feature, which intercepts newly spawned processes using the --enable_spawn_gating parameter:

bash fritap -m -p log.pcap --enable_spawn_gating com.example.app

Library Support exist only for Key Extraction

In cases where the target library solely supports key extraction (cf. the table below), you can utilize the -k <key.log> parameter alongside full packet capture:

bash fritap -m -p log.pcap --full_capture -k keys.log com.example.app

Seeking Further Assistance

If these approaches do not address your issue, please create a detailed issue report to aid in troubleshooting. To facilitate a more effective diagnosis, include the following information in your report:

• The operating system and its version
• The specific application encountering the issue or a comparable application that exhibits similar problems
• The output from executing friTap with the specified parameters, augmented with friTap's debug output: bash fritap -do -v com.example.app

Supported SSL/TLS implementations and corresponding logging capabilities

markdown | Library | Linux | Windows | MacOSX | Android | iOS | |---------------------------|---------------|---------------|----------|----------|--------------| | OpenSSL | Full | R/W-Hook only | TBI | Full | TBI | | BoringSSL | Full | R/W-Hook only | KeyEo | Full | KeyEo | | NSS | Full | R/W-Hook only | TBI | TBA | TBI | | GnuTLS | R/W-Hook only | R/W-Hook only | TBI | Full | TBI | | WolfSSL | R/W-Hook only | R/W-Hook only | TBI | Full | TBI | | MbedTLS | R/W-Hook only | R/W-Hook only | TBI | Full | TBI | | Bouncycastle/Spongycastle | TBA | TBA | TBA | Full | TBA | | Conscrypt | TBA | TBA | TBA | Full | TBA | | S2n-tls | Full | LibNO | TBA | Full | LibNO | | RusTLS | KeyEo | TBI | TBI | KeyEo | TBI | R/W-Hook only = Logging data sent and received by process
KeyEo = Only the keying material can be extracted
Full = Logging data send and received by process + Logging keys used for secure connection
TBA = To be answered
TBI = To be implemented
LibNO = This library is not supported for this plattform

We verified the Windows implementations only for Windows 10

Dependencies

• frida (>= 17)
• >= python3.7
• click (python3 -m pip install click)
• hexdump (python3 -m pip install hexdump)
• scapy (python3 -m pip install scapy)
• watchdog (python3 -m pip install watchdog)
• importlib.resources (python3 -m pip install importlib-resources)
• AndroidFridaManager (python3 -m pip install AndroidFridaManager)
• for hooking on Android ensure that the adb-command is in your PATH

Planned features

• [ ] add the capability to alter the decrypted payload
  • integration with https://github.com/mitmproxy/mitmproxy
  • integration with http://portswigger.net/burp/
• [ ] add wine support
• [x] add Flutter support
• [ ] add further libraries (have a look at this Wikipedia entry):
  • Botan (BSD license, Jack Lloyd)
  • LibreSSL (OpenBSD)
  • Cryptlib (Peter Gutmann)
  • JSSE (Java Secure Socket Extension, Oracle)
  • MatrixSSL
  • ...
• [x] Working with static linked libraries
• [x] Add feature to prototype TLS-Read/Write/SSLKEY functions
• [ ] improve iOS/MacOS support (currently under development)

Development

Quick Development Setup

For developers who want to contribute to friTap, we provide an automated setup:

```bash

Clone and setup development environment

git clone https://github.com/fkie-cad/friTap.git cd friTap

Automated setup (recommended)

python setup_dev.py

Manual setup

pip install -r requirements-dev.txt pip install -e . npm install # For TypeScript agent compilation ```

Testing

friTap includes a comprehensive testing framework:

```bash

Run all fast tests

python run_tests.py --fast

Run specific test categories

python runtests.py unit # Unit tests python runtests.py agent # Agent compilation tests
python run_tests.py integration # Mock integration tests

Generate coverage report

python run_tests.py coverage ```

Development Dependencies

• Python 3.7+ with development dependencies (requirements-dev.txt)
• Node.js 16+ for TypeScript agent compilation
• Testing framework: pytest with comprehensive mocking
• Code quality: black, flake8, mypy, pre-commit hooks

See DEVELOPMENT.md for detailed development setup and testing guide.

Contribute

Contributions are always welcome. Just fork it and open a pull request! More details can be found in the CONTRIBUTION.md.

Changelog

See the wiki for release notes.

How to Cite friTap

If you use friTap in your research, please cite the following paper:

Daniel Baier, Alexander Basse, Jan-Niclas Hilgert, Martin Lambertz
TLS key material identification and extraction in memory: current state and future challenges
Forensic Science International: Digital Investigation, Volume 49, 2024, 301766.
https://doi.org/10.1016/j.fsidi.2024.301766

📄 BibTeX

bibtex @article{baier2024tls, title={TLS key material identification and extraction in memory: current state and future challenges}, author={Baier, Daniel and Basse, Alexander and Hilgert, Jan-Niclas and Lambertz, Martin}, journal={Forensic Science International: Digital Investigation}, volume={49}, pages={301766}, year={2024}, publisher={Elsevier}, doi={10.1016/j.fsidi.2024.301766} }

Alternatively, you can find a citation file in CITATION.cff or use the “Cite this repository” button on GitHub.

Support

If you have any suggestions, or bug reports, please create an issue in the Issue Tracker.

In case you have any questions or other problems, feel free to send an email to:

daniel.baier@fkie.fraunhofer.de.