-
Notifications
You must be signed in to change notification settings - Fork 0
/
server.py
580 lines (484 loc) · 19.8 KB
/
server.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
"""
Webhook Queue - Simple, don-durable, multi-client webhook queueing server
Copyright (C) 2020 Andrew Story
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
"""
from bottle import post, get, run, response, request, route, parse_auth
from typing import TypedDict, List, Optional
import hashlib
import binascii
import json
import hmac
import time
import random
import os
class NoneHash:
def __init__(self):
self.data = b""
def update(self, content: bytes):
self.data += content
def digest(self) -> bytes:
return self.data
# If you're looking to add more ways to authenticate webhook requests, scan for `More Auth Methods`
# If you're missing certain hash types, this is where to add them
hash_dict = {
"plain": NoneHash,
"sha1": hashlib.sha1,
"sha224": hashlib.sha224,
"sha256": hashlib.sha256,
"sha384": hashlib.sha384,
"sha512": hashlib.sha512,
"blake2b": hashlib.blake2b,
"blake2s": hashlib.blake2s,
}
# If you need more ways to authenticate a message (in place of HMAC), this is where you would add them
def apply_auth(strategy: str, key: str, message: bytes) -> str:
global hash_dict
decomposed = strategy.split("-")
hasher = hash_dict[decomposed[1]]
if decomposed[1] == "plain":
raise StatusError(500, "Plain hasher is not permitted for the authentication method")
if decomposed[0] == "hmac":
authenticator = hmac.new(key.encode("utf-8"), digestmod=hasher)
elif decomposed[0] == "hash":
authenticator = hasher()
else:
raise StatusError(501, "Unknown auth strategy")
authenticator.update(message)
return authenticator.hexdigest()
class StatusError(Exception):
def __init__(self, status_code: int, reason: str):
self.status_code = status_code
self.reason = reason
class FatalError(StatusError):
def __init__(self, reason: str, other: Exception = None):
StatusError.__init__(self, 500, "FATAL ERROR: " + reason)
self.other = other
class RefreshError(StatusError):
def __init__(self, reason: str):
StatusError.__init__(self, 410, reason)
class QueueInfo(TypedDict, total=True):
name: str
last_message: int
class QueueMessage:
def __init__(self, id: int, message: str):
self.id: int = id
self.message: str = message
class UserConf(TypedDict, total=True):
name: str
pass_hash: str
can_reload: bool
queues: List[str]
class QueueAuthConf(TypedDict, total=False):
key: str
method: str
header_name: str
# More Auth Methods
# Insert whatever additional auth fields you need here
class QueueConf(TypedDict, total=False):
name: str
whitelist_ip: List[str]
auth: QueueAuthConf
max_message_count: int
max_message_size: int
max_queue_size: int
class Conf(TypedDict, total=False):
listen_host: str
listen_port: int
users: List[UserConf]
queues: List[QueueConf]
max_message_count: int
max_message_size: int
max_queue_size: int
def load_conf(fname: str) -> Conf:
def validate(target: dict, name: str, required: List[str] = [], optional: List[str] = []):
keys = [key for key in target]
for req in required:
if req not in keys:
raise StatusError(500, "Required key '{}' was not found in '{}' object".format(req, name))
for key in keys:
if key not in required and key not in optional:
raise StatusError(500, "Unrecognized key '{}' was found in '{}' object".format(key, name))
try:
with open(fname, "r") as f:
default_conf = {"max_message_count": 100, "max_message_size": 20000, "max_queue_size": 1000000}
result = json.load(f)
validate(result, "base configuration", ["listen_host", "listen_port", "users", "queues"], ["max_message_count", "max_message_size", "max_queue_size"])
for u in result["users"]:
validate(u, "user", ["name", "pass_hash"], ["queues", "can_reload"])
if u["queues"] is None:
u["queues"] = []
for q in result["queues"]:
validate(q, "queue", ["name"], ["whitelist_ip", "auth", "max_message_count", "max_message_size", "max_queue_size"])
if q["auth"] is not None:
validate(q["auth"], "queue.auth", optional=["key", "method", "header_name"])
# More Auth Methods
# Insert more validators here as needed
default_conf.update(result)
return Conf(**default_conf)
except FileNotFoundError:
print("No configuration file found. Writing example configuration to", fname)
with open(fname, "w") as f:
json.dump(
fp=f,
indent=4,
obj={
"listen_host": "0.0.0.0",
"listen_port": 8080,
"users": [{"name": "John Doe", "pass_hash": hash_pass("insecure", "plain"), "queues": ["foo"]}],
"queues": [{"name": "foo", "whitelist_ip": [], "auth": {"key": "12345", "method": "hmac-sha256", "header_name": "Foo-Auth"}}],
"max_message_count": 100,
"max_message_size": 2000,
"max_queue_size": 500000,
},
)
exit(1)
def write_conf(fname: str, conf: Conf):
temp = "{}.swap".format(fname)
with open(temp, "w") as f:
json.dump(conf, f, indent=4)
os.rename(temp, fname)
class UserClient:
def __init__(self, name: str, queue: str):
self.name = name
self.queue_name = queue
self.disconnected = False
self.disconnect_reason = ""
global queues
if queue not in queues:
raise StatusError(404, "That queue does not exist")
self.last_message = queues[queue].current_message
class User:
def __init__(self, conf: UserConf):
self.conf = conf
self.name = conf["name"]
self.clients = {}
def load_from_conf(self, conf: UserConf):
global queues
self.conf = conf
for c in self.clients:
client: UserClient = self.clients[c]
if client.queue_name not in self.conf["queues"]:
client.disconnected = True
client.disconnect_reason = "A reload has caused that queue to no longer be available to you"
if client.queue_name not in queues:
client.disconnected = True
client.disconnect_reason = "A reload has removed that queue"
def get_client(self, client: str) -> UserClient:
if client not in self.clients:
raise StatusError(404, "You are not currently listening on that client")
c = self.clients[client]
if c.disconnected:
raise StatusError(410, "That client has been disconnected because: {}".format(c.disconnect_reason))
return c
def listen(self, client: str, queue: str):
if queue not in self.conf["queues"]:
raise StatusError(404, "That queue is not available for listening")
if client not in self.clients:
self.clients[client] = UserClient(client, queue)
else:
c = self.clients[client]
if c.disconnected:
self.clients[client] = UserClient(client, queue)
else:
raise StatusError(400, "You are already listening from that client")
def unlisten(self, client: str):
if client in self.clients:
del self.clients[client]
else:
raise StatusError(404, "That client does not exist")
def set_password(self, new_password: str):
global config
if len(new_password) < 6:
raise StatusError(400, "Password must be at least 6 characters long")
self.conf["pass_hash"] = hash_pass(new_password, salt=str(int(random.random() * 10000000000000)))
write_conf(config_fname, config)
def can_reload(self):
return self.conf["can_reload"] == True
class Queue:
def __init__(self, globalConf: "Conf", conf: "QueueConf"):
self.name = conf["name"]
self.max_message_count = 0
self.max_message_size = 0
self.max_queue_size = 0
self.whitelist_ip = []
self.auth_key = None
self.auth_method = None
self.auth_header_name = None
# More Auth Methods
# Insert whatever new auth fields you need here
self.current_message: int = 0
self.messages: List[QueueMessage] = []
self.queue_size = 0
self.last_dropped_message = -1
self.load_from_conf(globalConf, conf)
def load_from_conf(self, globalConf: "Conf", conf: "QueueConf"):
def load(conf, key: str, default_value=None):
if conf is not None and key in conf:
return conf[key]
return default_value
self.max_message_count = load(conf, "max_message_count", load(globalConf, "max_message_count"))
self.max_message_size = load(conf, "max_message_size", load(globalConf, "max_message_size"))
self.max_queue_size = load(conf, "max_queue_size", load(globalConf, "max_queue_size"))
self.whitelist_ip = load(conf, "whitelist_ip")
auth = load(conf, "auth")
self.auth_key = load(auth, "key")
self.auth_method = load(auth, "method")
self.auth_header_name = load(auth, "header_name")
# More Auth Methods
# Insert whatever new auth fields you need to load here
# More Auth Methods
# Alter this function to handle other ways to authenticate a webhook request
# Determines if the current Bottle request meets authentication requirements
def auth(self, message: bytes) -> bool:
if self.whitelist_ip is not None and len(self.whitelist_ip) > 0:
if request.remote_addr not in self.whitelist_ip:
return False
if self.auth_method is None:
return True
if self.auth_header_name is not None and self.auth_key is not None:
h = request.get_header(self.auth_header_name)
authenticated = apply_auth(self.auth_method, self.auth_key, message)
if authenticated == h:
return True
return False
# Reads the current Bottle request as a message
def push(self):
message: bytes = request.body.read()
authed = self.auth(message)
if authed == False:
raise StatusError(403, "Message was not properly authenticated")
msg_size = len(message)
self.current_message += 1
if msg_size > self.max_message_size:
self.last_dropped_message = self.current_message
raise StatusError(413, "Message was too large")
self.messages.append(QueueMessage(self.current_message, message.decode("utf-8")))
self.queue_size += msg_size
# Pop messages off the front until our queue size and message count fits in the max configured size
while (self.queue_size > self.max_queue_size or len(self.messages) > self.max_message_count) and len(self.messages) > 0:
popped = self.messages[0]
self.queue_size -= len(popped.message)
self.messages = self.messages[1:]
def read(self, client: UserClient) -> List[dict]:
if len(self.messages) == 0:
return []
if self.messages[0].id > client.last_message + 1:
client.last_message = self.current_message
raise RefreshError("It's been too long since you've read from the queue. As such, at least one message has been discarded. Please refresh your local state")
if self.last_dropped_message > client.last_message:
client.last_message = self.current_message
raise RefreshError(
"One or more messages have been dropped from the queue due to size constraints. If this continues to happen, consider reconfiguring your max queue sizes. Please refresh your local state"
)
estimate = self.current_message - client.last_message
offset = 0
idx = None
if self.messages[0].id == client.last_message + 1:
idx = 0
else:
for offset in range(len(self.messages)):
for x in range(-1, 2, 2): # get -1 and 1
check = estimate + offset * x
if check >= 0 and check < len(self.messages) and self.messages[check].id == client.last_message:
idx = check + 1
break
else:
continue
break
client.last_message = self.current_message
if idx == None:
return []
return [data.__dict__ for data in self.messages[idx:]]
def hash_pass(password: str, strategy: str = "sha512", salt: str = "") -> str:
global hash_dict
hasher = hash_dict[strategy]()
hasher.update(password.encode("utf-8"))
if salt != "" and strategy != "plain":
hasher.update(salt.encode("utf-8"))
digest = hasher.digest()
if strategy != "plain":
digest = binascii.hexlify(digest)
return "{};{};{}".format(strategy, salt, digest.decode("ascii"))
def compare_pass(provided: str, actual: str) -> bool:
decomposed = actual.split(";")
if len(decomposed) != 3:
raise StatusError(500, "Password hash on file is malformed")
new_hash = hash_pass(provided, decomposed[0], decomposed[1])
return new_hash == actual
def authenticate(config: Conf, username: str, password: str) -> Optional[UserConf]:
for u in config["users"]:
if u["name"] != username:
continue
if not compare_pass(password, u["pass_hash"]):
continue
return u
return None
# Checks the request for valid authentication information in the Authorization header
def must_authenticate() -> User:
global config, users
auth = request.get_header("Authorization")
username, password = parse_auth(auth)
conf = authenticate(config, username, password)
if conf == None:
raise StatusError(403, "Unrecognized login")
return users[username]
started_at = int(time.time())
config_fname = "options.conf"
config = Conf()
queues = {}
users = {}
def reload_conf():
global config, queues, users, config_fname
config = load_conf(config_fname)
old_queues = queues
old_users = users
queues = {}
users = {}
try:
for q in config["queues"]:
if q["name"] in old_queues:
new_queue = old_queues[q["name"]]
new_queue.load_from_conf(config, q)
else:
new_queue = Queue(config, q)
queues[new_queue.name] = new_queue
for u in config["users"]:
if u["name"] in old_users:
new_user = old_users[u["name"]]
new_user.load_from_conf(u)
else:
new_user = User(u)
users[new_user.name] = new_user
except Exception as e:
raise FatalError("Exception caught while importing new config", e)
try:
reload_conf()
except FatalError as e:
print("Failed to load configuration:", e.reason)
if e.other is not None:
raise e.other
except StatusError as e:
print("Failed to load configuration:", e.reason)
exit(1)
@post("/q/<name>")
def enqueue(name):
try:
if name not in queues:
return
q = queues[name]
q.push()
return
except RefreshError as e:
response.status = e.status_code
return json.dumps({"refresh": True, "message": e.reason})
except StatusError as e:
response.status = e.status_code
return json.dumps({"refresh": False, "message": e.reason})
except Exception as e:
response.status = 500
return json.dumps({"refresh": False, "message": " ".join(e.args)})
@get("/read/<client>")
def fetch(client):
try:
user = must_authenticate()
c = user.get_client(client)
if c.queue_name not in queues:
raise StatusError(404, "Unknown queue '{}'".format(c.queue_name))
q = queues[c.queue_name]
msgs = q.read(c)
result = {"time": str(started_at), "messages": msgs, "current_message": q.current_message}
return json.dumps(result)
except RefreshError as e:
response.status = e.status_code
return json.dumps({"refresh": True, "message": e.reason})
except StatusError as e:
response.status = e.status_code
return json.dumps({"refresh": False, "message": e.reason})
except Exception as e:
response.status = 500
return json.dumps({"refresh": False, "message": " ".join(e.args)})
@get("/listen/<client>/<queue>")
def listen(client, queue):
try:
user = must_authenticate()
user.listen(client, queue)
return ""
except RefreshError as e:
response.status = e.status_code
return json.dumps({"refresh": True, "message": e.reason})
except StatusError as e:
response.status = e.status_code
return json.dumps({"refresh": False, "message": e.reason})
except Exception as e:
response.status = 500
return json.dumps({"refresh": False, "message": " ".join(e.args)})
@get("/unlisten/<client>")
def unlisten(client):
try:
user = must_authenticate()
user.unlisten(client)
return ""
except RefreshError as e:
response.status = e.status_code
return json.dumps({"refresh": True, "message": e.reason})
except StatusError as e:
response.status = e.status_code
return json.dumps({"refresh": False, "message": e.reason})
except Exception as e:
response.status = 500
return json.dumps({"refresh": False, "message": " ".join(e.args)})
@post("/setPassword")
def set_password():
try:
user = must_authenticate()
body = json.load(request.body)
user.set_password(body["password"])
return ""
except RefreshError as e:
response.status = e.status_code
return json.dumps({"refresh": True, "message": e.reason})
except StatusError as e:
response.status = e.status_code
return json.dumps({"refresh": False, "message": e.reason})
except Exception as e:
response.status = 500
return json.dumps({"refresh": False, "message": " ".join(e.args)})
@get("/reload")
def reload():
try:
user = must_authenticate()
if user.can_reload():
reload_conf()
else:
raise StatusError(403, "User does not have reload permissions")
return ""
except RefreshError as e:
response.status = e.status_code
return json.dumps({"refresh": True, "message": e.reason})
except FatalError as e:
response.status = e.status_code
if e.other is not None:
raise e.other
return json.dumps({"refresh": False, "message": e.reason + ". Please restart the server"})
except StatusError as e:
response.status = e.status_code
return json.dumps({"refresh": False, "message": e.reason})
except Exception as e:
response.status = 500
return json.dumps({"refresh": False, "message": " ".join(e.args)})
@route("/time")
def get_time():
return "{}".format(started_at)
if __name__ == "__main__":
run(host=config["listen_host"], port=config["listen_port"])