From 3a24bd72f6eb10f5d38d053f0b234793865f6821 Mon Sep 17 00:00:00 2001 From: John Estabrook Date: Wed, 6 May 2020 12:13:52 -0500 Subject: http api: function names should be consistent --- src/services/vyos-http-api-server | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/services/vyos-http-api-server b/src/services/vyos-http-api-server index c36cbd640..14cdd8437 100755 --- a/src/services/vyos-http-api-server +++ b/src/services/vyos-http-api-server @@ -77,7 +77,7 @@ def auth_required(f): @app.route('/configure', method='POST') @auth_required -def configure(): +def configure_op(): session = app.config['vyos_session'] env = session.get_session_env() config = vyos.config.Config(session_env=env) @@ -188,7 +188,7 @@ def configure(): @app.route('/retrieve', method='POST') @auth_required -def get_value(): +def retrieve_op(): session = app.config['vyos_session'] env = session.get_session_env() config = vyos.config.Config(session_env=env) @@ -274,7 +274,7 @@ def config_file_op(): @app.route('/image', method='POST') @auth_required -def config_file_op(): +def image_op(): session = app.config['vyos_session'] command = bottle.request.forms.get("data") -- cgit v1.2.3 From 25c65547458a3a2f4f4f8b1b70541229f3cbcc0c Mon Sep 17 00:00:00 2001 From: John Estabrook Date: Wed, 6 May 2020 12:35:16 -0500 Subject: http api: catch appropriate errors --- src/services/vyos-http-api-server | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/services/vyos-http-api-server b/src/services/vyos-http-api-server index 14cdd8437..4928b0bae 100755 --- a/src/services/vyos-http-api-server +++ b/src/services/vyos-http-api-server @@ -229,6 +229,8 @@ def retrieve_op(): return error(400, "\"{0}\" is not a valid operation".format(op)) except VyOSError as e: return error(400, str(e)) + except ConfigSessionError as e: + return error(400, str(e)) except Exception as e: print(traceback.format_exc(), file=sys.stderr) return error(500, "An internal error occured. Check the logs for details.") @@ -264,7 +266,7 @@ def config_file_op(): res = session.commit() else: return error(400, "\"{0}\" is not a valid operation".format(op)) - except VyOSError as e: + except ConfigSessionError as e: return error(400, str(e)) except Exception as e: print(traceback.format_exc(), file=sys.stderr) @@ -300,7 +302,7 @@ def image_op(): res = session.remove_image(name) else: return error(400, "\"{0}\" is not a valid operation".format(op)) - except VyOSError as e: + except ConfigSessionError as e: return error(400, str(e)) except Exception as e: print(traceback.format_exc(), file=sys.stderr) -- cgit v1.2.3 From dbe9f73cc9180b5c0d06007476d7120cde51725d Mon Sep 17 00:00:00 2001 From: John Estabrook Date: Wed, 6 May 2020 16:32:02 -0500 Subject: http api: use decorator to get command data from request --- src/services/vyos-http-api-server | 56 ++++++++++++++++++--------------------- 1 file changed, 26 insertions(+), 30 deletions(-) diff --git a/src/services/vyos-http-api-server b/src/services/vyos-http-api-server index 4928b0bae..5cad67eb7 100755 --- a/src/services/vyos-http-api-server +++ b/src/services/vyos-http-api-server @@ -63,6 +63,20 @@ def success(data): resp = {"success": True, "data": data, "error": None} return json.dumps(resp) +def get_command(f): + @wraps(f) + def decorated_function(*args, **kwargs): + cmd = bottle.request.forms.get("data") + if not cmd: + return error(400, "Non-empty data field is required") + try: + cmd = json.loads(cmd) + except Exception as e: + return error(400, "Failed to parse JSON: {0}".format(e)) + return f(cmd, *args, **kwargs) + + return decorated_function + def auth_required(f): @wraps(f) def decorated_function(*args, **kwargs): @@ -76,8 +90,9 @@ def auth_required(f): return decorated_function @app.route('/configure', method='POST') +@get_command @auth_required -def configure_op(): +def configure_op(commands): session = app.config['vyos_session'] env = session.get_session_env() config = vyos.config.Config(session_env=env) @@ -88,15 +103,6 @@ def configure_op(): else: strict = False - commands = bottle.request.forms.get("data") - if not commands: - return error(400, "Non-empty data field is required") - else: - try: - commands = json.loads(commands) - except Exception as e: - return error(400, "Failed to parse JSON: {0}".format(e)) - # Allow users to pass just one command if not isinstance(commands, list): commands = [commands] @@ -187,15 +193,13 @@ def configure_op(): return success(None) @app.route('/retrieve', method='POST') +@get_command @auth_required -def retrieve_op(): +def retrieve_op(command): session = app.config['vyos_session'] env = session.get_session_env() config = vyos.config.Config(session_env=env) - command = bottle.request.forms.get("data") - command = json.loads(command) - try: op = command['op'] path = " ".join(command['path']) @@ -238,13 +242,11 @@ def retrieve_op(): return success(res) @app.route('/config-file', method='POST') +@get_command @auth_required -def config_file_op(): +def config_file_op(command): session = app.config['vyos_session'] - command = bottle.request.forms.get("data") - command = json.loads(command) - try: op = command['op'] except KeyError: @@ -275,13 +277,11 @@ def config_file_op(): return success(res) @app.route('/image', method='POST') +@get_command @auth_required -def image_op(): +def image_op(command): session = app.config['vyos_session'] - command = bottle.request.forms.get("data") - command = json.loads(command) - try: op = command['op'] except KeyError: @@ -312,13 +312,11 @@ def image_op(): @app.route('/generate', method='POST') +@get_command @auth_required -def generate_op(): +def generate_op(command): session = app.config['vyos_session'] - command = bottle.request.forms.get("data") - command = json.loads(command) - try: op = command['op'] path = command['path'] @@ -342,13 +340,11 @@ def generate_op(): return success(res) @app.route('/show', method='POST') +@get_command @auth_required -def show_op(): +def show_op(command): session = app.config['vyos_session'] - command = bottle.request.forms.get("data") - command = json.loads(command) - try: op = command['op'] path = command['path'] -- cgit v1.2.3 From c4312498ebe0643061f1d06ad9655d49fb9d9af7 Mon Sep 17 00:00:00 2001 From: John Estabrook Date: Wed, 6 May 2020 17:43:33 -0500 Subject: http api: T2395: replace bottle with flask as microframework --- debian/control | 2 +- src/services/vyos-http-api-server | 27 +++++++++++++-------------- 2 files changed, 14 insertions(+), 15 deletions(-) diff --git a/debian/control b/debian/control index 5c176f40a..592d5153d 100644 --- a/debian/control +++ b/debian/control @@ -28,7 +28,7 @@ Depends: python3, python3-isc-dhcp-leases, python3-hurry.filesize, python3-vici (>= 5.7.2), - python3-bottle, + python3-flask, python3-netaddr, python3-zmq, cron, diff --git a/src/services/vyos-http-api-server b/src/services/vyos-http-api-server index 5cad67eb7..4a653bb66 100755 --- a/src/services/vyos-http-api-server +++ b/src/services/vyos-http-api-server @@ -26,7 +26,7 @@ import signal import vyos.config -import bottle +from flask import Flask, request from functools import wraps @@ -37,7 +37,7 @@ from vyos.config import VyOSError DEFAULT_CONFIG_FILE = '/etc/vyos/http-api.conf' CFG_GROUP = 'vyattacfg' -app = bottle.default_app() +app = Flask(__name__) # Giant lock! lock = threading.Lock() @@ -55,9 +55,8 @@ def check_auth(key_list, key): return id def error(code, msg): - bottle.response.status = code resp = {"success": False, "error": msg, "data": None} - return json.dumps(resp) + return json.dumps(resp), code def success(data): resp = {"success": True, "data": data, "error": None} @@ -66,7 +65,7 @@ def success(data): def get_command(f): @wraps(f) def decorated_function(*args, **kwargs): - cmd = bottle.request.forms.get("data") + cmd = request.form.get("data") if not cmd: return error(400, "Non-empty data field is required") try: @@ -80,7 +79,7 @@ def get_command(f): def auth_required(f): @wraps(f) def decorated_function(*args, **kwargs): - key = bottle.request.forms.get("key") + key = request.form.get("key") api_keys = app.config['vyos_keys'] id = check_auth(api_keys, key) if not id: @@ -89,7 +88,7 @@ def auth_required(f): return decorated_function -@app.route('/configure', method='POST') +@app.route('/configure', methods=['POST']) @get_command @auth_required def configure_op(commands): @@ -97,7 +96,7 @@ def configure_op(commands): env = session.get_session_env() config = vyos.config.Config(session_env=env) - strict_field = bottle.request.forms.get("strict") + strict_field = request.form.get("strict") if strict_field == "true": strict = True else: @@ -192,7 +191,7 @@ def configure_op(commands): else: return success(None) -@app.route('/retrieve', method='POST') +@app.route('/retrieve', methods=['POST']) @get_command @auth_required def retrieve_op(command): @@ -241,7 +240,7 @@ def retrieve_op(command): return success(res) -@app.route('/config-file', method='POST') +@app.route('/config-file', methods=['POST']) @get_command @auth_required def config_file_op(command): @@ -276,7 +275,7 @@ def config_file_op(command): return success(res) -@app.route('/image', method='POST') +@app.route('/image', methods=['POST']) @get_command @auth_required def image_op(command): @@ -311,7 +310,7 @@ def image_op(command): return success(res) -@app.route('/generate', method='POST') +@app.route('/generate', methods=['POST']) @get_command @auth_required def generate_op(command): @@ -339,7 +338,7 @@ def generate_op(command): return success(res) -@app.route('/show', method='POST') +@app.route('/show', methods=['POST']) @get_command @auth_required def show_op(command): @@ -396,4 +395,4 @@ if __name__ == '__main__': signal.signal(signal.SIGTERM, sig_handler) - bottle.run(app, host=server_config["listen_address"], port=server_config["port"], debug=True) + app.run(host=server_config["listen_address"], port=server_config["port"], debug=True) -- cgit v1.2.3 From 7b31dd720d96bc481323e3b00100da718f551cd5 Mon Sep 17 00:00:00 2001 From: John Estabrook Date: Wed, 6 May 2020 17:49:12 -0500 Subject: http api: T2395: add waitress as production WSGI server --- debian/control | 1 + src/services/vyos-http-api-server | 7 ++++++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/debian/control b/debian/control index 592d5153d..32c0286a4 100644 --- a/debian/control +++ b/debian/control @@ -29,6 +29,7 @@ Depends: python3, python3-hurry.filesize, python3-vici (>= 5.7.2), python3-flask, + python3-waitress, python3-netaddr, python3-zmq, cron, diff --git a/src/services/vyos-http-api-server b/src/services/vyos-http-api-server index 4a653bb66..4c41fa96d 100755 --- a/src/services/vyos-http-api-server +++ b/src/services/vyos-http-api-server @@ -27,6 +27,7 @@ import signal import vyos.config from flask import Flask, request +from waitress import serve from functools import wraps @@ -395,4 +396,8 @@ if __name__ == '__main__': signal.signal(signal.SIGTERM, sig_handler) - app.run(host=server_config["listen_address"], port=server_config["port"], debug=True) + try: + serve(app, host=server_config["listen_address"], + port=server_config["port"]) + except OSError as e: + print(f"OSError {e}") -- cgit v1.2.3