diff --git a/README.md b/README.md new file mode 100644 index 0000000..566f335 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# Androscalpel + +Androscalpel is a rust crate to manipulate Android application bytecode (dalvik). + +This developed between 2022 and 2025 by Jean-Marie Mineau for their PhD thesis, and release under the GPLv3 licence with the permission of CentraleSupelec. + +# Documentation + +The documentation can be generated with `cargo doc`. +It will be generated at `target/doc/androscalpel/index.html` + +Right now, the recompilation process is a little complexe, an example can be found [here](./androscalpel/examples/count_ins_and_genapk.rs). + +# Note + +The Dalvik v41 format (concatenated DEX files) is not currently supported. +Support is planned in the future. diff --git a/androscalpel/Cargo.toml b/androscalpel/Cargo.toml index 1bf5edc..087da1e 100644 --- a/androscalpel/Cargo.toml +++ b/androscalpel/Cargo.toml @@ -2,6 +2,7 @@ name = "androscalpel" version = "0.1.0" edition = "2024" +license = "GPL-3.0-or-later" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [lib] diff --git a/androscalpel_platform_api_list/Cargo.toml b/androscalpel_platform_api_list/Cargo.toml index 2eb6034..2edff07 100644 --- a/androscalpel_platform_api_list/Cargo.toml +++ b/androscalpel_platform_api_list/Cargo.toml @@ -2,6 +2,7 @@ name = "androscalpel_platform_api_list" version = "0.1.0" edition = "2024" +license = "GPL-3.0-or-later" [dependencies] diff --git a/androscalpel_serializer/Cargo.toml b/androscalpel_serializer/Cargo.toml index 6decc72..e5053fc 100644 --- a/androscalpel_serializer/Cargo.toml +++ b/androscalpel_serializer/Cargo.toml @@ -2,6 +2,7 @@ name = "androscalpel_serializer" version = "0.1.0" edition = "2024" +license = "GPL-3.0-or-later" [dependencies] androscalpel_serializer_derive = { path = "../androscalpel_serializer_derive" } diff --git a/androscalpel_serializer_derive/Cargo.toml b/androscalpel_serializer_derive/Cargo.toml index f104560..b44390d 100644 --- a/androscalpel_serializer_derive/Cargo.toml +++ b/androscalpel_serializer_derive/Cargo.toml @@ -2,6 +2,7 @@ name = "androscalpel_serializer_derive" version = "0.1.0" edition = "2024" +license = "GPL-3.0-or-later" [lib] proc-macro = true diff --git a/apk_frauder/Cargo.toml b/apk_frauder/Cargo.toml index fa0a34c..c3c951b 100644 --- a/apk_frauder/Cargo.toml +++ b/apk_frauder/Cargo.toml @@ -2,6 +2,7 @@ name = "apk_frauder" version = "0.1.0" edition = "2024" +license = "GPL-3.0-or-later" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html