6.4. Connection information

class safeguard.sessions.plugin.connection_info.ConnectionInfo(session_id=None, protocol=None, connection_name=None, client_ip=None, client_port=None, gateway_user=None, target_username=None, key_value_pairs=None, gateway_groups=None, target_server=None, target_port=None)

The ConnectionInfo class gives easy access to the parameters passed to an AAA plugin. It is meant to represent a read-only record of the SPS sessions being processed. It is also the means to pass many parameters between functions if needed.

session_id

The unique identifier of the session.

protocol

The protocol used in the connection, one of ssh, telnet, rdp.

connection_name

Name of the connection policy (<protocol> Control -> Connections).

client_ip

A string containing the IP address of the client.

client_port

The port number of the client.

gateway_user

Contains the gateway username of the client, if already available (for example, if the user performed inband gateway authentication), otherwise its value is None.

target_username

The user name SPS uses to authenticate on the target server.

key_value_pairs

A dictionary containing plugin-specific information, for example, it may include the username. This dictionary also contains any key-value pairs that the user specified. In the plugin, such fields are already parsed into separate key-value pairs.

gateway_groups

The gateway groups of the gateway user as calculated by SPS.

target_server

A string containing the IP address of the target server.

target_port

The port number on the target server.