Ags.AuthenticationManager¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`get_instance` ()
class	`new` ()
	`add_authentication` (authentication)
	`get_authentication` ()
	`get_digest` (authentication_module, realm, login, security_token)
	`get_session_timeout` ()
	`insert_login` (login, login_info)
	`is_session_active` (security_context, user_uuid, security_token)
	`login` (authentication_module, login, password)
	`logout` (security_context, login, security_token)
	`lookup_login` (login)
	`remove_authentication` (authentication)
	`remove_login` (login)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

None

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access
authentication	[`object`]	r
gobject	`GObject.Object`	r
obj_mutex	`GLib.RecMutex`	r
session_timeout	`int`	r

Class Details¶

class Ags.AuthenticationManager(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Ags.AuthenticationManagerClass

classmethod get_instance()¶

Returns:: the Ags.AuthenticationManager
Return type:: Ags.AuthenticationManager

Get instance.

New in version 3.0.0.

classmethod new()¶

Returns:: a new Ags.AuthenticationManager
Return type:: Ags.AuthenticationManager

Creates an Ags.AuthenticationManager

New in version 3.0.0.

add_authentication(authentication)¶

Parameters:: authentication (GObject.Object) – the GObject.Object implementing Ags.Authentication

Add authentication to self.

New in version 3.0.0.

get_authentication()¶

Returns:: the GLib.List-struct containing GObject.Object implementing Ags.Authentication
Return type:: [GObject.Object]

Get authentication.

New in version 3.0.0.

get_digest(authentication_module, realm, login, security_token)¶

Parameters:

authentication_module (str) – the authentication module
realm (str) – the realm
login (str) – the login
security_token (str) – the security token

Returns:

the digest as string, or None if not available

Return type:

str

Get digest of login.

New in version 3.0.0.

get_session_timeout()¶

Returns:: the session timeout
Return type:: int

Get session timeout.

New in version 3.0.0.

insert_login(login, login_info)¶

Parameters:

login (str) – the login
login_info (Ags.LoginInfo) – the Ags.LoginInfo-struct

Insert login as key and login_info as its value.

New in version 3.0.0.

is_session_active(security_context, user_uuid, security_token)¶

Parameters:

security_context (GObject.Object) – the security context
user_uuid (str) – the user’s UUID
security_token (str) – the security token

Returns:

True if active, otherwise False

Return type:

bool

Check if session is active.

New in version 3.0.0.

login(authentication_module, login, password)¶

Parameters:

authentication_module (str) – the authentication module
login (str) – the login
password (str) – the password

Returns:

True if login was successful, otherwise False

user_uuid:: return location of user UUID
security_token:: return location of 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

Returns:

True if logout was successful, otherwise False

Return type:

bool

Logout.

New in version 3.0.0.

lookup_login(login)¶

Parameters:: login (str) – the login
Returns:: the user Ags.LoginInfo-struct or None
Return type:: object or None

Lookup login.

New in version 3.0.0.

remove_authentication(authentication)¶

Parameters:: authentication (GObject.Object) – the GObject.Object implementing Ags.Authentication