6.4. Connection information

class safeguard.sessions.plugin.connection_info.ConnectionInfo(gateway_domain=None, gateway_groups=None, gateway_password=None, gateway_username=None, key_value_pairs=None, client_ip=None, client_hostname=None, client_port=None, connection_name=None, protocol=None, session_id=None, server_domain=None, server_ip=None, server_hostname=None, server_port=None, server_username=None)

The ConnectionInfo class gives easy access to the parameters passed to a 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. Note: SPS does not always know or pass all parameters in all hooks, in which case the corresponding value shall be None.

property connection_name

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

property client_ip

A string containing the IP address of the client.

property client_port

The port number of the client. Only available for AA plugins.

property client_hostname

A string containing the hostname of the client or None if the address cannot be resolved.

New in version 1.5.0.

property gateway_domain

The domain name of the gateway user if known. Only set for Credential Store plugins.

New in version 1.2.0.

property gateway_groups

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

property gateway_password

The gateway password as used, detected by SPS. Only set for Credential Store plugins. It is possible to have an empty string here in case the gateway authentication does not reveal the password itself. Empty string is presented in case of terminal server gateway mode of RDP.

New in version 1.2.0.

property gateway_user

See gateway_username(). For backwards compatibility.

property gateway_username

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

property 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.

property protocol

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

property session_id

The unique identifier of the session.

property server_domain

The domain name of the target user if known.

New in version 1.5.0.

property target_domain

See server_domain(). For backwards compatibility.

Deprecated.

property server_ip

A string containing the IP address of the target server.

New in version 1.5.0.

property target_ip

See target_host(). For backwards compatibility.

Deprecated.

property target_host

Equals to server_hostname() if available otherwise server_ip(). For backwards compatibility.

Deprecated.

property target_server

See target_host(). For backwards compatibility.

Deprecated.

property server_port

The port number on the target server.

New in version 1.5.0.

property target_port

See server_port(). For backwards compatibility.

Deprecated.

property server_hostname

A string containing the hostname of the target server or None if the address cannot be resolved.

New in version 1.5.0.

property server_username

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

New in version 1.5.0.

property target_username

See server_username(). For backwards compatibility.

Deprecated.