base/bif/plugins/Zeek_Login.functions.bif.zeek

GLOBAL

Namespace

GLOBAL

Summary

Functions

get_login_state: function	Returns the state of the given login (Telnet or Rlogin) connection.
set_login_state: function	Sets the login state of a connection with a login analyzer.

Detailed Interface

Functions

get_login_state

Type

function (cid: conn_id) : count

Returns the state of the given login (Telnet or Rlogin) connection.

Parameters

cid – The connection ID.

Returns

False if the connection is not active or is not tagged as a login analyzer. Otherwise the function returns the state, which can be one of:

• LOGIN_STATE_AUTHENTICATE: The connection is in its initial authentication dialog.

• LOGIN_STATE_LOGGED_IN: The analyzer believes the user has successfully authenticated.

• LOGIN_STATE_SKIP: The analyzer has skipped any further processing of the connection.

• LOGIN_STATE_CONFUSED: The analyzer has concluded that it does not correctly know the state of the connection, and/or the username associated with it.

See also: set_login_state

set_login_state

Type

function (cid: conn_id, new_state: count) : bool

Sets the login state of a connection with a login analyzer.

Parameters

• cid – The connection ID.

• new_state – The new state of the login analyzer. See get_login_state for possible values.

Returns

Returns false if cid is not an active connection or is not tagged as a login analyzer, and true otherwise.

See also: get_login_state