Skip to content

Commit

Permalink
minor updates in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
monkeywave committed Dec 2, 2024
1 parent 845d59c commit 81fed85
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,26 @@
</p>

# friTap
![version](https://img.shields.io/badge/version-1.2.4.0-blue) [![PyPI version](https://d25lcipzij17d.cloudfront.net/badge.svg?id=py&r=r&ts=1683906897&type=6e&v=1.2.4.0&x2=0)](https://badge.fury.io/py/friTap)
![version](https://img.shields.io/badge/version-1.2.4.3-blue) [![PyPI version](https://d25lcipzij17d.cloudfront.net/badge.svg?id=py&r=r&ts=1683906897&type=6e&v=1.2.4.3&x2=0)](https://badge.fury.io/py/friTap)

The goal of this project is to help researchers to analyze traffic encapsulated in SSL or TLS. For details have a view into the [OSDFCon webinar slides](assets/friTapOSDFConwebinar.pdf) or in [this blog post](https://lolcads.github.io/posts/2022/08/fritap/).


This project was inspired by [SSL_Logger](https://github.com/google/ssl_logger ) and currently supports all major operating systems (Linux, Windows, Android). More platforms and libraries will be added in future releases.

## Installation
## Key Features

The main features of friTap are:

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`.
- TLS key extraction in real time (`-k key.log`)
- Decryption of TLS payload as PCAP in real time (`-p plaintext.pcap`)
- Integration with Python. [Learn more](https://github.com/fkie-cad/friTap/blob/main/INTEGRATION.md)
- Support for custom Frida scripts. [Details](https://github.com/fkie-cad/friTap/blob/main/USAGE.md#Using-friTap-with-a-custom-Frida-scripts)
- Support of most common SSL libraries (OpenSSL, BoringSSL, NSS, GnuTLS, etc.)

Alternatively just clone the repository and run the `friTap.py` file.
## 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

Expand All @@ -29,7 +35,7 @@ $ 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 --pcap mycapture.pcap com.example.app
$ fritap -m -k keys.log com.example.app
```

Further ensure that the frida-server is running on the Android/iOS device.
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ def get_version():
version=get_version(), # Dynamically get the version from about.py

# The description that will be shown on PyPI.
description="Decrypts and logs a process's SSL/TLS traffic on all major platforms. Further it allows the TLS key extraction.",
description="Simplifying SSL/TLS traffic analysis for researchers by making SSL/TLS decryption effortless. Decrypts and logs a process's SSL/TLS traffic on all major platforms. Further it allows the SSL/TLS key extraction.",

# The content that will be shown on your project page.
# In this case, we're displaying whatever is there in our README.md file
Expand Down

0 comments on commit 81fed85

Please sign in to comment.