yetangitu/ghidra
1
0
Fork 0
mirror of https://github.com/NationalSecurityAgency/ghidra.git synced 2025-10-03 09:49:23 +02:00
Code Issues Releases Wiki Activity

Merge remote-tracking branch 'origin/GP-5598_ryanmkurtz_GettingStarted'

Browse source
This commit is contained in:
Ryan Kurtz 2025-04-21 12:02:39 -04:00
commit 5a2957ff2a
10 changed files with 28 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

2
DevGuide.md
View file

@ -410,7 +410,7 @@ issues in Eclipse:
[java]: https://dev.java
[cpp]: https://isocpp.org
[sleigh]: https://htmlpreview.github.io/?https://github.com/NationalSecurityAgency/ghidra/blob/master/GhidraDocs/languages/index.html
[sleigh]: https://htmlpreview.github.io/?https://github.com/NationalSecurityAgency/ghidra/blob/stable/GhidraDocs/languages/index.html
[python]: https://www.python.org
[venv]: https://docs.python.org/3/tutorial/venv.html
[jython]: https://www.jython.org

4
Ghidra/Configurations/Public_Release/src/global/docs/WhatsNew.md
View file

@ -38,7 +38,7 @@ causing a full logout, check if your xorg-server has been updated to at least th
**NOTE:** Each build distribution will include native components (e.g., decompiler) for at least one
platform (e.g., Windows x86-64). If you have another platform that is not included in the build
distribution, you can build native components for your platform directly from the distribution.
See the *Installation Guide* for additional information. Users running with older shared libraries
See the *Getting Started* document for additional information. Users running with older shared libraries
and operating systems (e.g., CentOS 7.x) may also run into compatibility errors when launching
native executables such as the Decompiler and GNU Demangler which may necessitate a rebuild of
native components.
@ -67,7 +67,7 @@ up analysis on a given sample and running a Ghidra script locally. It also conta
to allow the use of CPython 3 from the Ghidra GUI.
To launch Ghidra in PyGhidra mode, run `./support/pyghidra` (or `support\pyghidra.bat`). See the
*"PyGhidra Mode"* section of the *Installation Guide* and `Ghidra/Features/PyGhidra/README.html`
*"PyGhidra Mode"* section of the *Getting Started* document and `Ghidra/Features/PyGhidra/README.html`
for more information.
## Visual Studio Code

3
Ghidra/Features/PyGhidra/src/main/py/README.md
View file

