Users

Use the Users class when setting up your users in hyfiles like this:

(setv users
      (Users
        [{"admin"             ;; username
          "password"          ;; password
          :nickname "admin"}  ;; extra optional data
         {"user1" "password1"
         :attribute "blah"
         :nickname "mynickname"
         :email "admin@example.com"}]))

Create the Users object by giving it a list where each list item is a dictionary with user data. Each user entry is required to have at least on key:value pair which is assumed to be username:password and can therefore be accessed by the Variable Plugin as (Variable "username") and (Variable "password") respectively.

To use the optional user data, do the same but replace username/password with the symbol name you specified earlier, for example (Variable "nickname") will return admin if the first user is active and mynickname if the second one is.

class Users(users=None, active_user='DEFAULT')[source]

Class holding all the users of the application.

Users inherits from DataStructure, and contains the users set up in hyfiles. Each user is an User object. The data from a Users object can be accessed same way like from the DataStore.

active_user: A string with the username attribute of the currently active User.

__init__(users=None, active_user='DEFAULT')[source]

Initializes the Users object.

Given a list of dictionaries, map them to a User object and store them in this Users object.

Parameters

users (Optional[List[Dict[Keyword, str]]]) – A list of dictionaries. Dictionary’s data is mapped to a User object.
active_user (str) – An optional string specifying the default User.

to_dict()[source]

Returns the Users object data in dictionary format.

Return type: Dict[str, str]

property active: User

Returns the active User as an Users object.

Return type: User

The Users class inherits from DataStore where each element is a User class containing data about a single user:

class User(username=None, password=None, **kwargs)[source]

Class holding user related information.

User objects are created inside the Users. Each User object contains at least the username and the password. Every time a Plugin generates an output, it is saved in the User object. If the Plugin is a Cookie or a Header, the output will be stored in the the cookies and headers attributes respectively. Otherwise they’ll be saved inside data.

username: A string containing the user’s email or username used to log in.

password: A string containing the user’s password.

cookies: A CookieStore object containing all of the collected cookies for this user. The Cookie plugin only writes here.

headers: A HeaderStore object containing all of the collected headers for this user. The Header plugin only writes here.

data: A DataStore object containing the rest of the data collected from plugins for this user.

__init__(username=None, password=None, **kwargs)[source]

Initializes a User object.

Creates an object for easy access to user specific information. It’s used to store the username, password, cookies, headers, and other data extracted from the Plugin objects.

Parameters

username (Optional[str]) – A string with the username used for the login process.
password (Optional[str]) – A string with the password used for the login process.
**kwargs (Dict[str, str]) – A dictionary with additional data about the user.

set_cookie(cookie)[source]

Sets the cookies for the user.

Given a Cookie object, update the user’s cookies attribute to include this Cookie's value.

Parameters: cookie (Cookie) – A Cookie Plugin object with the data to be added.
Return type: None

set_cookies_from_dict(data)[source]

Set user’s cookies from a dictionary.

Given a dictionary of cookie values as strings, convert them to Cookie objects, and load them in the User object respectively.

Parameters: data (Dict[str, str]) – A dictionary of strings corresponding to cookie keys and values.
Return type: None

set_header(header)[source]

Sets the headers for the user.

Given a Header object, update the user’s headers attribute to include this header value.

Parameters: header (Header) – A Header Plugin <raider.plugins.common.Plugin object with the data to be added.
Return type: None

set_headers_from_dict(data)[source]

Set user’s headers from a dictionary.

Given a dictionary of header values as strings, convert them to Header objects, and load them in the User object respectively.

Parameters: data (Dict[str, str]) – A dictionary of strings corresponding to header keys and values.
Return type: None

set_data(data)[source]

Sets the data for the user.

Given a Plugin, update the user’s data attribute to include this data.

Parameters: data (Plugin) – A Plugin object with the data to be added.
Return type: None

set_data_from_dict(data)[source]

Set user’s data from a dictionary.

Given a dictionary of data items made out of strings, update the data attribute accordingly.

Parameters: data (Dict[str, str]) – A dictionary of strings corresponding to data keys and values.
Return type: None

to_dict()[source]

Returns this object’s data in a dictionary format.

Return type: Dict[str, str]