macOS releases now adjust the Yara-X library location. #132

Author: travisgoodspeed

CMakeLists.txt

@@ -32,6 +32,9 @@ pkg_check_modules(YARAX IMPORTED_TARGET yara_x_capi)
 if (YARAX_FOUND)
     set(YARAX PkgConfig::YARAX )
     message(STATUS "Found yarax: ${YARAX}")
+    # Sometimes macOS doesn't include /usr/local/include.
+    include_directories(${YARAX_INCLUDE_DIRS})
+
 else()
     message(STATUS "Yarax not found.  Will build without it.")
 endif()
@@ -162,7 +165,7 @@ qt_add_executable(maskromtool
 qt_create_translation(QM_FILES ${CMAKE_SOURCE_DIR} ${TS_FILES})
 target_link_libraries(maskromtool PRIVATE Qt6::Widgets
         Qt6::Charts Qt6::PrintSupport
-        libgoodasm ${READLINE} ${YARAX_LIBRARIES})
+        libgoodasm ${READLINE} ${YARAX_LINK_LIBRARIES})
 
 
 set_target_properties(maskromtool PROPERTIES
@@ -182,7 +185,7 @@ if(WIN32)
     )
     target_link_libraries(maskromtoolcli PRIVATE Qt6::Widgets
             Qt6::Charts Qt6::PrintSupport
-            libgoodasm ${READLINE} ${YARAX_LIBRARIES} )
+            libgoodasm ${READLINE} ${YARAX_LINK_LIBRARIES} )
     qt_finalize_executable(maskromtoolcli)
     install(TARGETS maskromtoolcli DESTINATION bin)
 endif()
@@ -200,7 +203,7 @@ add_executable(gatorom
   gatomain.cpp
 )
 target_link_libraries(gatorom Qt6::Core
-        Qt6::PrintSupport libgoodasm ${READLINE} ${YARAX_LIBRARIES})
+        Qt6::PrintSupport libgoodasm ${READLINE} ${YARAX_LINK_LIBRARIES})
 
 install(TARGETS gatorom
     LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR})

README.md

@@ -129,7 +129,7 @@ Building the tool is easiest from the CLI.  In Debian Bullseye (11.x),
 ```
 % sudo apt install make gcc g++ cmake git qt6-base-dev libqt6charts6-dev \
 qt6-translations-l10n linguist-qt6 qt6-l10n-tools qt6-tools-\* qt6-image-formats-plugins \
-libreadline-dev qt6-declarative-dev
+libreadline-dev qt6-declarative-dev pkgconfig
 % git clone https://github.com/travisgoodspeed/maskromtool/
 ...
 % cd maskromtool
@@ -156,7 +156,7 @@ On macOS, you might need to run 'xattr -dr com.apple.quarantine *` if
 you get warnings about the signature not being recognized.
 
 
-To install on macOS, first install XCode, [Homebrew](https://brew.sh),
+To build on macOS, first install XCode, [Homebrew](https://brew.sh),
 and [Qt for Open Source](https://www.qt.io/download-qt-installer-oss),
 which sadly requires an account.  After that, you can open
 `CMakeLists.txt` in QT Creator or use the release script to build.
@@ -172,7 +172,7 @@ You can also build it without the official Qt installer or App,
 through Homebrew alone.  This is roughly like what we'd do in Linux.
 
 ```
-% brew install cmake emacs qt
+% brew install cmake emacs qt pkgconfig
 % git submodule init
 % git submodule update --remote
 ...
@@ -181,6 +181,27 @@ through Homebrew alone.  This is roughly like what we'd do in Linux.
 % make -j 8 && sudo make install
 ```
 
+## Optional Libraries
+
+### YaraX
+
+[Yara-X](https://github.com/VirusTotal/yara-x) is a pattern matching
+library that's popular in the malware research world.  MaskRomTool and
+GatoROM support it as an optional library, for solving unkown layouts.
+Yara-X is automatically included when PkgConfig is available and its C
+API [has been
+installed](https://virustotal.github.io/yara-x/docs/api/c/c-/).
+
+```
+% git clone https://github.com/VirusTotal/yara-x
+...
+% cd yara-x
+% cargo install cargo-c
+...
+% cargo cinstall -p yara-x-capi --release
+... (If error here, make your user own /usr/local/lib and include.)
+```
+
 ## GUI Usage
 
 First use File/Open ROM to open a ROM image as a photograph.  Try to

buildrelease-macos.sh

@@ -11,9 +11,9 @@ set -e
 ## These paths are hardcoded to prevent Homebrew for gunking things
 ## up.  Be sure to install *everything* in that version of Qt, or
 ## you'll be missing important libraries like QtCharts.
-export QTDIR=~/Qt/6.9.2/macos/bin
-export CMAKE=~/Qt/6.9.2/macos/bin/qt-cmake
-export DEPLOYQT=~/Qt/6.9.2/macos/bin/macdeployqt
+export QTDIR=~/Qt/6.10.0/macos/bin
+export CMAKE=~/Qt/6.10.0/macos/bin/qt-cmake
+export DEPLOYQT=~/Qt/6.10.0/macos/bin/macdeployqt
 
 
 
@@ -34,8 +34,9 @@ cp -rf build/maskromtool.app build/gatorom build/extern/goodasm/goodasm release/
 # Set the rpath so that the CLI tools run.
 (cd release && install_name_tool -add_rpath @executable_path/maskromtool.app/Contents/Frameworks goodasm )
 (cd release && install_name_tool -add_rpath @executable_path/maskromtool.app/Contents/Frameworks gatorom )
+(cd release && install_name_tool -change /usr/local/lib/libyara_x_capi.1.dylib @executable_path/maskromtool.app/Contents/Frameworks/libyara_x_capi.1.dylib gatorom )
 # Hardcoding the executable is bad, but the Homebrew version will break the build.
-$DEPLOYQT release/maskromtool.app -dmg -sign-for-notarization="Developer ID Application: Travis Goodspeed"
+$DEPLOYQT release/maskromtool.app -dmg -sign-for-notarization="Apple Distribution: Travis Goodspeed (F56DQ35SUJ)"
 # Verify the signature
 codesign --verify --verbose  release/maskromtool.app