Installation¶

This guide will help you install and set up friTap for SSL/TLS traffic analysis.

Source of truth for frida version compatibility: compat.yml. All version statements in this document derive from it; if you spot a discrepancy, please file an issue.

System Requirements¶

Minimum Requirements¶

• Python: 3.10 or higher
• Frida: 17.x (see Frida compatibility)
• Operating System: Linux, Windows, macOS
• Memory: 512 MB RAM (minimum)
• Storage: 50 MB free disk space

Recommended Requirements¶

• Python: 3.10 or higher
• Frida: 17.x (latest patch)
• Memory: 2 GB RAM or more
• Storage: 1 GB free disk space

Installation Methods¶

Method 1: PyPI Installation (Recommended)¶

The easiest way to install friTap is through PyPI:

pip install fritap

For the latest version:

pip install --upgrade fritap

Method 2: Development Installation¶

If you want to modify friTap or contribute to its development:

# Clone the repository
git clone https://github.com/fkie-cad/friTap.git
cd friTap

# Install in development mode
pip install -e .

# Install with development dependencies
pip install -e .[dev]

Optional extras¶

friTap's crypto backend now ships in the base install, so offline protocol decryption works out of the box with pip install friTap (no extra needed). On platforms with a wheel, the optional tgcrypto accelerator is pulled in automatically too; the only remaining extra is dev. See Telegram (MTProto) for details.

If you want a lean install that skips the crypto backend, install without dependencies and use the minimal requirements:

pip install friTap --no-deps && pip install -r requirements-minimal.txt

In that lean mode offline decryption simply prints a pip install cryptography hint and skips (no crash); live key capture works regardless.

Platform-Specific Setup¶

Linux¶

1. Install dependencies:

   # Ubuntu/Debian
   sudo apt update
   sudo apt install python3-pip python3-dev build-essential
   
   # CentOS/RHEL/Fedora
   sudo yum install python3-pip python3-devel gcc
   

2. Install friTap:

   pip3 install fritap
   

3. Set up permissions (for desktop applications):

   # Add your user to the root group or use sudo
   sudo usermod -a -G root $USER
   

Windows¶

1. Install Python from python.org
2. Install Visual Studio Build Tools (if needed)

3. Install friTap:

   pip install fritap
   

4. Run as Administrator for desktop applications

macOS¶

1. Install Homebrew (if not already installed):

   /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
   

2. Install Python:

   brew install python3
   

3. Install friTap:

   pip3 install fritap
   

4. Disable SIP (if analyzing system applications):

   # Boot into Recovery Mode and run:
   csrutil disable
   

Mobile Platform Setup¶

Android¶

1. Enable Developer Options on your Android device
2. Enable USB Debugging

3. Install ADB on your computer:

   # Linux/macOS
   sudo apt install android-tools-adb  # Ubuntu/Debian
   brew install android-platform-tools # macOS
   
   # Windows
   # Download from https://developer.android.com/studio/releases/platform-tools
   

4. Install frida-server on Android:

   # Download frida-server for your Android architecture
   # Extract and push to device
   adb push frida-server /data/local/tmp/
   adb shell chmod 755 /data/local/tmp/frida-server
   
   # Run frida-server (requires root)
   adb shell su -c "/data/local/tmp/frida-server &"
   

iOS¶

1. Jailbreak your iOS device (required for friTap)

2. Install OpenSSH and Frida from Cydia:

   # Add frida repository in Cydia
   # https://build.frida.re/
   

3. Install frida-server:

   # SSH into your device
   ssh root@your-device-ip
   
   # Install frida-server
   cydia://package/re.frida.server
   

Verification¶

After installation, verify that friTap is working correctly:

# Check version
fritap --version

# Check help
fritap --help

Expected Output¶

friTap v2.0.8
Usage: fritap [OPTIONS] TARGET

Options:
  -m, --mobile                    Mobile application analysis
  -k, --keylog PATH               Save TLS keys to file
  -p, --pcap PATH                 Save decrypted traffic to PCAP
  --help                          Show this message and exit

Common Installation Issues¶

Issue: Permission Denied¶

Problem: Permission denied when running friTap

Solution:

# Linux/macOS
sudo fritap [options] target

# Windows
# Run Command Prompt as Administrator

Issue: Frida Not Found¶

Problem: frida: command not found

Solution:

# Install frida-tools
pip install frida-tools

# Verify installation
frida --version

Issue: Python Version Compatibility¶

Problem: friTap requires Python 3.10+

Solution:

# Check Python version
python3 --version

# Install newer Python version
# Follow platform-specific Python installation guides

Issue: ADB Not Found (Android)¶

Problem: adb: command not found

Solution:

# Linux
sudo apt install android-tools-adb

# macOS
brew install android-platform-tools

# Windows
# Download Android SDK Platform Tools
# Add to system PATH

Next Steps¶

Once friTap is installed, you can:

1. Read the Quick Start Guide for basic usage
2. Explore Usage Examples for specific scenarios
3. Check Platform Guides for detailed setup instructions
4. Review Troubleshooting if you encounter issues

Dependencies¶

friTap automatically installs the following dependencies:

• frida (>= 17.0.0, < 18.0.0): Core instrumentation framework
• frida-tools (>= 14.0.0, < 15.0.0): Frida command-line tools
• scapy: Network packet manipulation
• AndroidFridaManager: Android device management
• rich (>= 13.0.0): Terminal output formatting
• hexdump: Binary data display
• watchdog: File system monitoring
• psutil: System and process utilities
• textual (>= 0.80.0): Powers the interactive terminal UI (ships by default; no extra install needed)
• tlsLibHunter: TLS/SSL library detection — powers --library-scan, -ll/--list-libraries and --extract-libraries (imported as tlslibhunter)
• platformdirs, pydantic (>= 2.0): Configuration and platform-aware paths
• h11, hpack, pylsqpack: HTTP/1, HTTP/2 and HTTP/3 (QPACK) parsing
• zstandard (>= 0.19), brotli (>= 1.0): Response body decompression

Optional Dependencies¶

For enhanced functionality:

# Wireshark for live analysis
sudo apt install wireshark

# tcpdump for packet capture
sudo apt install tcpdump

# Development tools
pip install pytest ruff mypy