arena.auth

auth.py - Authentication methods for accessing the ARENA.

class ArenaAuth:

def authenticate_user(self, web_host, headless):

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

Parameters

• str web_host: The hostname of the ARENA webserver.

Returns

Username from arena-account, or None.

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

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

Parameters

• 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.

Returns

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.

Parameters

• str web_host: The hostname of the ARENA webserver.

Returns

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 upload_store_file(self, web_host, scenename, src_file_path, dest_file_path=None):

Upload a source file to the user's file store space. Google authentication is required.

Parameters

• str web_host: The hostname of the ARENA webserver.
• str scenename: The scene name/id.
• str src_file_path: Local path to the file to upload (required).
• str dest_file_path: Destination file path, can include dirs. Defaults to filename from src_file_path (optional).

Returns

Url address of successful file upload location, or None if failed.

def verify(self, web_host):

def urlopen_def(self, url, data=None):

urlopen default is for non-ARENA URL connections.

Parameters

• str url: the url to POST/GET.
• str data: None for GET, add params for POST.

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

urlopen is for ARENA URL connections.

Parameters

• 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():

class OAuthCallbackHandler(http.server.BaseHTTPRequestHandler):

HTTP request handler base class.

The following explanation of HTTP serves to guide you through the code as well as to expose any misunderstandings I may have about HTTP (so you don't need to read the code to figure out I'm wrong :-).

HTTP (HyperText Transfer Protocol) is an extensible protocol on top of a reliable stream transport (e.g. TCP/IP). The protocol recognizes three parts to a request:

1. One line identifying the request type and path
2. An optional set of RFC-822-style headers
3. An optional data part

The headers and data are separated by a blank line.

The first line of the request has the form

</p>

where is a (case-sensitive) keyword such as GET or POST, is a string containing path information for the request, and should be the string "HTTP/1.0" or "HTTP/1.1". is encoded using the URL encoding scheme (using %xx to signify the ASCII character with hex code xx).</p>

The specification specifies that lines are separated by CRLF but for compatibility with the widest range of clients recommends servers also handle LF. Similarly, whitespace in the request line is treated sensibly (allowing multiple spaces between components and allowing trailing whitespace).

Similarly, for output, lines ought to be separated by CRLF pairs but most clients grok LF characters just fine.

If the first line of the request has the form

</p>

(i.e. is left out) then this is assumed to be an HTTP 0.9 request; this form has no optional headers and data part and the reply consists of just the data.</p>

The reply form of the HTTP 1.x protocol again has three parts:

1. One line giving the response code
2. An optional set of RFC-822-style headers
3. The data

Again, the headers and data are separated by a blank line.

The response code line has the form

</p>

where is the protocol version ("HTTP/1.0" or "HTTP/1.1"), is a 3-digit response code indicating success or failure of the request, and is an optional human-readable string explaining what the response code means.</p>

This server parses the request and the headers, and then calls a function specific to the request type (). Specifically, a request SPAM will be handled by a method do_SPAM(). If no such method exists the server sends an error response to the client. If it exists, it is called with no arguments:

do_SPAM()

Note that the request name is case sensitive (i.e. SPAM and spam are different requests).

The various request details are stored in instance variables:

• client_address is the client IP address in the form (host, port);

• command, path and version are the broken-down request line;

• headers is an instance of email.message.Message (or a derived class) containing the header information;

• rfile is a file object open for reading positioned at the start of the optional input data part;

• wfile is a file object open for writing.

IT IS IMPORTANT TO ADHERE TO THE PROTOCOL FOR WRITING!

The first thing to be written must be the response line. Then follow 0 or more header lines, then a blank line, and then the actual data (if any). The meaning of the header lines depends on the command executed by the server; in most cases, when data is returned, there should be at least one header line of the form

Content-type: /</p>

where and should be registered MIME types, e.g. "text/html" or "text/plain".</p> </div>

def log_message(self, format, *args):

Log an arbitrary message.

This is used by all other logging functions. Override it if you have specific logging wishes.

The first argument, FORMAT, is a format string for the message to be logged. If the format string contains any % escapes requiring parameters, they should be specified as subsequent arguments (it's just like printf!).

The client ip and current date/time are prefixed to every message.

def do_GET(self):

Inherited Members

socketserver.BaseRequestHandler

BaseRequestHandler

request

client_address

server

http.server.BaseHTTPRequestHandler

sys_version

server_version

error_message_format

error_content_type

default_request_version

parse_request

handle_expect_100

handle_one_request

handle

send_error

send_response

send_response_only

send_header

end_headers

flush_headers

log_request

log_error

version_string

date_time_string

log_date_time_string

weekdayname

monthname

address_string

protocol_version

MessageClass

responses

socketserver.StreamRequestHandler

rbufsize

wbufsize

timeout

disable_nagle_algorithm

setup

finish

</section> </main> </div>