Package ghidra.features.base.memsearch.matcher

Class MaskedByteSequenceByteMatcher

java.lang.Object

ghidra.features.base.memsearch.matcher.UserInputByteMatcher

ghidra.features.base.memsearch.matcher.MaskedByteSequenceByteMatcher

All Implemented Interfaces:

ByteMatcher<SearchData>

public class MaskedByteSequenceByteMatcher
extends UserInputByteMatcher

ByteMatcher where the user search input has been parsed into a sequence of bytes and masks to be used for searching a byte sequence.

Field Summary

Fields inherited from class ghidra.features.base.memsearch.matcher.UserInputByteMatcher

searchData

Constructor Summary

Constructors

Constructor	Description
MaskedByteSequenceByteMatcher(String input, byte[] bytes, byte[] masks, SearchSettings settings)	Constructor that includes a mask byte for each search byte.
MaskedByteSequenceByteMatcher(String input, byte[] bytes, SearchSettings settings)	Constructor where no masking will be required.

Method Summary

Modifier and Type	Method	Description
byte[]	getBytes()
String	getDescription()	Returns a description of what this byte matcher matches.
byte[]	getMask()
String	getToolTip()	Returns additional information about this byte matcher.
Iterable<Match<SearchData>>	match(ExtendedByteSequence byteSequence)	Returns an Iterable for returning matches within the given byte sequence.

Methods inherited from class ghidra.features.base.memsearch.matcher.UserInputByteMatcher

equals, getInput, getName, getSearchData, getSettings, hashCode, isValidInput, isValidSearch, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

MaskedByteSequenceByteMatcher

public MaskedByteSequenceByteMatcher(String input,
 byte[] bytes,
 SearchSettings settings)

Constructor where no masking will be required. The bytes must match exactly.

Parameters:

input - the input text used to create this matcher

bytes - the sequence of bytes to use for searching

settings - the SearchSettings used to parse the input text

MaskedByteSequenceByteMatcher

public MaskedByteSequenceByteMatcher(String input,
 byte[] bytes,
 byte[] masks,
 SearchSettings settings)

Constructor that includes a mask byte for each search byte.

Parameters:

input - the input text used to create this matcher

bytes - the sequence of bytes to use for searching

masks - the sequence of mask bytes to use for search. Each mask byte will be applied to the bytes being search before comparing them to the target bytes.

settings - the SearchSettings used to parse the input text

Method Details

match

public Iterable<Match<SearchData>> match(ExtendedByteSequence byteSequence)

Description copied from class: UserInputByteMatcher

Returns an Iterable for returning matches within the given byte sequence.

Specified by:

match in interface ByteMatcher<SearchData>

Specified by:

match in class UserInputByteMatcher

Parameters:

byteSequence - the byte sequence to search

Returns:

an iterable for return matches in the given sequence

getDescription

public String getDescription()

Description copied from class: UserInputByteMatcher

Returns a description of what this byte matcher matches. (Typically a sequence of bytes)

Specified by:

getDescription in interface ByteMatcher<SearchData>

Specified by:

getDescription in class UserInputByteMatcher

Returns:

a description of what this byte matcher matches

getToolTip

public String getToolTip()

Description copied from class: UserInputByteMatcher

Returns additional information about this byte matcher. (Typically the mask bytes)

Specified by:

getToolTip in class UserInputByteMatcher

Returns:

additional information about this byte matcher

getBytes

public byte[] getBytes()

getMask

public byte[] getMask()