User

CybORG.Simulator.User.User

Bases: Entity

User entity

Attributes:

Name	Type	Description
username	str
password	str
password_hash	str
bruteforceable	bool
password_hash_type	str
groups	List[LocalGroup]
logged_in	bool
uid	int
disabled	bool

Functions

__init__

__init__(username: str, uid: int, password: str = None, password_hash: str = None, password_hash_type: str = None, groups: list = None, logged_in: bool = None, bruteforceable: bool = False)

Instantiate the User object

add_group

add_group(group: LocalGroup)

Add a group to the user's list of groups.

Parameters:

Name	Type	Description	Default
group	LocalGroup	group to add	required

disable_user

disable_user()

Set user to 'disabled'

get_state

get_state()

Get the current internal state of the user, as an observation

CybORG.Simulator.LocalGroup.LocalGroup

Bases: Entity

Attributes

ident instance-attribute

ident = gid

name instance-attribute

name = name

users instance-attribute

users = users

Functions

__init__

__init__(name: str = None, gid: int = None, users: list = None)

get_state

get_state()

remove_user

remove_user(user)