YAML Metadata Warning:empty or missing yaml metadata in repo card
Check out the documentation for more information.
TPL-Benchmark
TPL-Benchmark is a benchmark dataset for evaluating Android third-party library detection tools. This repository provides Android applications collected from multiple sources, together with their APK files, source code, locally imported library files, and manually/automatically generated third-party library labels at the GAV level.
In addition to the benchmark data, this repository also releases the intermediate and final outputs of 10 representative third-party library detection tools, as well as the code used by our TPL extraction pipeline.
Repository Structure
TPL-Benchmark/
βββ all_fdroid.zip
βββ all_readme_src_apk.zip
βββ unzip_all_releases_apk_src.zip
βββ src_with_apk.zip
βββ different_tools_result/
βββ unique_tpls_with_version.txt
βββ unique_tpls_without_version.txt
βββ TPL-Extractor/
βββ channel_fdroid/
β βββ no_files.txt
β βββ only_gradle.txt
β βββ only_kts.txt
β βββ both_files.txt
Benchmark Data Archives
1. all_fdroid.zip
This archive contains Android applications collected from F-Droid.
For each application, the archive includes:
- the APK file;
- the corresponding source code;
- locally imported library files, if any;
- label files describing which third-party libraries are included in the APK.
The label files are in .txt format. Their filenames usually contain the word label, such as label.txt.
Compared with the other sources, the F-Droid archive contains one additional directory level for application categories.
A typical directory structure is:
all_fdroid/
βββ <category>/
βββ <application>/
βββ <apk file>
βββ <source code folder>
βββ <local library folder>
βββ label.txt
2. all_readme_src_apk.zip
This archive contains Android applications collected from the README with APKs source.
For each application, the archive includes:
- the APK file;
- the corresponding source code;
- locally imported library files, if any;
- label files describing which third-party libraries are included in the APK.
The label files are in .txt format. Their filenames usually contain the word label, such as label.txt.
The directory structure of all_readme_src_apk.zip is consistent with that of unzip_all_releases_apk_src.zip.
A typical directory structure is:
all_readme_src_apk/
βββ <application or repository>/
βββ <apk file>
βββ <source code folder>
βββ <local library folder>
βββ label.txt
3. unzip_all_releases_apk_src.zip
This archive contains Android applications collected from GitHub Releases with APKs.
For each application, the archive includes:
- the APK file;
- the corresponding source code;
- locally imported library files, if any;
- label files describing which third-party libraries are included in the APK.
The label files are in .txt format. Their filenames usually contain the word label.
For GitHub Releases with APKs, one project may contain multiple APK files. Therefore, one project may also contain multiple label files. These label files are distinguished according to the corresponding APK name. For example:
abc.apk
abc_label.txt
A typical directory structure is:
unzip_all_releases_apk_src/
βββ <application or repository>/
βββ <apk file 1>
βββ <apk file 2>
βββ <source code folder>
βββ <local library folder>
βββ <apk name 1>_label.txt
βββ <apk name 2>_label.txt
4. src_with_apk.zip
This archive contains Android applications collected from GitHub Source with APKs.
For this source, the source code folder contains a folder named label. The label folder stores:
- the APK file;
- locally imported library files, if any;
- label files describing which third-party libraries are included in the APK.
For GitHub Source with APKs, one project may contain multiple APK files. Therefore, one project may also contain multiple label files. These label files are distinguished according to the corresponding APK name, such as abc_label.txt.
A typical directory structure is:
src_with_apk/
βββ <application or repository>/
βββ <source code files>
βββ label/
βββ <apk file 1>
βββ <apk file 2>
βββ <local library folder>
βββ <apk name 1>_label.txt
βββ <apk name 2>_label.txt
Label File Format
Each application has one or more label files describing the third-party libraries included in the corresponding APK.
The label files are in .txt format. Their filenames usually contain the word label, such as:
label.txt
abc_label.txt
Each label entry records a third-party library coordinate at the GAV level, namely:
Group ID : Artifact ID : Version
The label entries may appear in one of the following two formats.
Format 1:
"com.faendir:acra:4.10.0"
Format 2:
Group ID: joda-time, Artifact ID: joda-time, Version: 2.11.1
Both formats describe the same type of information: the group ID, artifact ID, and version of a third-party library.
Tool Results
The directory different_tools_result/ stores the intermediate and final results of 10 Android third-party library detection tools used in our evaluation.
The 10 tools are:
Depending on the design of each tool, this directory may contain:
- intermediate library feature files;
- intermediate application feature files;
- processed reference library data;
- processed APK feature data;
- final detection results;
- other tool-specific intermediate outputs.
These files are released to support reproducibility and to help future researchers compare their tools with existing third-party library detection methods under the same benchmark setting.
Library Coordinate Files
unique_tpls_with_version.txt
This file records all third-party library coordinates in TPL-Benchmark at the GAV level.
Each entry contains:
Group ID : Artifact ID : Version
Example:
com.faendir:acra:4.10.0
unique_tpls_without_version.txt
This file records all third-party library coordinates in TPL-Benchmark at the GA level.
Each entry contains:
Group ID : Artifact ID
This file removes the version information and can be used for GA-level analysis or evaluation.
TPL Extraction Pipeline
The directory TPL-Extractor/ contains the code of our pipeline for extracting GAV-level third-party library coordinates from Android source code.
The pipeline is used to identify third-party library dependencies from Android projects and generate the corresponding GAV-level labels for benchmark construction.
F-Droid Channel Files
The directory channel_fdroid/ contains four files that categorize F-Droid source projects according to their build script types.
no_files.txt
This file contains Android application projects that are not built by Gradle.
These projects may be hybrid or non-standard Android projects built with frameworks or languages such as:
- Flutter
- Cordova
- React Native
- Rust
- other customized build systems
only_gradle.txt
This file contains projects that only use Groovy-based Gradle build scripts.
The corresponding build script file is:
build.gradle
only_kts.txt
This file contains projects that only use Kotlin-based Gradle build scripts.
The corresponding build script file is:
build.gradle.kts
both_files.txt
This file contains projects that include both Groovy-based and Kotlin-based Gradle build scripts.
That is, these projects contain both:
build.gradle
build.gradle.kts
Reference Library Database
The reference library database used for detailed similarity-based methods is released in a separate HuggingFace repository:
https://huggingface.co/datasets/gujintao/old_all_jar
This repository contains the downloaded AAR/JAR artifacts used as the reference library database.
Notes on Multiple APKs
For the following two data sources, one project may contain multiple APK files:
- GitHub Releases with APKs;
- GitHub Source with APKs.
In such cases, the project may contain multiple label files. Each label file corresponds to a specific APK and is distinguished by the APK name.
For example:
abc.apk
abc_label.txt
This means that abc_label.txt records the third-party libraries contained in abc.apk.
Purpose of the Release
This repository is released to support the reproducibility of TPL-Benchmark.
Specifically, it provides:
- benchmark APKs;
- corresponding source code;
- locally imported libraries;
- GAV-level and GA-level third-party library labels;
- source-channel information;
- the TPL extraction pipeline;
- intermediate and final outputs of 10 evaluated third-party library detection tools;
- the reference library database used by detailed comparison-based methods.
We hope this release can help future research on Android third-party library detection, dependency analysis, and software supply-chain security.
- Downloads last month
- 19