Link Search Menu Expand Document

arena-py API v0.10.0

arena.auth - Authentication methods for accessing the ARENA.

class ArenaAuth:
def authenticate_user(self, web_host):

Begins authentication flow, getting Google auth, opening web browser if needed, getting username and state from ARENA server.

  • str web_host: The hostname of the ARENA webserver.

Username from arena-account, or None.

def authenticate_scene(self, web_host, realm, scene, username, video=False):

End authentication flow, requesting permissions may change by owner or admin, for now, get a fresh mqtt_token each time.

  • str web_host: The hostname of the ARENA webserver.
  • str realm: The topic realm name.
  • str scene: The namespace/scene name combination.
  • str username: The ARENA username for the user.
  • bool video: If Jitsi video conference is requested.

username and mqtt_token from arena-account.

def authenticate_device(self, web_host):

Check for device mqtt_token, ask for a missing one, and save to local memory.

def has_publish_rights(self, token, topic):

Check the MQTT token for permission to publish to topic.

def get_writable_scenes(self, web_host):

Request list of scene names for logged in user that user has publish permission for.

  • str web_host: The hostname of the ARENA webserver.

list of scenes.

def store_environment_auth(self, username, token):

Keep a copy of the token in local memory for urlopen and other tasks.

def check_local_auth(self):

Check for local mqtt_token and save to local memory.

def verify(self, web_host):
def urlopen(self, url, data=None, creds=False, csrf=None):

urlopen is for ARENA URL connections.

  • str url: the url to POST/GET.
  • str data: None for GET, add params for POST.
  • bool creds: True to pass the MQTT token as a cookie.
  • str csrf: The csrftoken.
def signout():
def permissions():

Table of contents