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 skeleton;
import java.io.IOException;
import java.util.*;
import ghidra.app.util.Option;
import ghidra.app.util.bin.ByteProvider;
import ghidra.app.util.opinion.AbstractProgramWrapperLoader;
import ghidra.app.util.opinion.LoadSpec;
import ghidra.framework.model.DomainObject;
import ghidra.program.model.listing.Program;
import ghidra.util.exception.CancelledException;
/**
* Provide class-level documentation that describes what this loader does.
*/
public class SkeletonLoader extends AbstractProgramWrapperLoader {
@Override
public String getName() {
// Name the loader. This name must match the name of the loader in the .opinion files.
return "My loader";
}
@Override
public Collection<LoadSpec> findSupportedLoadSpecs(ByteProvider provider) throws IOException {
List<LoadSpec> loadSpecs = new ArrayList<>();
// Examine the bytes in 'provider' to determine if this loader can load it. If it
// can load it, return the appropriate load specifications.
return loadSpecs;
}
@Override
protected void load(Program prgram, ImporterSettings settiings)
throws CancelledException, IOException {
// Load the bytes from 'settings.provider()' into the 'program'.
}
@Override
public List<Option> getDefaultOptions(ByteProvider provider, LoadSpec loadSpec,
DomainObject domainObject, boolean isLoadIntoProgram, boolean mirrorFsLayout) {
List<Option> list = super.getDefaultOptions(provider, loadSpec, domainObject,
isLoadIntoProgram, mirrorFsLayout);
// If this loader has custom options, add them to 'list'
list.add(Option.newString("Option name goes here")
.value("Default option value goes here")
.build());
return list;
}
@Override
public String validateOptions(ByteProvider provider, LoadSpec loadSpec, List<Option> options,
Program program) {
// If this loader has custom options, validate them here. Not all options require
// validation.
return super.validateOptions(provider, loadSpec, options, program);
}
}