@ -12,7 +12,8 @@ Ghidra provides an out-of-the box integration with the PyGhidra Python library w
installation and usage fairly straightforward. This enables the Ghidra GUI and headless Ghidra to
run GhidraScript's written in native CPython 3, as well as interact with the Ghidra GUI through a
built-in REPL. To launch Ghidra in PyGhidra-mode, see Ghidra's latest
[Installation Guide](https://github.com/NationalSecurityAgency/ghidra/blob/master/GhidraDocs/InstallationGuide.md#pyghidra-mode).
[Getting Started](https://github.com/NationalSecurityAgency/ghidra/blob/stable/GhidraDocs/GettingStarted.md#pyghidra-mode)
document.
It is also possible (and encouraged!) to use PyGhidra as a standalone Python library for usage
in reverse engineering workflows where Ghidra may be one of many components involved. The following

19
Ghidra/RuntimeScripts/Common/server/svrREADME.md
View file

@ -53,20 +53,19 @@ __NOTE__: It is highly recommended that the installation files for Ghidra reside
and that the intended Ghidra Server process owner is granted full access to the Ghidra installation
directory (this is frequently not the case for NFS/SMB mounted home directories).
You may also refer to the _InstallationGuide.html_ file within the _docs/_ subdirectory for general
installation information.
You may also refer to the _GettingStarted.html_ file within the Ghidra installation root directory
for general installation information.
([Back to Top][top])
## Java Runtime Environment
The installation of a suitable Java Runtime Environment must be completed before installing or
running the Ghidra Server. Please refer to the Ghidra Installation Guide to identify
a suitable version. Since the Ghidra Server is unable to interactively identify a Java installation
at runtime it must rely upon the setting of `JAVA_HOME`, execution search PATH or the use of
standard Java installation locations. It is important to consider the service execution environment
which may differ from the administrator who may be installing the service. For this reason use of
an installed Java release may be preferable over one that is simply unpacked to an arbitrary
location.
running the Ghidra Server. Please refer to the Getting Started document to identify a suitable
version. Since the Ghidra Server is unable to interactively identify a Java installation at runtime
it must rely upon the setting of `JAVA_HOME`, execution search PATH or the use of standard Java
installation locations. It is important to consider the service execution environment which may
differ from the administrator who may be installing the service. For this reason use of an
installed Java release may be preferable over one that is simply unpacked to an arbitrary location.
([Back to Top][top])
@ -731,7 +730,7 @@ Please note that the Ghidra Server does not currently support Certificate Revoca
[Linux/macOS](#uninstall-service-must-have-admin-privilege)).
3. Unzip the new Ghidra distribution to a new installation directory (general unpacking and
installation guidelines may be found in _ghidra_x.x/docs/InstallationGuide.html_).
installation guidelines may be found in _ghidra_x.x/GettingStarted.html_).
4. Copy the old _repositories_ directory to the new Ghidra Server installation directory.

6
Ghidra/RuntimeScripts/Linux/support/launch.sh
View file

@ -140,7 +140,7 @@ fi
if [ "${JAVA_CMD}" == "" ]; then
echo
echo "ERROR: The 'java' command could not be found in your PATH or with JAVA_HOME."
echo "Please refer to the Ghidra Installation Guide's Troubleshooting section."
echo "Please refer to the Getting Started document's Troubleshooting section."
exit 1
fi
@ -151,7 +151,7 @@ if [ ! $? -eq 0 ]; then
if [ ! -t 0 ]; then
echo
echo "ERROR: Unable to prompt user for JDK path, no TTY detected."
echo "Please refer to the Ghidra Installation Guide's Troubleshooting section."
echo "Please refer to the Getting Started document's Troubleshooting section."
exit 1
fi
@ -163,7 +163,7 @@ if [ ! $? -eq 0 ]; then
if [ ! $? -eq 0 ]; then
echo
echo "ERROR: Failed to find a supported JDK."
echo "Please refer to the Ghidra Installation Guide's Troubleshooting section."
echo "Please refer to the Getting Started document's Troubleshooting section."
exit 1
fi
fi

4
Ghidra/RuntimeScripts/Windows/support/launch.bat
View file

@ -127,7 +127,7 @@ echo WARNING: JAVA_HOME environment variable is set to an invalid directory: %JA
:javaNotFound
echo.
echo ERROR: The 'java' command could not be found in your PATH or with JAVA_HOME.
echo Please refer to the Ghidra Installation Guide's Troubleshooting section.
echo Please refer to the Getting Started document's Troubleshooting section.
set ERRORLEVEL=1
goto exit1
@ -146,7 +146,7 @@ if "%LS_JAVA_HOME%" == "" (
if "!LS_JAVA_HOME!" == "" (
echo.
echo ERROR: Failed to find a supported JDK.
echo Please refer to the Ghidra Installation Guide's Troubleshooting section.
echo Please refer to the Getting Started document's Troubleshooting section.
set ERRORLEVEL=1
goto exit1
)

6
GhidraDocs/InstallationGuide.md → GhidraDocs/GettingStarted.md
View file

@ -1,6 +1,6 @@
# Ghidra Installation Guide
The installation information provided is effective as of Ghidra 11.3 and is subject to change with
future releases.
# Getting Started with Ghidra
The information provided in this document is effective as of Ghidra 11.4 and is subject to change
with future releases.
## Table of Contents
1. [Platforms Supported](#platforms-supported)

4
GhidraDocs/build.gradle
View file

@ -52,8 +52,8 @@ rootProject.assembleDistribution {
}
rootProject.assembleMarkdownToHtml {
from ("${this.projectDir}/InstallationGuide.md") {
into "docs"
from ("${this.projectDir}/GettingStarted.md") {
into "."
}
from ("${this.projectDir}/GhidraClass/BSim") {
include "*.md"

2
GhidraDocs/certification.manifest
View file

@ -9,6 +9,7 @@
##MODULE IP: Public Domain
##MODULE IP: Tango Icons - Public Domain
CheatSheet.html||GHIDRA||||END|
GettingStarted.md||GHIDRA||||END|
GhidraClass/Advanced/improvingDisassemblyAndDecompilation.pdf||GHIDRA||||END|
GhidraClass/Advanced/src/Examples/Makefile||GHIDRA||||END|
GhidraClass/Advanced/src/Examples/compilerVsDecompiler.s||GHIDRA||||END|
@ -192,7 +193,6 @@ GhidraClass/Intermediate/VersionTracking.html||GHIDRA|||This file contains mostl
GhidraClass/Intermediate/VersionTracking_withNotes.html||Public Domain|||Slight modification of code that is available for distribution, without restrictions, (original extremely permissive wtf license allows us to change IP to Public Domain),from https://github.com/paulrouget/dzslides.|END|
GhidraCodingStandards.html||GHIDRA||||END|
GhidraFilesystemStorage.html||GHIDRA||||END|
InstallationGuide.md||GHIDRA||||END|
images/B.gif||GHIDRA||||END|
images/D.gif||GHIDRA||||END|
images/F.gif||GHIDRA||||END|

6
README.md
View file

@ -37,8 +37,8 @@ To install an official pre-built multi-platform Ghidra release:
- or launch [PyGhidra][pyghidra]: `./support/pyGhidraRun` (`support\pyGhidraRun.bat` for Windows)
For additional information and troubleshooting tips about installing and running a Ghidra release,
please refer to the [Installation Guide][installationguide] which can be found in a Ghidra release
at `docs/InstallationGuide.html`.
please refer to the [Getting Started][gettingstarted] document which can be found at the root of a
Ghidra installation directory.
## Build
To create the latest development build for your platform from this source repository:
@ -128,7 +128,7 @@ source project.
[nsa]: https://www.nsa.gov
[contrib]: CONTRIBUTING.md
[devguide]: DevGuide.md
[installationguide]: GhidraDocs/InstallationGuide.md
[gettingstarted]: GhidraDocs/GettingStarted.md
[known-issues]: DevGuide.md#known-issues
[career]: https://www.intelligencecareers.gov/nsa
[releases]: https://github.com/NationalSecurityAgency/ghidra/releases