Edge

class bhopengraph.Edge.Edge(start_node, end_node, kind, properties=None, start_match_by='id', end_match_by='id')

Bases: object

Edge class representing a directed edge in the OpenGraph.

Follows BloodHound OpenGraph schema requirements with start/end nodes, kind, and properties. All edges are directed and one-way as per BloodHound requirements.

Sources: - https://bloodhound.specterops.io/opengraph/schema#edges - https://bloodhound.specterops.io/opengraph/schema#minimal-working-json

Parameters:

• start_node (str)

• end_node (str)

• kind (str)

• properties (Properties)

• start_match_by (str)

• end_match_by (str)

__init__(start_node, end_node, kind, properties=None, start_match_by='id', end_match_by='id')

Initialize an Edge.

Parameters:

• start_node (-) – ID of the source node

• end_node (-) – ID of the destination node

• kind (-) – Type/class of the edge relationship

• properties (-) – Edge properties

• start_match_by (str)

• end_match_by (str)

set_property(key, value)

Set a property on the edge.

Parameters:

• key (-) – Property name

• value (-) – Property value

get_property(key, default=None)

Get a property from the edge.

Parameters:

• key (-) – Property name

• default (-) – Default value if property doesn’t exist

Returns:

• Property value or default

remove_property(key)

Remove a property from the edge.

Parameters:

key (-) – Property name to remove

to_dict()

Convert edge to dictionary for JSON serialization.

Returns:

Edge as dictionary following BloodHound OpenGraph schema

Return type:

• dict

classmethod from_dict(edge_data)

Create an Edge instance from a dictionary.

Parameters:

edge_data (-) – Dictionary containing edge data

Returns:

Edge instance or None if data is invalid

Return type:

• Edge

get_start_node()

Get the start node ID.

Returns:

Start node ID

Return type:

• str

get_end_node()

Get the end node ID.

Returns:

End node ID

Return type:

• str

get_kind()

Get the edge kind/type.

Returns:

Edge kind

Return type:

• str

get_unique_id()

Get a unique ID for the edge.

Returns:

Unique ID for the edge

Return type:

• str

__eq__(other)

Check if two edges are equal based on their start, end, and kind.

Parameters:

other (-) – The other edge to compare to

Returns:

True if the edges are equal, False otherwise

Return type:

• bool

__hash__()

Hash based on start, end, and kind for use in sets and as dictionary keys.

Returns:

Hash of the start, end, and kind

Return type:

• int

validate()

Validate the edge against the EDGE_SCHEMA.

Returns:

(is_valid, list_of_errors)

Return type:

• tuple[bool, list[str]]