Acquire.Identity._loginsession module

class LoginSession(username=None, public_key=None, public_cert=None, ipaddr=None, hostname=None, login_message=None, scope=None, permissions=None)

Bases: object

This class holds all details of a single login session

creation_time()

Return the date and time when this was created

device_uid()

If known, return the UID of the device from which the user approved this session

encoded_username()

Return a safely-encoded version of the username. This is used to create safe keys in the object store

static from_data(data)

Return a LoginSession constructed from the passed data (dictionary)

static get_status(uid)

Return the status of the LoginSession with specified UID

hostname()

Return the user-supplied hostname of the host making the login request

ipaddr()

Return the user-supplied IP address of the host making the login request

is_approved()

Return whether or not this session is open and approved by the user

is_logged_out()

Return whether or not this session has logged out

is_null()

Return whether or not this object is null

is_suspicious()

Return whether or not this session is suspicious

static load(status=None, short_uid=None, uid=None, scope=None, permissions=None)

Load and return a LoginSession specified from either a short_uid or a long uid. Note that if more than one session matches the short_uid then you will get a list of LoginSessions returned

login(user_uid=None, device_uid=None)

Convenience function to set the session into the logged in state

login_message()

Return any login message that has been set by the user

login_time()

Return the date and time when the user logged in. This returns None if the user has not yet logged in

login_url()

Return the login URL to login to this session. This is the URL of this identity service plus the short UID of the session

logout(authorisation=None, signature=None)

Convenience function to set the session into the logged out state

logout_time()

Return the date and time when the user logged out. This returns None if the user has not yet logged out

permissions()

Return the permissions requested for this login session

public_certificate()

Return the public certificate

public_key()

Return the public key

regenerate_uid()

Regenerate the UUID as there has been a clash

request_source()

Return the IP address of the source of this request. This could be used to rate limit someone who is maliciously requesting logins…

save()

Save the current state of this LoginSession to the object store

scope()

Return the scope requested for this login session

seconds_since_creation()

Return the number of seconds since this request was created

set_approved(user_uid=None, device_uid=None)

Register that this request has been approved, optionally providing data about the user who approved the session and the device from which the session was approved

set_denied()

Register that this request has been denied

set_logged_out(authorisation=None, signature=None)

Register that this request has been closed as the user has logged out. If an authorisation is passed then verify that this is correct

set_suspicious()

Put this login session into a suspicious state. This will be because weird activity has been detected which indicates that the session may be have been cracked. A login session in a suspicious state should not be granted any permissions.

short_uid()

Return a short UUID that will be used to provide a more human-readable session ID

status()

Return the status of this login session

to_data()

Return a data version (dictionary) of this LoginSession that can be serialised to json

static to_short_uid(long_uid)

Return the short UID version of the passed long uid

uid()

Return the UID of this request

user_uid()

If known, return the UID of the user who approved this session

username()

Return the username for this login session