Ags.Authentication

Implementations:

Ags.XmlAuthentication

Methods

	generate_token ()
	get_authentication_module ()
	get_digest (realm, login, security_token)
	is_session_active (security_context, user_uuid, security_token)
	login (login, password)
	logout (security_context, login, security_token)

Virtual Methods

	do_generate_token ()
	do_get_authentication_module ()
	do_get_digest (realm, login, security_token)
	do_is_session_active (security_context, user_uuid, security_token)
	do_login (login, password)
	do_logout (security_context, login, security_token)

Properties

None

Signals

None

Fields

None

Class Details

class Ags.Authentication

Bases:

GObject.GInterface

Structure:

Ags.AuthenticationInterface

generate_token()

Raises:

GLib.Error

Returns:

the generated token

Return type:

str

Generate token.

New in version 3.0.0.

get_authentication_module()

Returns:

a None terminated array of strings of available authentication modules

Return type:

[str]

Available authentication modules.

New in version 3.0.0.

get_digest(realm, login, security_token)

Parameters:

• realm (str) – the realm

• login (str) – the login

• security_token (str) – the security token

Raises:

GLib.Error

Returns:

the encrypted password

Return type:

str

Get digest of login.

New in version 3.0.0.

is_session_active(security_context, user_uuid, security_token)

Parameters:

• security_context (GObject.Object) – the Ags.SecurityContext

• user_uuid (str) – the user’s UUID

• security_token (str) – the security token

Raises:

GLib.Error

Returns:

True if session active, otherwise False

Return type:

bool

Check session.

New in version 3.0.0.

login(login, password)

Parameters:

• login (str) – the login

• password (str) – the password

Raises:

GLib.Error

Returns:

True on success, otherwise False

user_uuid:

return location of the user’s uuid

security_token:

return location of the security token

Return type:

(bool, user_uuid: str, security_token: str)

Login.

New in version 3.0.0.

logout(security_context, login, security_token)

Parameters:

• security_context (GObject.Object) – the Ags.SecurityContext

• login (str) – the login

• security_token (str) – the security token

Raises:

GLib.Error

Returns:

True on success, otherwise False

Return type:

bool

Logout.

New in version 3.0.0.

do_generate_token() virtual

Returns:

the generated token

Return type:

str

Generate token.

New in version 3.0.0.

do_get_authentication_module() virtual

Returns:

a None terminated array of strings of available authentication modules

Return type:

[str]

Available authentication modules.

New in version 3.0.0.

do_get_digest(realm, login, security_token) virtual

Parameters:

• realm (str) – the realm

• login (str) – the login

• security_token (str) – the security token

Returns:

the encrypted password

Return type:

str

Get digest of login.

New in version 3.0.0.

do_is_session_active(security_context, user_uuid, security_token) virtual

Parameters:

• security_context (GObject.Object) – the Ags.SecurityContext

• user_uuid (str) – the user’s UUID

• security_token (str) – the security token

Returns:

True if session active, otherwise False

Return type:

bool

Check session.

New in version 3.0.0.

do_login(login, password) virtual

Parameters:

• login (str) – the login

• password (str) – the password

Returns:

True on success, otherwise False

user_uuid:

return location of the user’s uuid

security_token:

return location of the security token

Return type:

(bool, user_uuid: str, security_token: str)

Login.

New in version 3.0.0.

do_logout(security_context, login, security_token) virtual

Parameters:

• security_context (GObject.Object) – the Ags.SecurityContext

• login (str) – the login

• security_token (str) – the security token

Returns:

True on success, otherwise False

Return type:

bool

Logout.

New in version 3.0.0.