Game Components

This module contains the core building blocks and data structures used throughout the NetSecGame environment. These include fundamental types such as IP addresses, networks, services, data objects, and actions. These components are used to define both the environment's state and the interactions between agents and the world.

netsecgame.game_components

Action dataclass

Immutable dataclass representing an Action.

Attributes:

Name	Type	Description
action_type	ActionType	The type of action.
parameters	Dict[str, Any]	Parameters for the action.

as_dict property

Return a dictionary representation of the Action.

Returns:

Type	Description
Dict[str, Any]	Dict[str, Any]: The action as a dictionary.

type property

Return the action type.

Returns:

Name	Type	Description
ActionType	ActionType	The action type.

__eq__

Check equality with another Action object.

Parameters:

Name	Type	Description	Default
other	object	Another Action object.	required

Returns:

Name	Type	Description
bool	bool	True if equal, False otherwise.

Source code in netsecgame/game_components.py

def __eq__(self, other: object) -> bool:
    """
    Check equality with another Action object.

    Args:
        other (object): Another Action object.

    Returns:
        bool: True if equal, False otherwise.
    """
    if not isinstance(other, Action):
        return NotImplemented
    return (
        self.action_type == other.action_type and
        self.parameters == other.parameters
    )

__hash__

Compute the hash of the Action.

Returns:

Name	Type	Description
int	int	The hash value.

Source code in netsecgame/game_components.py

def __hash__(self) -> int:
    """
    Compute the hash of the Action.

    Returns:
        int: The hash value.
    """
    # Convert parameters to a sorted tuple of key-value pairs for consistency
    sorted_params = tuple(sorted((k, hash(v)) for k, v in self.parameters.items()))
    return hash((self.action_type, sorted_params))

__repr__

Return the string representation of the Action.

Returns:

Name	Type	Description
str	str	The action as a string.

Source code in netsecgame/game_components.py

def __repr__(self) -> str:
    """
    Return the string representation of the Action.

    Returns:
        str: The action as a string.
    """
    return f"Action <{self.action_type}|{self.parameters}>"

__str__

Return the string representation of the Action.

Returns:

Name	Type	Description
str	str	The action as a string.

Source code in netsecgame/game_components.py

def __str__(self) -> str:
    """
    Return the string representation of the Action.

    Returns:
        str: The action as a string.
    """
    return f"Action <{self.action_type}|{self.parameters}>"

from_dict classmethod

Create an Action from a dictionary.

Parameters:

Name	Type	Description	Default
data_dict	Dict[str, Any]	The action as a dictionary.	required

Returns:

Name	Type	Description
Action	Action	The created Action object.

Raises:

Type	Description
ValueError	If an unsupported parameter is encountered.

Source code in netsecgame/game_components.py

@classmethod
def from_dict(cls, data_dict: Dict[str, Any]) -> Action:
    """
    Create an Action from a dictionary.

    Args:
        data_dict (Dict[str, Any]): The action as a dictionary.

    Returns:
        Action: The created Action object.

    Raises:
        ValueError: If an unsupported parameter is encountered.
    """
    action_type = ActionType.from_string(data_dict["action_type"])
    params: Dict[str, Any] = {}
    for k, v in data_dict["parameters"].items():
        match k:
            case "source_host" | "target_host" | "blocked_host" | "blocked_ip":
                params[k] = IP.from_dict(v)
            case "target_network":
                params[k] = Network.from_dict(v)
            case "target_service":
                params[k] = Service.from_dict(v)
            case "data":
                params[k] = Data.from_dict(v)
            case "agent_info":
                params[k] = AgentInfo.from_dict(v)
            case "request_trajectory" | "randomize_topology":
                if isinstance(v, bool):
                    params[k] = v
                else:
                    params[k] = ast.literal_eval(v)
            case "seed":
                if isinstance(v, int):
                    params[k] = v
                elif v is None or v == "None":
                    params[k] = None
                else:
                    raise ValueError(f"Unsupported value in {k}: {v}")
            case _:
                raise ValueError(f"Unsupported value in {k}: {v}")
    return cls(action_type=action_type, parameters=params)

