1
0
mirror of https://github.com/infinition/Bjorn.git synced 2024-11-11 22:38:39 +03:00
Files
2024-11-07 16:39:14 +01:00

606 lines
29 KiB
Python

#shared.py
# Description:
# This file, shared.py, is a core component responsible for managing shared resources and data for different modules in the Bjorn project.
# It handles the initialization and configuration of paths, logging, fonts, and images. Additionally, it sets up the environment,
# creates necessary directories and files, and manages the loading and saving of configuration settings.
#
# Key functionalities include:
# - Initializing various paths used by the application, including directories for configuration, data, actions, web resources, and logs.
# - Setting up the environment, including the e-paper display, network knowledge base, and actions JSON configuration.
# - Loading and managing fonts and images required for the application's display.
# - Handling the creation and management of a live status file to store the current status of network scans.
# - Managing configuration settings, including loading default settings, updating, and saving configurations to a JSON file.
# - Providing utility functions for reading and writing data to CSV files, updating statistics, and wrapping text for display purposes.
import os
import re
import json
import importlib
import random
import time
import csv
import logging
from PIL import Image, ImageFont
from logger import Logger
from epd_helper import EPDHelper
logger = Logger(name="shared.py", level=logging.DEBUG) # Create a logger object
class SharedData:
"""Shared data between the different modules."""
def __init__(self):
self.initialize_paths() # Initialize the paths used by the application
self.status_list = []
self.last_comment_time = time.time() # Last time a comment was displayed
self.default_config = self.get_default_config() # Default configuration of the application
self.config = self.default_config.copy() # Configuration of the application
self.setup_environment() # Setup the environment
self.initialize_variables() # Initialize the variables used by the application
self.create_livestatusfile()
self.load_fonts() # Load the fonts used by the application
self.load_images() # Load the images used by the application
# self.create_initial_image() # Create the initial image displayed on the screen
def initialize_paths(self):
"""Initialize the paths used by the application."""
"""Folders paths"""
self.currentdir = os.path.dirname(os.path.abspath(__file__))
# Directories directly under currentdir
self.configdir = os.path.join(self.currentdir, 'config')
self.datadir = os.path.join(self.currentdir, 'data')
self.actions_dir = os.path.join(self.currentdir, 'actions')
self.webdir = os.path.join(self.currentdir, 'web')
self.resourcesdir = os.path.join(self.currentdir, 'resources')
self.backupbasedir = os.path.join(self.currentdir, 'backup')
# Directories under backupbasedir
self.backupdir = os.path.join(self.backupbasedir, 'backups')
self.upload_dir = os.path.join(self.backupbasedir, 'uploads')
# Directories under datadir
self.logsdir = os.path.join(self.datadir, 'logs')
self.output_dir = os.path.join(self.datadir, 'output')
self.input_dir = os.path.join(self.datadir, 'input')
# Directories under output_dir
self.crackedpwddir = os.path.join(self.output_dir, 'crackedpwd')
self.datastolendir = os.path.join(self.output_dir, 'data_stolen')
self.zombiesdir = os.path.join(self.output_dir, 'zombies')
self.vulnerabilities_dir = os.path.join(self.output_dir, 'vulnerabilities')
self.scan_results_dir = os.path.join(self.output_dir, "scan_results")
# Directories under resourcesdir
self.picdir = os.path.join(self.resourcesdir, 'images')
self.fontdir = os.path.join(self.resourcesdir, 'fonts')
self.commentsdir = os.path.join(self.resourcesdir, 'comments')
# Directories under picdir
self.statuspicdir = os.path.join(self.picdir, 'status')
self.staticpicdir = os.path.join(self.picdir, 'static')
# Directory under input_dir
self.dictionarydir = os.path.join(self.input_dir, "dictionary")
"""Files paths"""
# Files directly under configdir
self.shared_config_json = os.path.join(self.configdir, 'shared_config.json')
self.actions_file = os.path.join(self.configdir, 'actions.json')
# Files directly under resourcesdir
self.commentsfile = os.path.join(self.commentsdir, 'comments.json')
# Files directly under datadir
self.netkbfile = os.path.join(self.datadir, "netkb.csv")
self.livestatusfile = os.path.join(self.datadir, 'livestatus.csv')
# Files directly under vulnerabilities_dir
self.vuln_summary_file = os.path.join(self.vulnerabilities_dir, 'vulnerability_summary.csv')
self.vuln_scan_progress_file = os.path.join(self.vulnerabilities_dir, 'scan_progress.json')
# Files directly under dictionarydir
self.usersfile = os.path.join(self.dictionarydir, "users.txt")
self.passwordsfile = os.path.join(self.dictionarydir, "passwords.txt")
# Files directly under crackedpwddir
self.sshfile = os.path.join(self.crackedpwddir, 'ssh.csv')
self.smbfile = os.path.join(self.crackedpwddir, "smb.csv")
self.telnetfile = os.path.join(self.crackedpwddir, "telnet.csv")
self.ftpfile = os.path.join(self.crackedpwddir, "ftp.csv")
self.sqlfile = os.path.join(self.crackedpwddir, "sql.csv")
self.rdpfile = os.path.join(self.crackedpwddir, "rdp.csv")
#Files directly under logsdir
self.webconsolelog = os.path.join(self.logsdir, 'temp_log.txt')
def get_default_config(self):
""" The configuration below is used to set the default values of the configuration settings."""
""" It can be used to reset the configuration settings to their default values."""
""" You can mofify the json file shared_config.json or on the web page to change the default values of the configuration settings."""
return {
"__title_Bjorn__": "Settings",
"manual_mode": False,
"websrv": True,
"web_increment ": False,
"debug_mode": True,
"scan_vuln_running": False,
"retry_success_actions": False,
"retry_failed_actions": True,
"blacklistcheck": True,
"displaying_csv": True,
"log_debug": True,
"log_info": True,
"log_warning": True,
"log_error": True,
"log_critical": True,
"startup_delay": 10,
"web_delay": 2,
"screen_delay": 1,
"comment_delaymin": 15,
"comment_delaymax": 30,
"livestatus_delay": 8,
"image_display_delaymin": 2,
"image_display_delaymax": 8,
"scan_interval": 180,
"scan_vuln_interval": 900,
"failed_retry_delay": 600,
"success_retry_delay": 900,
"ref_width" :122 ,
"ref_height" : 250,
"epd_type": "epd2in13_V2",
"__title_lists__": "List Settings",
"portlist": [20, 21, 22, 23, 25, 53, 69, 80, 110, 111, 135, 137, 139, 143, 161, 162, 389, 443, 445, 512, 513, 514, 587, 636, 993, 995, 1080, 1433, 1521, 2049, 3306, 3389, 5000, 5001, 5432, 5900, 8080, 8443, 9090, 10000],
"mac_scan_blacklist": ['00:11:32:c4:71:9b', '00:11:32:c4:71:9a'],
"ip_scan_blacklist": ['192.168.1.1', '192.168.1.12', '192.168.1.38','192.168.1.53', '192.168.1.40' , '192.168.1.29'],
"steal_file_names": ["ssh.csv","hack.txt"],
"steal_file_extensions": [".bjorn",".hack",".flag"],
"__title_network__": "Network",
"nmap_scan_aggressivity": "-T2",
"portstart": 1,
"portend": 2,
"__title_timewaits__": "Time Wait Settings",
"timewait_smb": 0,
"timewait_ssh": 0,
"timewait_telnet": 0,
"timewait_ftp": 0,
"timewait_sql": 0,
"timewait_rdp": 0,
}
def setup_environment(self):
"""Setup the environment with the necessary directories and files."""
os.system('cls' if os.name == 'nt' else 'clear')
self.load_config()
self.generate_actions_json()
self.delete_webconsolelog()
self.initialize_csv()
self.initialize_epd_display()
def initialize_epd_display(self):
"""Initialize the e-paper display."""
try:
logger.info("Initializing EPD display...")
time.sleep(1)
self.epd_helper = EPDHelper(self.config["epd_type"])
self.epd_helper = EPDHelper(self.epd_type)
if self.config["epd_type"] == "epd2in13_V2":
logger.info("EPD type: epd2in13_V2 screen reversed")
self.screen_reversed = False
self.web_screen_reversed = False
elif self.config["epd_type"] == "epd2in13_V4":
logger.info("EPD type: epd2in13_V4 screen reversed")
self.screen_reversed = True
self.web_screen_reversed = True
self.epd_helper.init_full_update()
self.width, self.height = self.epd_helper.epd.width, self.epd_helper.epd.height
logger.info(f"EPD {self.config['epd_type']} initialized with size: {self.width}x{self.height}")
except Exception as e:
logger.error(f"Error initializing EPD display: {e}")
raise
def initialize_variables(self):
"""Initialize the variables."""
self.should_exit = False
self.display_should_exit = False
self.orchestrator_should_exit = False
self.webapp_should_exit = False
self.bjorn_instance = None
self.wifichanged = False
self.bluetooth_active = False
self.wifi_connected = False
self.pan_connected = False
self.usb_active = False
self.bjornsays = "Hacking away..."
self.bjornorch_status = "IDLE"
self.bjornstatustext = "IDLE"
self.bjornstatustext2 = "Awakening..."
self.scale_factor_x = self.width / self.ref_width
self.scale_factor_y = self.height / self.ref_height
self.text_frame_top = int(88 * self.scale_factor_x)
self.text_frame_bottom = int(159 * self.scale_factor_y)
self.y_text = self.text_frame_top + 2
self.targetnbr = 0
self.portnbr = 0
self.vulnnbr = 0
self.crednbr = 0
self.datanbr = 0
self.zombiesnbr = 0
self.coinnbr = 0
self.levelnbr = 0
self.networkkbnbr = 0
self.attacksnbr = 0
self.show_first_image = True
def delete_webconsolelog(self):
"""Delete the web console log file."""
try:
if os.path.exists(self.webconsolelog):
os.remove(self.webconsolelog)
logger.info(f"Deleted web console log file at {self.webconsolelog}")
#recreate the file
else:
logger.info(f"Web console log file not found at {self.webconsolelog} ...")
except OSError as e:
logger.error(f"OS error occurred while deleting web console log file: {e}")
except Exception as e:
logger.error(f"Unexpected error occurred while deleting web console log file: {e}")
def create_livestatusfile(self):
"""Create the live status file, it will be used to store the current status of the scan."""
try:
if not os.path.exists(self.livestatusfile):
with open(self.livestatusfile, 'w', newline='') as csvfile:
csvwriter = csv.writer(csvfile)
csvwriter.writerow(['Total Open Ports', 'Alive Hosts Count', 'All Known Hosts Count', 'Vulnerabilities Count'])
csvwriter.writerow([0, 0, 0, 0])
logger.info(f"Created live status file at {self.livestatusfile}")
else:
logger.info(f"Live status file already exists at {self.livestatusfile}")
except OSError as e:
logger.error(f"OS error occurred while creating live status file: {e}")
except Exception as e:
logger.error(f"Unexpected error occurred while creating live status file: {e}")
def generate_actions_json(self):
"""Generate the actions JSON file, it will be used to store the actions configuration."""
actions_dir = self.actions_dir
actions_config = []
try:
for filename in os.listdir(actions_dir):
if filename.endswith('.py') and filename != '__init__.py':
module_name = filename[:-3]
try:
module = importlib.import_module(f'actions.{module_name}')
b_class = getattr(module, 'b_class')
b_status = getattr(module, 'b_status')
b_port = getattr(module, 'b_port', None)
b_parent = getattr(module, 'b_parent', None)
actions_config.append({
"b_module": module_name,
"b_class": b_class,
"b_port": b_port,
"b_status": b_status,
"b_parent": b_parent
})
#add each b_class to the status list
self.status_list.append(b_class)
except AttributeError as e:
logger.error(f"Module {module_name} is missing required attributes: {e}")
except ImportError as e:
logger.error(f"Error importing module {module_name}: {e}")
except Exception as e:
logger.error(f"Unexpected error while processing module {module_name}: {e}")
try:
with open(self.actions_file, 'w') as file:
json.dump(actions_config, file, indent=4)
except IOError as e:
logger.error(f"Error writing to file {self.actions_file}: {e}")
except Exception as e:
logger.error(f"Unexpected error while writing to file {self.actions_file}: {e}")
except Exception as e:
logger.error(f"Unexpected error in generate_actions_json: {e}")
def initialize_csv(self):
"""Initialize the network knowledge base CSV file with headers."""
logger.info("Initializing the network knowledge base CSV file with headers")
try:
if not os.path.exists(self.netkbfile):
try:
with open(self.actions_file, 'r') as file:
actions = json.load(file)
action_names = [action["b_class"] for action in actions if "b_class" in action]
except FileNotFoundError as e:
logger.error(f"Actions file not found: {e}")
return
except json.JSONDecodeError as e:
logger.error(f"Error decoding JSON from actions file: {e}")
return
except Exception as e:
logger.error(f"Unexpected error reading actions file: {e}")
return
headers = ["MAC Address", "IPs", "Hostnames", "Alive", "Ports"] + action_names
try:
with open(self.netkbfile, 'w', newline='') as file:
writer = csv.writer(file)
writer.writerow(headers)
logger.info(f"Network knowledge base CSV file created at {self.netkbfile}")
except IOError as e:
logger.error(f"Error writing to netkbfile: {e}")
except Exception as e:
logger.error(f"Unexpected error while writing to netkbfile: {e}")
else:
logger.info(f"Network knowledge base CSV file already exists at {self.netkbfile}")
except Exception as e:
logger.error(f"Unexpected error in initialize_csv: {e}")
def load_config(self):
"""Load the configuration from the shared configuration JSON file."""
try:
logger.info("Loading configuration...")
if os.path.exists(self.shared_config_json):
with open(self.shared_config_json, 'r') as f:
config = json.load(f)
self.config.update(config)
for key, value in self.config.items():
setattr(self, key, value)
else:
logger.warning("Configuration file not found, creating new one with default values...")
self.save_config()
self.load_config()
time.sleep(2)
except FileNotFoundError:
logger.error("Error loading configuration: File not found.")
self.save_config()
def save_config(self):
"""Save the configuration to the shared configuration JSON file."""
logger.info("Saving configuration...")
try:
if not os.path.exists(self.configdir):
os.makedirs(self.configdir)
logger.info(f"Created configuration directory at {self.configdir}")
try:
with open(self.shared_config_json, 'w') as f:
json.dump(self.config, f, indent=4)
logger.info(f"Configuration saved to {self.shared_config_json}")
except IOError as e:
logger.error(f"Error writing to configuration file: {e}")
except Exception as e:
logger.error(f"Unexpected error while writing to configuration file: {e}")
except OSError as e:
logger.error(f"OS error while creating configuration directory: {e}")
except Exception as e:
logger.error(f"Unexpected error in save_config: {e}")
def load_fonts(self):
"""Load the fonts."""
try:
logger.info("Loading fonts...")
self.font_arial14 = self.load_font('Arial.ttf', 14)
self.font_arial11 = self.load_font('Arial.ttf', 11)
self.font_arial9 = self.load_font('Arial.ttf', 9)
self.font_arialbold = self.load_font('Arial.ttf', 12)
self.font_viking = self.load_font('Viking.TTF', 13)
except Exception as e:
logger.error(f"Error loading fonts: {e}")
raise
def load_font(self, font_name, size):
"""Load a font."""
try:
return ImageFont.truetype(os.path.join(self.fontdir, font_name), size)
except Exception as e:
logger.error(f"Error loading font {font_name}: {e}")
raise
def load_images(self):
"""Load the images for the e-paper display."""
try:
logger.info("Loading images...")
# Load static images from the root of staticpicdir
self.bjornstatusimage = None
self.bjorn1 = self.load_image(os.path.join(self.staticpicdir, 'bjorn1.bmp')) # Used to calculate the center of the screen
self.port = self.load_image(os.path.join(self.staticpicdir, 'port.bmp'))
self.frise = self.load_image(os.path.join(self.staticpicdir, 'frise.bmp'))
self.target = self.load_image(os.path.join(self.staticpicdir, 'target.bmp'))
self.vuln = self.load_image(os.path.join(self.staticpicdir, 'vuln.bmp'))
self.connected = self.load_image(os.path.join(self.staticpicdir, 'connected.bmp'))
self.bluetooth = self.load_image(os.path.join(self.staticpicdir, 'bluetooth.bmp'))
self.wifi = self.load_image(os.path.join(self.staticpicdir, 'wifi.bmp'))
self.ethernet = self.load_image(os.path.join(self.staticpicdir, 'ethernet.bmp'))
self.usb = self.load_image(os.path.join(self.staticpicdir, 'usb.bmp'))
self.level = self.load_image(os.path.join(self.staticpicdir, 'level.bmp'))
self.cred = self.load_image(os.path.join(self.staticpicdir, 'cred.bmp'))
self.attack = self.load_image(os.path.join(self.staticpicdir, 'attack.bmp'))
self.attacks = self.load_image(os.path.join(self.staticpicdir, 'attacks.bmp'))
self.gold = self.load_image(os.path.join(self.staticpicdir, 'gold.bmp'))
self.networkkb = self.load_image(os.path.join(self.staticpicdir, 'networkkb.bmp'))
self.zombie = self.load_image(os.path.join(self.staticpicdir, 'zombie.bmp'))
self.data = self.load_image(os.path.join(self.staticpicdir, 'data.bmp'))
self.money = self.load_image(os.path.join(self.staticpicdir, 'money.bmp'))
self.zombie_status = self.load_image(os.path.join(self.staticpicdir, 'zombie.bmp'))
self.attack = self.load_image(os.path.join(self.staticpicdir, 'attack.bmp'))
""" Load the images for the different actions status"""
# Dynamically load status images based on actions.json
try:
with open(self.actions_file, 'r') as f:
actions = json.load(f)
for action in actions:
b_class = action.get('b_class')
if b_class:
indiv_status_path = os.path.join(self.statuspicdir, b_class)
image_path = os.path.join(indiv_status_path, f'{b_class}.bmp')
image = self.load_image(image_path)
setattr(self, b_class, image)
logger.info(f"Loaded image for {b_class} from {image_path}")
except Exception as e:
logger.error(f"Error loading images from actions file: {e}")
# Load image series dynamically from subdirectories
self.image_series = {}
for status in self.status_list:
self.image_series[status] = []
status_dir = os.path.join(self.statuspicdir, status)
if not os.path.isdir(status_dir):
os.makedirs(status_dir)
logger.warning(f"Directory {status_dir} did not exist and was created.")
logger.warning(f" {status} wil use the IDLE images till you add some images in the {status} folder")
for image_name in os.listdir(status_dir):
if image_name.endswith('.bmp') and re.search(r'\d', image_name):
image = self.load_image(os.path.join(status_dir, image_name))
if image:
self.image_series[status].append(image)
if not self.image_series:
logger.error("No images loaded.")
else:
for status, images in self.image_series.items():
logger.info(f"Loaded {len(images)} images for status {status}.")
"""Calculate the position of the Bjorn image on the screen to center it"""
self.x_center1 = (self.width - self.bjorn1.width) // 2
self.y_bottom1 = self.height - self.bjorn1.height
except Exception as e:
logger.error(f"Error loading images: {e}")
raise
def update_bjornstatus(self):
""" Using getattr to obtain the reference of the attribute with the name stored in self.bjornorch_status"""
try:
self.bjornstatusimage = getattr(self, self.bjornorch_status)
if self.bjornstatusimage is None:
raise AttributeError
except AttributeError:
logger.warning(f"The image for status {self.bjornorch_status} is not available, using IDLE image by default.")
self.bjornstatusimage = self.attack
self.bjornstatustext = self.bjornorch_status # Mettre à jour le texte du statut
def load_image(self, image_path):
"""Load an image."""
try:
if not os.path.exists(image_path):
logger.warning(f"Warning: {image_path} does not exist.")
return None
return Image.open(image_path)
except Exception as e:
logger.error(f"Error loading image {image_path}: {e}")
raise
def update_image_randomizer(self):
"""Update the image randomizer and the imagegen variable."""
try:
status = self.bjornstatustext
if status in self.image_series and self.image_series[status]:
random_index = random.randint(0, len(self.image_series[status]) - 1)
self.imagegen = self.image_series[status][random_index]
self.x_center = (self.width - self.imagegen.width) // 2
self.y_bottom = self.height - self.imagegen.height
else:
logger.warning(f"Warning: No images available for status {status}, defaulting to IDLE images.")
if "IDLE" in self.image_series and self.image_series["IDLE"]:
random_index = random.randint(0, len(self.image_series["IDLE"]) - 1)
self.imagegen = self.image_series["IDLE"][random_index]
self.x_center = (self.width - self.imagegen.width) // 2
self.y_bottom = self.height - self.imagegen.height
else:
logger.error("No IDLE images available either.")
self.imagegen = None
except Exception as e:
logger.error(f"Error updating image randomizer: {e}")
raise
def wrap_text(self, text, font, max_width):
"""Wrap text to fit within a specified width when rendered."""
try:
lines = []
words = text.split()
while words:
line = ''
while words and font.getlength(line + words[0]) <= max_width:
line = line + (words.pop(0) + ' ')
lines.append(line)
return lines
except Exception as e:
logger.error(f"Error wrapping text: {e}")
raise
def read_data(self):
"""Read data from the CSV file."""
self.initialize_csv() # Ensure CSV is initialized with correct headers
data = []
with open(self.netkbfile, 'r') as file:
reader = csv.DictReader(file)
for row in reader:
data.append(row)
return data
def write_data(self, data):
"""Write data to the CSV file."""
with open(self.actions_file, 'r') as file:
actions = json.load(file)
action_names = [action["b_class"] for action in actions if "b_class" in action]
# Read existing CSV file if it exists
if os.path.exists(self.netkbfile):
with open(self.netkbfile, 'r') as file:
reader = csv.DictReader(file)
existing_headers = reader.fieldnames
existing_data = list(reader)
else:
existing_headers = []
existing_data = []
# Check for missing action columns and add them
new_headers = ["MAC Address", "IPs", "Hostnames", "Alive", "Ports"] + action_names
missing_headers = [header for header in new_headers if header not in existing_headers]
# Update headers
headers = existing_headers + missing_headers
# Merge new data with existing data
mac_to_existing_row = {row["MAC Address"]: row for row in existing_data}
for new_row in data:
mac_address = new_row["MAC Address"]
if mac_address in mac_to_existing_row:
# Update the existing row with new data
existing_row = mac_to_existing_row[mac_address]
for key, value in new_row.items():
if value:
existing_row[key] = value
else:
# Add new row
mac_to_existing_row[mac_address] = new_row
# Write updated data back to CSV
with open(self.netkbfile, 'w', newline='') as file:
writer = csv.DictWriter(file, fieldnames=headers)
writer.writeheader()
# Write all data
for row in mac_to_existing_row.values():
writer.writerow(row)
def update_stats(self):
"""Update the stats based on formulas."""
self.coinnbr = int((self.networkkbnbr * 5 + self.crednbr * 5 + self.datanbr * 5 + self.zombiesnbr * 10+self.attacksnbr * 5+ self.vulnnbr * 2 ))
self.levelnbr = int((self.networkkbnbr * 0.1 + self.crednbr * 0.2 + self.datanbr * 0.1 + self.zombiesnbr * 0.5+ self.attacksnbr+ self.vulnnbr * 0.01 ))
def print(self, message):
"""Print a debug message if debug mode is enabled."""
if self.config['debug_mode']:
logger.debug(message)