Skip to content

Commit a3971b4

Browse files
emesareemesare
committed
WARP 1.0
- Added FFI - Added a sidebar to the UI - Added project, directory and archive processing - Added generic `Container` interface for extensible stores of WARP data - Fixed type references being constructed and pulled incorrectly - Added HTML, Markdown and JSON report generation - Made the WARP information added as an analysis activity - Flattened the signatures directory, the target information is stored in the file now - Matched function information is stored as function metadata in the database to reliably persist, alongside the function GUID - Split the matching out from the application, allowing you to match on a given function without applying it - Added more/better tests - Added support for binaries with multiple architectures, the functions are now also queried based off the Target, see WARP spec for more details - Greatly improved support for RISC architectures, see WARP spec for more details - Greatly improved UX when loading files after the fact, will now sanely rerun the matcher - Omitted the function type if not a user type, this greatly reduces file size - Improved support for functions that reference a page aligned base pointer, see WARP spec for more details - Removed some extra cache structures that were causing erroneous behavior - Fixed edge-case in LLIL traversal missing some constant pointers, this was a bug in the Rust bindings - Added support for function comments - Made long running tasks, such as generating, matching and loading signatures, cancellable where possible - Made function constraints more versatile, allowing for easy extensions in the future, see WARP spec for details - Added options to signature generation, such as what data to store, and whether to compress the data or not - Made all long running tasks prompt the user for required information before the task starts, allowing users to "set it and forget it" and not have to baby sit the finalization of the task - Myriad of other changes to the actual WARP format that impact performance, file size and general feature set, see https://github.com/Vector35/warp for more details
1 parent 4e89e81 commit a3971b4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

83 files changed

+11309
-3113
lines changed

