-
Notifications
You must be signed in to change notification settings - Fork 1
/
web_interface.py
610 lines (514 loc) · 25.5 KB
/
web_interface.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
"""
This module serves as the web interface for Tangerine. The webpage
is served at the default port 8080. Access control is provided
through GitHub oauth.
"""
import os
from urllib.request import Request, urlopen
import json
import cherrypy
from cherrypy.lib.static import serve_file
from hashlib import sha256
from settings import settings
from API import API
from time import time
from mako.template import Template
from mako.lookup import TemplateLookup
lookup = TemplateLookup(directories=['static'])
class Statuspage(object):
"""Render for the web application"""
@cherrypy.expose
def index(self):
"""Main page for Tangerine's web UI"""
tmpl = lookup.get_template("index.html.mako")
if settings['web_use_auth'] == "true":
return tmpl.render(
username = cherrypy.session['username'],
userimageurl = cherrypy.session['userimageurl'],
usertype = cherrypy.session['usertype']
)
else:
return tmpl.render(
username = cherrypy.session.get("username", "dev"),
userimageurl = cherrypy.session.get("userimageurl", "dev"),
usertype = cherrypy.session.get("usertype", "admin")
)
@cherrypy.expose
def login(self, code=None):
# if the session is already authorized send the user to the main page
if cherrypy.session.get("authorized", None):
raise cherrypy.HTTPRedirect("/")
# if the `code` parameter was POSTed, try to authenticate the user
if code:
# First check that the code is valid
# Query GitHub for an access token for the code
git_auth = "https://github.com/login/oauth/access_token?" + \
"client_id=" + settings['web_github_oauth_id'] + \
"&client_secret=" + settings['web_github_oauth_secret'] + \
"&code=" + code
req = Request(git_auth)
res = urlopen(req)
# split the response into a dict
response = {}
for param in res.read().decode('utf-8').split("&"):
response[param.split("=")[0]] = param.split("=")[1]
# Second, get the GitHub acccount information
# if the code resulted in a valid access token
if "access_token" in response.keys():
# Get the user information
get_info = "https://api.github.com/user?access_token=" + response['access_token']
req = Request(get_info)
res = urlopen(req)
# Parse the resulting JSON
data = json.loads(res.read().decode('utf-8'))
# if the user is in the authorized user list
userdata = API.get_users(userid=str(data['id']))
if userdata:
user_data = userdata[0]
if user_data.username == data['login']:
# Modify the user session to indicated authorization
# store a SHA of the inital request information
# if this doesn't match force a new session
agent = cherrypy.request.headers['User-Agent']
# remote_ip = cherrypy.request.remote.ip
print(agent)
cherrypy.session["_ident"] = sha256(agent.encode('utf-8')).hexdigest()
# Set the expiration time
cherrypy.session['expires'] = int(time()) + 1800 # 30 minutes from now
# Regenerate the session ID on successful login
cherrypy.session.regenerate()
# Store user information in the session
cherrypy.session["authorized"] = "true"
cherrypy.session["userid"] = user_data.userid
cherrypy.session["username"] = user_data.username
cherrypy.session["usertype"] = user_data.usertype
cherrypy.session["userimageurl"] = data['avatar_url']
# Send the authorized user to the main page or previous request
cherrypy.session["login_msg"] = None
redirect = cherrypy.session.get("redirect", "/")
raise cherrypy.HTTPRedirect(redirect)
else:
cherrypy.session["login_msg"] = "Login failed."
return "Login failed. User '" + data['login'] + "' is not authorized"
# The user is not authorized
else:
cherrypy.session["login_msg"] = "Login failed."
return "Login failed. User '" + data['login'] + "' is not authorized"
# The code was not valid or not sent by GitHub
else:
cherrypy.session["login_msg"] = "Login failed."
return "Login failed"
cherrypy.session["login_msg"] = "Login failed."
return "There was an error: " + str(response)
# Regenerate the session ID before logging in
cherrypy.session.regenerate()
tmpl = lookup.get_template("login.html.mako")
return tmpl.render(
client_id = settings['web_github_oauth_id'],
msg = cherrypy.session.get("login_msg", None)
)
@cherrypy.expose
def history(self):
tmpl = lookup.get_template("history.html.mako")
if settings['web_use_auth'] == "true":
return tmpl.render(
username = cherrypy.session['username'],
userimageurl = cherrypy.session['userimageurl'],
usertype = cherrypy.session['usertype']
)
else:
return tmpl.render(
username = cherrypy.session.get("username", "dev"),
userimageurl = cherrypy.session.get("userimageurl", "dev"),
usertype = cherrypy.session.get("usertype", "admin")
)
@cherrypy.expose
def admin(self):
# Check if the user is an admin
if cherrypy.session.get("usertype", "user") == "admin":
tmpl = lookup.get_template("admin.html.mako")
if settings['web_use_auth'] == "true":
return tmpl.render(
username = cherrypy.session['username'],
userimageurl = cherrypy.session['userimageurl'],
usertype = cherrypy.session['usertype'],
settings = settings,
users = API.get_users(),
hooks = API.get_hooks()
)
else:
return tmpl.render(
username = cherrypy.session.get("username", "dev"),
userimageurl = cherrypy.session.get("userimageurl", "dev"),
usertype = cherrypy.session.get("usertype", "admin"),
settings = settings,
users = API.get_users(),
hooks = API.get_hooks()
)
else:
return json.dumps({"error": "User not authorized for this request"})
@cherrypy.expose
def get_project(self):
if cherrypy.session.get("login_msg", None) == "AJAX not authorized":
return '{"redirect": "/login"}'
return '{"tasks": ' + API.get_tasks_summary() + ', "jobs": ' + API.get_jobs_summary() + '}'
@cherrypy.expose
def get_runs(self, _=None):
return API.get_runs()
@cherrypy.expose
def get_log(self, log_name, lines=200, full_log=False):
if not log_name:
if full_log:
return None
else:
return '{"error": "log_name must be present"}'
if full_log:
try:
return serve_file("/logs/" + log_name, "application/x-download", "attachment")
except Exception:
return None
return API.get_log(log_name=log_name, lines=lines)
@cherrypy.expose
def logout(self):
# Kill the current session
cherrypy.session.clear()
cherrypy.session.delete()
cherrypy.lib.sessions.expire()
cherrypy.session["login_msg"] = "Logged out"
raise cherrypy.HTTPRedirect("/login")
@cherrypy.expose
def update_task_form(self, id=None, clone=False):
tmpl = lookup.get_template("update_task.html.mako")
return tmpl.render(task = API.get_task_object(id), clone=clone)
@cherrypy.expose
def update_job_form(self, id=None, clone=False):
tmpl = lookup.get_template("update_job.html.mako")
return tmpl.render(job = API.get_job_object(id), clone=clone)
@cherrypy.expose
def new_task_form(self, id=None):
tmpl = lookup.get_template("new_task.html.mako")
return tmpl.render()
@cherrypy.expose
def add_task_form(self):
tmpl = lookup.get_template("new_task.html.mako")
return tmpl.render()
@cherrypy.expose
def display_task(self, id=None):
tmpl = lookup.get_template("display_task.html.mako")
task = API.get_task_object(id)
if task.parent_job == None:
job = None
else:
job = API.get_job_object(id=str(task.parent_job))
return tmpl.render(task=task, job=job)
@cherrypy.expose
def display_run(self, id=None):
tmpl = lookup.get_template("display_run.html.mako")
run = API.get_run_object(id)
log = API.get_log(run.log)
return tmpl.render(run = run, log = log)
# TODO: Give dvl, env, prt better names
@cherrypy.expose
def add_task(self, id=None, name=None, state=None, tag=None, dependency=None, parent_job=None, removed_parent_defaults=None,
image=None, command=None, entrypoint=None, cron=None, restartable=None, exitcodes=None, max_failures=None, delay=None,
faildelay=None, environment=None, datavolumes=None, port=None, description=None):
""" """
if id:
return API.update_task(id=id, name=name, state=state, tag=tag, dependency=dependency, parent_job=parent_job, removed_parent_defaults=removed_parent_defaults,
image=image, command=command, entrypoint=entrypoint, cron=cron, restartable=restartable, exitcodes=exitcodes, max_failures=max_failures, delay=delay, faildelay=faildelay,
environment=environment, datavolumes=datavolumes, port=port, description=description)
else:
return API.add_task(name=name, state=state, tag=tag, dependency=dependency, parent_job=parent_job, removed_parent_defaults=removed_parent_defaults,
image=image, command=command, entrypoint=entrypoint, cron=cron, restartable=restartable, exitcodes=exitcodes, max_failures=max_failures, delay=delay, faildelay=faildelay,
environment=environment, datavolumes=datavolumes, port=port, description=description)
@cherrypy.expose
def get_task(self, id=None, name=None):
return API.get_task(id, name)
@cherrypy.expose
def get_tasks(self):
if cherrypy.session.get("login_msg", None) == "AJAX not authorized":
return '{"redirect": "/login"}'
return API.get_tasks()
@cherrypy.expose
def get_users(self, username=None, userid=None, usertype=None):
# Check if the user is an admin
if cherrypy.session.get("usertype", "user") == "admin":
users = API.get_users(username, userid, usertype)
if users:
return [user.json for user in users]
else:
return json.dumps({"error": "No user matches the request"})
else:
return json.dumps({"error": "User not authorized for this request"})
@cherrypy.expose
def disable_task(self, id):
return API.disable_task(id)
@cherrypy.expose
def delete_task(self, id, username=""):
return API.delete_task(id, username)
@cherrypy.expose
def stop_task(self, id):
return API.stop_task(id)
@cherrypy.expose
def queue_task(self, id, username):
return API.queue_task(id=id, username=username)
@cherrypy.expose
def infrastructure(self):
tmpl = lookup.get_template("infrastructure.html.mako")
if settings['web_use_auth'] == "true":
return tmpl.render(
username = cherrypy.session['username'],
userimageurl = cherrypy.session['userimageurl'],
usertype = cherrypy.session['usertype']
)
else:
return tmpl.render(
username = cherrypy.session.get("username", "dev"),
userimageurl = cherrypy.session.get("userimageurl", "dev"),
usertype = cherrypy.session.get("usertype", "admin")
)
@cherrypy.expose
def get_hosts(self):
if cherrypy.session.get("login_msg", None) == "AJAX not authorized":
return '{"redirect": "/login"}'
return API.get_hosts()
#
#
# Begin functions for jobs
# TODO: Combine the API module with the web_interface module
#
#
@cherrypy.expose
def bulk_add_form(self):
tmpl = lookup.get_template("bulk_add_form.html.mako")
return tmpl.render()
@cherrypy.expose
def new_job_form(self, id=None):
tmpl = lookup.get_template("new_job.html.mako")
return tmpl.render()
@cherrypy.expose
def get_jobs(self, id=None, name=None, column=None, value=None):
return API.get_jobs(id, name, column, value)
@cherrypy.expose
def add_job(
self, name=None, description=None, tags=None, state=None, dependencies=None,
parent_job=None, command="", entrypoint="", exitcodes="",
restartable=True, datavolumes=None, environment=None, image=None, cron="",
max_failures=3, delay=0, faildelay=5, port=None, created_by=""
):
return API.add_job(
name, description, tags, state, dependencies,
parent_job, command, entrypoint, exitcodes,
restartable, datavolumes, environment, image, cron,
max_failures, delay, faildelay, port, created_by
)
@cherrypy.expose
def disable_job(self, id=None, name=None, username=None):
return API.disable_job(id, name)
@cherrypy.expose
def delete_job(self, id=None, name=None, username=None, mode=0):
return API.delete_job(id, name, username, mode)
@cherrypy.expose
def queue_job(self, id=None, name=None, username=None, state=""):
return API.queue_job(id, name, username, state)
@cherrypy.expose
def stop_job(self, id=None, name=None, username=None, state=""):
return API.stop_job(id, name, username, state)
@cherrypy.expose
def update_job(
self,
id=None, name=None, description="", tags=None, state=None, dependencies=None,
parent_job=None, command="", entrypoint="", exitcodes="",
restartable=True, datavolumes=None, environment=None, image=None, cron="",
max_failures=3, delay=0, faildelay=5, port=None
):
return API.update_job(
id, name, description, tags, state, dependencies, parent_job, command,
entrypoint, exitcodes, restartable, datavolumes, environment, image, cron,
max_failures, delay, faildelay, port
)
@cherrypy.expose
def hook(self, api_token):
return API.hook(api_token)
@cherrypy.expose
def get_hooks(self, id=None, action=None, target=None, state=None, api_token=None):
return API.get_hooks(id, action, target, state, api_token)
@cherrypy.expose
def delete_hook(self, id):
if cherrypy.session.get("usertype", "user") == "admin":
return API.delete_hook(id)
else:
return json.dumps({"error": "User not authorized for this request"})
@cherrypy.expose
def disable_hook(self, id):
if cherrypy.session.get("usertype", "user") == "admin":
return API.disable_hook(id)
else:
return json.dumps({"error": "User not authorized for this request"})
@cherrypy.expose
def enable_hook(self, id):
if cherrypy.session.get("usertype", "user") == "admin":
return API.enable_hook(id)
else:
return json.dumps({"error": "User not authorized for this request"})
@cherrypy.expose
def add_incoming_hook(self, name=None, action=None, target=None):
if cherrypy.session.get("usertype", "user") == "admin":
return API.add_incoming_hook(name, action, target)
@cherrypy.expose
def set_setting(self, setting=None, value=None):
# Check if the user is an admin
if cherrypy.session.get("usertype", "user") == "admin":
return API.set_setting(setting, value)
else:
return json.dumps({"error": "User not authorized for this request"})
@cherrypy.expose
def update_user(self, userid, usertype):
# Check if the user is an admin
if cherrypy.session.get("usertype", "user") == "admin":
return API.update_user(userid, usertype)
else:
return json.dumps({"error": "User not authorized for this request"})
@cherrypy.expose
def delete_user(self, userid):
# Check if the user is an admin
if cherrypy.session.get("usertype", "user") == "admin":
return API.delete_user(userid)
else:
return json.dumps({"error": "User not authorized for this request"})
@cherrypy.expose
def add_user(self, username, userid, usertype):
# Check if the user is an admin
if cherrypy.session.get("usertype", "user") == "admin":
return API.add_user(username, userid, usertype)
else:
return json.dumps({"error": "User not authorized for this request"})
@cherrypy.expose
def add_instance_configuration(self, name=None, ami=None, key=None, iam=None, ebssize=None,
ebstype=None, userdata=None, instance_type=None, spot=None, bid=None,
subnet=None, sg=None, tag=None, id=None, default=False):
if cherrypy.session.get("usertype", "user") == "admin":
return API.add_instance_configuration(name, ami, key, iam, ebssize,
ebstype, userdata, instance_type, spot, bid,
subnet, sg, tag, id, default)
else:
return json.dumps({"error": "User not authorized for this request"})
@cherrypy.expose
def get_instance_configurations(self, id=None, name=None):
return API.get_instance_configurations(id, name)
@cherrypy.expose
def delete_configuration(self, id):
return API.delete_configuration(id)
@cherrypy.expose
def ping(self):
return "pong"
def secureheaders():
headers = cherrypy.response.headers
headers['X-Frame-Options'] = 'DENY'
headers['X-XSS-Protection'] = '1; mode=block'
headers['Content-Security-Policy'] = "default-src='self'"
headers['Strict-Transport-Security'] = 'max-age=31536000' # one year
def redirect_to_ssl():
""" """
redirect_url = cherrypy.request.base
redirect_url = redirect_url.replace(":" + str(cherrypy.request.local.port), "")
redirect_url = redirect_url.replace("http:", "https:")
raise cherrypy.HTTPRedirect(redirect_url)
def authenticate():
"""
If the session isn't authorized this will send the user to the login page
If the user agent for the session has changed this will invalidate the session
"""
path = cherrypy.request.path_info
# Don't redirect if the user is going to the login page
if (path == "/login" or path == "/hook" or path == "/ping"):
return
# If the session is not authorized redirect the user to the login page
if cherrypy.session.get("authorized", None) == None:
# Recurring AJAX requests should always send back a redirect signal
if (path == "/get_project" or path == "/get_hosts"):
cherrypy.session["login_msg"] = "AJAX not authorized"
return
# Record the request to return the user to upon authentication
if path in ["/history", "/add_task", "/add_job", "/update_job", "/update_task"]:
cherrypy.session["redirect"] = cherrypy.request.wsgi_environ['REQUEST_URI']
else:
cherrypy.session["redirect"] = "/"
# Redirect the user to the login page
cherrypy.session["login_msg"] = "Session not authorized"
raise cherrypy.HTTPRedirect("login")
# If the above conditional is false then the session was authorized
# The rest of this function will check if the session is still valid
# if the useragent doesn't match the original request, force a new session
useragent = cherrypy.request.headers['User-Agent']
if not cherrypy.session["_ident"] == sha256(useragent.encode('utf-8')).hexdigest():
cherrypy.session.clear()
cherrypy.session.delete()
cherrypy.lib.sessions.expire()
cherrypy.session["login_msg"] = "User Agent has changed"
raise cherrypy.HTTPRedirect("login")
# Check if the session has expired. If it is not, extend the session
now = int(time())
if cherrypy.session['expires'] >= now:
# Don't extend the session for recurring AJAX requests
if not path == "/get_project" and not path == "/get_hosts":
cherrypy.session['expires'] = now + 1800 # 30 minutes from now
else:
# destroy the session if it is expired
cherrypy.session.clear()
cherrypy.session.delete()
cherrypy.lib.sessions.expire()
cherrypy.session["login_msg"] = "Session Expired"
raise cherrypy.HTTPRedirect("login")
def dev_user():
if cherrypy.session.get("authorized", None) == None:
cherrypy.session["authorized"] = "true"
cherrypy.session["userid"] = "0"
cherrypy.session["username"] = "dev"
cherrypy.session["usertype"] = "admin"
cherrypy.session["userimageurl"] = ""
def start_web_interface(pg):
"""
Start the server
Arguments:
pg: The postgres class instance used in the main program
"""
global API
API = API(pg)
# Define the static path for template rendering
# Enable this if Nginx proxy is not being used
#conf = {
# '/static': {'tools.staticdir.on': True, 'tools.staticdir.dir': os.path.abspath(os.getcwd()) + '/static'},
# '/favicon.ico': {'tools.staticfile.on': True, 'tools.staticfile.filename': os.path.abspath(os.getcwd()) + '/UI/static/favicon.ico'}
#}
if settings['web_use_auth'] == "true":
cherrypy.tools.authenticate = cherrypy.Tool('before_handler', authenticate)
else:
cherrypy.tools.authenticate = cherrypy.Tool('before_handler', dev_user)
cherrypy.tools.secureheaders = cherrypy.Tool('before_finalize', secureheaders, priority=60)
cherrypy.config.update({
#'environment': 'production',
'tools.authenticate.on': True,
'tools.sessions.on': True,
'engine.autoreload.on': False,
'tools.sessions.timeout': 45,
'tools.sessions.secure': True,
'tools.sessions.httponly': True,
'tools.secureheaders.on': True,
'server.socket_host': '0.0.0.0',
'server.socket_port': 443,
'server.ssl_module': 'builtin',
'server.ssl_certificate': settings['web_ssl_cert_path'],
'server.ssl_private_key': settings['web_ssl_key_path'],
'server.ssl_certificate_chain': settings['web_ssl_chain_path'],
})
#cherrypy.tree.mount(Statuspage(), config=conf) # for static files without Nginx
cherrypy.tree.mount(Statuspage())
print("Staring Web Server")
cherrypy.engine.start()
cherrypy.engine.block()
if __name__ == '__main__':
from postgres_functions import Postgres
postgres = Postgres()
status = start_web_interface(postgres)
exit(status)