FoRREST

Platform:Unix
Class Authors:Authors: Logan Rickert, Cole Loewer, David Sutherin
Standard:Flake8
class FoRREST.FoRREST
get_extracted_data(params=None)
Description:
Gets a dictionary of all of the extracted data.
Returns:
dict(str : (list | str)) - {
‘type’: str, ‘version’: str, ‘architecture’: int, ‘compiler’: str, ‘sections’: list

}

get_file(params=None)
Description:
Gets the filename and path of the current file. Returns None if no file.
Returns:
str? - The name and filepath of the file.
get_help(params=None)
Description:
Prints to std a message of help that is read in from help.txt.
Returns:
None
get_interpreted_data(params=None)
Description:
Gets a dictionary of all of the raw metadata.
Returns:
dict(str : int) - {
‘opcodes’: list, ‘strings’: list, ‘imports’: list, ‘exports’: list, ‘header_information’: list,

}

get_raw_data(params=None)
Description:
Gets a dictionary of all of the raw metadata.
Returns:
dict(str : (int | str)) - {
‘name’: str, ‘extension’: str, ‘size’: int, ‘md5’: str, ‘sha1’: str, ‘sha256’: str

}

set_file(params)
Description:
Sets the file to be used.
Args:
str - The name of the file. [str] - The name of the file (first element of list).
Example:
binaries/mybin.out
Returns:
None

Previous topic

Welcome to FoRREST’s documentation!

Next topic

Plugins

This Page