To build the native binaries for your current platform, execute the following script:
--<GhidraInstallDir>/support/buildNatives(.bat)
When this script successfully completes, Ghidra will contain newly built native binaries in +
To build the native binaries for your current platform, execute the following commands:
++++ cd <GhidraInstallDir>/support/gradle/ + gradle buildNatives ++
If you are connected to the Internet and do not have Gradle installed, execute:
++++ cd <GhidraInstallDir>/support/gradle/ + ./gradlew(.bat) buildNatives ++
When the commands successfully complete, Ghidra will contain newly built native binaries in the relevant modules' build/os/<platform>/ subdirectories, which will override any existing pre-built native binaries in the os/<platform>/ subdirectories.
diff --git a/README.md b/README.md index fc66d12629..451e231f8c 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ To create the latest development build for your platform from this source reposi ##### Install build tools: * [JDK 21 64-bit][jdk] -* [Gradle 8.5+][gradle] +* [Gradle 8.5+][gradle] (or provided Gradle wrapper if Internet connection is available) * [Python3][python3] (version 3.7 to 3.12) with bundled pip * make, gcc, and g++ (Linux/macOS-only) * [Microsoft Visual Studio][vs] 2017+ or [Microsoft C++ Build Tools][vcbuildtools] with the @@ -65,7 +65,9 @@ cd ghidra-master **NOTE:** Instead of downloading the compressed source, you may instead want to clone the GitHub repository: `git clone https://github.com/NationalSecurityAgency/ghidra.git` -##### Download additional build dependencies into source repository: +##### Download additional build dependencies into source repository: +**NOTE:** If an Internet connection is available and you did not install Gradle, the following +`gradle` commands may be replaced with `./gradle(.bat)`. ``` gradle -I gradle/support/fetchDependencies.gradle init ``` diff --git a/certification.local.manifest b/certification.local.manifest index 58244501fa..f5bd4d865f 100644 --- a/certification.local.manifest +++ b/certification.local.manifest @@ -1,4 +1,5 @@ ##VERSION: 2.0 +##MODULE IP: Apache License 2.0 .gitattributes||GHIDRA||||END| .gitignore||GHIDRA||||END| CONTRIBUTING.md||GHIDRA||||END| @@ -9,3 +10,5 @@ NOTICE||GHIDRA||||END| README.md||GHIDRA||||END| ghidra.repos.config||GHIDRA||||END| gradle.properties||GHIDRA||||END| +gradlew||Apache License 2.0||||END| +gradlew.bat||Apache License 2.0||||END| diff --git a/gradle/root/distribution.gradle b/gradle/root/distribution.gradle index 5b6b59624f..5f22665f10 100644 --- a/gradle/root/distribution.gradle +++ b/gradle/root/distribution.gradle @@ -346,14 +346,6 @@ task assembleDistribution (type: Copy) { into "Ghidra/patch" } - ///////////////////////////////// - // Distro native build support - ///////////////////////////////// - from (ROOT_PROJECT_DIR + "/GPL") { - include "settings.gradle" - into "Ghidra" - } - ///////////////////////////////// // Eclipse formatters ///////////////////////////////// @@ -400,7 +392,19 @@ project.PLATFORMS.each { platform -> // Make sure that we don't try to copy the same file with the same path into the // zip (this can happen!) duplicatesStrategy 'exclude' - + + ///////////////////////////////// + // Gradle Wrapper + ///////////////////////////////// + from (ROOT_PROJECT_DIR) { + if (isLinux(platform.name) || isMac(platform.name)) { + include "gradlew" + } + if (isWindows(platform.name)) { + include "gradlew.bat" + } + into "support/gradle" + } } } diff --git a/gradlew b/gradlew new file mode 100755 index 0000000000..5650f893ce --- /dev/null +++ b/gradlew @@ -0,0 +1,273 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +#------------Ghidra Additions ---------------------------------------------------------------------- + +# Set variables based on Production vs Dev environment +if [ -f "${APP_HOME}/gradle-wrapper.jar" ]; then + # Production Environment + CLASSPATH="${APP_HOME}/gradle-wrapper.jar" + GHIDRA_HOME="${APP_HOME}/../.." +else + # Development Environment (Eclipse classes or "gradle jar") + CLASSPATH="${APP_HOME}/Ghidra/RuntimeScripts/Common/support/gradle/gradle-wrapper.jar" + GHIDRA_HOME="${APP_HOME}" +fi + +# Read application properties +while IFS='=' read -r key value +do + key=$(echo $key | tr '.' '_') + eval ${key}=\${value} +done < "${GHIDRA_HOME}/Ghidra/application.properties" + +# Only proceed with wrapper if we are in single-repo PUBLIC/DEV mode +if [ -d "${GHIDRA_HOME}/../ghidra.bin" ] || ([ ${application_release_name} != "PUBLIC" ] && [ ${application_release_name} != "DEV" ]) ; then + echo "Please install Gradle ${application_gradle_min} or later and put it on your PATH." + exit 1 +fi +#--------------------------------------------------------------------------------------------------- + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000000..eb0c161e41 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,122 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + +@rem ------------Ghidra Additions ------------------------------------------------------------------ + +@rem Set variables based on Production vs Dev environment +if exist "%APP_HOME%\gradle-wrapper.jar" ( + @rem Production Environment + set "CLASSPATH=%APP_HOME%gradle-wrapper.jar" + set "GHIDRA_HOME=%APP_HOME%..\..\" +) else ( + @rem Development Environment (Eclipse classes or "gradle jar") + set "CLASSPATH=%APP_HOME%Ghidra\RuntimeScripts\Common\support\gradle\gradle-wrapper.jar" + set "GHIDRA_HOME=%APP_HOME%" +) + +@rem Read application properties +for /f "tokens=1,2 delims==" %%g in (%GHIDRA_HOME%Ghidra\application.properties) DO (set %%g=%%h) + +@rem Only proceed with wrapper if we are in single-repo PUBLIC/DEV mode +set PROCEED=1 +if exist "%GHIDRA_HOME%..\ghidra.bin" ( + set PROCEED=0 +) +if not "%application.release.name%" == "PUBLIC" ( + if not "%application.release.name%" == "DEV" ( + set PROCEED=0 + ) +) + +if %PROCEED% == 0 ( + echo Please install Gradle %application.gradle.min% or later and put it on your PATH. + goto fail +) +@rem ----------------------------------------------------------------------------------------------- + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega