1.1.9. graphs

This module provides the functionality to support the client application’s graphing capabilities.

1.1.9.1. Data

has_matplotlib = False

Whether the matplotlib module is available.

has_matplotlib_basemap = False

Whether the mpl_toolkits.basemap module is available.

1.1.9.2. Functions

export_graph_provider(cls)

Decorator to mark classes as valid graph providers. This decorator also sets the name attribute.

Parameters:cls (class) – The class to mark as a graph provider. Returns:The cls parameter is returned.

get_graph(graph_name)

Return the graph providing class for graph_name. The class providing the specified graph must have been previously exported using export_graph_provider().

Parameters:graph_name (str) – The name of the graph provider. Returns:The graph provider class. Return type:CampaignGraph

get_graphs()

Get a list of all registered graph providers.

Returns:All registered graph providers. Return type:list

1.1.9.3. Classes

class GraphBase(application, size_request=None, style_context=None)

Bases: object

A basic graph provider for using matplotlib to create graph representations of campaign data. This class is meant to be subclassed by real providers.

__init__(application, size_request=None, style_context=None)

Parameters:size_request (tuple) – The size to set for the canvas.

config = None

A reference to the King Phisher client configuration.

get_color(color_name, default)

Get a color by its style name such as ‘fg’ for foreground. If the specified color does not exist, default will be returned. The underlying logic for this function is provided by gtk_style_context_get_color().

Parameters:

• color_name (str) – The style name of the color.
• default – The default color to return if the specified one was not found.

Returns:

The desired color if it was found.

Return type:

tuple

graph_title = 'Unknown'

The title that will be given to the graph.

make_window()

Create a window from the figure manager.

Returns:The graph in a new, dedicated window. Return type:Gtk.Window

minimum_size = None

An absolute minimum size for the canvas.

name = 'Unknown'

The name of the graph provider.

name_human = 'Unknown'

The human readable name of the graph provider used for UI identification.

resize(width=0, height=0)

Attempt to resize the canvas. Regardless of the parameters the canvas will never be resized to be smaller than minimum_size.

Parameters:

• width (int) – The desired width of the canvas.
• height (int) – The desired height of the canvas.

class CampaignGraph(application, size_request=None, style_context=None)

Bases: king_phisher.client.graphs.GraphBase

Graph format used for the graphs generated in the dashboard and in the create graphs tab.

load_graph()

Load the graph information via refresh().

refresh(info_cache=None, stop_event=None)

Refresh the graph data by retrieving the information from the remote server.

Parameters:

• info_cache (dict) – An optional cache of data tables.
• stop_event (threading.Event) – An optional object indicating that the operation should stop.

Returns:

A dictionary of cached tables from the server.

Return type:

dict

class CampaignGraphMessageResults(*args, **kwargs)

Bases: king_phisher.client.graphs.CampaignPieGraph

Display the percentage of messages which resulted in a visit.

graph_title = 'Campaign Message Results'

name = 'MessageResults'

name_human = 'Pie - Message Results'

class CampaignGraphOverview(*args, **kwargs)

Bases: king_phisher.client.graphs.CampaignBarGraph

Display a graph which represents an overview of the campaign.

graph_title = 'Campaign Overview'

name = 'Overview'

name_human = 'Bar - Campaign Overview'

class CampaignGraphPasswordComplexityPie(*args, **kwargs)

Bases: king_phisher.client.graphs.CampaignPieGraph

Display a graph which displays the number of passwords which meet standard complexity requirements.

graph_title = 'Campaign Password Complexity'

name = 'PasswordComplexityPie'

name_human = 'Pie - Password Complexity'

class CampaignGraphVisitorInfo(*args, **kwargs)

Bases: king_phisher.client.graphs.CampaignBarGraph

Display a graph which shows the different operating systems seen from visitors.

graph_title = 'Campaign Visitor OS Information'

name = 'VisitorInfo'

name_human = 'Bar - Visitor OS Information'

class CampaignGraphVisitorInfoPie(*args, **kwargs)

Bases: king_phisher.client.graphs.CampaignPieGraph

Display a graph which compares the different operating systems seen from visitors.

graph_title = 'Campaign Visitor OS Information'

name = 'VisitorInfoPie'

name_human = 'Pie - Visitor OS Information'

class CampaignGraphVisitsMap(application, size_request=None, style_context=None)

Bases: king_phisher.client.graphs.CampaignGraph

A base class to display a map which shows the locations of visit origins.

color_with_creds

color_without_creds

draw_states = False

graph_title = 'Campaign Visit Locations'

is_available = False

CampaignGraphVisitsMapUSA

CampaignGraphVisitsMapWorld

class CampaignGraphVisitsTimeline(*args, **kwargs)

Bases: king_phisher.client.graphs.CampaignLineGraph

Display a graph which represents the visits of a campaign over time.

graph_title = 'Campaign Visits Timeline'

name = 'VisitsTimeline'

name_human = 'Line - Visits Timeline'

class CampaignGraphComparison(*args, **kwargs)

Bases: king_phisher.client.graphs.GraphBase

Display selected campaigns data by order of campaign start date.

__init__(*args, **kwargs)

Parameters:size_request (tuple) – The size to set for the canvas.

load_graph(campaigns)

Load the information to compare the specified and paint it to the canvas. Campaigns are graphed on the X-axis in the order that they are provided. No sorting of campaigns is done by this method.

Parameters:campaigns (tuple) – A tuple containing campaign IDs to compare.