Ghidra is a software reverse engineering (SRE) framework
/* ###
* IP: GHIDRA
*
* 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
*
* http://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.
*/
package help.screenshot;
import static ghidra.util.datastruct.Duo.Side.*;
import java.io.IOException;
import javax.swing.table.TableColumn;
import javax.swing.table.TableColumnModel;
import org.junit.Test;
import docking.action.DockingActionIf;
import docking.widgets.dialogs.TableSelectionDialog;
import docking.widgets.table.GFilterTable;
import docking.widgets.table.GTable;
import ghidra.app.cmd.disassemble.DisassembleCommand;
import ghidra.app.util.viewer.listingpanel.ListingPanel;
import ghidra.features.base.codecompare.listing.ListingCodeComparisonView;
import ghidra.features.base.codecompare.panel.FunctionComparisonPanel;
import ghidra.features.codecompare.plugin.FunctionComparisonPlugin;
import ghidra.features.codecompare.plugin.FunctionComparisonProvider;
import ghidra.program.model.address.Address;
import ghidra.program.model.address.AddressSet;
import ghidra.program.model.listing.*;
import ghidra.program.model.mem.Memory;
import ghidra.program.model.mem.MemoryAccessException;
import ghidra.program.model.symbol.SourceType;
import ghidra.util.InvalidNameException;
import ghidra.util.exception.DuplicateNameException;
import ghidra.util.exception.InvalidInputException;
import util.CollectionUtils;
public class FunctionComparisonScreenShots extends GhidraScreenShotGenerator {
private static final String TEST_SOURCE_PROGRAM_NAME = "VersionTracking/WallaceSrc";
private static final String TEST_DESTINATION_PROGRAM_NAME = "VersionTracking/WallaceVersion2";
private FunctionComparisonPlugin plugin;
private Program sourceProgram;
private Program destinationProgram;
@Override
public void setUp() throws Exception {
super.setUp();
plugin = getPlugin(tool, FunctionComparisonPlugin.class);
destinationProgram = loadProgram(TEST_DESTINATION_PROGRAM_NAME);
sourceProgram = loadProgram(TEST_SOURCE_PROGRAM_NAME);
}
@Override
public void tearDown() throws Exception {
super.tearDown();
}
@Test
public void testFunctionComparisonWindow() {
positionListingTop(0x004118f0);
int txId1 = sourceProgram.startTransaction("Modify Program1");
int txId2 = destinationProgram.startTransaction("Modify Program2");
try {
sourceProgram.getDomainFile().setName("FirstProgram");
destinationProgram.getDomainFile().setName("SecondProgram");
sourceProgram.setName("FirstProgram");
destinationProgram.setName("SecondProgram");
Listing sourceListing = sourceProgram.getListing();
Listing destListing = destinationProgram.getListing();
Memory sourceMemory = sourceProgram.getMemory();
Function f1 = getFunction(sourceProgram, addr(0x004118f0));
f1.setName("FunctionA", SourceType.USER_DEFINED);
sourceListing.setComment(addr(0x004118f0), CommentType.PLATE, null);
sourceListing.clearCodeUnits(addr(0x004119b1), addr(0x004119b4), false);
sourceMemory.setByte(addr(0x004119b2), (byte) 0x55);
sourceMemory.setByte(addr(0x004119b4), (byte) 0x52);
disassemble(sourceProgram, 0x004119b1, 4, false);
Function f2 = getFunction(destinationProgram, addr(0x004118c0));
f2.setName("FunctionB", SourceType.USER_DEFINED);
destListing.setComment(addr(0x004118c0), CommentType.PLATE, null);
plugin.createComparison(f1, f2);
FunctionComparisonProvider provider =
waitForComponentProvider(FunctionComparisonProvider.class);
FunctionComparisonPanel functionComparisonPanel = provider.getComponent();
runSwing(() -> {
functionComparisonPanel.setActiveView("Listing View");
ListingCodeComparisonView dualListing =
(ListingCodeComparisonView) functionComparisonPanel.getDisplayedView();
ListingPanel leftPanel = dualListing.getListingPanel(LEFT);
leftPanel.goTo(addr(0x004119aa));
});
waitForSwing();
captureIsolatedProvider(FunctionComparisonProvider.class, 1200, 550);
}
catch (DuplicateNameException | InvalidInputException | MemoryAccessException
| InvalidNameException | IOException e) {
e.printStackTrace();
}
finally {
destinationProgram.endTransaction(txId2, false);
sourceProgram.endTransaction(txId1, false);
}
}
@Test
public void testAddToComparisonIcon() {
Function f1 = getFunction(sourceProgram, addr(0x004118f0));
Function f2 = getFunction(destinationProgram, addr(0x004118c0));
plugin.createComparison(f1, f2);
captureActionIcon("Add Functions To Comparison");
}
@Test
public void testRemoveFromComparisonIcon() {
Function f1 = getFunction(sourceProgram, addr(0x004118f0));
Function f2 = getFunction(destinationProgram, addr(0x004118c0));
plugin.createComparison(f1, f2);
captureActionIcon("Remove Functions");
}
@Test
public void testNavNextIcon() {
Function f1 = getFunction(sourceProgram, addr(0x004118f0));
Function f2 = getFunction(destinationProgram, addr(0x004118c0));
plugin.createComparison(CollectionUtils.asSet(f1, f2));
captureActionIcon("Compare Next Function");
}
@Test
public void testNavPreviousIcon() {
Function f1 = getFunction(sourceProgram, addr(0x004118f0));
Function f2 = getFunction(destinationProgram, addr(0x004118c0));
plugin.createComparison(CollectionUtils.asSet(f1, f2));
captureActionIcon("Compare Previous Function");
}
@Test
public void testAddFunctionsPanel() {
Function f1 = getFunction(sourceProgram, addr(0x004118f0));
Function f2 = getFunction(destinationProgram, addr(0x004118c0));
plugin.createComparison(CollectionUtils.asSet(f1, f2));
waitForSwing();
DockingActionIf openTableAction = getAction(tool, "Add Functions To Comparison");
performAction(openTableAction, false);
TableSelectionDialog<?> dialog = waitForDialogComponent(TableSelectionDialog.class);
setColumnSizes(dialog);
captureDialog(dialog);
}
private void setColumnSizes(TableSelectionDialog<?> dialog) {
// note: these values are rough values found by trial-and-error
GFilterTable<?> filter = (GFilterTable<?>) getInstanceField("gFilterTable", dialog);
GTable table = filter.getTable();
runSwing(new Runnable() {
@Override
public void run() {
TableColumnModel columnModel = table.getColumnModel();
int columnCount = columnModel.getColumnCount();
for (int i = 0; i < columnCount; i++) {
TableColumn column = columnModel.getColumn(i);
Object headerValue = column.getHeaderValue();
if ("Name".equals(headerValue)) {
column.setPreferredWidth(100);
}
else if ("Location".equals(headerValue)) {
column.setPreferredWidth(70);
}
else if ("Function Signature".equals(headerValue)) {
column.setPreferredWidth(200);
}
else if ("Function Size".equals(headerValue)) {
column.setPreferredWidth(25);
}
}
}
});
}
private Function getFunction(Program program1, Address entryPoint) {
FunctionManager functionManager = program1.getFunctionManager();
return functionManager.getFunctionAt(entryPoint);
}
private void disassemble(Program pgm1, long addressAsLong, int length, boolean followFlows) {
Address address = addr(addressAsLong);
DisassembleCommand cmd = new DisassembleCommand(address,
new AddressSet(address, address.add(length - 1)), followFlows);
cmd.applyTo(pgm1);
}
}