csle-attack-profiler 0.9.4__py3-none-any.whl

csle_attack_profiler/__init__.py

@@ -0,0 +1 @@
+from . __version__ import __version__

csle_attack_profiler/__version__.py

@@ -0,0 +1 @@
+__version__ = '0.9.4'

csle_attack_profiler/attack_profiler.py

@@ -0,0 +1,204 @@
+from csle_common.dao.emulation_action.attacker.emulation_attacker_action \
+    import EmulationAttackerAction
+from csle_common.dao.emulation_action.attacker.emulation_attacker_action_id \
+    import EmulationAttackerActionId
+from csle_attack_profiler.dao.tactics import Tactics
+from csle_attack_profiler.dao.attack_mapping import EmulationAttackerMapping
+from csle_attack_profiler.dao.attack_graph import AttackGraph
+from mitreattack.stix20 import MitreAttackData
+from typing import List, Dict, Union
+import os
+
+
+class AttackProfiler:
+    """
+    Class representing the attack profile based on the MITRE ATT&CK framework for Enterprise.
+    """
+
+    def __init__(self, techniques_tactics: Dict[str, List[str]], mitigations: Dict[str, List[str]],
+                 data_sources: Dict[str, List[str]], subtechniques: Dict[str, str],
+                 action_id: EmulationAttackerActionId) -> None:
+        """
+        Class constructor
+
+        :params techniques_tactics: the techniques and tactics used by the attacker action.
+                                    The key is the technique and the value is the tactics
+        :params mitigations: the mitigations used by the attacker action. The key is the technique and the
+                             value is the mitigations
+        :params data_sources: the data sources used by the attacker action. The key is the technqiue and the value is
+                              the data sources
+        :params sub_techniques: the sub-techniques used by the attacker action. The key is the technique and
+                                the value is the sub-techniques
+        :params action_id: the id of the attacker action
+        """
+        
+        self.techniques_tactics = techniques_tactics
+        self.mitigations = mitigations
+        self.data_sources = data_sources
+        self.subtechniques = subtechniques
+        self.action_id = action_id
+
+    @staticmethod
+    def get_attack_profile(attacker_action: EmulationAttackerAction) -> 'AttackProfiler':
+        """
+        Returns the attack profile of the actions
+
+        :params attacker_action: the attacker action
+        :return: the attack profile of the action
+        """
+        current_dir = os.path.dirname(__file__)
+        path = os.path.join(current_dir, "./dao/enterprise-attack.json")
+        mitre_attack_data = MitreAttackData(path)
+
+        # Retrieve the id from the attacker action
+        attacker_id = attacker_action.id
+        # Get the defined tactics and techniques for the attack
+        attack_mapping = EmulationAttackerMapping.get_attack_info(attacker_id)
+        if attack_mapping is None:
+            return AttackProfiler({}, {}, {}, {}, EmulationAttackerActionId.CONTINUE)
+
+        attack_techniques_vals = [technique.value for technique in attack_mapping['techniques']]
+        
+        attacker_action_id = attacker_action.id
+        techniques_tactics = {}
+        mitigations = {}
+        data_sources = {}
+        sub_techniques = {}
+        # Loop over the techniques associated with the attack
+        for technique_name in attack_techniques_vals:
+            # Get technique from MitreAttackData, stix_id maps to technique in the library.
+            try:
+                obj = mitre_attack_data.get_objects_by_name(technique_name, "attack-pattern")
+            except Exception as e:
+                os.system("echo 'Error in getting technique: {}'".format(e))
+                continue
+            technique = obj[0]
+            stix_id = technique.id
+
+            # Collect the tactics and add it to the dictionary
+            tactics = [phase['phase_name'] for phase in technique.kill_chain_phases]
+            techniques_tactics[technique_name] = tactics
+            
+            # Add the data sources to the dictionary
+            if hasattr(technique, 'x_mitre_data_sources'):
+                data_sources[technique_name] = technique.x_mitre_data_sources
+            # Fetch the mitigations from the technique and add it to the dictionary
+            try:
+                mitigations_object = mitre_attack_data.get_mitigations_mitigating_technique(stix_id)
+                mitigations_list = [mitig['object']['name'] for mitig in mitigations_object]
+                mitigations[technique_name] = mitigations_list
+            except Exception as e:
+                os.system("echo 'Error in getting mitigations: {}'".format(e))
+                continue
+        
+        # Add the sub-technique to the dictionary
+        if 'subtechniques' in attack_mapping:
+            sub_techniques_mapping = [sub_technique.value for sub_technique in attack_mapping['subtechniques']]
+            for st in sub_techniques_mapping:
+                try:
+                    sub_technique_obj = mitre_attack_data.get_objects_by_name(st, "attack-pattern")
+                    parent_technique_obj = mitre_attack_data.get_parent_technique_of_subtechnique(
+                        sub_technique_obj[0].id)
+                    sub_techniques[parent_technique_obj[0]['object'].name] = st
+                except Exception as e:
+                    os.system("echo 'Error in getting sub-techniques: {}'".format(e))
+                    continue
+
+        return AttackProfiler(techniques_tactics, mitigations, data_sources, sub_techniques, attacker_action_id)
+    
+    @staticmethod
+    def get_attack_profile_sequence(attacker_actions: List[EmulationAttackerAction],
+                                    attack_graph: Union[AttackGraph, None] = None) -> List['AttackProfiler']:
+        """
+        Returns the attack profile of the actions in a sequence
+
+        :params attacker_action: a list of attacker actions
+
+        :return: a list of attack profiles of the actions
+        """
+
+        attack_profiles = []
+        for action in attacker_actions:
+            attack_profiles.append(AttackProfiler.get_attack_profile(action))
+        
+        # IF attack graph is provided
+        if attack_graph:
+
+            node = attack_graph.get_root_node()
+            for profile in attack_profiles:
+                # Get the mappings of the techniques and tactics
+                techniques_tactics = profile.techniques_tactics
+                techniques_to_keep = []
+                children = attack_graph.get_children(node[0], node[2])
+                possible_nodes = []
+                # First we check the techniques in node we are currently at
+                for technique in techniques_tactics:
+                    # If the node.name is in the techniques_tactics, add it to the techniques_to_keep
+                    if node[0].value in techniques_tactics[technique]:
+                        techniques_to_keep.append(technique)
+                        if node not in possible_nodes:
+                            possible_nodes.append(node)
+                if children is None:
+                    continue
+                for child in children:
+                    # Child is a list of tuples, where the first element is the node name,
+                    # and the second element is the node id
+                    for technique in techniques_tactics:
+                        if child[0].value in techniques_tactics[technique]:
+                            
+                            techniques_to_keep.append(technique)
+                            # If the child is not in the possible_children, add it to the list.
+                            if attack_graph.get_node(child[0], child[1]) not in possible_nodes:
+                                p_node = attack_graph.get_node(child[0], child[1])
+                                if p_node is not None:
+                                    possible_nodes.append(p_node)
+
+                # If the possible node is just one node, move to that node
+                if len(possible_nodes) == 1:
+                    node = possible_nodes[0]
+                if not techniques_to_keep:
+                    continue
+                # Remove the techniques and associated tactics, data sources,
+                # mitigations and sub-techniques that are not in the techniques_to_keep
+                techniques_to_remove = set(profile.techniques_tactics.keys()) - set(techniques_to_keep)
+                for technique in techniques_to_remove:
+                    try:
+                        del profile.techniques_tactics[technique]
+                        del profile.mitigations[technique]
+                        del profile.data_sources[technique]
+                        del profile.subtechniques[technique]
+                    except Exception as e:
+                        os.system("echo 'Error in removing techniques: {}'".format(e))
+                        continue
+                            
+        # ELSE Baseline conditions
+        else:
+            initial_access = False
+            for profile in attack_profiles:
+                techniques_tactics = profile.techniques_tactics
+                techniques_to_remove = set()
+                # Loop over the mappings of the techniques to tactics
+                for technique in techniques_tactics:
+                    if Tactics.DISCOVERY.value in techniques_tactics[technique] and not initial_access:
+                        techniques_to_remove.add(technique)
+                    elif Tactics.RECONNAISSANCE.value in techniques_tactics[technique] and initial_access:
+                        techniques_to_remove.add(technique)
+                    if Tactics.INITIAL_ACCESS.value in techniques_tactics[technique] and not initial_access:
+                        initial_access = True
+                    elif Tactics.INITIAL_ACCESS.value in techniques_tactics[technique] and initial_access:
+                        techniques_to_remove.add(technique)
+                    elif Tactics.LATERAL_MOVEMENT.value in techniques_tactics[technique] and not initial_access:
+                        techniques_to_remove.add(technique)
+                
+                # Remove the techniques and associated tactics, data sources, mitigations and sub-techniques
+                for technique in techniques_to_remove:
+                    try:
+                        del profile.techniques_tactics[technique]
+                        del profile.mitigations[technique]
+                        del profile.data_sources[technique]
+                        del profile.subtechniques[technique]
+                    except Exception as e:
+                        os.system("echo 'Error in removing techniques: {}'".format(e))
+                        continue
+                
+        return attack_profiles