from_json classmethod

Create an Action from a JSON string.

Parameters:

Name	Type	Description	Default
json_string	str	The JSON string representation.	required

Returns:

Name	Type	Description
Action	Action	The created Action object.

Source code in netsecgame/game_components.py

@classmethod
def from_json(cls, json_string: str) -> Action:
    """
    Create an Action from a JSON string.

    Args:
        json_string (str): The JSON string representation.

    Returns:
        Action: The created Action object.
    """
    data_dict = json.loads(json_string)
    return cls.from_dict(data_dict)

to_json

Serialize the Action to a JSON string.

Returns:

Name	Type	Description
str	str	The JSON string representation.

Source code in netsecgame/game_components.py

def to_json(self) -> str:
    """
    Serialize the Action to a JSON string.

    Returns:
        str: The JSON string representation.
    """
    return json.dumps(self.as_dict)

ActionType

Bases: Enum

Enum representing possible action types in the NetSecGame.

__eq__

Compare ActionType with another ActionType or string.

Parameters:

Name	Type	Description	Default
other	object	The object to compare.	required

Returns:

Name	Type	Description
bool	bool	True if equal, False otherwise.

Source code in netsecgame/game_components.py

def __eq__(self, other: object) -> bool:
    """
    Compare ActionType with another ActionType or string.

    Args:
        other (object): The object to compare.

    Returns:
        bool: True if equal, False otherwise.
    """
    # Compare with another ActionType
    if isinstance(other, ActionType):
        return self.value == other.value
    # Compare with a string
    elif isinstance(other, str):
       return self.value == other.replace("ActionType.", "")
    return False

__hash__

Compute the hash of the ActionType.

Returns:

Name	Type	Description
int	int	The hash value.

Source code in netsecgame/game_components.py

def __hash__(self) -> int:
    """
    Compute the hash of the ActionType.

    Returns:
        int: The hash value.
    """
    # Use the hash of the value for consistent behavior
    return hash(self.value)

from_string classmethod

Convert a string to an ActionType enum. Strips 'ActionType.' if present.

Parameters:

Name	Type	Description	Default
name	str	The string representation.	required

Returns:

Name	Type	Description
ActionType	ActionType	The corresponding ActionType.

Raises:

Type	Description
ValueError	If the string does not match any ActionType.

Source code in netsecgame/game_components.py

@classmethod
def from_string(cls, name: str) -> ActionType:
    """
    Convert a string to an ActionType enum. Strips 'ActionType.' if present.

    Args:
        name (str): The string representation.

    Returns:
        ActionType: The corresponding ActionType.

    Raises:
        ValueError: If the string does not match any ActionType.
    """
    if name.startswith("ActionType."):
        name = name.split("ActionType.")[1]
    try:
        return cls[name]
    except KeyError:
        raise ValueError(f"Invalid ActionType: {name}")

to_string

Convert the ActionType enum to string.

Returns:

Name	Type	Description
str	str	The string representation.

Source code in netsecgame/game_components.py

def to_string(self) -> str:
    """
    Convert the ActionType enum to string.

    Returns:
        str: The string representation.
    """
    return self.value

AgentInfo dataclass

Represents agent information.

Attributes:

Name	Type	Description
name	str	Name of the agent.
role	str	Role of the agent.

__repr__

Return the string representation of the AgentInfo.

Returns:

Name	Type	Description
str	str	The agent info as a string.

Source code in netsecgame/game_components.py

def __repr__(self) -> str:
    """
    Return the string representation of the AgentInfo.

    Returns:
        str: The agent info as a string.
    """
    return f"{self.name}({self.role})"

from_dict classmethod

Build the AgentInfo object from a dictionary.

Parameters:

Name	Type	Description	Default
data	Dict[str, Any]	Dictionary with agent info attributes.	required

Returns:

