class Loader:
def __init__(self):
self.badges = Badges()
self.importer = Importer()
self.config = Config()
def load_update_process(self):
remote_config = requests.get(
'https://raw.githubusercontent.com/EntySec/HatSploit/main/config/core_config.yml',
stream=True)
remote_config = remote_config.content
if self.config.get_config_file(remote_config)['details']['version'] != \
self.config.core_config['details']['version']:
self.badges.output_warning(
"Your HatSploit Framework is out-dated.")
self.badges.output_information("Consider running ./update.sh")
time.sleep(1)
def load_components(self):
self.importer.import_all()
def load_everything(self):
self.load_update_process()
self.load_components()
def load_all(self):
loading_process = threading.Thread(target=self.load_everything)
loading_process.start()
base_line = "Loading the HatSploit Framework..."
cycle = 0
while loading_process.is_alive():
for char in "/-\|":
status = base_line + char + "\r"
cycle += 1
if status[cycle % len(status)] in list(string.ascii_lowercase):
status = status[:cycle % len(status)] + status[cycle % len(
status)].upper() + status[cycle % len(status) + 1:]
elif status[cycle % len(status)] in list(
string.ascii_uppercase):
status = status[:cycle % len(status)] + status[cycle % len(
status)].lower() + status[cycle % len(status) + 1:]
sys.stdout.write(self.badges.P + status)
time.sleep(.1)
sys.stdout.flush()
loading_process.join()
class Sessions:
def __init__(self):
self.badges = Badges()
self.local_storage = LocalStorage()
def add_session(self, session_platform, session_type, session_host,
session_port, session_object):
if not self.local_storage.get("sessions"):
self.local_storage.set("sessions", dict())
session_id = 0
if session_platform in self.local_storage.get("sessions").keys():
sessions = self.local_storage.get("sessions")
session_id = len(sessions[session_platform])
sessions[session_platform][int(session_id)] = {
'type': session_type,
'host': session_host,
'port': session_port,
'object': session_object
}
else:
sessions = {
session_platform: {
int(session_id): {
'type': session_type,
'host': session_host,
'port': session_port,
'object': session_object
}
}
}
self.local_storage.update("sessions", sessions)
return session_id
def check_session_exist(self, session_platform, session_id):
sessions = self.local_storage.get("sessions")
if sessions:
if session_platform in sessions.keys():
if int(session_id) in sessions[session_platform].keys():
return True
return False
def spawn_interactive_connection(self, session_platform, session_id):
sessions = self.local_storage.get("sessions")
if self.check_session_exist(session_platform, session_id):
self.badges.output_process("Interacting with session " +
str(session_id) + "...")
self.badges.output_success("Interactive connection spawned!")
self.badges.output_information("Type commands below.\n")
sessions[session_platform][int(session_id)]['object'].interact()
else:
self.badges.output_error("Invalid session given!")
def close_session(self, session_platform, session_id):
sessions = self.local_storage.get("sessions")
if self.check_session_exist(session_platform, session_id):
try:
sessions[session_platform][int(session_id)]['object'].close()
del sessions[session_platform][int(session_id)]
if not sessions[session_platform]:
del sessions[session_platform]
self.local_storage.update("sessions", sessions)
except Exception:
self.badges.output_error("Failed to close session!")
else:
self.badges.output_error("Invalid session given!")
def get_session(self, session_platform, session_type, session_id):
sessions = self.local_storage.get("sessions")
if self.check_session_exist(session_platform, session_id):
if session_type == sessions[session_platform][int(
session_id)]['type']:
return sessions[session_platform][int(session_id)]['object']
self.badges.output_error("Session with invalid type!")
return None
return None
class Console:
def __init__(self):
self.io = IO()
self.tip = Tip()
self.jobs = Jobs()
self.execute = Execute()
self.loader = Loader()
self.config = Config()
self.badges = Badges()
self.banner = Banner()
self.colors = Colors()
self.local_storage = LocalStorage()
self.modules = Modules()
self.exceptions = Exceptions()
self.history = self.config.path_config['base_paths']['history_path']
def check_root(self):
if os.getuid() == 0:
return True
self.badges.output_error("Operation not permitted!")
return False
def check_install(self):
if os.path.exists(self.config.path_config['base_paths']['root_path']):
return True
self.badges.output_error("HatSploit is not installed!")
self.badges.output_information("Consider running ./install.sh")
return False
def start_hsf(self):
try:
self.loader.load_all()
except Exception:
sys.exit(1)
def launch_menu(self):
while True:
try:
if not self.modules.check_current_module():
prompt = '(hsf)> '
else:
module = self.modules.get_current_module_name()
name = self.modules.get_current_module_object(
).details['Name']
prompt = '(hsf: ' + self.modules.get_category(
module
) + ': ' + self.colors.RED + name + self.colors.END + ')> '
commands, arguments = self.io.input(prompt)
self.jobs.stop_dead()
self.execute.execute_command(commands, arguments)
if self.local_storage.get("history"):
readline.write_history_file(self.history)
except (KeyboardInterrupt, EOFError,
self.exceptions.GlobalException):
pass
except Exception as e:
self.badges.output_error("An error occurred: " + str(e) + "!")
def enable_history_file(self):
if not os.path.exists(self.history):
open(self.history, 'w').close()
readline.read_history_file(self.history)
def launch_shell(self):
using_history = self.local_storage.get("history")
if using_history:
self.enable_history_file()
readline.parse_and_bind("tab: complete")
version = self.config.core_config['details']['version']
codename = self.config.core_config['details']['codename']
if self.config.core_config['console']['clear']:
self.badges.output_empty(self.colors.CLEAR, end='')
if self.config.core_config['console']['banner']:
self.banner.print_random_banner()
if self.config.core_config['console']['header']:
plugins = self.local_storage.get("plugins")
modules = self.local_storage.get("modules")
payloads = self.local_storage.get("payloads")
plugins_total = 0
modules_total = 0
payloads_total = 0
if payloads:
for database in payloads.keys():
for payload_platform in payloads[database].keys():
for payload_architecture in payloads[database][
payload_platform].keys():
payloads_total += len(
payloads[database][payload_platform]
[payload_architecture])
if plugins:
for database in plugins.keys():
plugins_total += len(plugins[database])
if modules:
for database in modules.keys():
for module_category in modules[database].keys():
for module_platform in modules[database][
module_category].keys():
modules_total += len(
modules[database][module_category]
[module_platform])
header = ""
header += f"{self.colors.END}\n"
if codename and not codename.isspace():
header += f" --=( {self.colors.YELLOW}HatSploit Framework {codename} {version}{self.colors.END}\n"
else:
header += f" --=( {self.colors.YELLOW}HatSploit Framework {version}{self.colors.END}\n"
header += f"--==--=( Developed by EntySec ({self.colors.LINE}https://entysec.netlify.app/{self.colors.END})\n"
header += f" --=( {modules_total} modules | {payloads_total} payloads | {plugins_total} plugins\n"
header += f"{self.colors.END}"
self.badges.output_empty(header)
if self.config.core_config['console']['tip']:
self.tip.print_random_tip()
self.badges.output_empty("")
def shell(self):
self.start_hsf()
self.launch_shell()
self.launch_menu()
class Modules:
def __init__(self):
self.types = Types()
self.badges = Badges()
self.sessions = Sessions()
self.payloads = Payloads()
self.local_storage = LocalStorage()
self.importer = Importer()
def check_exist(self, name):
if self.check_style(name):
all_modules = self.local_storage.get("modules")
if all_modules:
for database in all_modules.keys():
modules = all_modules[database]
category = self.get_category(name)
platform = self.get_platform(name)
if category in modules.keys():
if platform in modules[category].keys():
module = self.get_name(name)
if module in modules[category][platform].keys():
return True
return False
def check_imported(self, name):
imported_modules = self.local_storage.get("imported_modules")
if imported_modules:
if name in imported_modules.keys():
return True
return False
@staticmethod
def check_style(name):
if len(name.split('/')) >= 3:
return True
return False
def check_current_module(self):
if self.local_storage.get("current_module"):
if len(self.local_storage.get("current_module")) > 0:
return True
return False
def get_module_object(self, category, platform, name):
module_full_name = self.get_full_name(category, platform, name)
if self.check_exist(module_full_name):
database = self.get_database(module_full_name)
return self.local_storage.get(
"modules")[database][category][platform][name]
return None
def get_current_module_object(self):
if self.check_current_module():
return self.local_storage.get_array(
"current_module",
self.local_storage.get("current_module_number"))
return None
def get_current_module_platform(self):
if self.check_current_module():
return self.local_storage.get_array(
"current_module",
self.local_storage.get(
"current_module_number")).details['Platform']
return None
def get_current_module_name(self):
if self.check_current_module():
return self.local_storage.get_array(
"current_module",
self.local_storage.get(
"current_module_number")).details['Module']
return None
def get_database(self, name):
if self.check_style(name):
all_modules = self.local_storage.get("modules")
if all_modules:
for database in all_modules.keys():
modules = all_modules[database]
category = self.get_category(name)
platform = self.get_platform(name)
if category in modules.keys():
if platform in modules[category].keys():
module = self.get_name(name)
if module in modules[category][platform].keys():
return database
return None
def get_category(self, name):
if self.check_style(name):
return name.split('/')[0]
return None
def get_platform(self, name):
if self.check_style(name):
return name.split('/')[1]
return None
def get_name(self, name):
if self.check_style(name):
return os.path.join(*(name.split(os.path.sep)[2:]))
return None
@staticmethod
def get_full_name(category, platform, name):
return category + '/' + platform + '/' + name
def compare_types(self, value_type, value):
if value_type and not value_type.lower == 'all':
if value_type.lower() == 'mac':
if not self.types.is_mac(value):
self.badges.output_error(
"Invalid value, expected valid MAC!")
return False
if value_type.lower() == 'ip':
if not self.types.is_ip(value):
self.badges.output_error(
"Invalid value, expected valid IP!")
return False
if value_type.lower() == 'ipv4':
if not self.types.is_ipv4(value):
self.badges.output_error(
"Invalid value, expected valid IPv4!")
return False
if value_type.lower() == 'ipv6':
if not self.types.is_ipv6(value):
self.badges.output_error(
"Invalid value, expected valid IPv6!")
return False
if value_type.lower() == 'ipv4_range':
if not self.types.is_ipv4_range(value):
self.badges.output_error(
"Invalid value, expected valid IPv4 range!")
return False
if value_type.lower() == 'ipv6_range':
if not self.types.is_ipv6_range(value):
self.badges.output_error(
"Invalid value, expected valid IPv6 range!")
return False
if value_type.lower() == 'port':
if not self.types.is_port(value):
self.badges.output_error(
"Invalid value, expected valid port!")
return False
if value_type.lower() == 'port_range':
if not self.types.is_port_range(value):
self.badges.output_error(
"Invalid value, expected valid port range!")
return False
if value_type.lower() == 'number':
if not self.types.is_number(value):
self.badges.output_error(
"Invalid value, expected valid number!")
return False
if value_type.lower() == 'integer':
if not self.types.is_integer(value):
self.badges.output_error(
"Invalid value, expected valid integer!")
return False
if value_type.lower() == 'float':
if not self.types.is_float(value):
self.badges.output_error(
"Invalid value, expected valid float!")
return False
if value_type.lower() == 'boolean':
if not self.types.is_boolean(value):
self.badges.output_error(
"Invalid value, expected valid boolean!")
return False
if value_type.lower() == 'session':
module_platform = self.get_current_module_platform()
if not self.sessions.check_exist(module_platform, value):
return False
return True
def set_current_module_option(self, option, value):
if self.check_current_module():
current_module = self.get_current_module_object()
if not hasattr(current_module, "options") and not hasattr(
current_module, "payload"):
self.badges.output_warning("Module has no options.")
return
if hasattr(current_module,
"payload") and option.lower() == "payload":
if self.payloads.check_exist(value):
module_name = self.get_current_module_name()
platform = self.payloads.get_platform(value)
architecture = self.payloads.get_architecture(value)
name = self.payloads.get_name(value)
payload = self.payloads.get_payload_object(
platform, architecture, name)
module_payload = current_module.payload
valid = 0
if module_payload['Types'] is None or payload[
'Type'] in module_payload['Types']:
valid += 1
if module_payload['Categories'] is None or payload[
'Category'] in module_payload['Categories']:
valid += 1
if module_payload['Platforms'] is None or payload[
'Platform'] in module_payload['Platforms']:
valid += 1
if module_payload['Architectures'] is None or payload[
'Architecture'] in module_payload['Architectures']:
valid += 1
if valid == 4:
if not self.payloads.add_payload(
module_name, platform, architecture, name):
self.badges.output_error(
"Invalid payload, expected valid payload!")
return
self.badges.output_information(option + " ==> " +
value)
self.local_storage.set_module_payload(
"current_module",
self.local_storage.get("current_module_number"),
value)
return
self.badges.output_error(
"Incompatible payload type, category or platform!")
return
self.badges.output_error(
"Invalid payload, expected valid payload!")
return
if hasattr(current_module, "options"):
if option in current_module.options.keys():
value_type = current_module.options[option]['Type']
if self.compare_types(value_type, value):
self.badges.output_information(option + " ==> " +
value)
self.local_storage.set_module_option(
"current_module",
self.local_storage.get("current_module_number"),
option, value)
return
if hasattr(current_module, "payload"):
current_payload = self.payloads.get_current_payload()
if current_payload and hasattr(current_payload, "options"):
if option in current_payload.options.keys():
value_type = current_payload.options[option]['Type']
if self.compare_types(value_type, value):
self.badges.output_information(option + " ==> " +
value)
self.local_storage.set_payload_option(
current_module.details['Module'],
current_payload.details['Payload'], option,
value)
else:
self.badges.output_error("Unrecognized option!")
else:
self.badges.output_error("Unrecognized option!")
else:
self.badges.output_warning("No module selected.")
def import_module(self, category, platform, name):
modules = self.get_module_object(category, platform, name)
try:
module_object = self.importer.import_module(modules['Path'])
if not self.local_storage.get("imported_modules"):
self.local_storage.set("imported_modules", dict())
self.local_storage.update(
"imported_modules",
{self.get_full_name(category, platform, name): module_object})
except Exception:
return None
return module_object
def add_module(self, category, platform, name):
modules = self.get_module_object(category, platform, name)
not_installed = list()
for dependence in modules['Dependencies']:
if not self.importer.import_check(dependence):
not_installed.append(dependence)
if not not_installed:
imported_modules = self.local_storage.get("imported_modules")
full_name = self.get_full_name(category, platform, name)
if self.check_imported(full_name):
module_object = imported_modules[full_name]
self.add_to_global(module_object)
else:
module_object = self.import_module(category, platform, name)
if module_object:
if hasattr(module_object, "payload"):
payload_name = module_object.payload['Value']
platform = self.payloads.get_platform(payload_name)
architecture = self.payloads.get_architecture(
payload_name)
name = self.payloads.get_name(payload_name)
self.badges.output_process("Using default payload " +
payload_name + "...")
if self.payloads.check_exist(payload_name):
if self.payloads.add_payload(
full_name, platform, architecture, name):
self.add_to_global(module_object)
return
self.badges.output_error("Invalid default payload!")
return
self.add_to_global(module_object)
else:
self.badges.output_error(
"Failed to select module from database!")
else:
self.badges.output_error(
"Module depends this dependencies which is not installed:")
for dependence in not_installed:
self.badges.output_empty(" * " + dependence)
def add_to_global(self, module_object):
if self.check_current_module():
self.local_storage.add_array("current_module", '')
self.local_storage.set(
"current_module_number",
self.local_storage.get("current_module_number") + 1)
self.local_storage.set_array(
"current_module",
self.local_storage.get("current_module_number"), module_object)
else:
self.local_storage.set("current_module", [])
self.local_storage.set("current_module_number", 0)
self.local_storage.add_array("current_module", '')
self.local_storage.set_array(
"current_module",
self.local_storage.get("current_module_number"), module_object)
class Importer:
def __init__(self):
self.db = DB()
self.badges = Badges()
self.local_storage = LocalStorage()
self.config = Config()
self.exceptions = Exceptions()
def get_module(self, mu, name, folderpath):
folderpath_list = folderpath.split(".")
for i in dir(mu):
if i == name:
return getattr(mu, name)
if i in folderpath_list:
i = getattr(mu, i)
return self.get_module(i, name, folderpath)
return None
@staticmethod
def import_check(module_name):
try:
__import__(module_name)
except ModuleNotFoundError:
return False
except Exception:
return True
return True
def import_command(self, command_path):
try:
command_directory = command_path
command_file = os.path.split(command_directory)[1]
command_directory = command_directory.replace('/', '.')
command_object = __import__(command_directory)
command_object = self.get_module(command_object, command_file,
command_directory)
command_object = command_object.HatSploitCommand()
except Exception as e:
self.badges.output_information('Reason: ' + str(e))
raise self.exceptions.GlobalException
return command_object
def import_payload(self, payload_path):
try:
payload_directory = payload_path
payload_file = os.path.split(payload_directory)[1]
payload_directory = payload_directory.replace('/', '.')
payload_object = __import__(payload_directory)
payload_object = self.get_module(payload_object, payload_file,
payload_directory)
payload_object = payload_object.HatSploitPayload()
except Exception as e:
self.badges.output_information('Reason: ' + str(e))
raise self.exceptions.GlobalException
return payload_object
def import_module(self, module_path):
try:
module_directory = module_path
module_file = os.path.split(module_directory)[1]
module_directory = module_directory.replace('/', '.')
module_object = __import__(module_directory)
module_object = self.get_module(module_object, module_file,
module_directory)
module_object = module_object.HatSploitModule()
except Exception as e:
self.badges.output_information('Reason: ' + str(e))
raise self.exceptions.GlobalException
return module_object
def import_plugin(self, plugin_path):
try:
plugin_directory = plugin_path
plugin_file = os.path.split(plugin_directory)[1]
plugin_directory = plugin_directory.replace('/', '.')
plugin_object = __import__(plugin_directory)
plugin_object = self.get_module(plugin_object, plugin_file,
plugin_directory)
plugin_object = plugin_object.HatSploitPlugin()
except Exception as e:
self.badges.output_information('Reason: ' + str(e))
raise self.exceptions.GlobalException
return plugin_object
def import_commands(self):
commands = dict()
command_path = self.config.path_config['base_paths']['commands_path']
try:
for file in os.listdir(command_path):
if file.endswith('py'):
command_file_path = command_path + file[:-3]
command_directory = command_file_path.replace(
self.config.path_config['base_paths']['root_path'], '',
1)
try:
command_object = self.import_command(command_directory)
command_name = command_object.details['Name']
commands[command_name] = command_object
self.local_storage.set("commands", commands)
except Exception:
self.badges.output_error("Failed to load " +
file[:-3] + " command!")
except Exception:
pass
def import_database(self):
self.db.connect_payloads_database(
'hsf_payloads', self.config.path_config['base_paths']['db_path'] +
self.config.db_config['base_dbs']['payloads_database'])
self.db.connect_modules_database(
'hsf_modules', self.config.path_config['base_paths']['db_path'] +
self.config.db_config['base_dbs']['modules_database'])
self.db.connect_plugins_database(
'hsf_plugins', self.config.path_config['base_paths']['db_path'] +
self.config.db_config['base_dbs']['plugins_database'])
def import_all(self):
self.import_commands()
self.import_database()