csle_attack_profiler/hmm_profiling.py

@@ -0,0 +1,448 @@
+from typing import List, Union, Tuple, Any
+import numpy as np
+import sys
+from csle_common.dao.system_identification.emulation_statistics import EmulationStatistics
+from csle_common.dao.emulation_action.attacker.emulation_attacker_action_id import EmulationAttackerActionId
+from csle_common.dao.emulation_action.attacker.emulation_attacker_action_type import EmulationAttackerActionType
+from csle_common.dao.emulation_action.attacker.emulation_attacker_action_outcome import EmulationAttackerActionOutcome
+from csle_common.dao.emulation_action.attacker.emulation_attacker_action import EmulationAttackerAction
+from csle_attack_profiler.attack_profiler import AttackProfiler
+
+
+class HMMProfiler:
+    """
+    The HMMProfiler class is used to profile a sequence of observations based on a Hidden Markov Model (HMM).
+    """
+
+    def __init__(self, statistics: List[EmulationStatistics], model_name: Union[str, None] = None) -> None:
+        """
+        Class constructor
+
+        :param statistics: The list of EmulationStatistics objects
+        :param model_name: The name of the model
+        :return: None
+        """
+        self.statistics = statistics
+        self.transition_matrix: List[List[float]] = []
+        self.emission_matrix: List[List[float]] = []
+        self.hidden_states: List[str] = []
+        self.emission_matrix_observations: List[int] = []
+        self.start_state_probs: List[float] = []
+        self.model_name = None
+
+    def create_model(self, transition_matrix: List[List[float]],
+                     hidden_states: List[str], metric: str,
+                     save_model: bool = False, location: str = ".") -> None:
+        """
+        Creates the HMM model based on the given transition matrix, states and metrics.
+        If save = True, matrices are saved to given location
+
+        :param transition_matrix: The transition matrix
+        :param states: The list of states of the HMM (format: 'A:attack_name' or
+                        'no_intrusion' based on emulation statistics file)
+        :param metrics: The list of metrics to profile
+        :param save: Whether to save the matrices to a file
+        :param location: The location to save the matrices, if save = True, e.g "./resources",
+                         default is current directory
+        :return: None
+        """
+        emission_matrix, emission_matrix_observations = self.get_matrices_of_observation(self.statistics,
+                                                                                         metric, hidden_states)
+        self.emission_matrix = emission_matrix
+        self.emission_matrix_observations = emission_matrix_observations
+        self.transition_matrix = transition_matrix
+        self.start_state_probs = self.calculate_initial_states(self.transition_matrix)
+        self.hidden_states = hidden_states
+        if save_model and location:
+            np.save(f'{location}/transition_matrix.npy', transition_matrix)
+            np.save(f'{location}/hidden_states.npy', hidden_states)
+            np.save(f'{location}/start_state_probs.npy', self.start_state_probs)
+            np.save(f'{location}/emission_matrix_{metric}.npy', emission_matrix)
+            np.save(f'{location}/emission_matrix_observations_{metric}.npy', emission_matrix_observations)
+
+    def load_model(self, location: str, metric: str) -> None:
+        """
+        Loads the HMM model from the given location.
+
+        :param location: The location of the model files, default is current directory
+        :return: None
+        """
+        self.transition_matrix = np.load(f'{location}/transition_matrix.npy')
+        self.hidden_states = np.load(f'{location}/hidden_states.npy')
+        self.start_state_probs = np.load(f'{location}/start_state_probs.npy')
+        self.emission_matrix = np.load(f'{location}/emission_matrix_{metric}.npy')
+        self.emission_matrix_observations = np.load(f'{location}/emission_matrix_observations_{metric}.npy')
+
+    def profile_sequence(self, sequence: List[int]) -> List[str]:
+        """
+        Profiles a sequence of observations based on the HMM model.
+
+        :param sequence: The sequence of observations
+        :return: The most likely sequence of states
+        """
+
+        path = HMMProfiler.viterbi(self.hidden_states, self.start_state_probs,
+                                   self.transition_matrix, self.emission_matrix,
+                                   sequence, self.emission_matrix_observations)
+        profiled_sequence = []
+        for i in range(len(path)):
+            profiled_sequence.append(self.hidden_states[int(path[i])])
+
+        return profiled_sequence
+
+    def get_matrices_of_observation(self, statistics: List[EmulationStatistics],
+                                    metric: str, states: List[str]) -> Tuple[List[List[float]], List[int]]:
+        """
+        Creates the emission matrix for a given metric based on the statistics from the EmulationStatistics objects.
+
+        :param statistics: The list of EmulationStatistics objects
+        :param metric: The metric to get the emission matrix for
+        :param states: The list of states
+        :return: The emission matrix, the list of observations, the list of states
+        """
+        emission_matrix = []
+        attack_observations = {}
+        attack_observations_total_counts = {}
+        all_keys = set()
+
+        for stats in statistics:
+            for condition, metric_distribution in stats.conditionals_counts.items():
+                action = condition.split('_')
+                if action[0] == 'no':
+                    action[0] = 'no_intrusion'
+                if action[0] not in attack_observations:
+                    # We are not intrested in the observations from 'intrusion' or 'A:Continue'
+                    if action[0] == 'intrusion' or action[0] == 'A:Continue':
+                        continue
+                    else:
+                        # Add the observations of the attack to the dictionary
+                        if metric in metric_distribution:
+                            attack_observations[action[0]] = metric_distribution[metric]
+                            # Sum the total counts of the observations
+                            attack_observations_total_counts[action[0]] = sum(attack_observations[action[0]].values())
+                # Aggregate the counts from the metric distribution
+                else:
+                    counts_observation = metric_distribution[metric]
+                    for element in counts_observation:
+                        if element in attack_observations[action[0]]:
+                            # Aggregate the counts if the element is already in the dictionary
+                            attack_observations[action[0]][element] += counts_observation[element]
+                        else:
+                            attack_observations[action[0]][element] = counts_observation[element]
+                    # Sum the total counts of the observations
+                    attack_observations_total_counts[action[0]] += sum(attack_observations[action[0]].values())
+
+                # Store all possible values for the observation
+                if action[0] in attack_observations:
+                    all_keys.update(attack_observations[action[0]])
+
+        # Normalize the counts
+        for attack, _ in attack_observations.items():
+            attack_observations_total_counts[attack] = sum(attack_observations[attack].values())
+            for key in all_keys:
+                int_key = int(key)
+                if key in attack_observations[attack]:
+                    count = attack_observations[attack].pop(key, 0)
+                    attack_observations[attack][int_key] = count / attack_observations_total_counts[attack]
+                else:
+                    attack_observations[attack][int_key] = 0
+            # Sort the dictionary by key
+            attack_observations[attack] = dict(sorted(attack_observations[attack].items()))
+
+        # Take any attack as the reference to get the keys
+        emission_matrix_observations = []
+        emission_matrix_states = []
+        # Create the emission matrix
+        for state in states:
+            if state in attack_observations:
+                # Normalize the and then append
+                emission_matrix.append(list(attack_observations[state].values()))
+                # Get the keys of all observations
+                emission_matrix_observations = list(attack_observations[state].keys())
+                emission_matrix_states.append(state)
+            else:
+                # LaPlace smoothing for missing observations
+                num_keys = len(all_keys)
+                laplace_probability = 1 / (num_keys + 2)
+                laplace_sum = laplace_probability * num_keys
+                laplace_probability_adj = laplace_probability / laplace_sum
+                emission_matrix.append([laplace_probability_adj] * num_keys)
+                emission_matrix_states.append(state)
+
+        # Check if the sum of the probabilities is 1
+        for i in range(len(emission_matrix)):
+            sum_prob = round(sum(emission_matrix[i]), 10)
+            if sum_prob != 1:
+                print(f'Sum of probabilities for state {emission_matrix_states[i]} is {sum_prob}')
+
+        return (emission_matrix, emission_matrix_observations)
+
+    def convert_states_to_profiles(self, states: List[str]) -> List[Union[AttackProfiler, str]]:
+        """
+        Converts a list of states to a list of AttackProfiles.
+
+        :param states: The list of states to convert
+        :return: The list of EmulationAttackerActionId
+        """
+
+        new_states: List[Union[AttackProfiler, str]] = []
+        for state in states:
+            if state == 'A:Continue':
+                action = EmulationAttackerAction(id=EmulationAttackerActionId.CONTINUE, name="Continue", cmds=[],
+                                                 type=None, descr="CONTINUE", ips=[], index=0, action_outcome='')
+                p = AttackProfiler.get_attack_profile(action)
+                new_states.append(p)
+            elif state == 'A:CVE-2015-1427 exploit':
+                action = EmulationAttackerAction(
+                    id=EmulationAttackerActionId.CVE_2015_1427_EXPLOIT, name="CVE-2015-1427 exploit", cmds=None,
+                    type=EmulationAttackerActionType.EXPLOIT,
+                    descr="Uses the CVE-2015-1427 vulnerability to "
+                          "get remote code execution and then sets up a SSH backdoor"
+                          "to upgrade the channel", index=None, ips=[],
+                    action_outcome=EmulationAttackerActionOutcome.SHELL_ACCESS)
+                p = AttackProfiler.get_attack_profile(action)
+                new_states.append(p)
+            elif state == 'A:DVWA SQL Injection Exploit':
+                action = EmulationAttackerAction(
+                    id=EmulationAttackerActionId.DVWA_SQL_INJECTION, name="DVWA SQL Injection Exploit",
+                    cmds=None, type=EmulationAttackerActionType.EXPLOIT,
+                    descr="Uses the DVWA SQL Injection exploit to extract secret passwords",
+                    index=None, ips=[], action_outcome=EmulationAttackerActionOutcome.SHELL_ACCESS)
+                p = AttackProfiler.get_attack_profile(action)
+                new_states.append(p)
+            elif state == 'A:Install tools':
+                action = EmulationAttackerAction(
+                    id=EmulationAttackerActionId.INSTALL_TOOLS, name="Install tools", cmds=None,
+                    type=EmulationAttackerActionType.POST_EXPLOIT,
+                    descr="If taken root on remote machine, installs pentest tools, e.g. nmap",
+                    index=None, ips=[], action_outcome=EmulationAttackerActionOutcome.PIVOTING)
+                p = AttackProfiler.get_attack_profile(action)
+                new_states.append(p)
+            elif state == 'A:Network service login':
+                action = EmulationAttackerAction(
+                    id=EmulationAttackerActionId.NETWORK_SERVICE_LOGIN, name="Network service login",
+                    cmds=[], type=EmulationAttackerActionType.POST_EXPLOIT,
+                    descr="Uses known credentials to login to network services on a server",
+                    index=None, ips=None, action_outcome=EmulationAttackerActionOutcome.LOGIN)
+                p = AttackProfiler.get_attack_profile(action)
+                new_states.append(p)
+            elif state == 'A:Ping Scan':
+                action = EmulationAttackerAction(
+                    id=EmulationAttackerActionId.PING_SCAN_HOST, name="Ping Scan",
+                    cmds=None, type=EmulationAttackerActionType.RECON,
+                    descr="A host discovery scan, it is quick because it only checks of hosts "
+                          "are up with Ping, without scanning the ports.", ips=None, index=None,
+                    action_outcome=EmulationAttackerActionOutcome.INFORMATION_GATHERING, backdoor=False)
+                p = AttackProfiler.get_attack_profile(action)
+                new_states.append(p)
+            elif state == 'A:Sambacry Explolit':
+                action = EmulationAttackerAction(
+                    id=EmulationAttackerActionId.SAMBACRY_EXPLOIT, name="Sambacry Explolit", cmds=None,
+                    type=EmulationAttackerActionType.EXPLOIT,
+                    descr="Uses the sambacry shell to get remote code execution and then"
+                          "sets up a SSH backdoor to upgrade the channel",
+                    index=None, ips=[], action_outcome=EmulationAttackerActionOutcome.SHELL_ACCESS)
+                p = AttackProfiler.get_attack_profile(action)
+                new_states.append(p)
+            elif state == 'A:ShellShock Explolit':
+                action = EmulationAttackerAction(
+                    id=EmulationAttackerActionId.SHELLSHOCK_EXPLOIT, name="ShellShock Explolit",
+                    cmds=None, type=EmulationAttackerActionType.EXPLOIT,
+                    descr="Uses the Shellshock exploit and curl to do remote code execution and create a backdoor",
+                    index=None, ips=[], action_outcome=EmulationAttackerActionOutcome.SHELL_ACCESS)
+                p = AttackProfiler.get_attack_profile(action)
+                new_states.append(p)
+            elif state == 'A:SSH dictionary attack for username=pw':
+                action = EmulationAttackerAction(
+                    id=EmulationAttackerActionId.SSH_SAME_USER_PASS_DICTIONARY_HOST,
+                    name="SSH dictionary attack for username=pw", cmds=None,
+                    type=EmulationAttackerActionType.EXPLOIT, index=None,
+                    descr="A dictionary attack that tries common passwords and usernames for SSH"
+                          "where username=password", ips=None,
+                    action_outcome=EmulationAttackerActionOutcome.SHELL_ACCESS)
+                p = AttackProfiler.get_attack_profile(action)
+                new_states.append(p)
+            elif state == 'A:FTP dictionary attack for username=pw':
+                action = EmulationAttackerAction(
+                    id=EmulationAttackerActionId.FTP_SAME_USER_PASS_DICTIONARY_HOST,
+                    name="FTP dictionary attack for username=pw", cmds=None, type=EmulationAttackerActionType.EXPLOIT,
+                    index=None, descr="A dictionary attack that tries common passwords and"
+                                      "usernames for FTP where username=password", ips=None,
+                    action_outcome=EmulationAttackerActionOutcome.SHELL_ACCESS)
+                p = AttackProfiler.get_attack_profile(action)
+                new_states.append(p)
+            elif state == 'A:Telnet dictionary attack for username=pw':
+                action = EmulationAttackerAction(
+                    id=EmulationAttackerActionId.TELNET_SAME_USER_PASS_DICTIONARY_HOST,
+                    name="Telnet dictionary attack for username=pw", cmds=None,
+                    type=EmulationAttackerActionType.EXPLOIT, index=None,
+                    descr="A dictionary attack that tries common passwords and usernames for"
+                          "Telnet where username=password", ips=None,
+                    action_outcome=EmulationAttackerActionOutcome.SHELL_ACCESS)
+                p = AttackProfiler.get_attack_profile(action)
+                new_states.append(p)
+            elif state == 'A:CVE-2010-0426 exploit':
+                action = EmulationAttackerAction(
+                    id=EmulationAttackerActionId.CVE_2010_0426_PRIV_ESC,
+                    name="CVE-2010-0426 exploit", cmds=None, type=EmulationAttackerActionType.PRIVILEGE_ESCALATION,
+                    descr="Uses the CVE-2010-0426 vulnerability to perform privilege escalation to get root access",
+                    index=None, ips=[], action_outcome=EmulationAttackerActionOutcome.PRIVILEGE_ESCALATION_ROOT)
+                p = AttackProfiler.get_attack_profile(action)
+                new_states.append(p)
+            elif state == 'A:TCP SYN (Stealth) Scan':
+                action = EmulationAttackerAction(
+                    id=EmulationAttackerActionId.TCP_SYN_STEALTH_SCAN_HOST, name="TCP SYN (Stealth) Scan",
+                    cmds=None, type=EmulationAttackerActionType.RECON,
+                    descr="A stealthy and fast TCP SYN scan to detect open TCP ports on the subnet", ips=None,
+                    index=None, action_outcome=EmulationAttackerActionOutcome.INFORMATION_GATHERING, backdoor=False)
+                p = AttackProfiler.get_attack_profile(action)
+                new_states.append(p)
+            elif state == 'ssh backdoor':
+                action = EmulationAttackerAction(
+                    id=EmulationAttackerActionId.SSH_BACKDOOR, name="Install SSH backdoor",
+                    cmds=None, type=EmulationAttackerActionType.POST_EXPLOIT,
+                    descr="If taken root on remote machine, installs a ssh backdoor useful for"
+                          "upgrading telnetor weaker channels", index=None, ips=[],
+                    action_outcome=EmulationAttackerActionOutcome.PIVOTING, alt_cmds=None, backdoor=True)
+                p = AttackProfiler.get_attack_profile(action)
+                new_states.append(p)
+            else:
+                new_states.append(state)
+
+        return new_states
+
+    def calculate_initial_states(self, transition_matrix: List[List[float]]) -> List[float]:
+        """
+        Calculates the initial states probabilities based on the transition matrix.
+
+        1 / (# of states)
+
+        :param transition_matrix: The transition matrix
+        :return: The start states probabilities
+        """
+        start_states = []
+        total_states = len(transition_matrix)
+        for _ in range(total_states):
+            start_states.append(1 / total_states)
+
+        return start_states
+
+    @staticmethod
+    def viterbi(hidden_states: List[EmulationAttackerActionId], init_probs: List[float],
+                trans_matrix: List[List[float]], emission_matrix: List[List[float]],
+                obs: List[int], emissions_list: List[int]) -> List[float]:
+        """
+        Viterbi algorithm for Hidden Markov Models (HMM).
+
+        :param hidden_states: The hidden states
+        :param init_probs: The initial probabilities of the hidden states
+        :param trans_matrix: The transition matrix
+        :param emission_matrix: The emission matrix
+        :param obs: The observation sequence
+        :param emissions_list: The list of possible observations
+        :return: The most likely sequence of hidden states
+        """
+        # Convert the emissions list to a numpy array, to use the where function
+        emissions_list_typed: np.ndarray[int, Any] = np.array(emissions_list)
+
+        # Check that the sum equals 1
+        for i in range(len(emission_matrix)):
+            if round(sum(emission_matrix[i]), 10) != 1:
+                print(f'Sum of probabilities for state {hidden_states[i]} is not 1')
+                print(f'Sum of probabilities: {sum(emission_matrix[i])}')
+
+        # The number of hidden states
+        S = len(hidden_states)
+        # The number of observations
+        T = len(obs)
+
+        # The Viterbi matrix (prob) T x S matrix of zeroes
+        prob = np.zeros((T, S))
+        # The backpointer matrix (prev)
+        prev = np.empty((T, S))
+        # Initialization
+        for i in range(S):
+            # Fetch the index of the observation in the emission_matrix
+            index, = np.where(emissions_list_typed == obs[0])
+            if index[0].size > 0:
+                prob[0][i] = init_probs[i] * emission_matrix[i][index[0]]
+            else:
+                print(f'Observation {obs[0]} not found in the emission matrix')
+                sys.exit(1)
+
+        # Recursion
+        for t in range(1, T):
+            index, = np.where(emissions_list_typed == obs[t])
+            for i in range(S):
+                max_prob = -1
+                max_state = -1
+                for j in range(S):
+                    new_prob = prob[t - 1][j] * trans_matrix[j][i] * emission_matrix[i][index[0]]
+                    if new_prob > max_prob:
+                        max_prob = new_prob
+                        max_state = j
+                prob[t][i] = max_prob
+                prev[t][i] = max_state
+
+        path = np.zeros(T)
+        path[T - 1] = np.argmax(prob[T - 1])
+        for t in range(T - 2, -1, -1):
+            path[t] = prev[t + 1][int(path[t + 1])]
+        # Convert the path to a list
+        typed_path: List[float] = path.tolist()
+
+        return typed_path
+
+    def generate_sequence(self, intrusion_length: int, initial_state_index: int,
+                          seed: Union[int, None] = None) -> Tuple[List[str], List[int]]:
+        """
+        Generates a sequence of states and corresponding observations based on the given emission matrix,
+        and transition matrix. First, a sequence of observation from 'no intrusion' is generated
+        based on the geometric distribution of the initial state. Then, a sequence observations and states are
+        generated based on emission matrix and transition matrix. The length of this intrusion
+        sequence is given by the intrusion_length parameter.
+
+        :param intrusion_length: The length of the intrusion
+        :param initial_state_index: The index of the initial state
+        :param seed: The seed for the random number generator
+        return: The sequence of states and observations
+        """
+
+        P_obs = self.emission_matrix
+        P_states = self.transition_matrix
+        states = self.hidden_states
+        observations = self.emission_matrix_observations
+
+        if seed:
+            np.random.seed(seed)
+        obs_len = len(observations)
+        states_len = len(states)
+        # Return the geometric distribution of the initial state
+        dist = np.random.geometric(p=P_states[initial_state_index][0], size=1000)
+        T_i = round(sum(dist) / len(dist))
+
+        state_seq = [states[initial_state_index]] * T_i
+        obs_seq = []
+        for i in range(T_i):
+            o_i = np.random.choice(obs_len, p=P_obs[initial_state_index])
+            obs_seq.append(observations[o_i])
+
+        recon_states_sum = np.sum(P_states[initial_state_index][1:])
+        recon_states = P_states[initial_state_index][1:] / recon_states_sum
+
+        intrusion_start_state = np.random.choice(states_len - 1, p=recon_states) + 1
+        intrusion_start_observation = np.random.choice(obs_len, p=P_obs[intrusion_start_state])
+        state_seq.append(states[intrusion_start_state])
+        obs_seq.append(observations[intrusion_start_observation])
+
+        s_i = intrusion_start_state
+        if intrusion_length == 1:
+            return state_seq, obs_seq
+        for i in range(intrusion_length - 1):
+            # si ~ Ps(si | si-1)
+            s_i = np.random.choice(states_len, p=P_states[s_i])
+            # oi ~ Po(oi | si)
+            o_i = np.random.choice(obs_len, p=P_obs[s_i])
+            state_seq.append(states[s_i])
+            obs_seq.append(observations[o_i])
+        return state_seq, obs_seq