Name	Type	Description
AgentInfo	AgentInfo	The created AgentInfo object.

Source code in netsecgame/game_components.py

@classmethod
def from_dict(cls, data: Dict[str, Any]) -> AgentInfo:
    """
    Build the AgentInfo object from a dictionary.

    Args:
        data (Dict[str, Any]): Dictionary with agent info attributes.

    Returns:
        AgentInfo: The created AgentInfo object.
    """
    if isinstance(data, str):
        data = ast.literal_eval(data)
    processed = {"name": data["name"], "role": AgentRole.from_string(data["role"])}
    return cls(**processed)   

AgentRole

Bases: str, Enum

Enum representing possible roles of agents.

__eq__

Compare AgentRole with another AgentRole or string.

Parameters:

Name	Type	Description	Default
other	object	The object to compare.	required

Returns:

Name	Type	Description
bool	bool	True if equal, False otherwise.

Source code in netsecgame/game_components.py

def __eq__(self, other: object) -> bool:
    """
    Compare AgentRole with another AgentRole or string.

    Args:
        other (object): The object to compare.

    Returns:
        bool: True if equal, False otherwise.
    """
    if isinstance(other, AgentRole):
         return self.value == other.value
    elif isinstance(other, str):
         return self.value.lower() == other.lower().replace("agentrole.", "")
    return False

__hash__

Compute the hash of the AgentRole.

Returns:

Name	Type	Description
int	int	The hash value.

Source code in netsecgame/game_components.py

def __hash__(self) -> int:
    """
    Compute the hash of the AgentRole.

    Returns:
        int: The hash value.
    """
    return hash(self.value)

__repr__

Return the string representation of the AgentRole.

Returns:

Name	Type	Description
str	str	The agent role as a string.

Source code in netsecgame/game_components.py

def __repr__(self) -> str:
    """
    Return the string representation of the AgentRole.

    Returns:
        str: The agent role as a string.
    """
    return self.value

from_string classmethod

Convert a string to an AgentRole enum.

Parameters:

Name	Type	Description	Default
name	str	The string representation.	required

Returns:

Name	Type	Description
AgentRole	AgentRole	The corresponding AgentRole.

Raises:

Type	Description
ValueError	If the string does not match any AgentRole.

Source code in netsecgame/game_components.py

@classmethod
def from_string(cls, name: str) -> AgentRole:
    """
    Convert a string to an AgentRole enum.

    Args:
        name (str): The string representation.

    Returns:
        AgentRole: The corresponding AgentRole.

    Raises:
        ValueError: If the string does not match any AgentRole.
    """
    # Clean up input string
    name = name.split(".")[-1] # Remove prefix if present

    # Try case-insensitive matching
    for role in cls:
        if role.value.lower() == name.lower():
            return role

    raise ValueError(f"Invalid AgentRole: {name}")

to_string

Convert the AgentRole enum to string.

Returns:

Name	Type	Description
str	str	The string representation.

Source code in netsecgame/game_components.py

def to_string(self) -> str:
    """
    Convert the AgentRole enum to string.

    Returns:
        str: The string representation.
    """
    return self.value

AgentStatus

Bases: Enum

Enum representing possible agent statuses.

__eq__

Compare AgentStatus with another AgentStatus or string.

Parameters:

Name	Type	Description	Default
other	object	The object to compare.	required

Returns:

Name	Type	Description
bool	bool	True if equal, False otherwise.

Source code in netsecgame/game_components.py

def __eq__(self, other: object) -> bool:
    """
    Compare AgentStatus with another AgentStatus or string.

    Args:
        other (object): The object to compare.

    Returns:
        bool: True if equal, False otherwise.
    """
    # Compare with another ActionType
    if isinstance(other, AgentStatus):
        return self.value == other.value
    # Compare with a string
    elif isinstance(other, str):
       return self.value == other.replace("AgentStatus.", "")
    return False

__hash__

Compute the hash of the AgentStatus.

Returns:

Name	Type	Description
int	int	The hash value.

Source code in netsecgame/game_components.py

