The highest tagged major version is
README
¶
Ghidra-Script-Runner
A Golang package for running Ghidra Scripts (Thread Safe)
Documentation
¶
Index ¶
- type Configuration
- type GhidraScriptTask
- func (ghidraScriptTask *GhidraScriptTask) GetTaskID() *string
- func (ghidraScriptTask *GhidraScriptTask) GetTaskStatus() *GhidraTaskStatus
- func (ghidraScriptTask *GhidraScriptTask) RunTask(ghidraConfig *Configuration) (successful bool)
- func (ghidraScriptTask *GhidraScriptTask) SetTaskStatus(queueStatus *GhidraTaskStatus)
- type GhidraTask
- type GhidraTaskService
- func (ghidraTaskService *GhidraTaskService) AddNewTaskToQueue(task GhidraTask)
- func (ghidraTaskService *GhidraTaskService) AddToQueue(taskID, script *string)
- func (ghidraTaskService *GhidraTaskService) GetAllStatus() map[string]*GhidraTaskStatus
- func (ghidraTaskService *GhidraTaskService) GetStatusByTaskID(taskID *string) *GhidraTaskStatus
- func (ghidraTaskService *GhidraTaskService) IsQueueEmpty() bool
- func (ghidraTaskService *GhidraTaskService) RemoveFromQueueByTaskID(taskID *string)
- func (ghidraTaskService *GhidraTaskService) UpdateTaskStatusByTaskID(taskID *string, statusUpdate GhidraTaskStatus)
- type GhidraTaskStatus
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Configuration ¶
type Configuration struct {
// contains filtered or unexported fields
}
Configuration The ghidra configuration to be utilized for running scripts
func NewConfiguration ¶
func NewConfiguration(ghidraHeadless, ghidraProjectLocation, ghidraProject string) (*Configuration, error)
NewConfiguration returns a new ghidra configuration
type GhidraScriptTask ¶ added in v1.0.2
type GhidraScriptTask struct {
// contains filtered or unexported fields
}
GhidraScriptTask a single task for ghidra to execute
func NewGhidraScriptTask ¶ added in v1.0.2
func NewGhidraScriptTask(fileName, script *string) *GhidraScriptTask
NewGhidraScriptTask returns a new GhidraScriptTask struct, should be used instead of calling new
func (*GhidraScriptTask) GetTaskID ¶ added in v1.0.2
func (ghidraScriptTask *GhidraScriptTask) GetTaskID() *string
GetTaskID returns the taskID associated with this GhidraScriptTask struct
func (*GhidraScriptTask) GetTaskStatus ¶ added in v1.0.2
func (ghidraScriptTask *GhidraScriptTask) GetTaskStatus() *GhidraTaskStatus
GetTaskStatus returns the GhidraTaskStatus associated with this GhidraScriptTask struct
func (*GhidraScriptTask) RunTask ¶ added in v1.0.2
func (ghidraScriptTask *GhidraScriptTask) RunTask(ghidraConfig *Configuration) (successful bool)
RunTask run the task assigned to this GhidraScriptTask struct
func (*GhidraScriptTask) SetTaskStatus ¶ added in v1.0.2
func (ghidraScriptTask *GhidraScriptTask) SetTaskStatus(queueStatus *GhidraTaskStatus)
SetTaskStatus sets the GhidraTaskStatus of this GhidraScriptTask to the argument passed to this method
type GhidraTask ¶ added in v1.0.2
type GhidraTask interface {
RunTask(config *Configuration) bool
GetTaskID() *string
GetTaskStatus() *GhidraTaskStatus
SetTaskStatus(status *GhidraTaskStatus)
}
GhidraTask a single task for the queue
type GhidraTaskService ¶ added in v1.0.2
type GhidraTaskService struct {
// contains filtered or unexported fields
}
GhidraTaskService the service utilized to run ghidra scripts and manage the task queue.
func NewGhidraTaskService ¶ added in v1.0.2
func NewGhidraTaskService(config *Configuration) *GhidraTaskService
NewGhidraTaskService used to create a new ghidra task service. Required to start polling task
func (*GhidraTaskService) AddNewTaskToQueue ¶ added in v1.0.2
func (ghidraTaskService *GhidraTaskService) AddNewTaskToQueue(task GhidraTask)
AddNewTaskToQueue takes a GhidraQueueTask and adds it to the task queue
func (*GhidraTaskService) AddToQueue ¶ added in v1.0.2
func (ghidraTaskService *GhidraTaskService) AddToQueue(taskID, script *string)
AddToQueue adds a new task to the queue
func (*GhidraTaskService) GetAllStatus ¶ added in v1.0.2
func (ghidraTaskService *GhidraTaskService) GetAllStatus() map[string]*GhidraTaskStatus
GetAllStatus returns a map with the status of all task in the queue.
func (*GhidraTaskService) GetStatusByTaskID ¶ added in v1.0.2
func (ghidraTaskService *GhidraTaskService) GetStatusByTaskID(taskID *string) *GhidraTaskStatus
GetStatusByTaskID returns the current status of a task currently in the queue.
func (*GhidraTaskService) IsQueueEmpty ¶ added in v1.0.2
func (ghidraTaskService *GhidraTaskService) IsQueueEmpty() bool
IsQueueEmpty returns a bool indicating whether the queue is empty
func (*GhidraTaskService) RemoveFromQueueByTaskID ¶ added in v1.0.2
func (ghidraTaskService *GhidraTaskService) RemoveFromQueueByTaskID(taskID *string)
RemoveFromQueueByTaskID removes a task from the queue
func (*GhidraTaskService) UpdateTaskStatusByTaskID ¶ added in v1.0.2
func (ghidraTaskService *GhidraTaskService) UpdateTaskStatusByTaskID(taskID *string, statusUpdate GhidraTaskStatus)
UpdateTaskStatusByTaskID updates the status of a task currently in the queue.
type GhidraTaskStatus ¶ added in v1.0.2
type GhidraTaskStatus string
GhidraTaskStatus the status of a task in the queue
Source Files