csle_attack_profiler-0.9.4.dist-info/METADATA

@@ -0,0 +1,409 @@
+Metadata-Version: 2.1
+Name: csle-attack-profiler
+Version: 0.9.4
+Summary: Library with MITRE attack profiler for CSLE
+Author: Bength Pappila
+Author-email: brpa@kth.se
+Maintainer-email: Kim Hammar <kimham@kth.se>
+License: ## creative commons
+        
+        # Attribution-ShareAlike 4.0 International
+        
+        Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible.
+        
+        ### Using Creative Commons Public Licenses
+        
+        Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses.
+        
+        * __Considerations for licensors:__ Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. [More considerations for licensors](http://wiki.creativecommons.org/Considerations_for_licensors_and_licensees#Considerations_for_licensors).
+        
+        * __Considerations for the public:__ By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described. Although not required by our licenses, you are encouraged to respect those requests where reasonable. [More considerations for the public](http://wiki.creativecommons.org/Considerations_for_licensors_and_licensees#Considerations_for_licensees).
+        
+        ## Creative Commons Attribution-ShareAlike 4.0 International Public License
+        
+        By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-ShareAlike 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.
+        
+        ### Section 1 – Definitions.
+        
+        a. __Adapted Material__ means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.
+        
+        b. __Adapter's License__ means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License.
+        
+        c. __BY-SA Compatible License__ means a license listed at [creativecommons.org/compatiblelicenses](http://creativecommons.org/compatiblelicenses), approved by Creative Commons as essentially the equivalent of this Public License.
+        
+        d. __Copyright and Similar Rights__ means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
+        
+        e. __Effective Technological Measures__ means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements.
+        
+        f. __Exceptions and Limitations__ means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material.
+        
+        g. __License Elements__ means the license attributes listed in the name of a Creative Commons Public License. The License Elements of this Public License are Attribution and ShareAlike.
+        
+        h. __Licensed Material__ means the artistic or literary work, database, or other material to which the Licensor applied this Public License.
+        
+        i. __Licensed Rights__ means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license.
+        
+        j. __Licensor__ means the individual(s) or entity(ies) granting rights under this Public License.
+        
+        k. __Share__ means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them.
+        
+        l. __Sui Generis Database Rights__ means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world.
+        
+        m. __You__ means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning.
+        
+        ### Section 2 – Scope.
+        
+        a. ___License grant.___
+        
+            1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to:
+        
+                A. reproduce and Share the Licensed Material, in whole or in part; and
+        
+                B. produce, reproduce, and Share Adapted Material.
+        
+            2. __Exceptions and Limitations.__ For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions.
+        
+            3. __Term.__ The term of this Public License is specified in Section 6(a).
+        
+            4. __Media and formats; technical modifications allowed.__ The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material.
+        
+            5. __Downstream recipients.__
+        
+                A. __Offer from the Licensor – Licensed Material.__ Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License.
+        
+                B. __Additional offer from the Licensor – Adapted Material. Every recipient of Adapted Material from You automatically receives an offer from the Licensor to exercise the Licensed Rights in the Adapted Material under the conditions of the Adapter’s License You apply.
+        
+                C. __No downstream restrictions.__ You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material.
+        
+            6. __No endorsement.__ Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i).
+        
+        b. ___Other rights.___
+        
+            1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise.
+        
+            2. Patent and trademark rights are not licensed under this Public License.
+        
+            3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties.
+        
+        ### Section 3 – License Conditions.
+        
+        Your exercise of the Licensed Rights is expressly made subject to the following conditions.
+        
+        a. ___Attribution.___
+        
+            1. If You Share the Licensed Material (including in modified form), You must:
+        
+                A. retain the following if it is supplied by the Licensor with the Licensed Material:
+        
+                    i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated);
+        
+                    ii. a copyright notice;
+        
+                    iii. a notice that refers to this Public License;
+        
+                    iv. a notice that refers to the disclaimer of warranties;
+        
+                    v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
+        
+                B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and
+        
+                C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License.
+        
+            2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information.
+        
+            3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable.
+        
+        b. ___ShareAlike.___
+        
+        In addition to the conditions in Section 3(a), if You Share Adapted Material You produce, the following conditions also apply.
+        
+        1. The Adapter’s License You apply must be a Creative Commons license with the same License Elements, this version or later, or a BY-SA Compatible License.
+        
+        2. You must include the text of, or the URI or hyperlink to, the Adapter's License You apply. You may satisfy this condition in any reasonable manner based on the medium, means, and context in which You Share Adapted Material.
+        
+        3. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, Adapted Material that restrict exercise of the rights granted under the Adapter's License You apply.
+        
+        ### Section 4 – Sui Generis Database Rights.
+        
+        Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:
+        
+        a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database;
+        
+        b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material, including for purposes of Section 3(b); and
+        
+        c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database.
+        
+        For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights.
+        
+        ### Section 5 – Disclaimer of Warranties and Limitation of Liability.
+        
+        a. __Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.__
+        
+        b. __To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.__
+        
+        c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.
+        
+        ### Section 6 – Term and Termination.
+        
+        a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically.
+        
+        b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:
+        
+            1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or
+        
+            2. upon express reinstatement by the Licensor.
+        
+            For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License.
+        
+        c. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.
+        
+        d. Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
+        
+        ### Section 7 – Other Terms and Conditions.
+        
+        a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.
+        
+        b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.t stated herein are separate from and independent of the terms and conditions of this Public License.
+        
+        ### Section 8 – Interpretation.
+        
+        a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.
+        
+        b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions.
+        
+        c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.
+        
+        d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.
+        
+        ```
+        Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at [creativecommons.org/policies](http://creativecommons.org/policies), Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses.
+        
+        Creative Commons may be contacted at creativecommons.org
+        ```
+        
+        ## Disclaimer
+        
+        All code and software in this repository is for Educational purpose ONLY. Do not use it without permission. The usual
+        disclaimer applies, especially the fact that me (Kim Hammar) is not liable for any damages caused by direct or indirect
+        use of the information or functionality provided by these programs. The author or any Internet provider bears NO
+        responsibility for content or misuse of these programs or any derivatives thereof. By using these programs you accept
+        the fact that any damage (dataloss, system crash, system compromise, etc.)
+        caused by the use of these programs is not Kim Hammar's responsibility.
+Project-URL: Homepage, https://limmen.dev/csle
+Project-URL: Source, https://github.com/Limmen/csle
+Keywords: Reinforcement-Learning,Cyber-Security,Markov-Games,Markov-Decision-Processes
+Platform: unix
+Platform: linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Intended Audience :: Science/Research
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: mitreattack-python==2.0.14
+Requires-Dist: csle-base==0.9.4
+Requires-Dist: csle-common==0.9.4
+Provides-Extra: test
+Requires-Dist: pytest>=6.0; extra == "test"
+Requires-Dist: pytest-cov>=2.0; extra == "test"
+Requires-Dist: pytest-mock>=3.6.0; extra == "test"
+Requires-Dist: pytest-grpc>=0.8.0; extra == "test"
+Requires-Dist: grpcio>=1.69.0; extra == "test"
+Requires-Dist: grpcio-tools>=1.69.0; extra == "test"
+Requires-Dist: mypy>=1.7.0; extra == "test"
+Requires-Dist: mypy-extensions>=1.0.0; extra == "test"
+Requires-Dist: mypy-protobuf>=3.5.0; extra == "test"
+Requires-Dist: types-PyYAML>=6.0.12.11; extra == "test"
+Requires-Dist: types-paramiko>=3.2.0.0; extra == "test"
+Requires-Dist: types-protobuf>=5.29.1.20250208; extra == "test"
+Requires-Dist: types-requests>=2.31.0.1; extra == "test"
+Requires-Dist: types-urllib3>=1.26.25.13; extra == "test"
+Requires-Dist: flake8>=6.1.0; extra == "test"
+Requires-Dist: flake8-rst-docstrings>=0.3.0; extra == "test"
+Requires-Dist: tox>=4.24.1; extra == "test"
+Requires-Dist: sphinx>=5.3.0; extra == "test"
+Requires-Dist: sphinxcontrib-napoleon>=0.7; extra == "test"
+Requires-Dist: sphinx-rtd-theme>=1.1.1; extra == "test"
+Requires-Dist: twine>=6.1.0; extra == "test"
+Requires-Dist: build>=0.10.0; extra == "test"
+
+# `csle-attack-profiler`
+
+Scripts and programs to profile attacks, attack sequences, and a probabilistic HMM profiler 
+using data from the csle platform, profiling attacks to MITRE ATT&CK techniques, and tactics.
+
+[![PyPI version]] 0.5.1
+![PyPI - Downloads] (https://pypi.org/project/csle-attack-profiler/)
+
+## Requirements
+
+- Python 3.8+
+- `csle-common`
+- `csle-base`
+- `mitreattack-python`
+
+
+## Development Requirement`
+
+- Python 3.8+
+- `flake8` (for linting)
+- `flake8-rst-docstrings` (for linting docstrings)
+- `tox` (for automated testing)
+- `pytest` (for unit tests)
+- `pytest-cov` (for unit test coverage)
+- `mypy` (for static typing)
+- `mypy-extensions` (for static typing)
+- `mypy-protobuf` (for static typing)
+- `types-PyYaml` (for static typing)
+- `types-paramiko` (for static typing)
+- `types-protobuf` (for static typing)
+- `types-requests` (for static typing)
+- `types-urllib3` (for static typing)
+- `sphinx` (for API documentation)
+- `sphinxcontrib-napoleon` (for API documentation)
+- `sphinx-rtd-theme` (for API documentation)
+- `pytest-mock` (for mocking tests)
+- `pytest-grpc` (for grpc tests)
+
+## Installation
+
+```bash
+# install from pip
+pip install csle-attack-profiler==<version>
+# local install from source
+$ pip install -e csle-attack-profiler
+# or (equivalently):
+make install
+# force upgrade deps
+$ pip install -e csle-attack-profiler --upgrade
+# git clone and install from source
+git clone https://github.com/Limmen/csle
+cd csle/simulation-system/libs/csle-attack-profiler
+pip3 install -e .
+# Install development dependencies
+$ pip install -r requirements_dev.txt
+```
+
+### Development tools 
+
+Install all development tools at once:
+```bash
+make install_dev
+```
+or
+```bash
+pip install -r requirements_dev.txt
+```
+## API documentation
+
+This section contains instructions for generating API documentation using `sphinx`.
+
+### Latest Documentation
+
+The latest documentation is available at [https://limmen.dev/csle/docs/csle-attack-profiler](https://limmen.dev/csle/docs/csle-attack-profiler)
+
+### Generate API Documentation
+
+First make sure that the `CSLE_HOME` environment variable is set:
+```bash
+echo $CSLE_HOME
+```
+Then generate the documentation with the commands:
+```bash
+cd docs
+sphinx-apidoc -f -o source/ ../src/csle_attack_profiler/
+make html
+```
+To update the official documentation at [https://limmen.dev/csle](https://limmen.dev/csle), 
+copy the generated HTML files to the documentation folder:
+```bash
+cp -r build/html ../../../../docs/_docs/csle-attack-profiler
+```
+
+To run all documentation commands at once, use the command:
+```bash
+make docs
+```
+
+## Static code analysis
+
+To run the Python linter, execute the following command:
+```
+flake8 .
+# or (equivalently):
+make lint
+```
+
+To run the mypy type checker, execute the following command:
+```
+mypy .
+# or (equivalently):
+make types
+```
+
+## Unit tests
+
+To run the unit tests, execute the following command:
+```
+pytest
+# or (equivalently):
+make unit_tests
+```
+
+To run tests of a specific test suite, execute the following command:
+```
+pytest -k "ClassName"
+```
+
+To generate a coverage report, execute the following command:
+```
+pytest --cov=csle_attack_profiler
+```
+
+## Run tests and code analysis in different python environments
+
+To run tests and code analysis in different python environments, execute the following command:
+
+```bash
+tox
+# or (equivalently):
+make tests
+```
+
+## Create a new release and publish to PyPi
+
+First build the package by executing:
+```bash
+python -m build
+# or (equivalently)
+make build
+```
+After running the command above, the built package is available at `./dist`.
+
+Push the built package to PyPi by running:
+```bash
+python -m twine upload dist/*
+# or (equivalently)
+make push
+```
+
+To run all commands for the release at once, execute:
+```bash
+make release
+```
+
+## Author & Maintainer
+
+Bength Pappila <brpa@kth.se>
+
+## Copyright and license
+
+[LICENSE](LICENSE.md)
+
+Creative Commons
+
+(C) 2024, Bength Pappila
+

csle_attack_profiler-0.9.4.dist-info/RECORD

@@ -0,0 +1,8 @@
+csle_attack_profiler/__init__.py,sha256=C7_gE0lIQJ8Wh2jgU8C8P_xyvq76bKTf0gm8bGYhMBk,37
+csle_attack_profiler/__version__.py,sha256=PrvpsFpxFfV-9CkerqH8w9aj7jp44ZzlQ22FXf5IOIk,22
+csle_attack_profiler/attack_profiler.py,sha256=bYqSeItJkhswronvIRFPyvf1rtvUKEWPPF4K2t1JVqE,10535
+csle_attack_profiler/hmm_profiling.py,sha256=cHE2wImgBJ3xwW33S0JcTwsiccstijR9uRMeBPXIT18,24167
+csle_attack_profiler-0.9.4.dist-info/METADATA,sha256=s-B-_-PYsvG8fPylVkp_d_yvVYiTkRHLz6TpG-qvmo4,26732
+csle_attack_profiler-0.9.4.dist-info/WHEEL,sha256=A3WOREP4zgxI0fKrHUG8DC8013e3dK3n7a6HDbcEIwE,91
+csle_attack_profiler-0.9.4.dist-info/top_level.txt,sha256=OuI4zvPo3MQYLQ7Dqm32oM0V8rNdwHe9tjtngx2KVtA,21
+csle_attack_profiler-0.9.4.dist-info/RECORD,,

csle_attack_profiler-0.9.4.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.7.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

csle_attack_profiler-0.9.4.dist-info/top_level.txt

@@ -0,0 +1 @@
+csle_attack_profiler