def __hash__(self) -> int:
    """
    Compute the hash of the AgentStatus.

    Returns:
        int: The hash value.
    """
    # Use the hash of the value for consistent behavior
    return hash(self.value)

from_string classmethod

Convert a string to an AgentStatus enum.

Parameters:

Name	Type	Description	Default
name	str	The string representation.	required

Returns:

Name	Type	Description
AgentStatus	AgentStatus	The corresponding AgentStatus.

Raises:

Type	Description
ValueError	If the string does not match any AgentStatus.

Source code in netsecgame/game_components.py

@classmethod
def from_string(cls, name: str) -> AgentStatus:
    """
    Convert a string to an AgentStatus enum.

    Args:
        name (str): The string representation.

    Returns:
        AgentStatus: The corresponding AgentStatus.

    Raises:
        ValueError: If the string does not match any AgentStatus.
    """
    if name.startswith("AgentStatus."):
        name = name.split("AgentStatus.")[1]
    try:
        return cls[name]
    except KeyError:
        raise ValueError(f"Invalid AgentStatus: {name}")

to_string

Convert the AgentStatus enum to string.

Returns:

Name	Type	Description
str	str	The string representation.

Source code in netsecgame/game_components.py

def to_string(self) -> str:
    """
    Convert the AgentStatus enum to string.

    Returns:
        str: The string representation.
    """
    return self.value

Data dataclass

Represents a data object in the NetSecGame.

Attributes:

Name	Type	Description
owner	str	Owner of the data.
id	str	Identifier of the data.
size	int	Size of the data. Default = 0
type	str	Type of the data. Default = ""
content	str	Content of the data. Default = ""

__hash__

Compute the hash of the Data object.

Returns:

Name	Type	Description
int	int	The hash value.

Source code in netsecgame/game_components.py

def __hash__(self) -> int:
    """
    Compute the hash of the Data object.

    Returns:
        int: The hash value.
    """
    return hash((self.owner, self.id, self.type))

from_dict classmethod

Build the Data object from a dictionary.

Parameters:

Name	Type	Description	Default
data	Dict[str, Any]	Dictionary with data attributes.	required

Returns:

Name	Type	Description
Data	Data	The created Data object.

Source code in netsecgame/game_components.py

@classmethod
def from_dict(cls, data: Dict[str, Any]) -> Data:
    """
    Build the Data object from a dictionary.

    Args:
        data (Dict[str, Any]): Dictionary with data attributes.

    Returns:
        Data: The created Data object.
    """
    return cls(**data)

GameState dataclass

Represents the state of the game.

Attributes:

Name	Type	Description
controlled_hosts	Set[IP]	Controlled hosts.
known_hosts	Set[IP]	Known hosts.
known_services	Dict[IP, Set[Service]]	Known services.
known_data	Dict[IP, Set[Data]]	Known data.
known_networks	Set[Network]	Known networks.
known_blocks	Dict[IP, Set[IP]]	Known blocks.

as_dict property

Return the dictionary representation of the GameState.

Returns:

Type	Description
Dict[str, Any]	Dict[str, Any]: The game state as a dictionary.

as_graph property

Build a graph representation of the game state.

Returns:

Type	Description
List[int]	Tuple[List[int], List[int], List[Tuple[int, int]], Dict[Any, int]]:
List[int]	(node_features, controlled, edges, node_index_map)

__str__

Return the string representation of the GameState.

Returns:

Name	Type	Description
str	str	The game state as a string.

Source code in netsecgame/game_components.py

def __str__(self) -> str:
    """
    Return the string representation of the GameState.

    Returns:
        str: The game state as a string.
    """
    return f"State<nets:{self.known_networks}; known:{self.known_hosts}; owned:{self.controlled_hosts}; services:{self.known_services}; data:{self.known_data}; blocks:{self.known_blocks}>"    

as_json

Return the JSON representation of the GameState.

Returns:

Name	Type	Description
str	str	The JSON string.

Source code in netsecgame/game_components.py