‎Cargo.lock‎

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎plugins/warp/CMakeLists.txt‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,13 @@ file(GLOB_RECURSE PLUGIN_SOURCES CONFIGURE_DEPENDS
2121
${PROJECT_SOURCE_DIR}/Cargo.toml
2222
${PROJECT_SOURCE_DIR}/src/*.rs)
2323

24+
# Add API library.
25+
add_subdirectory(api)
26+
# Add UI plugin.
27+
if(NOT HEADLESS)
28+
add_subdirectory(ui)
29+
endif()
30+
2431
if(CMAKE_BUILD_TYPE MATCHES Debug)
2532
set(TARGET_DIR ${PROJECT_BINARY_DIR}/target/debug)
2633
set(CARGO_OPTS --target-dir=${PROJECT_BINARY_DIR}/target)
@@ -38,8 +45,14 @@ endif()
3845
set(CARGO_FEATURES "--no-default-features")
3946
set(OUTPUT_FILE_NAME ${CMAKE_SHARED_LIBRARY_PREFIX}${PROJECT_NAME}${CMAKE_SHARED_LIBRARY_SUFFIX})
4047
set(OUTPUT_PDB_NAME ${CMAKE_SHARED_LIBRARY_PREFIX}${PROJECT_NAME}.pdb)
48+
set(OUTPUT_LIB_NAME ${CMAKE_SHARED_LIBRARY_PREFIX}${PROJECT_NAME}.dll.lib)
4149
set(OUTPUT_FILE_PATH ${BN_CORE_PLUGIN_DIR}/${CMAKE_SHARED_LIBRARY_PREFIX}${PROJECT_NAME}${CMAKE_SHARED_LIBRARY_SUFFIX})
4250
set(OUTPUT_PDB_PATH ${BN_CORE_PLUGIN_DIR}/${CMAKE_SHARED_LIBRARY_PREFIX}${PROJECT_NAME}.pdb)
51+
set(OUTPUT_LIB_PATH ${BN_CORE_PLUGIN_DIR}/${PROJECT_NAME}.lib)
52+
53+
# warp_ninja_interface is the target hack im going with for now to get warp_api to build on windows
54+
add_library(${PROJECT_NAME}_interface INTERFACE)
55+
add_dependencies(${PROJECT_NAME}_interface ${PROJECT_NAME})
4356

4457
add_custom_target(${PROJECT_NAME} ALL DEPENDS ${OUTPUT_FILE_PATH})
4558
add_dependencies(${PROJECT_NAME} binaryninjaapi)
@@ -109,11 +122,12 @@ if(APPLE)
109122
endif()
110123
elseif(WIN32)
111124
add_custom_command(
112-
OUTPUT ${OUTPUT_FILE_PATH}
125+
OUTPUT ${OUTPUT_FILE_PATH} ${OUTPUT_PDB_PATH} ${OUTPUT_LIB_PATH}
113126
COMMAND ${CMAKE_COMMAND} -E env BINARYNINJADIR=${BINJA_LIB_DIR} ${RUSTUP_COMMAND} clean ${CARGO_OPTS} --package binaryninjacore-sys
114127
COMMAND ${CMAKE_COMMAND} -E env BINARYNINJADIR=${BINJA_LIB_DIR} ${RUSTUP_COMMAND} build ${CARGO_OPTS} ${CARGO_FEATURES}
115128
COMMAND ${CMAKE_COMMAND} -E copy ${TARGET_DIR}/${OUTPUT_FILE_NAME} ${OUTPUT_FILE_PATH}
116129
COMMAND ${CMAKE_COMMAND} -E copy ${TARGET_DIR}/${OUTPUT_PDB_NAME} ${OUTPUT_PDB_PATH}
130+
COMMAND ${CMAKE_COMMAND} -E copy ${TARGET_DIR}/${OUTPUT_LIB_NAME} ${OUTPUT_LIB_PATH}
117131
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
118132
DEPENDS ${PLUGIN_SOURCES} ${API_SOURCES}
119133
)

‎plugins/warp/Cargo.toml‎

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -10,32 +10,31 @@ crate-type = ["lib", "cdylib"]
1010
[dependencies]
1111
binaryninja = { workspace = true, features = ["rayon"] }
1212
binaryninjacore-sys.workspace = true
13-
warp = { git = "https://github.com/Vector35/warp/", rev = "0ee5a6f" }
13+
warp = { git = "https://github.com/Vector35/warp/", branch = "next" }
1414
log = "0.4"
15-
arboard = "3.4"
15+
itertools = "0.14.0"
16+
dashmap = { version = "6.1", features = ["rayon"]}
1617
rayon = "1.10"
17-
dashmap = "6.1"
18+
arboard = "3.4"
1819
walkdir = "2.5"
19-
rfd = "0.15"
20+
serde = { version = "1.0", features = ["derive"] }
2021
serde_json = "1.0"
22+
uuid = { version = "1.12.0", features = ["v4"] }
23+
thiserror = "2.0"
24+
ar = { git = "https://github.com/mdsteele/rust-ar" }
25+
tempdir = "0.3.7"
26+
regex = "1.11"
2127

22-
# For sigem
23-
env_logger = { version = "0.11", optional = true }
24-
clap = { version = "4.5", features = ["derive"], optional = true }
25-
ar = { git = "https://github.com/mdsteele/rust-ar", optional = true }
26-
tempdir = { version = "0.3.7", optional = true }
28+
# For reports
29+
minijinja = "2.10.2"
30+
minijinja-embed = "2.10.2"
2731

28-
[dev-dependencies]
29-
criterion = "0.5.1"
30-
insta = { version = "1.38.0", features = ["yaml"] }
32+
[build-dependencies]
33+
minijinja-embed = "2.10.2"
3134

32-
[features]
33-
default = ["sigem"]
34-
sigem = ["env_logger", "clap", "ar", "tempdir"]
35-
36-
[[bin]]
37-
name = "sigem"
38-
required-features = ["sigem"]
35+
[dev-dependencies]
36+
criterion = "0.6"
37+
insta = { version = "1.42", features = ["yaml"] }
3938

4039
[[bench]]
4140
name = "guid"

‎plugins/warp/api/CMakeLists.txt‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
cmake_minimum_required(VERSION 3.13 FATAL_ERROR)
2+
3+
project(warp_api CXX C)
4+
5+
add_library(warp_api STATIC warp.cpp warp.h warpcore.h)
6+
target_include_directories(warp_api PUBLIC ${PROJECT_SOURCE_DIR})
7+
8+
if (NOT BN_API_BUILD_EXAMPLES AND NOT BN_INTERNAL_BUILD)
9+
# Out-of-tree build
10+
find_path(
11+
BN_API_PATH
12+
NAMES binaryninjaapi.h
13+
HINTS ../.. binaryninjaapi $ENV{BN_API_PATH}
14+
REQUIRED
15+
)
16+
add_subdirectory(${BN_API_PATH} api)
17+
endif()
18+
19+
# Make sure the core rust dylib is built before warp_api.
20+
add_dependencies(warp_api warp_ninja)
21+
22+
target_link_libraries(warp_api binaryninjaui)
23+
24+
if (NOT DEMO)
25+
add_subdirectory(python)
26+
endif()
27+
28+
# Link to the warp plugin.
29+
# TODO: Need to make this less scuffed, but this will do for now.
30+
if (WIN32)
31+
# By linking to warp_ninja_interface we insure that we get built _after_ the lib has been generated.
32+
target_link_libraries(${PROJECT_NAME} warp_ninja_interface "${BN_CORE_PLUGIN_DIR}/warp_ninja.lib")
33+
else ()
34+
target_link_libraries(${PROJECT_NAME} warp_ninja_interface ${BN_CORE_PLUGIN_DIR}/libwarp_ninja${CMAKE_SHARED_LIBRARY_SUFFIX})
35+
endif()
36+
37+
set_target_properties(warp_api PROPERTIES
38+
CXX_STANDARD 17
39+
CXX_VISIBILITY_PRESET hidden
40+
CXX_STANDARD_REQUIRED ON
41+
VISIBILITY_INLINES_HIDDEN ON
42+
POSITION_INDEPENDENT_CODE ON
43+
ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/out)

‎plugins/warp/api/python/CMakeLists.txt‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
cmake_minimum_required(VERSION 3.9...3.15 FATAL_ERROR)
2+
3+
project(warp-python-api)
4+
5+
file(GLOB PYTHON_SOURCES ${PROJECT_SOURCE_DIR}/*.py)
6+
list(REMOVE_ITEM PYTHON_SOURCES ${PROJECT_SOURCE_DIR}/_warpcore.py)
7+
list(REMOVE_ITEM PYTHON_SOURCES ${PROJECT_SOURCE_DIR}/enums.py)
8+
9+
add_executable(warp_generator
10+
${PROJECT_SOURCE_DIR}/generator.cpp)
11+
target_link_libraries(warp_generator binaryninjaapi)
12+
target_include_directories(warp_generator PUBLIC {PROJECT_SOURCE_DIR}/../../api)
13+
14+
set_target_properties(warp_generator PROPERTIES
15+
CXX_STANDARD 17
16+
CXX_STANDARD_REQUIRED ON
17+
BUILD_WITH_INSTALL_RPATH OFF
18+
RUNTIME_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR})
19+
20+
if(BN_INTERNAL_BUILD)
21+
set(PYTHON_OUTPUT_DIRECTORY ${BN_RESOURCE_DIR}/python/binaryninja/warp/)
22+
else()
23+
set(PYTHON_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/out/plugins/warp/)
24+
endif()
25+
26+
if(WIN32)
27+
if (BN_INTERNAL_BUILD)
28+
add_custom_command(TARGET warp_generator PRE_BUILD
29+
COMMAND ${CMAKE_COMMAND} -E copy ${BN_CORE_OUTPUT_DIR}/binaryninjacore.dll ${PROJECT_BINARY_DIR}/)
30+
else()
31+
add_custom_command(TARGET warp_generator PRE_BUILD
32+
COMMAND ${CMAKE_COMMAND} -E copy ${BN_INSTALL_DIR}/binaryninjacore.dll ${PROJECT_BINARY_DIR}/)
33+
endif()
34+
endif()
35+
36+
add_custom_target(warp_generator_copy ALL
37+
BYPRODUCTS ${PROJECT_SOURCE_DIR}/_warpcore.py ${PROJECT_SOURCE_DIR}/enums.py
38+
DEPENDS ${PYTHON_SOURCES} ${PROJECT_SOURCE_DIR}/../warpcore.h $<TARGET_FILE:warp_generator>
39+
COMMAND ${CMAKE_COMMAND} -E echo "Copying WARP Python Sources"
40+
COMMAND ${CMAKE_COMMAND} -E make_directory ${PYTHON_OUTPUT_DIRECTORY}
41+
COMMAND ${CMAKE_COMMAND} -E env ASAN_OPTIONS=detect_leaks=0 $<TARGET_FILE:warp_generator>
42+
${PROJECT_SOURCE_DIR}/../warpcore.h
43+
${PROJECT_SOURCE_DIR}/_warpcore.py
44+
${PROJECT_SOURCE_DIR}/_warpcore_template.py
45+
${PROJECT_SOURCE_DIR}/warp_enums.py
46+
47+
COMMAND ${CMAKE_COMMAND} -E copy ${PYTHON_SOURCES} ${PYTHON_OUTPUT_DIRECTORY}
48+
COMMAND ${CMAKE_COMMAND} -E copy ${PROJECT_SOURCE_DIR}/_warpcore.py ${PYTHON_OUTPUT_DIRECTORY}
49+
COMMAND ${CMAKE_COMMAND} -E copy ${PROJECT_SOURCE_DIR}/warp_enums.py ${PYTHON_OUTPUT_DIRECTORY})
50+

‎plugins/warp/api/python/__init__.py‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import os
2+
3+
from binaryninja._binaryninjacore import BNGetUserPluginDirectory
4+
user_plugin_dir = os.path.realpath(BNGetUserPluginDirectory())
5+
current_path = os.path.realpath(__file__)
6+
7+
from .warp import *

0 commit comments

Comments
 (0)