def as_json(self) -> str:
    """
    Return the JSON representation of the GameState.

    Returns:
        str: The JSON string.
    """
    ret_dict = self.as_dict
    return json.dumps(ret_dict)

from_dict classmethod

Create a GameState from a dictionary.

Parameters:

Name	Type	Description	Default
data_dict	Dict[str, Any]	The game state as a dictionary.	required

Returns:

Name	Type	Description
GameState	GameState	The created GameState object.

Source code in netsecgame/game_components.py

@classmethod
def from_dict(cls, data_dict: Dict[str, Any]) -> GameState:
    """
    Create a GameState from a dictionary.

    Args:
        data_dict (Dict[str, Any]): The game state as a dictionary.

    Returns:
        GameState: The created GameState object.
    """
    if "known_blocks" in data_dict:
        known_blocks = {}
        for target_host, blocked_hosts in data_dict["known_blocks"].items():
            blocked_ips = set()
            for blocked_host in blocked_hosts:
                ip_val = blocked_host["ip"]
                if isinstance(ip_val, dict):
                     ip_val = ip_val["ip"]
                blocked_ips.add(IP(ip_val))
            known_blocks[IP(target_host)] = blocked_ips
    else:
        known_blocks = {}
    state = GameState(
        known_networks = {Network(x["ip"], x["mask"]) for x in data_dict["known_networks"]},
        known_hosts = {IP(x["ip"]) for x in data_dict["known_hosts"]},
        controlled_hosts = {IP(x["ip"]) for x in data_dict["controlled_hosts"]},
        known_services = {IP(k):{Service(s["name"], s["type"], s["version"], s["is_local"])
            for s in services} for k,services in data_dict["known_services"].items()},  
        known_data = {IP(k):{Data(v["owner"], v["id"], v["size"], v["type"], v["content"]) for v in values} for k,values in data_dict["known_data"].items()},
        known_blocks = known_blocks
            )
    return state

from_json classmethod

Create a GameState from a JSON string.

Parameters:

Name	Type	Description	Default
json_string	str	The JSON string.	required

Returns:

Name	Type	Description
GameState	GameState	The created GameState object.

Source code in netsecgame/game_components.py

@classmethod
def from_json(cls, json_string: str) -> GameState:
    """
    Create a GameState from a JSON string.

    Args:
        json_string (str): The JSON string.

    Returns:
        GameState: The created GameState object.
    """
    data_dict = json.loads(json_string)
    return cls.from_dict(data_dict)

GameStatus

Bases: Enum

Enum representing possible game statuses.

__repr__

Return the string representation of the GameStatus.

Returns:

Name	Type	Description
str	str	The game status as a string.

Source code in netsecgame/game_components.py

def __repr__(self) -> str:
    """
    Return the string representation of the GameStatus.

    Returns:
        str: The game status as a string.
    """
    return str(self)

from_string classmethod

Convert a string to a GameStatus enum.

Parameters:

Name	Type	Description	Default
string	str	The string representation.	required

Returns:

Name	Type	Description
GameStatus	GameStatus	The corresponding GameStatus.

Source code in netsecgame/game_components.py

@classmethod
def from_string(cls, string: str) -> GameStatus:
    """
    Convert a string to a GameStatus enum.

    Args:
        string (str): The string representation.

    Returns:
        GameStatus: The corresponding GameStatus.
    """
    match string:
        case "GameStatus.OK":
            return GameStatus.OK
        case "GameStatus.CREATED":
            return GameStatus.CREATED
        case "GameStatus.BAD_REQUEST":
            return GameStatus.BAD_REQUEST
        case "GameStatus.FORBIDDEN":
            return GameStatus.FORBIDDEN
        case "GameStatus.RESET_DONE":
            return GameStatus.RESET_DONE
        case _:
            raise ValueError(f"Invalid GameStatus string: {string}")

IP dataclass

Immutable object representing an IPv4 address in the NetSecGame.

Attributes:

Name	Type	Description
ip	str	The IP address in dot-decimal notation.

__eq__

Check equality with another IP object.

Parameters:

Name	Type	Description	Default
other	object	Another object to compare with.	required

Returns:

Name	Type	Description
bool	bool	True if equal, False otherwise.

Source code in netsecgame/game_components.py

def __eq__(self, other: object) -> bool:
    """
    Check equality with another IP object.

    Args:
        other (object): Another object to compare with.

    Returns:
        bool: True if equal, False otherwise.
    """
    if not isinstance(other, IP):
        return NotImplemented
    return self.ip == other.ip

__hash__

Compute the hash of the IP.

Returns:

Name	Type	Description
int	int	The hash value.

Source code in netsecgame/game_components.py

def __hash__(self) -> int:
    """
    Compute the hash of the IP.

    Returns:
        int: The hash value.
    """
    return hash(self.ip)

__post_init__

Verify if the provided IP is valid.

Raises:

Type	Description
ValueError	If the IP address is invalid.

Source code in netsecgame/game_components.py

def __post_init__(self):
    """
    Verify if the provided IP is valid.

    Raises:
        ValueError: If the IP address is invalid.
    """
    try:
        ipaddress.ip_address(self.ip)
    except ValueError:
        raise ValueError(f"Invalid IP address provided: {self.ip}")

__repr__

Return the string representation of the IP.

Returns:

Name	Type	Description
str	str	The IP address.

Source code in netsecgame/game_components.py

def __repr__(self) -> str:
    """
    Return the string representation of the IP.

    Returns:
        str: The IP address.
    """
    return self.ip

from_dict classmethod

Build the IP object from a dictionary representation.

Parameters:

Name	Type	Description	Default
data	Dict[str, Any]	Dictionary with IP attributes.	required

Returns:

Name	Type	Description
IP	IP	The created IP object.

Source code in netsecgame/game_components.py

@classmethod
def from_dict(cls, data: Dict[str, Any]) -> IP:
    """
    Build the IP object from a dictionary representation.

    Args:
        data (Dict[str, Any]): Dictionary with IP attributes.

    Returns:
        IP: The created IP object.
    """
    return cls(**data)

is_private

Check if the IP address is private. Uses ipaddress module.

Returns:

Name	Type	Description
bool	bool	True if the IP is private, False otherwise.

Source code in netsecgame/game_components.py

def is_private(self) -> bool:
    """
    Check if the IP address is private. Uses ipaddress module.

    Returns:
        bool: True if the IP is private, False otherwise.
    """
    try:
        return ipaddress.IPv4Network(self.ip).is_private
    except ipaddress.AddressValueError:
        # The IP is a string 
        # In the concepts, 'external' is the string used for external hosts.
        if self.ip != 'external':
            return True
        return False

Network dataclass

Immutable object representing an IPv4 network in the NetSecGame.

Attributes:

Name	Type	Description
ip	str	IP address of the network.
mask	int	CIDR mask of the network.

__gt__

Greater-than comparison for networks.

Parameters:

Name	Type	Description	Default
other	Network	Another network.	required

Returns:

Name	Type	Description
bool	bool	True if self > other, False otherwise.

Source code in netsecgame/game_components.py

def __gt__(self, other: Network) -> bool:
    """
    Greater-than comparison for networks.

    Args:
        other (Network): Another network.

    Returns:
        bool: True if self > other, False otherwise.
    """
    try:
        return netaddr.IPNetwork(str(self)) > netaddr.IPNetwork(str(other))
    except netaddr.AddrFormatError:
        return str(self.ip) > str(other.ip)

__le__

Less-than-or-equal comparison for networks.

Parameters:

Name	Type	Description	Default
other	Network	Another network.	required

Returns:

Name	Type	Description
bool	bool	True if self <= other, False otherwise.

Source code in netsecgame/game_components.py

def __le__(self, other: Network) -> bool:
    """
    Less-than-or-equal comparison for networks.

    Args:
        other (Network): Another network.

    Returns:
        bool: True if self <= other, False otherwise.
    """
    try:
        return netaddr.IPNetwork(str(self)) <= netaddr.IPNetwork(str(other))
    except netaddr.AddrFormatError:
        return str(self.ip) <= str(other.ip)

__lt__

Less-than comparison for networks.

Parameters:

Name	Type	Description	Default
other	Network	Another network.	required

Returns:

Name	Type	Description
bool	bool	True if self < other, False otherwise.

Source code in netsecgame/game_components.py

def __lt__(self, other: Network) -> bool:
    """
    Less-than comparison for networks.

    Args:
        other (Network): Another network.

    Returns:
        bool: True if self < other, False otherwise.
    """
    try:
        return netaddr.IPNetwork(str(self)) < netaddr.IPNetwork(str(other))
    except netaddr.AddrFormatError:
        return str(self.ip) < str(other.ip)

__repr__

Return the string representation of the network.

Returns:

Name	Type	Description
str	str	The network in CIDR notation.

Source code in netsecgame/game_components.py

def __repr__(self) -> str:
    """
    Return the string representation of the network.

    Returns:
        str: The network in CIDR notation.
    """
    return f"{self.ip}/{self.mask}"

__str__

Return the string representation of the network.

Returns:

Name	Type	Description
str	str	The network in CIDR notation.

Source code in netsecgame/game_components.py

def __str__(self) -> str:
    """
    Return the string representation of the network.

    Returns:
        str: The network in CIDR notation.
    """
    return f"{self.ip}/{self.mask}"

from_dict classmethod

Build the Network object from a dictionary.

Parameters:

Name	Type	Description	Default
data	Dict[str, Any]	Dictionary with network attributes.	required

Returns:

Name	Type	Description
Network	Network	The created Network object.

Source code in netsecgame/game_components.py

@classmethod
def from_dict(cls, data: Dict[str, Any]) -> Network:
    """
    Build the Network object from a dictionary.

    Args:
        data (Dict[str, Any]): Dictionary with network attributes.

    Returns:
        Network: The created Network object.
    """
    return cls(**data)

is_private

Check if the network is private. Uses ipaddress module.

Returns:

Name	Type	Description
bool	bool	True if the network is private, False otherwise.

Source code in netsecgame/game_components.py

def is_private(self) -> bool:
    """
    Check if the network is private. Uses ipaddress module.

    Returns:
        bool: True if the network is private, False otherwise.
    """
    try:
        return ipaddress.IPv4Network(f'{self.ip}/{self.mask}',strict=False).is_private
    except ipaddress.AddressValueError:
        # If we are dealing with strings, assume they are local networks
        return True

Observation

Bases: NamedTuple

Observations are given when making a step in the environment.

Attributes:

Name	Type	Description
state	GameState	Current state of the environment.
reward	float	Value with immediate reward for last step.
end	bool	True if the game ended.
info	Dict[str, Any]	Dictionary with additional information about the reason for ending.

ProtocolConfig dataclass

Configuration for protocol constants.

Attributes:

Name	Type	Description
END_OF_MESSAGE	bytes	End-of-message marker.
BUFFER_SIZE	int	Buffer size for messages.

Service dataclass

Represents a service in the NetSecGame.

Attributes:

Name	Type	Description
name	str	Name of the service.
type	str	Type of the service. Default unknown.
version	str	Version of the service. Default unknown.
is_local	bool	Whether the service is local. Default True.

from_dict classmethod

Create a Service object from a dictionary.

Parameters:

Name	Type	Description	Default
data	Dict[str, Any]	Dictionary with service attributes.	required

Returns:

Name	Type	Description
Service	Service	The created Service object.

Source code in netsecgame/game_components.py

@classmethod
def from_dict(cls, data: Dict[str, Any]) -> Service:
    """
    Create a Service object from a dictionary.

    Args:
        data (Dict[str, Any]): Dictionary with service attributes.

    Returns:
        Service: The created Service object.
    """
    return cls(**data)